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