| Template-Plugin-PodSimple documentation | view source | Contained in the Template-Plugin-PodSimple distribution. |
Template::Plugin::PodSimple - simple Pod::Simple plugin for TT
[% USE PodSimple %]
[% PodSimple.parse('format',string_containing_pod_or_filename) %]
[% SET somepod = "
=head1 NAME
the name
=head1 DESCRIPTION
somepod
=cut
";
USE PodSimple;
%]
[% PodSimple.parse('Text', somepod, 76) %]
[% PodSimple.parse('xml', somepod) %]
[% mySimpleTree = PodSimple.parse('tree', somepod ) %]
[% PodSimple.parse('html', somepod, 'pod_link_prefix','man_link_prefix') %]
Text translates to Pod::Simple::Text.
When dealing with text, the 3rd argument is the value for $Text::Wrap::columns .
xMl translates to Pod::Simple::XMLOutStream.
tree translates to Pod::Simple::SimpleTree, and the tree root is what's returned. This is what you want to use if you want to create your own formatter.
htMl translates to Pod::Simple::HTML.
When dealing with htMl, the 3rd and 4th arguments are
is used to prefix all non-local L<>inks,
by temporarily overriding
*Pod::Simple::HTML::do_pod_link.
and
*Pod::Simple::HTML::do_man_link.
pod_link_prefix is "?" by default.
man_link_prefix is http://man.linuxquestions.org/index.php?type=2&query=
by default.
The prefix always gets html escaped by Pod::Simple.
An example man link is crontab(5).
To report bugs, go to <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Template-Plugin-PodSimple> or send mail to <bug-Template-Plugin-PodSimple#rt.cpan.org>.
Copyright (c) 2003 by D.H. (PodMaster). All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The LICENSE file contains the full text of the license.
| Template-Plugin-PodSimple documentation | view source | Contained in the Template-Plugin-PodSimple distribution. |