OODoc::Format::Pod - Produce POD pages from the doc tree
OODoc::Format::Pod is a OODoc::Format is a OODoc::Object OODoc::Format::Pod is extended by OODoc::Format::Pod2 OODoc::Format::Pod3
my $doc = OODoc->new(...); $doc->create ( 'pod' , format_options => [show_examples => 'NO'] , append => "extra text\n" );
Create manual pages in the POD syntax. POD is the standard document description syntax for Perl. POD can be translated to many different operating system specific manual systems, like the Unix
The POD is produced in the specified IN filename, but may contain some garbage, especially a lot of superfluous blanks lines. Because it is quite complex to track double blank lines in the production process, we make an extra pass over the POD to remove it afterwards. Other clean-up activities may be implemented later.
-Option --Defined in --Default append '' format_options OODoc::Format  manual OODoc::Format <required> project OODoc::Format <required> template OODoc::Format undef
The OPTIONS are a collection of all options available to show* methods. They are completed with the defaults set by createManual(format_options).
-Option--Default append '' manual <required> output <required>
Used after each manual page has been formatting according to the standard rules. When a STRING is specified, it will be appended to the manual page. When a CODE reference is given, that function is called with all the options that showChapter() usually gets.
append is one of the alternatives to create the correct Reference, Copyrights, etc chapters at the end of each manual page. See "Configuring".
Create the text for a link which refers to the OBJECT. The link will be shown somewhere in the MANUAL. The TEXT will be displayed is stead of the link path, when specified.
There is (AFAIK) no way to get the standard podlators code to remove all markup from a string: to simplify a string. On the other hand, you are not allowed to put markup in a verbatim block, but we do have that. So: we have to clean the strings ourselves.
-Option--Default ARRAY <required> header <required> output <required> widths undef
createManual(format_options) or OODoc::create(format_options) can be used with a list of formatting options which are passed to showChapter(). This will help you to produce pages which have pre-planned changes in layout.
By default, the last chapters are not filled in: the
COPYRIGHTS chapters are very personal. You can fill these in by extending the POD generator, as described in the next section, or take a very simple approach simply using createManual(append).
OODoc is an object oriented module, which means that you can extend the functionality of a class by creating a new class. This provides an easy way to add, change or remove chapters from the produced manual pages.
When using 'pod2' in stead of 'pod' when OODoc::create() is called, the OODoc::Format::Pod2 will be used. It's nearly a drop-in replacement by its default behavior. When you specify your own template file, every thing can be made.
See the manual page of Template::Magic. You have to install
Bundle::Template::Magic to get it to work.
Probably, the output which is produced by the POD formatter is only a bit in the direction of your own ideas, but not quite what you like. Therefore, there are a few ways to adapt the output.
A formatter was created without a name specified for the project at hand. This should be passed with new(project).
The formatter has to know where the output can be written. This directory must be provided via new(workdir), but was not specified.
This module is part of OODoc distribution version 1.06, built on January 26, 2011. Website: http://perl.overmeer.net/oodoc/
Copyrights 2003-2011 by Mark Overmeer. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html