%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)
=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
=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
L<....>
) are not supported
PerlDocPlugin.zip
in your twiki installation directory.
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 |