diff --git a/forrest.properties b/forrest.properties new file mode 100644 index 0000000..ce97bb0 --- /dev/null +++ b/forrest.properties @@ -0,0 +1,81 @@ +############## +# Properties used by forrest.build.xml for building the website +############## + +# Prints out a summary of Forrest settings for this project +#forrest.echo=true + +# Project name (used to name .war file) +#project.name=my-project + +# Specifies name of Forrest skin to use +#project.skin=forrest-site +#project.skin=avalon-tigris + + +############## +# layout properties + +# Properties that must be set to override the default locations +#project.status=status.xml +#project.content-dir=src/documentation +#project.conf-dir=${project.content-dir}/conf +#project.sitemap=${project.content-dir}/sitemap.xmap +#project.xdocs-dir=${project.content-dir}/content/xdocs +#project.stylesheets-dir=${project.content-dir}/resources/stylesheets +#project.images-dir=${project.content-dir}/resources/images +#project.schema-dir=${project.content-dir}/resources/schema +#project.skins-dir=${project.content-dir}/skins +#project.skinconf=${project.content-dir}/skinconf.xml +#project.lib-dir=${project.content-dir}/lib +#project.classes-dir=${project.content-dir}/classes + + +############## +# validation properties + +# These props determine if validation is performed at all +# Values are inherited unless overridden. +# Eg, if forrest.validate=false, then all others are false unless set to true. +#forrest.validate=true +#forrest.validate.xdocs=${forrest.validate} +#forrest.validate.skinconf=${forrest.validate} +#forrest.validate.sitemap=${forrest.validate} +#forrest.validate.stylesheets=${forrest.validate} +#forrest.validate.skins=${forrest.validate} +#forrest.validate.skins.stylesheets=${forrest.validate.skins} + + +# Key: +# *.failonerror=(true|false) stop when an XML file is invalid +# *.includes=(pattern) Comma-separated list of path patterns to validate +# *.excludes=(pattern) Comma-separated list of path patterns to not validate + +#forrest.validate.failonerror=true +#forrest.validate.includes=**/* +#forrest.validate.excludes= +# +#forrest.validate.xdocs.failonerror=${forrest.validate.failonerror} +# +#forrest.validate.xdocs.includes=*.x* +#forrest.validate.xdocs.excludes= +# +#forrest.validate.skinconf.includes=${skinconf-file} +#forrest.validate.skinconf.excludes= +#forrest.validate.skinconf.failonerror=${forrest.validate.failonerror} +# +#forrest.validate.sitemap.includes=${sitemap-file} +#forrest.validate.sitemap.excludes= +#forrest.validate.sitemap.failonerror=${forrest.validate.failonerror} +# +#forrest.validate.stylesheets.includes=**/*.xsl +#forrest.validate.stylesheets.excludes= +#forrest.validate.stylesheets.failonerror=${forrest.validate.failonerror} +# +#forrest.validate.skins.includes=**/* +#forrest.validate.skins.excludes=**/*.xsl +#forrest.validate.skins.failonerror=${forrest.validate.failonerror} +# +#forrest.validate.skins.stylesheets.includes=**/*.xsl +#forrest.validate.skins.stylesheets.excludes= +#forrest.validate.skins.stylesheets.failonerror=${forrest.validate.skins.failonerror} diff --git a/src/documentation/README.txt b/src/documentation/README.txt new file mode 100644 index 0000000..4545b58 --- /dev/null +++ b/src/documentation/README.txt @@ -0,0 +1,10 @@ +This is the base documentation directory. It usually contains two files: + +skinconf.xml # This file customizes Forrest for your project. In it, you + # tell forrest the project name, logo, copyright info, etc + +sitemap.xmap # Optional. This sitemap overrides the default one bundled + # with Forrest. Typically, one would copy a sitemap from + # xml-forrest/src/resources/conf/sitemap.xmap, and customize + # it. + diff --git a/src/documentation/content/xdocs/book.xml b/src/documentation/content/xdocs/book.xml new file mode 100644 index 0000000..c205a79 --- /dev/null +++ b/src/documentation/content/xdocs/book.xml @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/src/documentation/content/xdocs/components/book.xml b/src/documentation/content/xdocs/components/book.xml new file mode 100644 index 0000000..1767d0b --- /dev/null +++ b/src/documentation/content/xdocs/components/book.xml @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + diff --git a/src/documentation/content/xdocs/components/index.xml b/src/documentation/content/xdocs/components/index.xml new file mode 100644 index 0000000..3433945 --- /dev/null +++ b/src/documentation/content/xdocs/components/index.xml @@ -0,0 +1,29 @@ + + + +
+ Components of xml-commons + + + +
+ + +
+ Overview +

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

