NAME

OODoc::Format::Pod3 - Produce POD pages using OODoc::Template

INHERITANCE

OODoc::Format::Pod3
  is an OODoc::Format::Pod
  is an OODoc::Format
  is an OODoc::Object

SYNOPSIS

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

DESCRIPTION

Create manual pages in the POD syntax, using the OODoc::Template template system.

Extends "DESCRIPTION" in OODoc::Format::Pod.

OVERLOADED

Extends "OVERLOADED" in OODoc::Format::Pod.

METHODS

Extends "METHODS" in OODoc::Format::Pod.

Constructors

Extends "Constructors" in OODoc::Format::Pod.

OODoc::Format::Pod3->new(%options)

Inherited, see "METHODS" in OODoc::Format

Inheritance knowledge

Extends "Inheritance knowledge" in OODoc::Format::Pod.

$obj->extends( [$object] )

Inherited, see "Inheritance knowledge" in OODoc::Object

Attributes

Extends "Attributes" in OODoc::Format::Pod.

$obj->manifest()

Inherited, see "Attributes" in OODoc::Format

$obj->project()

Inherited, see "Attributes" in OODoc::Format

$obj->version()

Inherited, see "Attributes" in OODoc::Format

$obj->workdir()

Inherited, see "Attributes" in OODoc::Format

Page generation

Extends "Page generation" in OODoc::Format::Pod.

$obj->cleanup($manual, STRING)

Inherited, see "Page generation" in OODoc::Format

$obj->cleanupPOD($in, $out)

Inherited, 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::Pod3. You may start your own template by copying it to a file.

$obj->createOtherPages(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->formatManual(%options)

Inherited, see "Page generation" in OODoc::Format::Pod

$obj->link( $manual, $object, [$text] )

Inherited, see "Page generation" in OODoc::Format::Pod

$obj->removeMarkup(STRING)

Inherited, see "Page generation" in OODoc::Format::Pod

$obj->showChapter(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->showChapterIndex($file, $chapter, $indent)

Inherited, see "Page generation" in OODoc::Format::Pod

$obj->showExamples(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->showOptionExpand(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->showOptionTable(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->showOptionUse(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->showOptionalChapter($name, %options)

Inherited, see "Page generation" in OODoc::Format

$obj->showOptions(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->showRequiredChapter($name, %options)

Inherited, see "Page generation" in OODoc::Format

$obj->showStructureExpanded(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->showStructureRefer(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->showSubroutine( <@> )

Inherited, see "Page generation" in OODoc::Format

$obj->showSubroutineDescription(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->showSubroutineName(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->showSubroutineUse(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->showSubroutines(%options)

Inherited, see "Page generation" in OODoc::Format

$obj->writeTable()

Inherited, see "Page generation" in OODoc::Format::Pod

Commonly used functions

Extends "Commonly used functions" in OODoc::Format::Pod.

$obj->filenameToPackage($filename)

OODoc::Format::Pod3->filenameToPackage($filename)

Inherited, see "Commonly used functions" in OODoc::Object

$obj->mkdirhier($directory)

OODoc::Format::Pod3->mkdirhier($directory)

Inherited, see "Commonly used functions" in OODoc::Object

Manual Repository

Extends "Manual Repository" in OODoc::Format::Pod.

$obj->addManual($manual)

Inherited, see "Manual Repository" in OODoc::Object

$obj->mainManual($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->manual($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->manuals()

Inherited, see "Manual Repository" in OODoc::Object

$obj->manualsForPackage($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->packageNames()

Inherited, see "Manual Repository" in OODoc::Object

Template processing

DETAILS

Extends "DETAILS" in OODoc::Format::Pod.

DIAGNOSTICS

Error: cannot read prelimary pod from $infn: $!

Error: cannot write final pod to $outfn: $!

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

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 2.02, built on December 08, 2021. Website: http://perl.overmeer.net/oodoc/

LICENSE

Copyrights 2003-2021 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the Artistic license. See http://dev.perl.org/licenses/artistic.html

cpanm OODoc

perl -MCPAN -e shell
install OODoc