.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "XML::Grove::Subst 3pm"
.TH XML::Grove::Subst 3pm "2010-01-29" "perl v5.10.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"
XML::Grove::Subst \- substitute values into a template
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use XML::Grove::Subst;
\&
\& # Using subst method on XML::Grove::Document or XML::Grove::Element:
\& $new_grove = $source_grove\->subst( ARGS );
\& $new_grove = $source_grove\->subst_hash( ARG );
\&
\& # Using an XML::Grove::Subst instance:
\& $subster = XML::Grove::Subst\->new();
\& $new_grove = $subster\->subst( $source_grove, ARGS );
\& $new_grove = $subster\->subst_hash( $source_grove, ARG );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`XML::Grove::Subst\*(C'\fR implements \s-1XML\s0 templates.  \f(CW\*(C`XML::Grove::Subst\*(C'\fR
traverses through a source grove replacing all elements with names
`\f(CW\*(C`SUB:XXX\*(C'\fR' or `\f(CW\*(C`SUB:key\*(C'\fR' with their corresponding values from \s-1ARGS\s0 (a
list) or \s-1ARG\s0 (a hash), repsectively.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$grove_obj\->subst( \fI\s-1ARGS\s0\fR ) =item $subster\->subst( $grove_obj, \fI\s-1ARGS\s0\fR )" 4
.el .IP "\f(CW$grove_obj\fR\->subst( \fI\s-1ARGS\s0\fR ) =item \f(CW$subster\fR\->subst( \f(CW$grove_obj\fR, \fI\s-1ARGS\s0\fR )" 4
.IX Item "$grove_obj->subst( ARGS ) =item $subster->subst( $grove_obj, ARGS )"
Search for `\f(CW\*(C`SUB:\f(CIXXX\f(CW\*(C'\fR' elements, where \fI\s-1XXX\s0\fR is an array index,
and replace the element with the value from \fI\s-1ARGS\s0\fR, a list of values.
The return value is a new grove with the substitutions applied.
.ie n .IP "$grove_obj\->subst_hash( \fI\s-1ARG\s0\fR ) =item $subster\->subst_hash( $grove_obj, \fI\s-1ARG\s0\fR )" 4
.el .IP "\f(CW$grove_obj\fR\->subst_hash( \fI\s-1ARG\s0\fR ) =item \f(CW$subster\fR\->subst_hash( \f(CW$grove_obj\fR, \fI\s-1ARG\s0\fR )" 4
.IX Item "$grove_obj->subst_hash( ARG ) =item $subster->subst_hash( $grove_obj, ARG )"
Search for `\f(CW\*(C`SUB:key\*(C'\fR' elements and replace the element with the
value from \fI\s-1ARG\s0\fR, a hash of values.  The hash key is taken from the
`\f(CW\*(C`key\*(C'\fR' attribute of the `\f(CW\*(C`SUB:key\*(C'\fR' element, for example,
`\f(CW\*(C`<SUB:key key=\*(Aqfoo\*(Aq>\*(C'\fR'.  The return value is a new grove
with the substitutions applied.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
The following template, in a file `\f(CW\*(C`template.xml\*(C'\fR', could be used for
a simple parts database conversion to \s-1HTML:\s0
.PP
.Vb 10
\&    <html>
\&      <head>
\&        <title><SUB:key key=\*(AqName\*(Aq></title>
\&      </head>
\&      <body>
\&        <h1><SUB:key key=\*(AqName\*(Aq></title>
\&        <p>Information for part number <SUB:key key=\*(AqNumber\*(Aq>:</p>
\&        <SUB:key key=\*(AqDescription\*(Aq>
\&      </body>
\&    </html>
.Ve
.PP
To use this template you would first parse it and convert it to a
grove, and then use `\f(CW\*(C`subst_hash()\*(C'\fR' every time you needed a new
page:
.PP
.Vb 6
\&    use XML::Parser::PerlSAX;
\&    use XML::Grove;
\&    use XML::Grove::Builder;
\&    use XML::Grove::Subst;
\&    use XML::Grove::PerlSAX;
\&    use XML::Handler::XMLWriter;
\&
\&    # Load the template
\&    $b = XML::Grove::Builder\->new();
\&    $p = XML::Parser::PerlSAX\->new( Handler = $b );
\&    $source_grove = $p\->parse( Source => { SystemId => \*(Aqtemplate.xml\*(Aq } );
\&
\&    # Apply the substitutions
\&    $new_grove = $source_grove\->subst_hash( { Name => \*(AqAcme DCX\-2000 Filter\*(Aq,
\&                                              Number => \*(AqN4728\*(Aq,
\&                                              Description => \*(AqThe Best\*(Aq } );
\&
\&    # Write the new grove to standard output
\&    $w = XML::Handler::XMLWriter\->new();
\&    $wp = XML::Grove::PerlSAX\->new( Handler => $w );
\&    $wp\->parse( Source => { Grove => $new_grove } );
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Ken MacLeod, ken@bitsko.slc.ut.us
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1), \fIXML::Grove\fR\|(3)
.PP
Extensible Markup Language (\s-1XML\s0) <http://www.w3c.org/XML>