ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / contrib / pod.mdwn
1 [[!template id=plugin name=pod author="[[rubykat]]"]]
2 [[!tag type/format]]
3 ## NAME
4
5 IkiWiki::Plugin::pod - process pages written in POD format.
6
7 ## SYNOPSIS
8
9 In the ikiwiki setup file, enable this plugin by adding it to the
10 list of active plugins.
11
12     add_plugins => [qw{goodstuff pod ....}],
13
14 ## DESCRIPTION
15
16 IkiWiki::Plugin::pod is an IkiWiki plugin enabling ikiwiki to
17 process pages written in POD ([Plain Old Documentation](http://en.wikipedia.org/wiki/Plain_Old_Documentation)) format.
18 This will treat files with a `.pod` or `.pm` extension as files
19 which contain POD markup.
20
21 ## OPTIONS
22
23 The following options can be set in the ikiwiki setup file.
24
25 * **pod_index:** If true, this will generate an index (table of contents) for the page.
26 * **pod_toplink:** The label to be used for links back to the top of the page.  If this is empty, then no top-links will be generated.
27
28 ## PREREQUISITES
29
30     IkiWiki
31     Pod::Xhtml
32     IO::String
33
34 ## DOWNLOAD
35
36 * browse at GitHub: <http://github.com/rubykat/ikiplugins/blob/master/IkiWiki/Plugin/pod.pm>
37 * git repo at git://github.com/rubykat/ikiplugins.git
38