.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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
.\" ========================================================================
.\"
.IX Title "Syntax::POD 3pm"
.TH Syntax::POD 3pm "2023-01-22" "perl v5.36.0" "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"
Embperl::Syntax::POD \- convert POD to XML on\-the\-fly
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Class derived from Embperl::Syntax to convert Perl Plain Old
Documentation (\s-1POD\s0) files on the fly into \s-1XML.\s0
.PP
Used for generating the Embperl online documentation from the Embperl
\&\s-1POD\s0 files. See to eg directory in the distribution for an example how
to use it.
.SH "TODO"
.IX Header "TODO"
Documentation of the resulting \s-1XML\s0 format still has to be written...
.SH "Methods"
.IX Header "Methods"
\&\fIEmbperl::Syntax::POD\fR defines the following methods:
.ie n .SS "Embperl::Syntax::POD \-> new  /  $self \-> new"
.el .SS "Embperl::Syntax::POD \-> new  /  \f(CW$self\fP \-> new"
.IX Subsection "Embperl::Syntax::POD -> new / $self -> new"
Create a new syntax class. This method should only be called inside a constructor
of a derived class.
.ie n .SS "AddPODCmd ($cmdname, $procinfo)"
.el .SS "AddPODCmd ($cmdname, \f(CW$procinfo\fP)"
.IX Subsection "AddPODCmd ($cmdname, $procinfo)"
Add a new \s-1POD\s0 command with name \f(CW$cmdname\fR and use processor info from
\&\f(CW$procinfo\fR. See \fIEmbperl::Syntax\fR for a definition of procinfo.
.ie n .SS "AddPODCmdStartEnd ($cmdname, $endname, $procinfo)"
.el .SS "AddPODCmdStartEnd ($cmdname, \f(CW$endname\fP, \f(CW$procinfo\fP)"
.IX Subsection "AddPODCmdStartEnd ($cmdname, $endname, $procinfo)"
Add a new \s-1POD\s0 command with name \f(CW$cmdname\fR and use processor info from
\&\f(CW$procinfo\fR. Addtionaly specify that a matching \f(CW$endname\fR \s-1POD\s0 command
must be found to end the block, that is started by this \s-1POD\s0 command.
See \fIEmbperl::Syntax\fR for a definition of procinfo.
.SH "Author"
.IX Header "Author"
G. Richter (richter at embperl dot org)
.SH "See Also"
.IX Header "See Also"
Embperl::Syntax