POD2WIKI(1p) User Contributed Perl Documentation POD2WIKI(1p)NAME
pod2wiki - A utility to convert Pod documents to Wiki format.
SYNOPSIS
pod2wiki [--style --noerrata --help --man] podfile [outfile]
Options:
--style wiki style (defaults to wiki. See --help)
--noerrata don't generate a "POD ERRORS" section
--help brief help message
--man full documentation
DESCRIPTION
This program is used for converting Pod text to Wiki text.
Pod is Perl's Plain Old Documentation format. See "man perlpod" or "perldoc perlpod".
A Wiki is a user extensible web site. It uses very simple mark-up that is converted to Html. For an introduction to Wikis see:
http://en.wikipedia.org/wiki/Wiki
OPTIONS
podfile
The input file that contains the Pod file to be converted. It can also be stdin.
outfile
The converted output file in wiki format. Defaults to stdout if not specified.
--style or -s
Sets the wiki style of the output. If no "style" is specified the program defaults to "wiki". The available options are:
wiki
This is the original Wiki format as used on Ward Cunningham's Portland repository of Patterns. See http://c2.com/cgi/wiki
kwiki
This is the format as used by Brian Ingerson's Kwiki: http://www.kwiki.org
usemod
This is the format used by the Usemod wikis. See: http://www.usemod.com/cgi-bin/wiki.pl
twiki
This is the format used by TWiki wikis. See: http://twiki.org/
tiddlywiki
This is the format used by the TiddlyWiki. See: http://www.tiddlywiki.com/
textile
The Textile markup format as used on GitHub. See: http://textile.thresholdstate.com/
wikipedia or mediawiki
This is the format used by Wikipedia and MediaWiki wikis. See: http://www.mediawiki.org/
moinmoin
This is the format used by MoinMoin wikis. See: http://moinmo.in/MoinMoinWiki
confluence
This is the format used by Confluence. See: http://www.atlassian.com/software/confluence/
--noerrata or -noe
Don't generate a "POD ERRORS" section at the end of the document. Equivalent to the "Pod::Simple::no_errata_section()" method.
--help or -h
Print a brief help message and exits.
--man or -m
Prints the manual page and exits.
DISCLAIMER OF WARRANTY
Please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki.
AUTHOR
John McNamara jmcnamara@cpan.org
COPYRIGHT
X MMIII-MMVIII, John McNamara.
All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.
perl v5.10.1 2009-08-26 POD2WIKI(1p)
Check Out this Related Man Page
Wiki::Toolkit::Feed::Atom(3pm) User Contributed Perl Documentation Wiki::Toolkit::Feed::Atom(3pm)NAME
Wiki::Toolkit::Feed::Atom - A Wiki::Toolkit plugin to output RecentChanges Atom.
DESCRIPTION
This is an alternative access to the recent changes of a Wiki::Toolkit wiki. It outputs the Atom Syndication Format as described at
<http://www.atomenabled.org/developers/syndication/>.
This module is a straight port of Wiki::Toolkit::Feed::RSS.
SYNOPSIS
use Wiki::Toolkit;
use Wiki::Toolkit::Feed::Atom;
my $wiki = Wiki::Toolkit->new( ... ); # See perldoc Wiki::Toolkit
# Set up the RSS feeder with the mandatory arguments - see
# C<new()> below for more, optional, arguments.
my $atom = Wiki::Toolkit::Feed::Atom->new(
wiki => $wiki,
site_name => 'My Wiki',
site_url => 'http://example.com/',
make_node_url => sub
{
my ($node_name, $version) = @_;
return 'http://example.com/?id=' . uri_escape($node_name) . ';version=' . uri_escape($version);
},
html_equiv_link => 'http://example.com/?RecentChanges',
atom_link => 'http://example.com/?action=rc;format=atom',
);
print "Content-type: application/atom+xml
";
print $atom->recent_changes;
METHODS
"new()"
my $atom = Wiki::Toolkit::Feed::Atom->new(
# Mandatory arguments:
wiki => $wiki,
site_name => 'My Wiki',
site_url => 'http://example.com/',
make_node_url => sub
{
my ($node_name, $version) = @_;
return 'http://example.com/?id=' . uri_escape($node_name) . ';version=' . uri_escape($version);
},
html_equiv_link => 'http://example.com/?RecentChanges',,
atom_link => 'http://example.com/?action=rc;format=atom',
# Optional arguments:
site_description => 'My wiki about my stuff',
software_name => $your_software_name, # e.g. "Wiki::Toolkit"
software_version => $your_software_version, # e.g. "0.73"
software_homepage => $your_software_homepage, # e.g. "http://search.cpan.org/dist/CGI-Wiki/"
encoding => 'UTF-8'
);
"wiki" must be a Wiki::Toolkit object. "make_node_url", if supplied, must be a coderef.
The mandatory arguments are:
o wiki
o site_name
o site_url
o make_node_url
o html_equiv_link or recent_changes_link
o atom_link
The three optional arguments
o software_name
o software_version
o software_homepage
are used to generate the "generator" part of the feed.
The optional argument
o encoding
will be used to specify the character encoding in the feed. If not set, will default to the wiki store's encoding.
"recent_changes()"
$wiki->write_node(
'About This Wiki',
'blah blah blah',
$checksum,
{
comment => 'Stub page, please update!',
username => 'Fred',
}
);
print "Content-type: application/atom+xml
";
print $atom->recent_changes;
# Or get something other than the default of the latest 15 changes.
print $atom->recent_changes( items => 50 );
print $atom->recent_changes( days => 7 );
# Or ignore minor edits.
print $atom->recent_changes( ignore_minor_edits => 1 );
# Personalise your feed further - consider only changes
# made by Fred to pages about bookshops.
print $atom->recent_changes(
filter_on_metadata => {
username => 'Fred',
category => 'Bookshops',
},
);
If using "filter_on_metadata", note that only changes satisfying all criteria will be returned.
Note: Many of the fields emitted by the Atom generator are taken from the node metadata. The form of this metadata is not mandated by
Wiki::Toolkit. Your wiki application should make sure to store some or all of the following metadata when calling "write_node":
comment - a brief comment summarising the edit that has just been made; will be used in the summary for this item. Defaults to the empty
string.
username - an identifier for the person who made the edit; will be used as the Dublin Core contributor for this item, and also in the RDF
description. Defaults to 'No description given for change'.
host - the hostname or IP address of the computer used to make the edit; if no username is supplied then this will be used as the author
for this item. Defaults to 'Anonymous'.
"generate_node_list_feed"
Generate and return an Atom feed for a list of nodes
"generate_node_name_distance_feed"
Generate a very cut down atom feed, based just on the nodes, their locations (if given), and their distance from a reference location (if
given).
Typically used on search feeds.
"feed_timestamp()"
print $atom->feed_timestamp();
Returns the timestamp of the feed in POSIX::strftime style ("Tue, 29 Feb 2000 12:34:56 GMT"), which is equivalent to the timestamp of the
most recent item in the feed. Takes the same arguments as recent_changes(). You will most likely need this to print a Last-Modified HTTP
header so user-agents can determine whether they need to reload the feed or not.
"parse_feed_timestamp"
Take a feed_timestamp and return a Time::Piece object.
SEE ALSO
o Wiki::Toolkit
o <http://www.atomenabled.org/developers/syndication/>
MAINTAINER
The Wiki::Toolkit team, http://www.wiki-toolkit.org/.
COPYRIGHT AND LICENSE
Copyright 2006-2009 Earle Martin and the Wiki::Toolkit team. Copyright 2012 the Wiki::Toolkit team.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
THANKS
Kake Pugh for originally writing Wiki::Toolkit::Feed::RSS and indeed Wiki::Toolkit itself.
perl v5.14.2 2012-05-28 Wiki::Toolkit::Feed::Atom(3pm)