Mark Overmeer > OODoc-1.06 > OODoc::Format::Pod2

Download:
OODoc-1.06.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 1.06   Source   Latest Release: OODoc-2.00

NAME ^

OODoc::Format::Pod2 - Produce POD pages from the doc tree with a template

INHERITANCE ^

 OODoc::Format::Pod2
   is a OODoc::Format::Pod
   is a OODoc::Format
   is a OODoc::Object

 OODoc::Format::Pod2
   is a OODoc::Format::TemplateMagic

SYNOPSIS ^

 my $doc = OODoc->new(...);
 $doc->create
   ( 'pod2'   # or 'OODoc::Format::Pod2'
   , format_options => [show_examples => 'NO']
   );

DESCRIPTION ^

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.

METHODS ^

Constructors

OODoc::Format::Pod2->new(OPTIONS)

See "METHODS" in OODoc::Format

Inheritance knowledge

$obj->extends([OBJECT])

See "Inheritance knowledge" in OODoc::Object

Attributes

$obj->manifest

See "Attributes" in OODoc::Format

$obj->project

See "Attributes" in OODoc::Format

$obj->version

See "Attributes" in OODoc::Format

$obj->workdir

See "Attributes" in OODoc::Format

Page generation

$obj->cleanup(MANUAL, STRING)

See "Page generation" in OODoc::Format

$obj->cleanupPOD(IN, OUT)

See "Page generation" in OODoc::Format::Pod

$obj->createManual(OPTIONS)
 -Option        --Defined in     --Default
  append          OODoc::Format::Pod  ''
  format_options  OODoc::Format    []
  manual          OODoc::Format    <required>
  project         OODoc::Format    <required>
  template                         <in code>
append => STRING|CODE
format_options => ARRAY
manual => MANUAL
project => STRING
template => FILENAME

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.

$obj->createOtherPages(OPTIONS)

See "Page generation" in OODoc::Format

$obj->formatManual(OPTIONS)

See "Page generation" in OODoc::Format::Pod

$obj->link(MANUAL, OBJECT, [TEXT])

See "Page generation" in OODoc::Format::Pod

$obj->removeMarkup(STRING)

See "Page generation" in OODoc::Format::Pod

$obj->showChapter(OPTIONS)

See "Page generation" in OODoc::Format

$obj->showChapterIndex(FILE, CHAPTER, INDENT)

See "Page generation" in OODoc::Format::Pod

$obj->showExamples(OPTIONS)

See "Page generation" in OODoc::Format

$obj->showOptionExpand(OPTIONS)

See "Page generation" in OODoc::Format

$obj->showOptionTable(OPTIONS)

See "Page generation" in OODoc::Format

$obj->showOptionUse(OPTIONS)

See "Page generation" in OODoc::Format

$obj->showOptionalChapter(NAME, OPTIONS)

See "Page generation" in OODoc::Format

$obj->showOptions(OPTIONS)

See "Page generation" in OODoc::Format

$obj->showRequiredChapter(NAME, OPTIONS)

See "Page generation" in OODoc::Format

$obj->showStructureExpanded(OPTIONS)

See "Page generation" in OODoc::Format

$obj->showStructureRefer(OPTIONS)

See "Page generation" in OODoc::Format

$obj->showSubroutine((@))

See "Page generation" in OODoc::Format

$obj->showSubroutineDescription(OPTIONS)

See "Page generation" in OODoc::Format

$obj->showSubroutineName(OPTIONS)

See "Page generation" in OODoc::Format

$obj->showSubroutineUse(OPTIONS)

See "Page generation" in OODoc::Format

$obj->showSubroutines(OPTIONS)

See "Page generation" in OODoc::Format

$obj->writeTable

See "Page generation" in OODoc::Format::Pod

Template processing

$obj->templateChapter

Commonly used functions

$obj->filenameToPackage(FILENAME)

OODoc::Format::Pod2->filenameToPackage(FILENAME)

See "Commonly used functions" in OODoc::Object

$obj->mkdirhier(DIRECTORY)

OODoc::Format::Pod2->mkdirhier(DIRECTORY)

See "Commonly used functions" in OODoc::Object

Manual Repository

$obj->addManual(MANUAL)

See "Manual Repository" in OODoc::Object

$obj->mainManual(NAME)

See "Manual Repository" in OODoc::Object

$obj->manual(NAME)

See "Manual Repository" in OODoc::Object

$obj->manuals

See "Manual Repository" in OODoc::Object

$obj->manualsForPackage(NAME)

See "Manual Repository" in OODoc::Object

$obj->packageNames

See "Manual Repository" in OODoc::Object

$obj->zoneGetParameters(ZONE|STRING)

See "METHODS" in OODoc::Format::TemplateMagic

DIAGNOSTICS ^

Error: cannot read prelimary pod from $infn: $!
Error: cannot write final pod to $outfn: $!
Error: chapter without name in template.

In your template file, a {chapter} statement is used, which is erroneous, because it requires a chapter name.

Error: formatter does not know the version.
Error: formatter has no project name.

A formatter was created without a name specified for the project at hand. This should be passed with new(project).

Error: manual definition requires manual object

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().

Warning: missing required chapter $name in $manual
Error: no directory to put pod manual for $name in
Warning: no meaning for container $container in chapter block
Error: no package name for pod production
Error: no working directory specified.

The formatter has to know where the output can be written. This directory must be provided via new(workdir), but was not specified.

Warning: unknown subroutine type $type for $name in $manual

SEE ALSO ^

This module is part of OODoc distribution version 1.06, built on January 26, 2011. Website: http://perl.overmeer.net/oodoc/

LICENSE ^

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

syntax highlighting: