Codex

Pod::LaTeX

Section: User Contributed Perl Documentation (3pm)

Updated: 2013-05-20

Index?action=index Return to Main Contents


NAME

Pod::LaTeX - Convert Pod data to formatted Latex

SYNOPSIS

DESCRIPTION

is a module to convert documentation in the Pod format into Latex. The pod2latex command uses this module for translation.
is a derived class from Pod::Select.

OBJECT METHODS

The following methods are provided in this module. Methods inherited from are not described in the public interface.

Data Accessors

The following methods are provided for accessing instance data. These methods should be used for accessing configuration parameters rather than assuming the object is a hash.

Default values can be supplied by using these names as keys to a hash of arguments when using the constructor.
AddPreamble
Logical to control whether a preamble is to be written. If true, a valid preamble is written before the pod data is written. This is similar to:

but will be more complicated if table of contents and indexing are required. Can be used to set or retrieve the current value.

$add = $parser->AddPreamble(); $parser->AddPreamble?(1);

@]

If used in conjunction with a full latex document will be written that could be immediately processed by .

For some pod escapes it may be necessary to include the amsmath package. This is not yet added to the preamble automatically.

:

AddPostamble
Logical to control whether a standard ending is written to the output file after the document has been processed. In its simplest form this is simply:

but can be more complicated if a index is required. Can be used to set or retrieve the current value.

$add = $parser->AddPostamble(); $parser->AddPostamble?(1);

@]

If used in conjunction with a full latex document will be written that could be immediately processed by .

:

Head1Level
The sectioning level that should be used to correspond to a pod directive. This can be used, for example, to turn a into a . This should hold a number corresponding to the required position in an array containing the following elements:

Can be used to set or retrieve the current value:

$parser->Head1Level?(2); $sect = $parser->Head1Level;

@]

Setting this number too high can result in sections that may not be reproducible in the expected way. For example, setting this to 4 would imply that do not have a corresponding section ( would correspond to a ).

A check is made to ensure that the supplied value is an integer in the range 0 to 5.

Default is for a value of 1 (i.e. a ).

:

Label
This is the label that is prefixed to all label and index entries to make them unique. In general, pods have similarly titled sections (NAME, DESCRIPTION etc) and a label will be multiply defined if more than one pod document is to be included in a single file. To overcome this, this label is prefixed to a label whenever a label is required (joined with an underscore) or to an index entry (joined by an exclamation mark which is the normal index separator). For example, becomes .

Can be used to set or retrieve the current value:

This label is only used if is true. Its value is set automatically from the field if is true. If this is not the case it must be set manually before starting the parse.
Default value is .

:

LevelNoNum
Control the point at which section numbering is turned off. For example, this can be used to make sure that sections are numbered but subsections are not.

Can be used to set or retrieve the current value:

$lev = $parser->LevelNoNum; $parser->LevelNoNum?(2);

@]

The argument must be an integer between 0 and 5 and is the same as the number described in method description. The number has nothing to do with the pod heading number, only the sectioning.
Default is 2. (i.e. subsections are written as but sections are numbered).

:

MakeIndex
Controls whether commands for creating an index are to be inserted into the preamble and postamble
Irrelevant if both and are false (or equivalently, and are set).

Default is for an index to be created.

:

ReplaceNAMEwithSection
This controls whether the section in the pod is to be translated literally or converted to a slightly modified output where the section name is the pod name rather than ``NAME''.

If true, the pod segment

is converted to the
(dependent on the value of and ). Note that subsequent directives translate to subsections rather than sections and that the labels and index now include the pod name (dependent on the value of ).
The is set from the pod name regardless of any current value of .

Default is to translate the pod literally.

:

StartWithNewPage
If true, each pod translation will begin with a .

$parser->StartWithNewPage?(1); $newpage = $parser->StartWithNewPage;

@]

Default is false.

:

TableOfContents
If true, a table of contents will be created. Irrelevant if is false or is set.

$toc = $parser->TableOfContents; $parser->TableOfContents?(1);

@]

Default is false.

:

UniqueLabels
If true, the translator will attempt to make sure that each label or index entry will be uniquely identified by prefixing the contents of . This allows multiple documents to be combined without clashing common labels such as and

$parser->UniqueLabels?(1); $unq = $parser->UniqueLabels;

@]

Default is true.

:

UserPreamble
User supplied preamble. Added before the pod translation data.
If set, the contents will be prepended to the output file before the translated data regardless of the value of . and will also be ignored.

:

UserPostamble
User supplied postamble. Added after the pod translation data.
If set, the contents will be prepended to the output file after the translated data regardless of the value of . will also be ignored.

:

NOTES

Compatible with only. Can not be used with v2.09 or earlier.
A subclass of so that specific pod sections can be converted to by using the method.

Some HTML escapes are missing and many have not been tested.

SEE ALSO

Pod::Parser, Pod::Select, pod2latex, Pod::Simple.

AUTHORS

Tim Jenness <[email protected]>

Bug fixes and improvements have been received from: Simon Cozens <[email protected]>, Mark A. Hershberger <[email protected]>, Marcel Grunauer <[email protected]>, Hugh S Myers <[email protected]>, Peter J Acklam <[email protected]>, Sudhi Herle <[email protected]>, Ariel Scolnicov <[email protected]>, Adriano Rodrigues Ferreira <[email protected]>, R. de Vries <[email protected]> and Dave Mitchell <[email protected]>.

COPYRIGHT

Copyright (C) 2011 Tim Jenness. Copyright (C) 2000-2004 Tim Jenness. All Rights Reserved.

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


Index

NAME

SYNOPSIS

DESCRIPTION

OBJECT METHODS

Data Accessors

NOTES

SEE ALSO

AUTHORS

COPYRIGHT