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->formatter('pod3')->createPages(
   manual_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.

overload: '==' and '!=' (numeric comparison)

Inherited, see "OVERLOADED" in OODoc::Object

overload: 'bool'

Inherited, see "OVERLOADED" in OODoc::Object

METHODS

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

Constructors

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

$class->new(%options)

Inherited, see "Constructors" in OODoc::Object

-Option  --Defined in     --Default
 format    OODoc::Format    'pod3'
 manifest  OODoc::Format    undef
 project   OODoc::Format    <required>
 version   OODoc::Format    <required>
 workdir   OODoc::Format    <required>

format => 'pod*'|'html*'|PACKAGE

manifest => OBJECT

project => STRING

version => STRING

workdir => DIRECTORY

Attributes

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

$obj->format()

Inherited, see "Attributes" in OODoc::Format

$obj->manifest()

Inherited, see "Attributes" in OODoc::Format

$obj->project()

Inherited, see "Attributes" in OODoc::Format

$obj->unique()

Inherited, see "Attributes" in OODoc::Object

$obj->version()

Inherited, see "Attributes" in OODoc::Format

$obj->workdir()

Inherited, see "Attributes" in OODoc::Format

Manual Repository

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

$obj->addManual($manual)

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

$obj->findManual($name)

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

$obj->mainManual($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

$obj->publicationIndex()

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

$obj->publish(\%options)

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

Page generation

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

$obj->cleanup($manual, $text, %options)

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

$obj->createManual(%options)

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

-Option  --Defined in        --Default
 append    OODoc::Format::Pod  ''
 manual    OODoc::Format       <required>
 project   OODoc::Format       <required>
 template                      <in code>

append => STRING|CODE

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->createPages(%options)

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

$any->link( $manual, $object, [$text, \%settings] )

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(%options)

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->simplifyPod($in, $out)

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

$obj->writeTable(%options)

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

DETAILS

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

DIAGNOSTICS

Error: cannot link to a $package

Fault: cannot read prelimary pod from $file: $!

Fault: cannot write final pod to $file: $!

Error: illegal show option choice: $value

Error: illegal value for show_option_table: $value

Error: illegal value for show_sub_description: $value

Error: illegal value for show_subroutine: $value

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

Error: missing required chapter $name in $manual

Fault: write to $file failed: $!

SEE ALSO

This module is part of OODoc version 3.02, built on August 15, 2025. Website: https://perl.overmeer.net/oodoc/

LICENSE

For contributors see file ChangeLog.

This software is copyright (c) 2003-2025 by Mark Overmeer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm OODoc

perl -MCPAN -e shell
install OODoc