+
    +
  • Resolver + - ### Fixme: add concise description here. +
    • +
  • Which + - ### Fixme: add concise description here. +
    • +
+
+ + + diff --git a/src/documentation/content/xdocs/components/resolver.xml b/src/documentation/content/xdocs/components/resolver.xml new file mode 100644 index 0000000..49cfe78 --- /dev/null +++ b/src/documentation/content/xdocs/components/resolver.xml @@ -0,0 +1,20 @@ + + + +
+ Resolver + + + +
+ + +
+ Overview +

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

+
+ + + diff --git a/src/documentation/content/xdocs/components/which.xml b/src/documentation/content/xdocs/components/which.xml new file mode 100644 index 0000000..f1add35 --- /dev/null +++ b/src/documentation/content/xdocs/components/which.xml @@ -0,0 +1,20 @@ + + + +
+ Which + + + +
+ + +
+ Overview +

+ ### Fixme: add overview of Which here. +

+
+ + + diff --git a/src/documentation/content/xdocs/history.xml b/src/documentation/content/xdocs/history.xml new file mode 100644 index 0000000..93adb02 --- /dev/null +++ b/src/documentation/content/xdocs/history.xml @@ -0,0 +1,239 @@ + + + +
+ History of XML Commons + + + +
+ + + +
+ xml-subproject-proposal-commons-v1.1 + +
+ + +
+ xml-subproject-proposal-commons-v1.1-vote-count-26-Apr-01 +

Below follows the votes cast to create this subproject

+

---- From open general@xml.apache.org mailing list through 3pm 26-Apr-01 ---- +

+

Original proposal at: +http://marc.theaimsgroup.com/?l=xml-apache-general&m=987524447023862 +

+

+---- 17 Total committer +1 votes, plus 13 +1's for 4.c (allow all xml +committers) ---- +

+
    +
  • +1 4.c Shane Curcuru curcuru@apache.org (my implicit vote with the proposal)
    • +
  • +1 and 4c Kelly Campbell camk@channelpoint.com
    • +
  • +1 4.c Arnaud Le Hors lehors@us.ibm.com
    • +
  • +1, and 4c Tinny Ng tng-xml@ca.ibm.com
    • +
  • +1, and 4c "Ted Leung" twleung@sauria.com
    • +
  • +1 (4.c) Elena Litani elena@apache.org
    • +
  • +1, 4.c Vincent Hardy vhardy@eng.sun.com
    • +
  • ballot committer="arved" email="asandstrom@accesswave.ca" + vote issue="xml-subproject-proposal-commons-v1.1" vote="+1" + comment/ + /vote + vote issue="xml-subproject-proposal-commons-v1.1-committers" + vote="+1" + comment4.(c)/comment + /vote +/ballot +
    • +
  • +1 and 4c. Andy Clark andyc@apache.org
    • +
  • +1 4.c "Jeffrey Rodriguez" jeffreyr_97@hotmail.com
    • +
  • +1, I vote for the least restrictive option, 4.c. Edwin.Goei@sun.com
    • +
  • +1 for the proposal. +1 for 4.d - all current xml.apache.org and jakarta.apache.org :-) ( but I can settle for 4.c :-) cmanolache@yahoo.com
    • +
  • +1 for 4c Donald_Leslie@lotus.com
    • +
  • +1. Scott Sanders satan@totalsync.com (jakarta committer, don't know if he's an xml committer, but he volunteered to work on coordination with jakarta-commons)
    • +
  • +1, 4.c Thierry Kormann tkormann@sophia.inria.fr
    • +
  • +1 from me. Davanum Srinivas dims@yahoo.com
    • +
  • +1 Scott_Boag@lotus.com
    • +
+
    +
  • ---- Other comments and non-committer votes ----
    • +
  • ballot committer="" email="shugal@gmx.de" + vote issue="xml-subproject-proposal-commons-v1.1" vote="+1" + commentA good and necessary idea! I'd like to contribute here. + Also see below./comment + /vote + vote issue="xml-subproject-proposal-commons-v1.1-committers" + vote="4.b or 4.a" + commentI'm no committer, but I think we should get the + number of committers low at least a this initial stage. Everyone is + free to contribute code to one of the actual committers who will + check it into CVS if they think it's useful./comment + /vote +/ballot +
    • +
  • "Once the /xml-commons repository is set up, I volunteer to check in the +latest JAXP code into /xml-commons. Right now there are 3 different +projects with 3 different versions. It'd be nice to have just one." Edwin +Goei edwingo@sun.com +
    • +
