Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info

1 files changed, 36 insertions, 0 deletions

diff --git a/doc/plugins/contrib/pod.mdwn b/doc/plugins/contrib/pod.mdwn
new file mode 100644
index 000000000..5ca1b3347
--- /dev/null
+++ b/doc/plugins/contrib/pod.mdwn
@@ -0,0 +1,36 @@
+[[!template id=plugin name=pod author="[[rubykat]]"]]
+## NAME
+
+IkiWiki::Plugin::pod - process pages written in POD format.
+
+## SYNOPSIS
+
+In the ikiwiki setup file, enable this plugin by adding it to the
+list of active plugins.
+
+    add_plugins => [qw{goodstuff pod ....}],
+
+## DESCRIPTION
+
+IkiWiki::Plugin::pod is an IkiWiki plugin enabling ikiwiki to
+process pages written in POD (Plain Old Documentation) format.
+This will treat files with a `.pod` or `.pm` extension as files
+which contain POD markup.
+
+## OPTIONS
+
+The following options can be set in the ikiwiki setup file.
+
+* **pod_index:** If true, this will generate an index (table of contents) for the page.
+* **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.
+
+## PREREQUISITES
+
+    IkiWiki
+    Pod::Xhtml
+    IO::String
+
+## DOWNLOAD
+
+* browse at GitHub: <http://github.com/rubykat/ikiplugins/blob/master/IkiWiki/Plugin/pod.pm>
+* git repo at git://github.com/rubykat/ikiplugins.git