Perl Doc Plugin

Extract the Perl documentation (POD) from a Perl module and display it in a topic

Syntax Rules and Example

Write %PERLDOC{"Module"}% to display the documentation of a Perl module, for example %PERLDOC{"File::Copy"}% shows the doc of File::Copy. Optionally use a format="pod" parameter to see the raw POD format, or format="twiki" to see the TWiki markup text.

Use the following form to see the documentation of a Perl module: (this Plugin needs to be installed and enabled)

Perl module name: in format

PerlDocPlugin: Nothing to do, no module specified.

Perl code with POD (Plain Old Documentation)

Perl code may contain blocks of documentation. A block typically starts with a =pod or =head1 at the beginning of a line, and ends with =cut at the beginning of a line or at the end of the file. Read the details in http://www.perldoc.com/perl5.6/pod/perlpod.html

POD example:

=head1 Demo of POD

Silly paragraph

=cut

Perl code with TWiki markup

TWiki markup can be used inside a =begin twiki ... =end twiki block. Keep in mind that this markup gets parsed correctly only by the PerlDocPlugin, other POD translator ignore the block. The TWiki markup is richer and more compact then POD. Example:

=begin twiki
---++ Demo of TWiki markup
Silly paragraph

=end twiki

=cut

Limitations

  • Links (L<....>) are not supported

Plugin Installation Instructions

  • For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

  • Or, follow these manual installation steps:
    • Download the ZIP file from the extension home on twiki.org (see below).
    • Unzip PerlDocPlugin.zip in your twiki installation directory.
    • Set the ownership of the extracted directories and files to the webserver user.
    • Install the dependencies (if any).

  • Plugin configuration and testing:
    • Run the configure script and enable the plugin in the Plugins section.
    • Configure additional plugin settings in the Extensions section if needed.
    • Test if the installation was successful using the examples provided.

Plugin Info

Plugin Author: TWiki:Main.PeterThoeny
Copyright: © 2002-2011 TWiki:Main.PeterThoeny;
© 2008-2011 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 29704 (2015-12-20)
Change History:  
2015-12-20: TWikibug:Item7706: Suppress expansion perl arrays to Twitter links;
TWikibug:Item7707: Fix POD parsing example in plugin topic
2011-07-13: TWikibug:Item6725: Change global package variables from "use vars" to "our"
2011-01-25: TWikibug:Item6638: Doc improvements
2010-08-25: TWikibug:Item6530: Fix for TWiki-5.0; doc improvements; changing TWIKIWEB to SYSTEMWEB
20 May 2007 Fixed for TWiki-4, added "=pod", repackaged with BuildContrib - TWiki:Main.CrawfordCurrie
07 Dec 2002: Removed "=pod" from showing up in html or twiki blocks
01 Dec 2002: Initial version
Dependencies: None
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/PerlDocPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/PerlDocPluginDev

Related Topics: TWikiPreferences, TWikiPlugins, AdminToolsCategory

Edit | Attach | Watch | Print version | History: r1 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r1 - 2011-07-14 - TWikiContributor
 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    TWiki All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2018 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.PerlDocPlugin