+

/xml-subproject-proposal-commons-v1.1-vote-count-26-Apr-01

+
+ + diff --git a/src/documentation/content/xdocs/howto-forrest.xml b/src/documentation/content/xdocs/howto-forrest.xml new file mode 100644 index 0000000..ff3709c --- /dev/null +++ b/src/documentation/content/xdocs/howto-forrest.xml @@ -0,0 +1,81 @@ + + + +
+ How to produce xml-commons website with Forrest + + + +
+ +
+ Overview +

+This is the procedure that i followed to build the initial xml-commons +website with Forrest. +

+ +This is just to get us started. Later Forrest will automatically build it. + +
+ +
+ Install Forrest on localhost +

+ Followed the document: + Using + Forrest +

+
+ +
+ Seed the new website +

+ This only needed to be done to start and it is done now and committed + to CVS. +

+ +
+ +
+ Edit the content + +
+ +
+ Build it and view it + +
+ +
+ Still to do + +
+ + diff --git a/src/documentation/content/xdocs/index.xml b/src/documentation/content/xdocs/index.xml new file mode 100644 index 0000000..2784dee --- /dev/null +++ b/src/documentation/content/xdocs/index.xml @@ -0,0 +1,288 @@ + + + +
+ Welcome to xml-commons + + + +
+ + +
+ Overview +

xml-commons is focussed on common code and guidelines for xml projects. +The first focus will be to organize and have common packaging for the various +externally-defined standards code relating to XML - things like the DOM, SAX, +and JAXP interfaces.

+

As the xml-commons community forms, we also hope to serve as a holding area +for other common xml-related utilities and code, and to help promulgate common +packaging, testing, documentation, and other guidelines across all +xml.apache.org subprojects.

+
+ + +
+ Commons Guidelines +

As the community forms, we need to formalize these guidelines, especially +to differentiate "requirements" from suggested "guidelines".

+

Shane's starting proposals:

+

xml-commons is an unusual project in several ways.

+

First, it encompasses two kinds of code: External and Apache.

+

Secondly, +xml-commons mainly focuses on providing code and services to other +xml.apache.org projects instead of shipping it's own 'standalone' project. +

+

Third, it will also tend to be more focussed on smaller, interoperable modules of +code and a very high degree of stability.

+

In some ways, the forming of +xml-commons is the seed of a catalyst to improve cross-project coordination +throughout xml.apache.org. One potential goal is to get all xml.apache.org +projects to take their xml standards oriented code - like DOM, SAX and JAXP - +from specific marked builds of xml-commons, instead of each project +using different versions of these files.

+

External code: xml-commons will serve as an Apache-controlled +copy of externally-defined standards-based files. This way, we can try +to manage common versions of these important xml standards-based files +and interfaces. Read more.

+

Apache code: xml-commons will serve as a shared repository for +common xml-oriented utilities or building blocks that several other +xml.apache.org projects wish to use. The first example is org.apache.env.Which, +and environment checking utility that scans your environment and reports common +versions of xml-related files. The next likely submission is an entity resolver +that could be plugged into any xml parsing, transforming, or processing +project. Read more.

+

Directory tree (proposed)

+ +This needs to be updated to reflect the current tree. +It also needs to go into a section of its own or perhaps a separate document. + + + +
    +
  • We should consider adopting those guidelines from the jakarta-commons +project that make sense for our xml projects - keeping in mind that both the kind of +projects we build are different than jakarta, and some of our goals are a +little bit different.
    • +
  • Dicsussion and buy-in should happen on the project mailing list +before checking in new modules.
    • +
  • New modules generally shouldn't go in until at least two separate +other projects express interest in using the module. I think this is an +important difference from jakarta-commons that makes sense in our world. +I.e. I'd rather not just throw something in because it seems like it might +be useful, I'd rather only put things in that we know will be shared among +multiple projects.
    • +
  • The xml-commons community should come up with guidelines for other +xml.apache.org subprojects to use the code that commons has. I.e. suggestions +and ways to package this code vis-a-vis the other project's code in a common way.
    • +
  • Other shared xml.apache.org guidelines? Like documentation format, testing techniques/policies, etc.
    • +
+
+ + +
+ External code: DOM, SAX, and JAXP, etc. +

xml-commons primary goal is to provide Apache projects with a stable version of +XMl-related externally-defined standards-based code. This is mainly the various +interfaces that you use when programming XML from JAVA: DOM, SAX and JAXP for now.

+

This tree is rooted at xml-commons/java/external, and has a build.xml file. +Basic documentation from each external project is also checked in.

