1Pod::PseudoPod::LaTeX(3U)ser Contributed Perl DocumentatiPoond::PseudoPod::LaTeX(3)
2
3
4

NAME

6       Pod::PseudoPod::LaTeX - convert Pod::PseudoPod documents into LaTeX
7

SYNOPSIS

9       This module is a "Pod::PseudoPod" subclass, itself a "Pod::Simple"
10       subclass.  This means that this is a full-fledged POD parser.  Anything
11       those modules can do, this can do.
12
13       Perhaps a little code snippet.
14
15           use Pod::PseudoPod::LaTeX;
16
17           my $parser = Pod::PseudoPod::LaTeX->new();
18           $parser->emit_environments( sidebar => 'sidebar' );
19           $parser->output_fh( $some_fh );
20           $parser->parse_file( 'some_document.pod' );
21
22           ...
23

LATEX PREAMBLE

25       The generated LaTeX code needs some packages to be loaded to work
26       correctly.  Currently it needs
27
28           \usepackage{fancyvrb}  % for Screen and Verbatim environments
29           \usepackage{url}       % for L<> URLs
30           \usepackage{titleref}  % for A<> generated code
31
32       The standard font in LaTeX (Computer Modern) does not support bold and
33       italic variants of its monospace font, an alternative is
34
35           \usepackage[T1]{fontenc}
36           \usepackage{textcomp}
37           \usepackage[scaled]{beramono}
38

MODULE OPTIONS

40       Currently we support:
41
42       "keep_ligatures"
43           LaTeX usually joins some pairs of letters (ff, fi and fl), named
44           ligatures. By default the module splits them. If you prefer to
45           render them with ligatures, use:
46
47               my $parser = Pod::PseudoPod::LaTeX->new( keep_ligatures => 1 );
48
49       "captions_below"
50           Set this flag to a true value if you prefer that figure and table
51           captions are placed below the object and not above (the default).
52
53       "full"
54           Create a standalone document which can immediately be run through
55           "latex" or "pdflatex".
56

STYLES / EMITTING ENVIRONMENTS

58       The "emit_environments" method accepts a hashref whose keys are POD
59       environments and values are LaTeX environments. Use this method if you
60       would like "Pod::PseudoPod::LaTeX" to emit a simple
61       "\begin{foo}...\end{foo}" environment rather than emit specific
62       formatting codes. You must define any environments you use in this way
63       in your LaTeX prelude.
64
65       You can define your own environments easily. First you need to define
66       the "=begin...=end" environment with:
67
68           $parser->acept_target_as_text('my_environment');
69
70       Then, you can use the "emit_environments" method to tell
71       "Pod::PseudoPod::LaTeX" what LaTeX environment to emit:
72
73           $parser->emit_environments('my_environment' => 'latex_env');
74
75       Also, if "my_environment" is used in POD with a title, it is passed as
76       the first argument to the LaTeX environment. That is,
77
78           =begin my_environment Some title
79
80       Will generate
81
82           \begin{latex_env}{Some title}
83

AUTHOR

85       chromatic, "<chromatic at wgz.org>"
86

BUGS

88       Please report any bugs or feature requests to "bug-pod-pseudopod-tex at
89       rt.cpan.org", or through the web interface at
90       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-PseudoPod-LaTeX>.
91       I'll hear about it and you'll hear about any progress on your bug as I
92       make changes.
93

SUPPORT

95       Read this documentation with the perldoc command:
96
97           $ B<perldoc Pod::PseudoPod::LaTeX>
98
99       You can also look for information at:
100
101       •   AnnoCPAN: Annotated CPAN documentation
102
103           <http://annocpan.org/dist/Pod-PseudoPod-LaTeX>
104
105       •   CPAN Ratings
106
107           <http://cpanratings.perl.org/d/Pod-PseudoPod-LaTeX>
108
109       •   RT: CPAN's request tracker
110
111           <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Pod-PseudoPod-LaTeX>
112
113       •   Search CPAN
114
115           <http://search.cpan.org/dist/Pod-PseudoPod-LaTeX>
116

ACKNOWLEDGEMENTS and SEE ALSO

118       Based on Allison Randal's Pod::PseudoPod module.
119
120       See also perlpod, Pod::Simple and Pod::TeX.  I did not reuse the latter
121       because I need to support the additional POD directives found in
122       PseudoPod.
123
124       Thanks to multiple contributors, including (but not limited to) Dean
125       Serenevy, Moritz Lenz, Alberto Simões, and Jerome Quelin.
126
127       Thanks to Onyx Neon Press (<http://www.onyxneon.com/>) for sponsoring
128       this work under free software guidelines.
129

131       Copyright (c) 2006, 2009 - 2019, chromatic.
132
133       This program is free software; you can redistribute it and/or modify it
134       under the same terms as Perl 5.30.
135
136
137
138perl v5.34.0                      2022-01-21          Pod::PseudoPod::LaTeX(3)
Impressum