curcuru bd99f739b3 First-cut implementations of top level xml-commons doc
Note issues remain, esp. about getting each deliverable
(external, which, resolver, etc.) to be able to have it's
own docset, or at least be able to build thereof


git-svn-id: https://svn.apache.org/repos/asf/xml/commons/trunk@226018 13f79535-47bb-0310-9956-ffa450edef68
2002-11-20 01:02:55 +00:00

50 lines
2.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
<document>
<header>
<title>External Components</title>
<authors>
<person name="Shane Curcuru" email="curcuru@apache.org"/>
</authors>
</header>
<body>
<anchor id="overview"/>
<section>
<title>Overview</title>
<p>xml-commons provides an Apache-hosted set of DOM, SAX, and JAXP interfaces for use in
other xml-based projects. Our hope is that we can standardize on both a common version and
packaging scheme for these critical XML standards interfaces to make the lives of both
our developers and users easier.
</p>
<p>The External Components portion of xml-commons contains interfaces that
are defined by external standards organizations. For DOM, that's the W3c; for SAX it's
David Megginson and sax.sourceforge.net; for JAXP it's Sun. While we could send users to
each of the primary sources for these deliverables, keeping our own versions of these in
the xml-commons repository gives us a number of advantages:
</p>
<ul>
<li>Simplicity of downloads: users get the whole product from one place.
</li>
<li>Better version control: we can only take fixes we want, and add Apache-specific changes.
</li>
<li>Better overview documentation of how these interfaces fit into the XML processing world.
</li>
<li>More chance for cross-project community building within Apache projects.
</li>
</ul>
<fixme author="curcuru">In progress. See the commons-dev-at-xml.apache.org mailing list
for our current progress at updating the structure of the xml-commons project. Volunteers
to help with the documentation set appreciated as well!
</fixme>
<p>Currently, we provide just the native sets of javadoc from each of these external
sets of code, plus whatever native documentation provided.
We also include LICENSE and README files for each set of code from
an external source.
</p>
</section>
</body>
</document>