OODoc::Format::Pod2 - Produce POD pages from the doc tree with a template
OODoc::Format::Pod2 is a OODoc::Format::Pod is a OODoc::Format is a OODoc::Object OODoc::Format::Pod2 is a OODoc::Format::TemplateMagic
my $doc = OODoc->new(...); $doc->create ( 'pod2' # or 'OODoc::Format::Pod2' , format_options => [show_examples => 'NO'] );
Create manual pages in the POD syntax, using the Template::Magic template system. It may be a bit simpler to configure the outcome using the template, than using OODoc::Format::Pod, however you first need to install Bundle::Template::Magic.
Extends "DESCRIPTION" in OODoc::Format::TemplateMagic.
Extends "DESCRIPTION" in OODoc::Format::Pod.
Extends "OVERLOADED" in OODoc::Format::Pod.
Extends "METHODS" in OODoc::Format::TemplateMagic.
Extends "METHODS" in OODoc::Format::Pod.
Inherited, see "METHODS" in OODoc::Format::TemplateMagic
Extends "Constructors" in OODoc::Format::Pod.
Inherited, see "METHODS" in OODoc::Format
Extends "Inheritance knowledge" in OODoc::Format::Pod.
Inherited, see "Inheritance knowledge" in OODoc::Object
Extends "Attributes" in OODoc::Format::Pod.
Inherited, see "Attributes" in OODoc::Format
Extends "Page generation" in OODoc::Format::Pod.
Inherited, see "Page generation" in OODoc::Format
Inherited, see "Page generation" in OODoc::Format::Pod
-Option --Defined in --Default append OODoc::Format::Pod '' format_options OODoc::Format [] manual OODoc::Format <required> project OODoc::Format <required> template <in code>
The default template is included in the DATA segment of OODoc::Format::Pod2. You may start your own template by copying it to a file.
Extends "Commonly used functions" in OODoc::Format::Pod.
Inherited, see "Commonly used functions" in OODoc::Object
Extends "Manual Repository" in OODoc::Format::Pod.
Inherited, see "Manual Repository" in OODoc::Object
Extends "DETAILS" in OODoc::Format::Pod.
In your template file, a {chapter} statement is used, which is erroneous, because it requires a chapter name.
A formatter was created without a name specified for the project at hand. This should be passed with new(project).
A call to addManual() expects a new manual object (a OODoc::Manual), however an incompatible thing was passed. Usually, intended was a call to manualsForPackage() or mainManual().
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 2.01, built on November 11, 2015. Website: http://perl.overmeer.net/oodoc/
Copyrights 2003-2015 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
To install OODoc, copy and paste the appropriate command in to your terminal.
cpanm
cpanm OODoc
CPAN shell
perl -MCPAN -e shell install OODoc
For more information on module installation, please visit the detailed CPAN module installation guide.