File Coverage

blib/lib/XML/Easy.pm

Criterion	Covered	Total	%
statement	11	11	100.0
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	15	15	100.0

=head1 NAME

XML::Easy - XML processing with a clean interface

=head1 SYNOPSIS

    use XML::Easy::NodeBasics qw(xml_element xml_e_attribute);
    use XML::Easy::Text qw(xml10_read_document xml10_write_document);

    $element = xml_element("a", { href => "there" }, "there");
    $element = xml10_read_document('there');

    $href = xml_e_attribute($element, "href");
    $text = xml10_write_document($element);

    # see specific modules for many more functions

=head1 DESCRIPTION

L is a collection of modules relating to the processing,
parsing, and serialisation of XML data.  It is oriented towards the
use of XML to represent data for interchange purposes, rather than the
use of XML as markup of principally textual data.  It does not perform
any schema processing, and does not interpret DTDs or any other kind
of schema.  It adheres strictly to the XML specification, in all its
awkward details, except for the aforementioned DTDs.

L strictly separates the in-program manipulation of XML
data from the processing of the textual form of XML.  This shields
the XML user from the inconvenient and obscure aspects of XML syntax.
XML data nodes are mainly processed in a clean functional style, using
the L module.  In the (very likely) event that
an application requires some more purpose-specific XML data processing
facilities, they are readily built on top of L,
retaining the abstraction from textual XML.

When XML must be handled in textual form, for input and output,
the L module supplies a parser and a serialiser.
The interfaces here, too, are functional in nature.

There are other modules for some ancillary aspects of XML processing.

=head2 Minimum Perl Version

While the code in this library's modules was originally written to accommodate
perl-5.8, its prerequisites are in large part no longer working on that
version of F.  So as of XML-Easy-0.012 we will set perl-5.10.1 as our
recommended minimum Perl version.

=head1 MODULES

The modules in the L distribution are:

=over

=item L

This document.  For historical reasons, this can also be loaded as
a module, and (though it is deprecated) some of the functions from
L can be imported from here.

=item L

This module provides various type-testing functions, relating to data
types used in the L ensemble.  These are mainly intended to be
used to enforce validity of data being processed by XML-related functions.

=item L

=item L

These are classes used to represent XML data for general manipulation.
Objects of these classes hold the meaningful content of the data,
independent of textual representation.  The data in these nodes cannot
be modified: different data requires new nodes.

=item L

This module supplies functions concerned with the creation, examination,
and other manipulation of XML data nodes (content chunks and elements).
The nodes are dumb data objects, best manipulated using plain functions
such as the ones in this module.

=item L

This module supplies Perl regular expressions describing the grammar of
XML 1.0.  This is intended to support doing irregular things with XML,
rather than for normal parsing.

=item L

This module supplies functions that parse and serialise XML data as text
according to the XML 1.0 specification.

=back

=head1 OTHER DISTRIBUTIONS

Other CPAN distributions that work with L are:

=over

=item L

A testing tool, providing L-style functions that check
whether XML nodes are as expected.

=item L

Provides a way to construct XML data nodes by procedural code.
Some programmers will find this more comfortable than the functional
style offered by L.

=item L

Helps to parse things that are encoded in XML in common ways.

=item C

This namespace exists to contain modules that perform transformations
on XML documents, or parts thereof, in the form of L
and L nodes.

=back

=cut

package XML::Easy;

{ use 5.010001; }
use warnings;
use strict;

our $VERSION = "0.014";

use parent "Exporter";
our @EXPORT_OK = qw(
	xml10_read_content xml10_read_element
	xml10_read_document xml10_read_extparsedent
	xml10_write_content xml10_write_element
	xml10_write_document xml10_write_extparsedent
);

require XML::Easy::Text;
XML::Easy::Text->VERSION($VERSION);
XML::Easy::Text->import(@EXPORT_OK);

=head1 SEE ALSO

L,
L,
L,
L,
L

=head1 AUTHOR

Andrew Main (Zefram)  (deceased March 10 2025)

=head2 Maintainer

James E Keenan ([e-mail]), beginning with version 0.012

=head1 COPYRIGHT

Copyright (C) 2008, 2009 PhotoBox Ltd

Copyright (C) 2009, 2010, 2011, 2017
Andrew Main (Zefram)

=head1 LICENSE

This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut

1;