You are here: TWiki> Plugins Web>PodPlugin (2009-04-10, PeterThoeny)
Tags:
deployment1Add my vote for this tag documentation1Add my vote for this tag create new tag
, view all tags

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:
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:
    • 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:

=head1 NAME

Test podplugin - testing podplugin

=cut

Plugin Info

Plugin Author(s): TWiki:Main.JoenioCosta, TWiki:Main.NelsonFerraz, TWiki:Main.AndreaSterbini
Plugin Version: 27 Mai 2008 (0.1)
Copyright: © 2007, TWiki:Main.JoenioCosta
License: GPL (Gnu General Public License)
Change History:  
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:
NameVersionDescription
Carp>=0Required for lib/TWiki/Plugins/PodPlugin/Pod2Html.pm
File::Spec::Unix>=0Required 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

-- TWiki:Main.JoenioCosta - 28 May 2008

Topic attachments
I Attachment Action Size Date Who Comment
zipzip PodPlugin.zip manage 16.8 K 2008-05-28 - 02:57 JoenioCosta PodPlugin v0.1
Topic revision: r3 - 2009-04-10 - 21:18:10 - PeterThoeny
 
TWIKI.NET
This site is powered by the TWiki collaboration platform
Ideas, requests, problems regarding TWiki? Send feedback
Copyright © 1999-2009 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.