PodPlugin

Usage

Just install the plugin and it will look for topics in POD format and render them to HTML. (A POD is generally recognized by a =head1 tag)

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %PODPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Extract Perl documentation (POD) online. Write TWiki topics in POD.

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

• Non-zero to put an index at the top of the file:
  • Set DO_INDEX = 1

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

• Download the ZIP file from the Plugin Home (see below)
• Unzip PodPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/PodPlugin.txt	Plugin topic documentation
  lib/TWiki/Plugins/PodPlugin.pm	Plugin Perl module
  lib/TWiki/Plugins/PodPlugin/Pod2Html.pm	Pod to Html translation module

• Configure the Plugin:
  • Run the configure script to enable the plugin
  • Change the plugin settings as needed
• Test if the installation was successful:
  • Create a topic with below content and check if result is rendered in HTML:

Plugin Info

Plugin Author(s):	TWiki:Main.JoenioCosta, TWiki:Main.NelsonFerraz, TWiki:Main.AndreaSterbini
Plugin Version:	19368 (2010-08-25)
Copyright:	© 2007, TWiki:Main.JoenioCosta, © 2007-2010 TWiki:TWiki.TWikiContributor
License:	GPL (Gnu General Public License)
Change History:
2010-08-25:	TWikibug:Item6530 - fix issue in Exporter import; doc enhancements; changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny
28 Mai 2008:	First public version
22 Mai 2008:	resuming development of the plugin
21 Mar 2004:	Added afterSaveHandler
14 Jul 2001:	Changed to plug&play
27 Feb 2001:	Initial version
Dependencies:	Name Version Description Carp >=0 Required for lib/TWiki/Plugins/PodPlugin/Pod2Html.pm File::Spec::Unix >=0 Required for lib/TWiki/Plugins/PodPlugin/Pod2Html.pm
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/PodPlugin
Feedback:	http://twiki.org/cgi-bin/view/Plugins/PodPluginDev

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences