doc/plugins/contrib/pod.mdwn

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