+
    +
  • Current (Feb-02) status:
    • +
  • No significant changes from Jan-02
    • +
  • Current (Jan-02) status:
    • +
  • DOM L2 - full set of interfaces (including HTML stuff) from w3c.org
    • +
  • SAX 2.0 from megginson.com, plus minor bugfixes. Note that SAX +is currently maintained at +http://sax.sourceforge.net/ +( we need to update and cross-check with them soon!)
    • +
  • JAXP 1.1.3-HEAD from Sun, with current bugfixes by edwingo@apache.org
    • +
+

Issues Jan-02: our current SAX and JAXP code may not pass the current +J2EE CTS test suite, since we have bugfixes above what those CTS tests +mandate. If you don't know what that is, you don't care; otherwise ask +on commons-dev for an update.

+
+ + +
+ Apache-authored code +

xml-commons' secondary goal is to provide a project space for small +XML-related utilities that are being used in multiple other xml.apache.org +projects. In an effort to simplify and reduce dependency headaches, we'll +probably accept new projects only fairly slowly (this is in contrast to +the much more open +jakarta-commons project). +In particular, code submitted here should probably have minimal dependencies: +possibly only depending on DOM/SAX/JAXP and Ant (for builds).

+
    +
  • Current (Nov-02) status:
    • +
  • org.apache.xml.resolver.Resolver: Norm Walsh's entity resolver utility now released +as a separate distribution, see Releases.
    • +
  • Current (Feb-02) status:
    • +
  • org.apache.env.Which - a simple environment check utility for +xml-related items in your JVM's environment: see xml-commons/java/which.xml
  • org.apache.xml.resolver.Resolver: Norm Walsh's entity resolver utility now checked in!
    • +
  • (to be voted in) Jeff Turner's DOCTYPE changer
    • +
  • Current (Jan-02) status:
    • +
  • org.apache.env.Which - a simple environment check utility for +xml-related items in your JVM's environment: see xml-commons/java/which.xml
  • (to be submitted) Norm Walsh's entity resolver utility
    • +
  • (to be voted in) Jeff Turner's DOCTYPE changer
    • +
+
+ + +
+ Where can I download releases? +

The xml-commons-resolver-1.0 release 12-Nov-02 is available in our +distribution directory +and includes: +

+
    +
  • This release is includes just the 1.0 XmlResolver component, by request from coccoon-dev and others. +It is released for users who just want to use the Resolver and don't need the rest +of xml-commons. Pending discussion on commons-dev, we believe that future xml-commons +releases will be separated out in this manner (external/resolver/which/etc).
    • +
+ +

The xml-commons-1.0.b2 release 06-Feb-02 is available in our +distribution directory +and includes: +

+
    +
  • The previous contents from the 1.0.b1 release (minor javadoc fixes may have been made)
    • +
  • Various LICENSE.* and README.* files for our external sources
    • +
  • New code! org.apache.xml.resolver.Resolver: Norm Walsh's entity resolver utility +is now checked in and building!
    • +
+ +

The xml-commons-1.0.b1 release 11-Jan-02 is available in our +distribution directory +and includes the following code: +

+
    +
  • java/build/which.jar containing:
    • +
  • org.apache.env.Which - a simple environment check utility for +xml-related items in your JVM's environment: 1.0 funtionality working
    • +
  • java/external/build/xml-apis.jar containing:
    • +
  • DOM Level 2 including all base files and HTML and CSS DOMs; from +w3c.org
    • +
  • JAXP code roughly equivalent to JAXP 1.1.3; for reference releases +from Sun, see +java.sun.com/xml
    • +
  • SAX 2.0-r2-prerelease and SAX2-ext-1.0; plus bugfixes to +org.xml.sax.helpers.ParserAdapter (make compile in JDK 1.1.x) and AttributesImpl (minor +removeAttribute bug); from megginson.com although SAX maintenance has +now moved to +sax.sourceforge.net
    • +
+ +

Future 'b' or beta releases leading up to a gold 1.0 release will +be discussed on our mailing list. Likely releases +might address points such as: +

+
    +
  • Improvements or submissions to org.apache.env.Which
    • +
  • A new submission of an entity resolver from Norman Walsh
    • +
  • A specific version of backlevel JAXP 1.1 that will work with +Sun's J2EE CTS conformance tests, if enough people request it
    • +
  • Specific versions of SAX, if the xml.apache.org community +requests it and wants to update to a newer shipped release of SAX, perhaps +SAX 2R2pre3 or later
    • +
+
+ + +
+ How can I find out more? +

We have a project mailing list ... commons-dev<at>xml.apache.org +... Ask your questions or bring your suggestions there, +or to general<at>xml.apache.org +

