.\" 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 "SReview::Template 3pm"
.TH SReview::Template 3pm "2023-11-03" "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"
SReview::Template \- process a string or a file and apply changes to it
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use SReview::Template;
\&  use SReview::Talk;
\&
\&  my $talk = SReview::Talk\->new(...);
\&  my $template = SReview::Template\->new(talk => $talk, vars => { foo => "bar" }, regexvars => {"@FOO@" => "foo"});
\&  my $processed = $template\->string("The @FOO@ is <%== $foo %>, and the talk is titled <%== $talk\->title %>");
\&  # $processed now contains "The foo is bar, and the talk is titled ..."
\&  # (with the actual talk title there)
\&  $template\->file("inputfile.txt", "outputfile.txt"
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`SReview::Template\*(C'\fR is a simple wrapper around Mojo::Template. All
the variables that are passed in to the \*(L"vars\*(R" parameter are passed as
named variables to Mojo::Template.
.PP
In addition, some bits of SReview previously did some simple sed-like
search-and-replace templating. For backwards compatibility, this module
also supports such search-and-replace templating (e.g.,
SReview::Template::SVG has a few of those). These, however, are now
deprecated; the \f(CW$talk\fR variable and Mojo::Template\-style templates
should be used instead.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
\&\f(CW\*(C`SReview::Template\*(C'\fR objects support the following attributes:
.SS "talk"
.IX Subsection "talk"
An SReview::Talk object for the talk that this template is for.
Required. Will be passed on to the template as the \f(CW$talk\fR variable.
.SS "vars"
.IX Subsection "vars"
Additional Mojo::Template variables to be made available to the
template.
.SS "regexvars"
.IX Subsection "regexvars"
Variables to be replaced by search-and-replace.
.SH "METHODS"
.IX Header "METHODS"
.SS "file"
.IX Subsection "file"
A method to process an input file through the templating engine into an
output file.
.PP
Takes to arguments: the name of the input file, followed by the name of
the output file.
.PP
Is implemented in terms of the \f(CW\*(C`string\*(C'\fR method.
.SS "string"
.IX Subsection "string"
A function to process a string, passed as the only argument. Returns the
result of the template function.