.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 "XML::Struct::Simple 3pm"
.TH XML::Struct::Simple 3pm "2019-02-21" "perl v5.28.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::Struct::Simple \- Transform MicroXML data structures into simple (unordered) form
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&    my $micro = [
\&        root => { xmlns => \*(Aqhttp://example.org/\*(Aq },
\&        [ \*(Aq!\*(Aq, [ x => {}, [42] ] ]
\&    ];
\&    my $converter = XML::Struct::Simple\->new( root => \*(Aqrecord\*(Aq );
\&    my $simple = $converter\->transform( $micro );
\&    # { record => { xmlns => \*(Aqhttp://example.org/\*(Aq, x => 42 } }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements a transformation from structured \s-1XML\s0 (MicroXML) to
simple key-value format (SimpleXML) as known from XML::Simple: Attributes
and child elements are treated as hash keys with their content as value. Text
elements without attributes are converted to text and empty elements without
attributes are converted to empty hashes.
.PP
XML::Struct can export the function \f(CW\*(C`simpleXML\*(C'\fR for easy use. Function
\&\f(CW\*(C`readXML\*(C'\fR and XML::Struct::Reader apply transformation to SimpleXML with
option \f(CW\*(C`simple\*(C'\fR.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "transform( $element )"
.el .SS "transform( \f(CW$element\fP )"
.IX Subsection "transform( $element )"
Transform \s-1XML\s0 given as array reference (MicroXML) to \s-1XML\s0 as hash reference
(SimpleXML) as configured.
.ie n .SS "transform_content( $element [, $depth ] )"
.el .SS "transform_content( \f(CW$element\fP [, \f(CW$depth\fP ] )"
.IX Subsection "transform_content( $element [, $depth ] )"
Transform child nodes and attributes of an \s-1XML\s0 element given as array reference
at a given depth (\f(CW0\fR by default). Returns a hash reference, a scalar, or the
element unmodified.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
.IP "root" 4
.IX Item "root"
Keep the root element instead of removing. This corresponds to option
\&\f(CW\*(C`KeepRoot\*(C'\fR in XML::Simple. In addition a non-numeric value can be used to
override the name of the root element. Disabled by default.
.IP "attributes" 4
.IX Item "attributes"
Include \s-1XML\s0 attributes. Enabled by default. The special value \f(CW\*(C`remove\*(C'\fR is
equivalent to false. Corresponds to option \f(CW\*(C`NoAttr\*(C'\fR in XML::Simple.
.IP "content" 4
.IX Item "content"
Name of a field to put text content in. Set to "\f(CW\*(C`content\*(C'\fR by default.
Corresponds to option \f(CW\*(C`ContentKey\*(C'\fR in XML::Simple.
.IP "depth" 4
.IX Item "depth"
Only transform up to a given depth. Set to a negative value by default for
unlimited depth. Elements below depth are not cloned but copied by reference.
Depth 0 will return the element unmodified.
.PP
Option \f(CW\*(C`KeyAttr\*(C'\fR, \f(CW\*(C`ForceArray\*(C'\fR, and other fetures of XML::Simple not
supported. Options \f(CW\*(C`NsExpand\*(C'\fR and \f(CW\*(C`NsStrip\*(C'\fR supported in
XML::LibXML::Simple are not supported yet.