Pod::Ps...d::LaTeX(3)

πŸ“¦
version 1.20190729 Β· 2 versions
, in fedora 43

πŸ’– Pod::PseudoPod::LaTeX β€” the manual, but make it cute πŸ’–

okay so bestie, welcome to Pod::PseudoPod::LaTeX (yes the manual page header is doing that whole Pod::Ps...d::LaTeX(3) abbreviating thing, it's giving truncated-on-purpose, don't worry about it 🫢). This is the module that takes your Pod::PseudoPod docs and turns them into LaTeX. slay.


✨ NAME ✨

Pod::PseudoPod::LaTeX β€” convert Pod::PseudoPod documents into LaTeX. literally that's the whole job and it eats πŸ’…


🌸 SYNOPSIS 🌸

so this module is a "Pod::PseudoPod" subclass, which is itself a "Pod::Simple" subclass. which means?? it's a full-fledged POD parser bestie. anything those modules can do, this can do. no cap.

Perhaps a little code snippet. πŸ‘‘

use Pod::PseudoPod::LaTeX;

my $parser = Pod::PseudoPod::LaTeX->new();
$parser->emit_environments( sidebar => 'sidebar' );
$parser->output_fh( $some_fh );
$parser->parse_file( 'some_document.pod' );

...

πŸŽ€ LATEX PREAMBLE πŸŽ€

the LaTeX code this thing generates needs some packages loaded or it will simply Not Work correctly. currently it needs:

\usepackage{fancyvrb}  % for Screen and Verbatim environments
\usepackage{url}       % for L<> URLs
\usepackage{titleref}  % for A<> generated code

and okay here's the tea β˜•: the standard font in LaTeX (Computer Modern) does not support bold and italic variants of its monospace font. tragic. an alternative is:

\usepackage[T1]{fontenc}
\usepackage{textcomp}
\usepackage[scaled]{beramono}

πŸ’… MODULE OPTIONS πŸ’…

currently we support:

  • "keep_ligatures" β€” LaTeX usually joins some pairs of letters (ff, fi and fl), and those are named ligatures. by default the module splits them. if you prefer to render them with ligatures, use:
my $parser = Pod::PseudoPod::LaTeX->new( keep_ligatures => 1 );
  • "captions_below" β€” set this flag to a true value if you prefer that figure and table captions are placed below the object and not above (the default). your call bestie ✨
  • "full" β€” create a standalone document which can immediately be run through "latex" or "pdflatex". iconic, honestly.

πŸ¦‹ STYLES / EMITTING ENVIRONMENTS πŸ¦‹

the "emit_environments" method accepts a hashref whose keys are POD environments and values are LaTeX environments. use this method if you would like "Pod::PseudoPod::LaTeX" to emit a simple "\begin{foo}...\end{foo}" environment rather than emit specific formatting codes. you must define any environments you use in this way in your LaTeX prelude. periodt.

you can define your own environments easily. first you need to define the "=begin...=end" environment with:

$parser->acept_target_as_text('my_environment');

then, you can use the "emit_environments" method to tell "Pod::PseudoPod::LaTeX" what LaTeX environment to emit:

$parser->emit_environments('my_environment' => 'latex_env');

also, if "my_environment" is used in POD with a title, it is passed as the first argument to the LaTeX environment. that is,

=begin my_environment Some title

will generate

\begin{latex_env}{Some title}

main character energy fr fr πŸ’«


πŸ‘‘ AUTHOR πŸ‘‘

chromatic, "<chromatic at wgz.org>"


πŸ’€ BUGS πŸ’€

please report any bugs or feature requests to "bug-pod-pseudopod-tex at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-PseudoPod-LaTeX>. I'll hear about it and you'll hear about any progress on your bug as I make changes. we love a responsive maintainer 🫢


🌈 SUPPORT 🌈

read this documentation with the perldoc command:

$ B<perldoc Pod::PseudoPod::LaTeX>

you can also look for information at:

  • AnnoCPAN: Annotated CPAN documentation

<http://annocpan.org/dist/Pod-PseudoPod-LaTeX>

  • CPAN Ratings

<http://cpanratings.perl.org/d/Pod-PseudoPod-LaTeX>

  • RT: CPAN's request tracker

<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Pod-PseudoPod-LaTeX>

  • Search CPAN

<http://search.cpan.org/dist/Pod-PseudoPod-LaTeX>


⭐ ACKNOWLEDGEMENTS and SEE ALSO ⭐

based on Allison Randal's Pod::PseudoPod module. shoutout 🫑

see also perlpod, Pod::Simple and Pod::TeX. I did not reuse the latter because I need to support the additional POD directives found in PseudoPod.

thanks to multiple contributors, including (but not limited to) Dean Serenevy, Moritz Lenz, Alberto SimΓ΅es, and Jerome Quelin. πŸ’–

thanks to Onyx Neon Press (<http://www.onyxneon.com/>) for sponsoring this work under free software guidelines. sponsoring open source?? that's the vibe. 🌸


Copyright (c) 2006, 2009 - 2019, chromatic.

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


and that's the whole page bestie, no notes ✨ ily, go write some LaTeX πŸ’…

perl v5.42.0 Β· 2025-07-25 β€” yeah this page is serving Pod::Ps...d::LaTeX(3) energy one last time on the way out. byeee πŸ¦‹πŸ’–πŸŽ€

πŸ“¦ where this page comes from