.\" Automatically generated by Pod::Man 4.11 (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 "Catmandu::Exporter::XSD 3pm"
.TH Catmandu::Exporter::XSD 3pm "2020-04-02" "perl v5.30.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"
Catmandu::Exporter::XSD \- Export and validate XML documents
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    # Convert one shiporder YAML to XML
\&    catmandu convert YAML to XSD \-\-root \*(Aq{}shiporder\*(Aq
\&                                 \-\-schemas demo/order/*.xsd < shiporder.YAML
\&
\&    # Same as above but store multiple shiporders in the YAML into a separate file
\&    catmandu convert YAML to XSD \-\-root \*(Aq{}shiporder\*(Aq
\&                                 \-\-schemas demo/order/*.xsd
\&                                 \-\-split 1
\&                                 < shiporder.YAML
\&
\&    # Same as above but use template toolkit to pack the XML into an container
\&    # (The xml record is stored in the \*(Aqxml\*(Aq key which can be retrieved in the
\&    # template by [% xml %])
\&    catmandu convert YAML to XSD \-\-root \*(Aq{}shiporder\*(Aq
\&                                 \-\-schemas demo/order/*.xsd
\&                                 \-\-template_before t/xml_header.tt
\&                                 \-\-template t/xml_record.tt
\&                                 \-\-template t/xml_footer.tt
\&                                 < shiporder.YAML
\&
\&    use Catmandu;
\&
\&    # Print to STDOUT
\&    my $exporter = Catmandu\->exporter(\*(AqXSD\*(Aq,
\&                        root => ...
\&                        schemas => ...
\&    );
\&
\&    $exporter\->add_many($arrayref);
\&    $exporter\->add_many($iterator);
\&    $exporter\->add_many(sub { });
\&    $exporter\->add($hashref);
\&
\&    $exporter\->commit;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a Catmandu::Exporter for converting Perl into valided \s-1XML\s0 documents
using an \s-1XSD\s0 schema file.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
.IP "file" 4
.IX Item "file"
Write output to a local file given by its path. Alternatively a scalar
reference can be passed to write to a string.
.IP "fh" 4
.IX Item "fh"
Write output to an IO::Handle. If not specified, Catmandu::Util::io is used to
create the output stream from the \f(CW\*(C`file\*(C'\fR argument or by using \s-1STDOUT.\s0
.IP "split" 4
.IX Item "split"
Optional. Don't write to the file (or \s-1STDOUT\s0) and split the output documents into
one or more files. E.g.
.Sp
.Vb 1
\&    catmandu ... to XSD \-\-root ... \-\-schemas ... \-\-split 1  < data
.Ve
.IP "split_pattern" 4
.IX Item "split_pattern"
Optional. Use a \s-1FORMAT\s0 as template for naming output files. Uses the '_id' field in
the data or an incremental counter as input. E.g.
.Sp
.Vb 2
\&    # Creates 000001.xml , 000002.xml, etc
\&    catmandu ... to XSD \-\-root ... \-\-schemas ... \-\-split 1 \-\-split_pattern \*(Aq%\-6.6d.xml\*(Aq < data
.Ve
.IP "split_directory" 4
.IX Item "split_directory"
Optional. Specify the directory in which the split files need to be written.
.IP "template" 4
.IX Item "template"
Optional. A template toolkit template to be used for creating each \s-1XML\s0 output record. Gets as input
the input data plus the \s-1XML\s0 serialized form in the 'xml' field.
.IP "template_before" 4
.IX Item "template_before"
Optional. The template toolkit template to be used as \s-1XML\s0 header.
.IP "template_after" 4
.IX Item "template_after"
Optional. The template toolkit template to be used as \s-1XML\s0 footer.
.IP "fix" 4
.IX Item "fix"
An \s-1ARRAY\s0 of one or more fixes or file scripts to be applied to imported items.
.IP "root" 4
.IX Item "root"
Required. The name (and namespace) of the root element of the \s-1XML\s0 document. E.g.:
.Sp
.Vb 3
\&    {}shiporder
\&    {http://www.loc.gov/mods/v3}mods
\&    {urn:isbn:1\-931666\-22\-9}ead
.Ve
.IP "schemas" 4
.IX Item "schemas"
Required. An array or comma separated list of \s-1XSD\s0 schema locations.
.IP "prefixes" 4
.IX Item "prefixes"
Optional. An array or comma delimited string of namespace prefixes to be used
hand handling \s-1XML\s0 files. E.g.
.Sp
.Vb 2
\&    # On the command line:
\&    catmandu ... \-\-prefixes ead:urn:isbn:1\-931666\-22\-9,...
\&
\&    # In Perl
\&    prefixes => [
\&        ead => \*(Aqurn:isbn:1\-931666\-22\-9\*(Aq ,
\&        ... => ...
\&    ]
.Ve
.IP "mixed" 4
.IX Item "mixed"
Optional. The handling of mixed element content. One of \s-1ATTRIBUTES\s0 (default),
\&\s-1TEXTUAL, STRUCTURAL, XML_NODE, XML_STRING, CODE\s0 reference. See also
Catmandu::XSD and XML::Compile::Translate::Reader
.SH "METHODS"
.IX Header "METHODS"
Every Catmandu::Importer is a Catmandu::Iterable all its methods are
inherited.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catmandu::Exporter, Catmandu::XSD , Template
.SH "AUTHOR"
.IX Header "AUTHOR"
Patrick Hochstenbach , \f(CW\*(C`patrick.hochstenbach at ugent.be\*(C'\fR
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
This program is free software; you can redistribute it and/or modify it
under the terms of either: the \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See <http://dev.perl.org/licenses/> for more information.