diff options
author | Philip Newton <pne@cpan.org> | 2001-11-21 10:04:03 +0100 |
---|---|---|
committer | Jarkko Hietaniemi <jhi@iki.fi> | 2001-11-21 13:19:08 +0000 |
commit | 1c29294760263b030b04cb5526f17ddb14673375 (patch) | |
tree | cd6ea3c08b36e1dd3de91915d8b054862c0bc307 /lib | |
parent | 7c90792d19bda45f3e74bba037b0c5537074a440 (diff) | |
download | perl-1c29294760263b030b04cb5526f17ddb14673375.tar.gz |
Re: PERFORCE change 13142 for review
Message-ID: <m9lmvt8a2vjq2sa8stds01msej0f2f03up@4ax.com>
plus rewrap few paragraphs.
p4raw-id: //depot/perl@13159
Diffstat (limited to 'lib')
-rw-r--r-- | lib/Pod/LaTeX.pm | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/lib/Pod/LaTeX.pm b/lib/Pod/LaTeX.pm index 58a3714c47..1f958b5981 100644 --- a/lib/Pod/LaTeX.pm +++ b/lib/Pod/LaTeX.pm @@ -53,7 +53,7 @@ $VERSION = '0.54'; %HTML_Escapes = ( # lt, gt and verbar are inserted without math mode # since the $$ will be added during general correction - # for those escpae characters + # for those escape characters 'amp' => '\&', # ampersand 'lt' => '<', # ' left chevron, less-than 'gt' => '>', # ' right chevron, greater-than @@ -336,8 +336,8 @@ of arguments when using the C<new()> constructor. =item B<AddPreamble> Logical to control whether a C<latex> preamble is to be written. -If true, a valid C<latex> preamble is written before the pod data is written. -This is similar to: +If true, a valid C<latex> preamble is written before the pod data +is written. This is similar to: \documentclass{article} \begin{document} @@ -363,13 +363,13 @@ sub AddPreamble { =item B<AddPostamble> -Logical to control whether a standard C<latex> ending is written to the output -file after the document has been processed. -In its simplest form this is simply: +Logical to control whether a standard C<latex> ending is written to +the output file after the document has been processed. In its +simplest form this is simply: \end{document} -but can be more complicated if a index is required. +but can be more complicated if an index is required. Can be used to set or retrieve the current value. $add = $parser->AddPostamble(); @@ -408,10 +408,10 @@ 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 C<=head3> -do not have a corresponding C<latex> section (C<=head1> would correspond to -a C<paragraph>). +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 C<=head3> do not have a corresponding C<latex> section +(C<=head1> would correspond to a C<paragraph>). A check is made to ensure that the supplied value is an integer in the range 0 to 5. @@ -502,8 +502,8 @@ into the preamble and postamble $makeindex = $parser->MakeIndex; $parser->MakeIndex(0); -Irrelevant if both C<AddPreamble> and C<AddPostamble> are false (or equivalently, -C<UserPreamble> and C<UserPostamble> are set). +Irrelevant if both C<AddPreamble> and C<AddPostamble> are false +(or equivalently, C<UserPreamble> and C<UserPostamble> are set). Default is for an index to be created. @@ -632,8 +632,8 @@ sub UniqueLabels { User supplied C<latex> 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 C<AddPreamble>. +If set, the contents will be prepended to the output file before +the translated data regardless of the value of C<AddPreamble>. C<MakeIndex> and C<TableOfContents> will also be ignored. =cut @@ -651,8 +651,8 @@ sub UserPreamble { User supplied C<latex> 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 C<AddPostamble>. +If set, the contents will be prepended to the output file after +the translated data regardless of the value of C<AddPostamble>. C<MakeIndex> will also be ignored. =cut |