.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Pod::Pandoc 3pm"
.TH Pod::Pandoc 3pm "2022-01-20" "perl v5.32.1" "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"
Pod::Pandoc \- process Plain Old Documentation format with Pandoc
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Plain Old Documentation format (Pod) is a markup language used to document
Perl code (see perlpod for reference). Several Perl modules exist to process
and convert Pod into other formats.
.PP
Pod::Pandoc is an attempt to unify and extend Pod converting based on the
Pandoc <http://pandoc.org/> document converter. Pandoc supports more document
formats in a more detailled and uniform way than any set of Perl modules will
ever do. For this reason Pod::Pandoc provides methods to convert Pod to the
Pandoc document model for further processing with Pandoc.
.SH "OUTLINE"
.IX Header "OUTLINE"
.IP "\(bu" 4
pod2pandoc is a command line script to convert Pod to any format supported
by Pandoc.
.IP "\(bu" 4
App::pod2pandoc provides functionality of pod2pandoc to be used in Perl code.
.IP "\(bu" 4
Pod::Simple::Pandoc converts Pod to the abstract document model of Pandoc.
.IP "\(bu" 4
Pod::Pandoc::Modules manages a set of Pod documents of Perl modules.
.SH "REQUIREMENTS"
.IX Header "REQUIREMENTS"
Installation of this module does not require Pandoc but it is needed to make
actual use of it. See <http://pandoc.org/installing.html> for installation.
.SH "USAGE EXAMPLES"
.IX Header "USAGE EXAMPLES"
.SS "Replace pod2html"
.IX Subsection "Replace pod2html"
.Vb 2
\&  # pod2html \-\-infile=input.pm \-\-css=style.css \-\-title=TITLE > output.html
\&  pod2pandoc input.pm \-\-css=style.css \-\-toc \-\-name \-o output.html
.Ve
.PP
Pandoc option \f(CW\*(C`\-\-toc\*(C'\fR corresponds to pod2html option \f(CW\*(C`\-\-index\*(C'\fR and is
disabled by default. pod2pandoc adds title and subtitle from \s-1NAME\s0 section.
.SS "Replace pod2markdown"
.IX Subsection "Replace pod2markdown"
.Vb 2
\&  # pod2markdown input.pod
\&  pod2pandoc input.pod \-t markdown
\&
\&  # pod2markdown input.pod output.md
\&  pod2pandoc input.pod \-o output.md
.Ve
.SS "GitHub wiki"
.IX Subsection "GitHub wiki"
The GitHub wiki of this project <https://github.com/nichtich/Pod-Pandoc/wiki>
is automatically populated with its module documentation.  Wiki pages
are created with pod2pandoc as following (see script \f(CW\*(C`update\-wiki.sh\*(C'\fR):
.PP
.Vb 1
\&  pod2pandoc lib/ script/ wiki/ \-\-ext md \-\-index Home \-\-wiki \-t markdown_github
.Ve
.SS "Sphinx and Read The Docs"
.IX Subsection "Sphinx and Read The Docs"
The Sphinx documentation generator <https://sphinx-doc.org/> recommends
documents in reStructureText format. It further requires a configuration file
\&\f(CW\*(C`conf.py\*(C'\fR and some links need to be adjusted because Pandoc does not support
wikilinks in rst output format (see script \f(CW\*(C`update\-docs.sh\*(C'\fR:
.PP
.Vb 3
\&  pod2pandoc lib/ script/ docs/ \-\-ext rst \-\-wiki \-t rst \-\-standalone
\&  perl \-pi \-e \*(Aqs!\`([^\`]+) <([^>]+)>\`_\|_!\-e "docs/$2.rst" ? ":doc:\`$1 <$2>\`" : "\`$1 <$2>\`_\|_"!e\*(Aq docs/*.rst
\&  make \-C docs html
.Ve
.PP
The result is published automatically at
<http://pod\-pandoc.rtfd.io/en/latest/Pod\-Pandoc.html>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is based on the wrapper module Pandoc to execute pandoc from Perl
and on the module Pandoc::Elements for pandoc document processing.
.PP
This module makes obsolete several specialized \f(CW\*(C`Pod::Simple::...\*(C'\fR modules such
as Pod::Simple::HTML, Pod::Simple::XHTML, Pod::Simple::LaTeX,
Pod::Simple::RTF Pod::Simple::Text, Pod::Simple::Wiki, Pod::WordML,
Pod::Perldoc::ToToc etc. It also covers batch conversion such as
Pod::Simple::HTMLBatch, Pod::ProjectDocs, Pod::POM::Web, and
Pod::HtmlTree.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jakob Vo\*8 <jakob.voss@gbv.de>
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
Benct Philip Jonsson
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2017\- Jakob Vo\*8
.PP
\&\s-1GNU\s0 General Public License, Version 2