.\" 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 "MKDoc::XML 3pm"
.TH MKDoc::XML 3pm "2005-03-10" "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"
MKDoc::XML \- The MKDoc XML Toolkit
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This is an article, not a module.
.SH "SUMMARY"
.IX Header "SUMMARY"
MKDoc is a web content management system written in Perl which focuses on
standards compliance, accessiblity and usability issues, and multi-lingual
websites.
.PP
At MKDoc Ltd we have decided to gradually break up our existing commercial
software into a collection of completely independent, well-documented,
well-tested open-source \s-1CPAN\s0 modules.
.PP
Ultimately we want MKDoc code to be a coherent collection of module
distributions, yet each distribution should be usable and useful in itself.
.PP
MKDoc::XML is part of this effort.
.PP
You could help us and turn some of MKDoc's code into a \s-1CPAN\s0 module.
You can take a look at the existing code at http://download.mkdoc.org/.
.PP
If you are interested in some functionality which you would like to
see as a standalone \s-1CPAN\s0 module, send an email to
<mkdoc\-modules@lists.webarch.co.uk>.
.SH "DISCLAIMER"
.IX Header "DISCLAIMER"
.IP "\fBMKDoc::XML is a low level \s-1XML\s0 library.\fR" 4
.IX Item "MKDoc::XML is a low level XML library."
.PD 0
.IP "MKDoc::XML::* modules do not make sure your \s-1XML\s0 is well-formed." 4
.IX Item "MKDoc::XML::* modules do not make sure your XML is well-formed."
.IP "MKDoc::XML::* modules can be used to work with somehow broken \s-1XML\s0." 4
.IX Item "MKDoc::XML::* modules can be used to work with somehow broken XML."
.IP "MKDoc::XML::* modules should not be used as high-level parsers with general purpose \s-1XML\s0 unless you know what you're doing." 4
.IX Item "MKDoc::XML::* modules should not be used as high-level parsers with general purpose XML unless you know what you're doing."
.PD
.SH "WHAT'S IN THE BOX"
.IX Header "WHAT'S IN THE BOX"
.SS "\s-1XML\s0 tokenizer"
.IX Subsection "XML tokenizer"
MKDoc::XML::Tokenizer splits your \s-1XML\s0 / \s-1XHTML\s0 files into a list of
MKDoc::XML::Token objects using a single regex.
.SS "\s-1XML\s0 tree builder"
.IX Subsection "XML tree builder"
MKDoc::XML::TreeBuilder sits on top of MKDoc::XML::Tokenizer and builds
parsed trees out of your \s-1XML\s0 / \s-1XHTML\s0 data.
.SS "\s-1XML\s0 stripper"
.IX Subsection "XML stripper"
MKDoc::XML::Stripper objects removes unwanted markup from your \s-1XML\s0 / \s-1HTML\s0
data. Useful to remove all those nasty presentational tags or 'style'
attributes from your \s-1XHTML\s0 data for example.
.SS "\s-1XML\s0 tagger"
.IX Subsection "XML tagger"
MKDoc::XML::Tagger module matches expressions in \s-1XML\s0 / \s-1XHTML\s0 documents and
tag them appropriately. For example, you could automatically hyperlink certain
glossary words or add <abbr> tags based on a dictionary of abbreviations and
acronyms.
.SS "\s-1XML\s0 entity decoder"
.IX Subsection "XML entity decoder"
MKDoc::XML::Decode is a pluggable, configurable entity expander module which
currently supports html entities, numerical entities and basic xml entities.
.SS "\s-1XML\s0 entity encoder"
.IX Subsection "XML entity encoder"
MKDoc::XML::Encode does the exact reverse operation as MKDoc::XML::Decode.
.SS "\s-1XML\s0 Dumper"
.IX Subsection "XML Dumper"
MKDoc::XML::Dumper serializes arbitrarily complex perl structures into \s-1XML\s0 strings.
It is also able of doing the reverse operation, i.e. deserializing an \s-1XML\s0 string into
a perl structure.
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright 2003 \- MKDoc Holdings Ltd.
.PP
Author: Jean-Michel Hiver
.PP
This module is free software and is distributed under the same license as Perl
itself. Use it at your own risk.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 2
\&  Petal: http://search.cpan.org/dist/Petal/
\&  MKDoc: http://www.mkdoc.com/
.Ve
.PP
Help us open-source MKDoc. Join the mkdoc-modules mailing list:
.PP
.Vb 1
\&  mkdoc\-modules@lists.webarch.co.uk
.Ve