Perl Brasil> TWiki Web>PodPlugin (04 Mar 2006, NelsonFerraz)EditAttach

PodPlugin

Extract Perl documentation (POD) online. Write TWiki topics in POD.

On this page:

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:
    File: Description:
    data/TWiki/PodPlugin.txt Plugin topic
    data/TWiki/PodPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/PodPlugin.pm Plugin Perl module
    lib/TWiki/Plugins/PodPlugin/Pod2Html.pm Pod to Html translation module

Plugin Info

Plugin Author(s): TWiki:Main.JoenioCosta, TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny
Plugin Version: 0 (26 Mai 2008)
Copyright: ©
License: GPL (Gnu General Public License)
Change History:  
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:
NameVersionDescription
Carp>=0Required for lib/TWiki/Plugins/PodPlugin/Pod2Html.pm
File::Spec::Unix>=0Required for lib/TWiki/Plugins/PodPlugin/Pod2Html.pm
Perl Version: 5.0
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/PodPlugin
Appraisal: http://twiki.org/cgi-bin/view/Plugins/PodPluginAppraisal
Feedback: http://twiki.org/cgi-bin/view/Plugins/PodPluginDev

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

Edit | Attach | Print version | History: r1 | Backlinks | Raw View | More topic actions
Topic revision: r1 - 04 Mar 2006 - 02:30:26 - NelsonFerraz
 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Perl Brasil? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.PodPlugin