.\" 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
.\" ========================================================================
.\"
.IX Title "Syntax::RTF 3pm"
.TH Syntax::RTF 3pm "2020-11-09" "perl v5.32.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::RTF \- define syntax for RTF files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Class derived from Embperl::Syntax to define the syntax for 
\&\s-1RTF\s0 files. \s-1RTF\s0 files can be read and written by various word processing
programs. This allows you to create dynamic wordprocessing documents or
let process serial letters thru Embperl.
.PP
Currently Embperl regocnices the fields \f(CW\*(C`DOCVARIABLE\*(C'\fR, \f(CW\*(C`MERGEFIELD\*(C'\fR and
\&\f(CW\*(C`NEXT\*(C'\fR. Variablenames are resolved as hash keys to \f(CW$param\fR[0] e.g. \f(CW\*(C`foo.bar\*(C'\fR
referes to \f(CW\*(C`$param[0]{foo}{bar}\*(C'\fR, the \f(CW@param\fR Array can by set via the
\&\f(CW\*(C`param\*(C'\fR parameter of the \f(CW\*(C`Execute\*(C'\fR function. \f(CW\*(C`NEXT\*(C'\fR moves to the next element
of the \f(CW@param\fR array. If the end of the document is reached, Embperl repeats
the document until all element of \f(CW@param\fR are processed. This can for example
be use to tie a database table to \f(CW@param\fR and generate a serial letter.
.PP
\&\s-1NOTE:\s0 Extenting this syntax to support full Embperl support (like embedding Perl
into \s-1RTF\s0 file is planned, but not implemented yet)
.SH "Example for generating a serial letter from a database"
.IX Header "Example for generating a serial letter from a database"
.Vb 2
\&  use DBIx::Recordset ;
\&  use Embperl ;
\&
\&  *set = DBIx::Recordset \-> Search({\*(Aq!DataSource\*(Aq => $db, \*(Aq!Table\*(Aq => \*(Aqaddress\*(Aq, \*(Aq!WriteMode\*(Aq => 0}) ;
\&
\&  die DBIx::Recordset \-> LastError if (DBIx::Recordset \-> LastError) ;
\&
\&  Embperl::Execute ({\*(Aqinputfile\*(Aq => \*(Aqaddress.rtf\*(Aq, param => \e@set, syntax => \*(AqRTF\*(Aq}) ;
\&
\&
\&  # if your database table contains fields \*(Aqname\*(Aq and \*(Aqstreet\*(Aq you can now simply insert a
\&  # fields call \*(Aqname\*(Aq and \*(Aqstreet\*(Aq in your RTF file and Embperl will repeat the document
\&  # until all records are outputed
.Ve
.SH "Methods"
.IX Header "Methods"
\&\fIEmbperl::Syntax::RTF\fR defines the following methods:
.ie n .SS "Embperl::Syntax::RTF \-> new  /  $self \-> new"
.el .SS "Embperl::Syntax::RTF \-> new  /  \f(CW$self\fP \-> new"
.IX Subsection "Embperl::Syntax::RTF -> new / $self -> new"
Create a new syntax class. This method should only be called inside a constructor
of a derived class.
.ie n .SS "AddRTFCmd ($cmdname, $procinfo)"
.el .SS "AddRTFCmd ($cmdname, \f(CW$procinfo\fP)"
.IX Subsection "AddRTFCmd ($cmdname, $procinfo)"
Add a new \s-1RTF\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 "AddRTFCmdWithEnd ($cmdname, $endname, $procinfo)"
.el .SS "AddRTFCmdWithEnd ($cmdname, \f(CW$endname\fP, \f(CW$procinfo\fP)"
.IX Subsection "AddRTFCmdWithEnd ($cmdname, $endname, $procinfo)"
Add a new \s-1RTF\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-1RTF\s0 command
must be found to end the block, that is started by this \s-1RTF\s0 command.
See \fIEmbperl::Syntax\fR for a definition of procinfo.
.ie n .SS "AddRTFCmdBlock ($cmdname, $endname, $procinfostart, $procinfoend)"
.el .SS "AddRTFCmdBlock ($cmdname, \f(CW$endname\fP, \f(CW$procinfostart\fP, \f(CW$procinfoend\fP)"
.IX Subsection "AddRTFCmdBlock ($cmdname, $endname, $procinfostart, $procinfoend)"
Add a new \s-1RTF\s0 command with name \f(CW$cmdname\fR and and a second \s-1RTF\s0 command
\&\f(CW$endname\fR which ends the block that is started by \f(CW$cmdname\fR.
Use processor info from \f(CW$procinfo\fR.
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