.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Text::Markup::Pod 3pm"
.TH Text::Markup::Pod 3pm 2024-03-03 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH Name
.IX Header "Name"
Text::Markup::Pod \- Pod parser for Text::Markup
.SH Synopsis
.IX Header "Synopsis"
.Vb 2
\&  use Text::Markup;
\&  my $pod = Text::Markup\->new\->parse(file => \*(AqREADME.pod\*(Aq);
.Ve
.SH Description
.IX Header "Description"
This is the Pod parser for Text::Markup. It runs the file
through Pod::Simple::XHTML and returns the result. If the Pod contains any
non-ASCII characters, the encoding must be declared either via a BOM or via
the \f(CW\*(C`=encoding\*(C'\fR tag. Text::Markup::Pod recognizes files with the following
extensions as Pod:
.IP \fI.pod\fR 4
.IX Item ".pod"
.PD 0
.IP \fI.pm\fR 4
.IX Item ".pm"
.IP \fI.pl\fR 4
.IX Item ".pl"
.PD
.PP
To change it the files it recognizes, load this module directly and pass a
regular expression matching the desired extension(s), like so:
.PP
.Vb 1
\&  use Text::Markup::Pod qr{cgi};
.Ve
.SH Options
.IX Header "Options"
You may pass an arrayref of settings to this parser which changes the output returned.  For example,
to suppress an HTML header and footer, pass:
.PP
.Vb 7
\&  my $pod_fragment = Text::Markup\->new\->parse(
\&          file => \*(AqREADME.pod\*(Aq,
\&          options => [
\&              html_header => \*(Aq\*(Aq,
\&              html_footer => \*(Aq\*(Aq,
\&          ]
\&  );
.Ve
.PP
This implementation makes method calls to the Pod::Simple::XHTML parser using the key as the method
name and the value as the parameter list to pass.
.PP
See Pod::Simple::XHTML and Pod::Simple for the full list of options and inherited options
which can be manipulated.
.SH Author
.IX Header "Author"
David E. Wheeler <david@justatheory.com>
.SH "Copyright and License"
.IX Header "Copyright and License"
Copyright (c) 2011\-2024 David E. Wheeler. Some Rights Reserved.
.PP
This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.