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 PRELUDE

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 pair of letters (ff, fi and fl), named
44           ligatures. By default the module split thems. If you prefer to
45           render them with ligatures, use:
46
47             my $parser = Pod::PseudoPod::LaTeX->new( keep_ligatures => 1 );
48

STYLES / EMITTING ENVIRONMENTS

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

AUTHOR

77       chromatic, "<chromatic at wgz.org>"
78

BUGS

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

SUPPORT

87       Read this documentation with the perldoc command:
88
89           $ B<perldoc Pod::PseudoPod::LaTeX>
90
91       You can also look for information at:
92
93       ·   AnnoCPAN: Annotated CPAN documentation
94
95           <http://annocpan.org/dist/Pod-PseudoPod-LaTeX>
96
97       ·   CPAN Ratings
98
99           <http://cpanratings.perl.org/d/Pod-PseudoPod-LaTeX>
100
101       ·   RT: CPAN's request tracker
102
103           <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Pod-PseudoPod-LaTeX>
104
105       ·   Search CPAN
106
107           <http://search.cpan.org/dist/Pod-PseudoPod-LaTeX>
108

ACKNOWLEDGEMENTS and SEE ALSO

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

123       Copyright (c) 2006, 2009 - 2011, chromatic.
124
125       This program is free software; you can redistribute it and/or modify it
126       under the same terms as Perl 5.14
127

POD ERRORS

129       Hey! The above document had some coding errors, which are explained
130       below:
131
132       Around line 814:
133           Non-ASCII character seen before =encoding in 'Simões,'. Assuming
134           UTF-8
135
136
137
138perl v5.28.1                      2019-02-02          Pod::PseudoPod::LaTeX(3)
Impressum