PodPlugin

Extract Perl Old Documentation (POD) online. (Write TWiki topics in POD!!!)

Usage

Just install the plugin and it will look for PODs to convert. (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:

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

Plugin Info

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWiki:Main.JoenioCosta - 28 May 2008