diff --git a/src/documentation/content/xdocs/components/book.xml b/src/documentation/content/xdocs/components/book.xml index 1767d0b..582de9c 100644 --- a/src/documentation/content/xdocs/components/book.xml +++ b/src/documentation/content/xdocs/components/book.xml @@ -14,6 +14,7 @@ + diff --git a/src/documentation/content/xdocs/components/external.xml b/src/documentation/content/xdocs/components/external.xml new file mode 100644 index 0000000..3062b60 --- /dev/null +++ b/src/documentation/content/xdocs/components/external.xml @@ -0,0 +1,49 @@ + + + +
+ External Components + + + +
+ + +
+ Overview +

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. +

+

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: +

+
    +
  • Simplicity of downloads: users get the whole product from one place. +
    • +
  • Better version control: we can only take fixes we want, and add Apache-specific changes. +
    • +
  • Better overview documentation of how these interfaces fit into the XML processing world. +
    • +
  • More chance for cross-project community building within Apache projects. +
    • +
+ + 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! + +

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. +

+ +
+ + + diff --git a/src/documentation/content/xdocs/components/index.xml b/src/documentation/content/xdocs/components/index.xml index 3433945..4d53d13 100644 --- a/src/documentation/content/xdocs/components/index.xml +++ b/src/documentation/content/xdocs/components/index.xml @@ -4,6 +4,7 @@
Components of xml-commons +
@@ -12,15 +13,18 @@
Overview

- These are some of the components that are provided by Apache XML - Commons. + These are some of the components that are provided by the Apache XML + Commons project.

  • Resolver - - ### Fixme: add concise description here. + An XML Entity and URI Resolver donated by Norman Walsh.
  • Which - - ### Fixme: add concise description here. + A simple environment checking utility for Apache projects by Shane Curcuru +
    • +
  • External Interfaces (xml-apis) + An Apache-hosted set of externally-defined standards interfaces, namely DOM, SAX, and JAXP.
diff --git a/src/documentation/content/xdocs/components/resolver.xml b/src/documentation/content/xdocs/components/resolver.xml index 49cfe78..db16d0d 100644 --- a/src/documentation/content/xdocs/components/resolver.xml +++ b/src/documentation/content/xdocs/components/resolver.xml @@ -11,9 +11,15 @@
Overview -

- ### Fixme: add overview of Resolver here. +

See the current set of resolver docs java/docs/resolver.html + See the current /java/docs/releasenotes.html.

+ Need to either update existing resolver docs to + use forrest or provide a stylesheet to translate it (it uses Docbook since + ndw used that). Also need to either move docs or provide correct links + to the resolver-specific docs. + +
diff --git a/src/documentation/content/xdocs/components/which.xml b/src/documentation/content/xdocs/components/which.xml index f1add35..d4a2619 100644 --- a/src/documentation/content/xdocs/components/which.xml +++ b/src/documentation/content/xdocs/components/which.xml @@ -12,8 +12,15 @@
Overview

- ### Fixme: add overview of Which here. + Which is a simple environment checking utility that focuses on reporting the versions of + various XML interfaces and some common Apache projects.

+

Currently, most of the documentation about Which is in it's Javadoc, which you can + build via build docs.

+ Still need to write overview and user guide docs, as well + as guidelines for creating WhichProject implementations and best practices about + how to use Which for customer support or automated tools. +