+
    +
  • Send an email to commons-dev +... commons-dev<at>xml.apache.org
    • +
  • Subscribe to commons-dev +... commons-dev-subscribe<at>xml.apache.org
    • +
  • Un-subscribe from commons-dev +... commons-dev-unsubscribe<at>xml.apache.org
    • +
+
+ + +
+ Where can I get the code/CVS? +

The xml-commons repository is available thru normal and anonymous CVS, or +through this +nifty web +interface.

+

See +xml.apache.org CVS overview. +

+
+ + +
+ History +

See the separate document History of XML Commons +for the proposal to establish the xml-commons project and for the record of the +vote on 2001-04-26. +

+
+ + +
+ Licenses +

+See information about licensing. +

+
+ + +
+ Information about this document +
    +
  • Version: $Id$
    • +
  • This document is stored in the xml-commons CVS repository as: +/home/cvs/xml-commons/src/documentation/content/xdocs/index.xml +
    • +
  • +The HTML and PDF renditions are generated by +Apache Forrest +
    • +
+
+ + diff --git a/src/documentation/content/xdocs/licenses.xml b/src/documentation/content/xdocs/licenses.xml new file mode 100644 index 0000000..2e486de --- /dev/null +++ b/src/documentation/content/xdocs/licenses.xml @@ -0,0 +1,108 @@ + + + +
+ Licenses for xml-commons + + + +
+ +
+ HEAR YE, HEAR YE! +

+Software and documentation in this repository are covered under +a number of different licenses. +

+ +

+Most files under xml-commons/java/external/ are covered +under their respective LICENSE.*.txt files; see the matching +README.*.txt files for descriptions. +

+ +

+Note that xml-commons/java/external/build.xml and +xml-commons/java/external/src/manifest.commons are +both covered under the Apache Software License. +

+ +

+All files not otherwise noted are covered under the +Apache Software License in LICENSE.txt including all +files under xml-commons/java/src +

+
+ + +
+ General License +. + */ +]]> +
+ + +
+ Information about this document +
    +
  • Version: $Id$
    • +
+
+ + diff --git a/src/documentation/content/xdocs/tabs.xml b/src/documentation/content/xdocs/tabs.xml new file mode 100644 index 0000000..01c0ec6 --- /dev/null +++ b/src/documentation/content/xdocs/tabs.xml @@ -0,0 +1,12 @@ + + + + + + + + + diff --git a/src/documentation/resources/images/group-logo.gif b/src/documentation/resources/images/group-logo.gif new file mode 100644 index 0000000..57e4b36 Binary files /dev/null and b/src/documentation/resources/images/group-logo.gif differ diff --git a/src/documentation/resources/images/icon.png b/src/documentation/resources/images/icon.png new file mode 100644 index 0000000..3be8bbb Binary files /dev/null and b/src/documentation/resources/images/icon.png differ diff --git a/src/documentation/resources/images/project-logo.png b/src/documentation/resources/images/project-logo.png new file mode 100644 index 0000000..74770b6 Binary files /dev/null and b/src/documentation/resources/images/project-logo.png differ diff --git a/src/documentation/skinconf.xml b/src/documentation/skinconf.xml new file mode 100644 index 0000000..22061a1 --- /dev/null +++ b/src/documentation/skinconf.xml @@ -0,0 +1,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ]> + + + + false + xml.apache.org + Apache XML + + + xml-commons + http://xml.apache.org/xml-commons/ + images/project-logo.png + + + Apache XML + http://xml.apache.org/ + images/group-logo.gif + + + + + + + 2002 + The Apache Software Foundation. + + + + + + + + + + + + Built with Apache Forrest + http://xml.apache.org/forrest/ + images/built-with-forrest-button.png + 88 + 31 + + + diff --git a/status.xml b/status.xml new file mode 100644 index 0000000..3777493 --- /dev/null +++ b/status.xml @@ -0,0 +1,69 @@ + + + + + + + + + + + + + + + Finish initial website. Follow procedure in + How-to Forrest + + + Tweak the initial content for the top-level docs. + + + Decide how to build separate distributable docs for each "component", + and how they will also be published to xml-commons website. Best if + xdocs content can remain in /java with their code. See email: + draft website for xml-commons using Forrest + + + + + Add top-level documents about each resource that is provided by + xml-commons. + + + Decide directory layout. See email: + Repository layout + + + Replace the README file at + http://xml.apache.org/commons/dist/ + + + + + + + + + + + Added placeholder docs and tabs for components. + + + + + + Built demo website using Forrest. Gleaned content from + xml-commons/README.html + + + +