Initial top-level documentation using Forrest.
git-svn-id: https://svn.apache.org/repos/asf/xml/commons/trunk@226016 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
crossley
parent
eed062b3a8
commit
ce5fe72b4f
81
forrest.properties
Normal file
81
forrest.properties
Normal file
@ -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}
|
||||
10
src/documentation/README.txt
Normal file
10
src/documentation/README.txt
Normal file
@ -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.
|
||||
|
||||
25
src/documentation/content/xdocs/book.xml
Normal file
25
src/documentation/content/xdocs/book.xml
Normal file
@ -0,0 +1,25 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "book-cocoon-v10.dtd">
|
||||
|
||||
<book software="xml-commons"
|
||||
title="Apache xml-commons"
|
||||
copyright="@year@ The Apache Software Foundation"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
|
||||
<menu label="About">
|
||||
<menu-item label="Index" href="index.html"/>
|
||||
<menu-item label="Licenses" href="licenses.html"/>
|
||||
<external label="Download" href="http://xml.apache.org/commons/dist/"/>
|
||||
<menu-item label="Components" href="components/index.html"/>
|
||||
<menu-item label="History" href="history.html"/>
|
||||
<!-- Add new entries here, or in a new menu. Consult the DTD for
|
||||
valid elements -->
|
||||
<menu-item label="Changes" href="changes.html"/>
|
||||
<menu-item label="Todo" href="todo.html"/>
|
||||
</menu>
|
||||
|
||||
<menu label="Temporary">
|
||||
<menu-item label="How-to Forrest" href="howto-forrest.html"/>
|
||||
</menu>
|
||||
|
||||
</book>
|
||||
19
src/documentation/content/xdocs/components/book.xml
Normal file
19
src/documentation/content/xdocs/components/book.xml
Normal file
@ -0,0 +1,19 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "book-cocoon-v10.dtd">
|
||||
|
||||
<book software="xml-commons"
|
||||
title="Apache xml-commons"
|
||||
copyright="@year@ The Apache Software Foundation"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
|
||||
<menu label="Navigation">
|
||||
<menu-item label="Home" href="../index.html"/>
|
||||
</menu>
|
||||
|
||||
<menu label="About">
|
||||
<menu-item label="Overview" href="index.html"/>
|
||||
<menu-item label="Resolver" href="resolver.html"/>
|
||||
<menu-item label="Which" href="which.html"/>
|
||||
</menu>
|
||||
|
||||
</book>
|
||||
29
src/documentation/content/xdocs/components/index.xml
Normal file
29
src/documentation/content/xdocs/components/index.xml
Normal file
@ -0,0 +1,29 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
|
||||
<document>
|
||||
<header>
|
||||
<title>Components of xml-commons</title>
|
||||
<authors>
|
||||
<person name="David Crossley" email="crossley@apache.org"/>
|
||||
</authors>
|
||||
</header>
|
||||
<body>
|
||||
<anchor id="overview"/>
|
||||
<section>
|
||||
<title>Overview</title>
|
||||
<p>
|
||||
These are some of the components that are provided by Apache XML
|
||||
Commons.
|
||||
</p>
|
||||
<ul>
|
||||
<li><link href="resolver.html">Resolver</link>
|
||||
- ### Fixme: add concise description here.
|
||||
</li>
|
||||
<li><link href="which.html">Which</link>
|
||||
- ### Fixme: add concise description here.
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
</body>
|
||||
</document>
|
||||
20
src/documentation/content/xdocs/components/resolver.xml
Normal file
20
src/documentation/content/xdocs/components/resolver.xml
Normal file
@ -0,0 +1,20 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
|
||||
<document>
|
||||
<header>
|
||||
<title>Resolver</title>
|
||||
<authors>
|
||||
<person name="Norman Walsh" email="ndw@apache.org"/>
|
||||
</authors>
|
||||
</header>
|
||||
<body>
|
||||
<anchor id="overview"/>
|
||||
<section>
|
||||
<title>Overview</title>
|
||||
<p>
|
||||
### Fixme: add overview of Resolver here.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
</body>
|
||||
</document>
|
||||
20
src/documentation/content/xdocs/components/which.xml
Normal file
20
src/documentation/content/xdocs/components/which.xml
Normal file
@ -0,0 +1,20 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
|
||||
<document>
|
||||
<header>
|
||||
<title>Which</title>
|
||||
<authors>
|
||||
<person name="Shane Curcuru" email="curcuru@apache.org"/>
|
||||
</authors>
|
||||
</header>
|
||||
<body>
|
||||
<anchor id="overview"/>
|
||||
<section>
|
||||
<title>Overview</title>
|
||||
<p>
|
||||
### Fixme: add overview of Which here.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
</body>
|
||||
</document>
|
||||
239
src/documentation/content/xdocs/history.xml
Normal file
239
src/documentation/content/xdocs/history.xml
Normal file
@ -0,0 +1,239 @@
|
||||
<?xml version="1.0"?>
|
||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
|
||||
<document>
|
||||
<header>
|
||||
<title>History of XML Commons</title>
|
||||
<authors>
|
||||
<person name="Shane Curcuru" email="curcuru@apache.org"/>
|
||||
</authors>
|
||||
</header>
|
||||
<body>
|
||||
|
||||
<anchor id="proposal"/>
|
||||
<section>
|
||||
<title>xml-subproject-proposal-commons-v1.1</title>
|
||||
<source><![CDATA[
|
||||
List: xml-apache-general
|
||||
Subject: [VOTE] Proposal: new xml-commons subproject for standards-based files
|
||||
From: Shane_Curcuru@lotus.com
|
||||
Date: 2001-04-17 16:08:07
|
||||
|
||||
I propose a new xml.apache.org/xml-commons subproject to fulfill the need
|
||||
for a central repository for various XML standards-based files and common
|
||||
tools.
|
||||
|
||||
COMMITTERS-PLEASE-VOTE! Although I'm not sure of the exact voting procedure
|
||||
for creating whole new subprojects, I'm hoping to see a bunch of +1's to
|
||||
start with; feel free to either reply-to or use the handy mini-xml ballot
|
||||
below.
|
||||
|
||||
NON-COMMITTERS-PLEASE-DISCUSS! While votes from non-committers are not
|
||||
binding your discussion and insights are very valuable!
|
||||
|
||||
Key: committer="your_apache_login" email="your@preferred.email.address"
|
||||
Leave committer blank if you aren't; vote must be +1 | 0 | -1
|
||||
Add comment(s) if you like on specific issues
|
||||
|
||||
ballot committer="" email=""
|
||||
vote issue="xml-subproject-proposal-commons-v1.1" vote
|
||||
=""comment/comment/vote
|
||||
vote issue="xml-subproject-proposal-commons-v1.1-committers" vote
|
||||
=""comment/comment/vote
|
||||
/ballot
|
||||
|
||||
xml-subproject-proposal-commons-v1.1
|
||||
Proposal: form a new xml.apache.org subproject called xml-commons to
|
||||
fulfill the below needs.
|
||||
|
||||
(0) Rationale:
|
||||
Many xml.apache.org projects use and ship with sets of similar
|
||||
externally-defined standards-based code; differences in versioning and
|
||||
configuration of this code often make developing and using our projects
|
||||
more difficult. A common place for all xml.apache.org projects to get DOM,
|
||||
SAX, JAXP, and other externally-defined code would be a fairly low-cost and
|
||||
low-maintenance way to alleviate these difficulties. Having a subproject
|
||||
and a community focused on cross-xml-subproject issues will also help drive
|
||||
better cross-project coordination and tooling.
|
||||
|
||||
(0.1) Programming Languages: While the coding details of Java/C/Perl/etc
|
||||
are obviously different, the core concept is the same: a central repository
|
||||
for all xml.apache.org projects to share common interfaces and utilities.
|
||||
We should start with xml-commons/java, xml-commons/c, and xml-commons/perl
|
||||
since these languages are in current use in various xml.apache.org
|
||||
subprojects today.
|
||||
|
||||
|
||||
(1) Scope of this subproject:
|
||||
|
||||
(1.1) Common externally-defined standards:
|
||||
This includes the packages: org.w3c.dom.**, org.xml.sax.**, and javax.xml.
|
||||
** This is designed to essentially be an xml.apache.org-specific holding
|
||||
place for commonly-used interfaces/headers that are created outside of
|
||||
Apache. This subproject should provide guidelines and build scripts to aid
|
||||
xml.apache.org groups to easily use these common files in a common manner
|
||||
across all subprojects. This subproject should provide some basic
|
||||
versioning abilities so that xml.apache.org projects temporarily using
|
||||
new/beta/updated/proposed versions of these specs can continue to get their
|
||||
code from this area.
|
||||
|
||||
(1.2) Common xml-oriented utilities:
|
||||
We should also include additional utilities/common code in this subproject,
|
||||
like current copies of bsf.jar, stylebook, servlet API classes, etc. This
|
||||
could also include code that did originate in an Apache project, that we
|
||||
wanted to centralize the use of: SystemIDResolver, XML Serializers, etc.
|
||||
|
||||
(1.3) General project starting guidelines for future directions/scope:
|
||||
While the details of guidelines for this work should be finalized by the
|
||||
community that forms it (along with input from the other xml.apache.org
|
||||
projects who will be using this code), there are some basics to start with:
|
||||
- Communicate status regularly with general@xml.apache.org and with other
|
||||
subprojects
|
||||
- Clearly document and checkin 'best practices' for usage of xml-commons
|
||||
code in other subprojects
|
||||
- Proactively work with other subprojects to implement and improve our
|
||||
'best practices'
|
||||
- Provide upgrade paths and help; deprecate (or equivalent) old API's
|
||||
before removing, so other subprojects have ample time to upgrade.
|
||||
- Test and document all non-standards-based code; provide tests/additional
|
||||
documentation for standards-based code
|
||||
|
||||
(1.4) General guidelines for future directions/scope:
|
||||
Note this is firstly a subproject to make life inside of xml.apache.org
|
||||
easier, to enable us to more efficiently develop nifty XML projects. As we
|
||||
gain experience in developing this subproject, an obvious future direction
|
||||
for this community will be to work on a potential AXDK (Apache XML
|
||||
Development Kit) that would be a meta-packaging-project composed out of
|
||||
several xml projects together. The AXDK would be a way to make life for
|
||||
end-users easier: a single package of various Apache XML tools that works
|
||||
'out of the box'. (AXDK naming credit to kellyc I think?)
|
||||
|
||||
(1.5) Interaction with other subprojects
|
||||
Additional guidelines can be drawn up on general@xml.apache.org for this
|
||||
subproject, and then documented and checked in. These should include both
|
||||
how other xml subprojects should use these resources in their development
|
||||
cycles, as well as how all xml subprojects should package these resources
|
||||
when creating public, shipped distributions (to avoid version conflicts,
|
||||
etc.) This subproject's community, along with general@xml.apache.org, will
|
||||
need to draw up guidelines for code within this subproject as well.
|
||||
|
||||
|
||||
(2) Identify the initial source from which the subproject is to be
|
||||
populated:
|
||||
Standards-based sources would be obtained from the relevant owners/creators
|
||||
and checked into the project repository. A basic build.xml file and apache
|
||||
project usage guidelines would need to be created. Possible legal review
|
||||
would be needed for licensed files (one solution might be to waive the
|
||||
Apache license on these files). For common xml-oriented utilities, the
|
||||
initial sources can be moved in from other xml.apache.org subprojects (cf.
|
||||
potential org.apache.xml.utils.SystemIdResolver from xml-xalan).
|
||||
|
||||
|
||||
(3) Identify the xml.apache.org resources to be created
|
||||
|
||||
(3.1) mailing list(s)
|
||||
xml-commons-dev
|
||||
(ed note: added xml-commons-cvs as well -Shane)
|
||||
|
||||
(3.2) CVS repositories
|
||||
xml-commons
|
||||
|
||||
(3.3) Bugzilla
|
||||
program: Commons
|
||||
components: External Standards, Common XML Utils
|
||||
|
||||
|
||||
xml-subproject-proposal-commons-v1.1-committers
|
||||
A sub-issue that I'd like people to vote on separately for whichever of the
|
||||
below option(s) they like best.
|
||||
(4) Identify the initial set of committers
|
||||
|
||||
(4.a) [vote-multiple] kellyc, curcuru, rubys
|
||||
(4.b) [vote-multiple] one committer from each xml.apache.org subproject
|
||||
that wants to volunteer, plus at least one PMC member (for projects that
|
||||
don't get someone volunteered)
|
||||
(4.c) [vote-multiple] all current xml.apache.org committers
|
||||
|
||||
/xml-subproject-proposal-commons-v1.1-committers
|
||||
|
||||
/xml-subproject-proposal-commons-v1.1
|
||||
|
||||
|
||||
(*) Important cross-reference:
|
||||
http://jakarta.apache.org/commons/index.html
|
||||
Jakarta is currently working on a similar, yet different, tool/util/common
|
||||
code area. While we can steal a lot of their ideas, I think the needs of
|
||||
xml.apache.org will be different than Jakarta, so we should make our own
|
||||
community decision on how to do this. Many thanks to the nice format for a
|
||||
proposal that I plagarized. 8-)
|
||||
|
||||
- Shane shane_curcuru@lotus.com curcuru@apache.org
|
||||
]]></source>
|
||||
</section>
|
||||
|
||||
<anchor id="proposal-votes"/>
|
||||
<section>
|
||||
<title>xml-subproject-proposal-commons-v1.1-vote-count-26-Apr-01</title>
|
||||
<p>Below follows the votes cast to create this subproject</p>
|
||||
<p>---- From open general@xml.apache.org mailing list through 3pm 26-Apr-01 ----
|
||||
</p>
|
||||
<p>Original proposal at:
|
||||
<link href="http://marc.theaimsgroup.com/?l=xml-apache-general&m=987524447023862">http://marc.theaimsgroup.com/?l=xml-apache-general&m=987524447023862</link>
|
||||
</p>
|
||||
<p>
|
||||
---- 17 Total committer +1 votes, plus 13 +1's for 4.c (allow all xml
|
||||
committers) ----
|
||||
</p>
|
||||
<ul>
|
||||
<li>+1 4.c Shane Curcuru curcuru@apache.org (my implicit vote with the proposal)</li>
|
||||
<li>+1 and 4c Kelly Campbell camk@channelpoint.com</li>
|
||||
<li>+1 4.c Arnaud Le Hors lehors@us.ibm.com</li>
|
||||
<li>+1, and 4c Tinny Ng tng-xml@ca.ibm.com</li>
|
||||
<li>+1, and 4c "Ted Leung" twleung@sauria.com</li>
|
||||
<li>+1 (4.c) Elena Litani elena@apache.org</li>
|
||||
<li>+1, 4.c Vincent Hardy vhardy@eng.sun.com</li>
|
||||
<li>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
|
||||
</li>
|
||||
<li>+1 and 4c. Andy Clark andyc@apache.org</li>
|
||||
<li>+1 4.c "Jeffrey Rodriguez" jeffreyr_97@hotmail.com</li>
|
||||
<li>+1, I vote for the least restrictive option, 4.c. Edwin.Goei@sun.com</li>
|
||||
<li>+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</li>
|
||||
<li>+1 for 4c Donald_Leslie@lotus.com</li>
|
||||
<li>+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)</li>
|
||||
<li>+1, 4.c Thierry Kormann tkormann@sophia.inria.fr</li>
|
||||
<li>+1 from me. Davanum Srinivas dims@yahoo.com</li>
|
||||
<li>+1 Scott_Boag@lotus.com</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li>---- Other comments and non-committer votes ----</li>
|
||||
<li>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
|
||||
</li>
|
||||
<li>"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
|
||||
</li>
|
||||
</ul>
|
||||
<p>/xml-subproject-proposal-commons-v1.1-vote-count-26-Apr-01</p>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
81
src/documentation/content/xdocs/howto-forrest.xml
Normal file
81
src/documentation/content/xdocs/howto-forrest.xml
Normal file
@ -0,0 +1,81 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
|
||||
<document>
|
||||
<header>
|
||||
<title>How to produce xml-commons website with Forrest</title>
|
||||
<authors>
|
||||
<person name="David Crossley" email="crossley@apache.org"/>
|
||||
</authors>
|
||||
</header>
|
||||
<body>
|
||||
<section>
|
||||
<title>Overview</title>
|
||||
<p>
|
||||
This is the procedure that i followed to build the initial xml-commons
|
||||
website with Forrest.
|
||||
</p>
|
||||
<note>
|
||||
This is just to get us started. Later Forrest will automatically build it.
|
||||
</note>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Install Forrest on localhost</title>
|
||||
<p>
|
||||
Followed the document:
|
||||
<link href="http://xml.apache.org/forrest/your-project.html">Using
|
||||
Forrest</link>
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Seed the new website</title>
|
||||
<p>
|
||||
This only needed to be done to start and it is done now and committed
|
||||
to CVS.
|
||||
</p>
|
||||
<source><![CDATA[
|
||||
cd /usr/local/cvs/xml-commons
|
||||
forrest seed
|
||||
vi src/documentation/skinconf.xml
|
||||
]]></source>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Edit the content</title>
|
||||
<source><![CDATA[
|
||||
vi src/documentation/content/xdocs/*.xml
|
||||
(DC already copied content from README.html)
|
||||
vi src/documentation/content/xdocs/licenses.xml
|
||||
(DC already copied content from README.txt and LICENSE.txt)
|
||||
]]></source>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Build it and view it</title>
|
||||
<source><![CDATA[
|
||||
cd /usr/local/cvs/xml-commons
|
||||
forrest
|
||||
mozilla file:///usr/local/cvs/xml-commons/build/site/index.html
|
||||
]]></source>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Still to do</title>
|
||||
<ul>
|
||||
<li>Ensure okay by the xml-commons team.
|
||||
See temporary demo at
|
||||
<link href="http://cvs.apache.org/~crossley/commons/">http://cvs.apache.org/~crossley/commons/</link>
|
||||
</li>
|
||||
<li>Synchronise changes with any to README.html until we are in production</li>
|
||||
<li>Commit src/documentation/* to xml-commons CVS</li>
|
||||
<li>Commit the HTML/PDF result to xml-site/targets CVS</li>
|
||||
<li>Add link to xml.apache.org/index.html</li>
|
||||
<li>Later get Forrest to automatically build our website by extracting sources
|
||||
from CVS. This will later be done as a batch process, along with other Apache
|
||||
websites. For the time being, an xml-commons committer needs to manually do it.
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
288
src/documentation/content/xdocs/index.xml
Normal file
288
src/documentation/content/xdocs/index.xml
Normal file
@ -0,0 +1,288 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
|
||||
<document>
|
||||
<header>
|
||||
<title>Welcome to xml-commons</title>
|
||||
<authors>
|
||||
<person name="Shane Curcuru" email="curcuru@apache.org"/>
|
||||
</authors>
|
||||
</header>
|
||||
<body>
|
||||
<anchor id="overview"/>
|
||||
<section>
|
||||
<title>Overview</title>
|
||||
<p>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.</p>
|
||||
<p>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.</p>
|
||||
</section>
|
||||
|
||||
<anchor id="guidelines"/>
|
||||
<section>
|
||||
<title>Commons Guidelines</title>
|
||||
<p>As the community forms, we need to formalize these guidelines, especially
|
||||
to differentiate "requirements" from suggested "guidelines".</p>
|
||||
<p>Shane's starting proposals:</p>
|
||||
<p>xml-commons is an unusual project in several ways.</p>
|
||||
<p>First, it encompasses two kinds of code: External and Apache.</p>
|
||||
<p>Secondly,
|
||||
xml-commons mainly focuses on providing code and services to other
|
||||
xml.apache.org projects instead of shipping it's own 'standalone' project.
|
||||
</p>
|
||||
<p>Third, it will also tend to be more focussed on smaller, interoperable modules of
|
||||
code and a very high degree of stability.</p>
|
||||
<p>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.</p>
|
||||
<p><strong>External code:</strong> 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. <link href="#external">Read more</link>.</p>
|
||||
<p><strong>Apache code:</strong> 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. <link href="#java">Read more</link>.</p>
|
||||
<p>Directory tree (proposed)</p>
|
||||
|
||||
<fixme author="crossley">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.
|
||||
</fixme>
|
||||
|
||||
<source><![CDATA[
|
||||
xml-commons/
|
||||
README.html - this file
|
||||
build.xml - overall build file for top-level items
|
||||
xdocs/ - top-level xml format docs about this project itself and our guidelines
|
||||
(in whatever format xml.apache.org uses for site)
|
||||
|
||||
docs/ - (not checked in) html format docs created by 'build docs' from xdocs
|
||||
java/ - root of all java-related files
|
||||
|
||||
external/ - src root of all source files in java that come from external sources
|
||||
for example: the DOM, SAX, and JAXP files
|
||||
org/xml/sax/*
|
||||
org/w3c/dom/*
|
||||
javax/xml/*
|
||||
external/build.xml - Ant build file for all external sources
|
||||
|
||||
xdocs/ - xml format docs describing any java files, as needed
|
||||
|
||||
{name}.xml - Ant build file for Apache-defined subproject(s)
|
||||
future: resolver.xml: for Norm Walsh's entity resolver submission, when done
|
||||
|
||||
src/ - root of Apache-defined Java code
|
||||
src/org/apache/... etc
|
||||
|
||||
which.xml - Ant build file for org.apache.env.Which utility
|
||||
|
||||
|
||||
c/ - root of all C/C++ related files
|
||||
external/ - root of all externally-owned C/C++ sources
|
||||
|
||||
perl/ - root of all Perl related files
|
||||
etc.
|
||||
]]></source>
|
||||
<ul>
|
||||
<li>We should consider adopting those guidelines from the <link href="http://jakarta.apache.org/commons/">jakarta-commons</link>
|
||||
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.</li>
|
||||
<li>Dicsussion and buy-in should happen on the project mailing list
|
||||
<strong>before</strong> checking in new modules.</li>
|
||||
<li>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.</li>
|
||||
<li>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.</li>
|
||||
<li>Other shared xml.apache.org guidelines? Like documentation format, testing techniques/policies, etc.</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<anchor id="external"/>
|
||||
<section>
|
||||
<title>External code: DOM, SAX, and JAXP, etc.</title>
|
||||
<p>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.</p>
|
||||
<p>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.</p>
|
||||
<ul>
|
||||
<li>Current (Feb-02) status:</li>
|
||||
<li>No significant changes from Jan-02</li>
|
||||
<li>Current (Jan-02) status:</li>
|
||||
<li>DOM L2 - full set of interfaces (including HTML stuff) from w3c.org</li>
|
||||
<li>SAX 2.0 from megginson.com, plus minor bugfixes. Note that SAX
|
||||
is currently maintained at
|
||||
<link href="http://sax.sourceforge.net/">http://sax.sourceforge.net/</link>
|
||||
( we need to update and cross-check with them soon!)</li>
|
||||
<li>JAXP 1.1.3-HEAD from Sun, with current bugfixes by edwingo@apache.org</li>
|
||||
</ul>
|
||||
<p>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.</p>
|
||||
</section>
|
||||
|
||||
<anchor id="java"/>
|
||||
<section>
|
||||
<title>Apache-authored code</title>
|
||||
<p>xml-commons' secondary goal is to provide a project space for small
|
||||
XML-related utilities that are being used in <strong>multiple</strong> 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
|
||||
<link href="http://jakarta.apache.org/commons/">jakarta-commons</link> project).
|
||||
In particular, code submitted here should probably have minimal dependencies:
|
||||
possibly only depending on DOM/SAX/JAXP and Ant (for builds).</p>
|
||||
<ul>
|
||||
<li>Current (Nov-02) status:</li>
|
||||
<li>org.apache.xml.resolver.Resolver: Norm Walsh's entity resolver utility now released
|
||||
as a separate distribution, see <link href="#releases">Releases</link>.</li>
|
||||
<li>Current (Feb-02) status:</li>
|
||||
<li>org.apache.env.Which - a simple environment check utility for
|
||||
xml-related items in your JVM's environment: see xml-commons/java/which.xml</li><li>org.apache.xml.resolver.Resolver: Norm Walsh's entity resolver utility now checked in!</li>
|
||||
<li>(to be voted in) Jeff Turner's DOCTYPE changer</li>
|
||||
<li>Current (Jan-02) status:</li>
|
||||
<li>org.apache.env.Which - a simple environment check utility for
|
||||
xml-related items in your JVM's environment: see xml-commons/java/which.xml</li><li>(to be submitted) Norm Walsh's entity resolver utility</li>
|
||||
<li>(to be voted in) Jeff Turner's DOCTYPE changer</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<anchor id="releases"/>
|
||||
<section>
|
||||
<title>Where can I download releases?</title>
|
||||
<p>The xml-commons-resolver-1.0 release 12-Nov-02 is available in our
|
||||
<link href="http://xml.apache.org/dist/commons/">distribution directory</link>
|
||||
and includes:
|
||||
</p>
|
||||
<ul>
|
||||
<li>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). </li>
|
||||
</ul>
|
||||
|
||||
<p>The xml-commons-1.0.b2 release 06-Feb-02 is available in our
|
||||
<link href="http://xml.apache.org/dist/commons/">distribution directory</link>
|
||||
and includes:
|
||||
</p>
|
||||
<ul>
|
||||
<li>The previous contents from the 1.0.b1 release (minor javadoc fixes may have been made)</li>
|
||||
<li>Various LICENSE.* and README.* files for our external sources</li>
|
||||
<li>New code! org.apache.xml.resolver.Resolver: Norm Walsh's entity resolver utility
|
||||
is now checked in and building!</li>
|
||||
</ul>
|
||||
|
||||
<p>The xml-commons-1.0.b1 release 11-Jan-02 is available in our
|
||||
<link href="http://xml.apache.org/dist/commons/">distribution directory</link>
|
||||
and includes the following code:
|
||||
</p>
|
||||
<ul>
|
||||
<li>java/build/which.jar containing:</li>
|
||||
<li>org.apache.env.Which - a simple environment check utility for
|
||||
xml-related items in your JVM's environment: 1.0 funtionality working</li>
|
||||
<li>java/external/build/xml-apis.jar containing:</li>
|
||||
<li>DOM Level 2 including all base files and HTML and CSS DOMs; from
|
||||
<link href="http://www.w3.org/DOM/">w3c.org</link></li>
|
||||
<li>JAXP code roughly equivalent to JAXP 1.1.3; for reference releases
|
||||
from Sun, see
|
||||
<link href="http://java.sun.com/xml/">java.sun.com/xml</link></li>
|
||||
<li>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
|
||||
<link href="http://sax.sourceforge.net/">sax.sourceforge.net</link></li>
|
||||
</ul>
|
||||
|
||||
<p>Future 'b' or beta releases leading up to a gold 1.0 release will
|
||||
be discussed on our <link href="#mailing">mailing list</link>. Likely releases
|
||||
might address points such as:
|
||||
</p>
|
||||
<ul>
|
||||
<li>Improvements or submissions to org.apache.env.Which</li>
|
||||
<li>A new submission of an entity resolver from Norman Walsh</li>
|
||||
<li>A specific version of backlevel JAXP 1.1 that will work with
|
||||
Sun's J2EE CTS conformance tests, if enough people request it</li>
|
||||
<li>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</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<anchor id="mailing"/>
|
||||
<section>
|
||||
<title>How can I find out more?</title>
|
||||
<p>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
|
||||
</p>
|
||||
<ul>
|
||||
<li>Send an email to commons-dev
|
||||
... commons-dev<at>xml.apache.org</li>
|
||||
<li>Subscribe to commons-dev
|
||||
... commons-dev-subscribe<at>xml.apache.org</li>
|
||||
<li>Un-subscribe from commons-dev
|
||||
... commons-dev-unsubscribe<at>xml.apache.org</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<anchor id="cvs"/>
|
||||
<section>
|
||||
<title>Where can I get the code/CVS?</title>
|
||||
<p>The xml-commons repository is available thru normal and anonymous CVS, or
|
||||
through this
|
||||
<link href="http://cvs.apache.org/viewcvs.cgi/xml-commons/">nifty web
|
||||
interface</link>.</p>
|
||||
<p>See
|
||||
<link href="http://xml.apache.org/cvs.html">xml.apache.org CVS overview</link>.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<anchor id="history"/>
|
||||
<section>
|
||||
<title>History</title>
|
||||
<p>See the separate document <link href="history.html">History of XML Commons</link>
|
||||
for the proposal to establish the xml-commons project and for the record of the
|
||||
vote on 2001-04-26.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<anchor id="licenses"/>
|
||||
<section>
|
||||
<title>Licenses</title>
|
||||
<p>
|
||||
See <link href="licenses.html">information about licensing</link>.
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<anchor id="info-about"/>
|
||||
<section>
|
||||
<title>Information about this document</title>
|
||||
<ul>
|
||||
<li>Version: $Id$</li>
|
||||
<li>This document is stored in the xml-commons CVS repository as:
|
||||
<code>/home/cvs/xml-commons/src/documentation/content/xdocs/index.xml</code>
|
||||
</li>
|
||||
<li>
|
||||
The HTML and PDF renditions are generated by
|
||||
<link href="http://xml.apache.org/forrest/">Apache Forrest</link>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
108
src/documentation/content/xdocs/licenses.xml
Normal file
108
src/documentation/content/xdocs/licenses.xml
Normal file
@ -0,0 +1,108 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
|
||||
<document>
|
||||
<header>
|
||||
<title>Licenses for xml-commons</title>
|
||||
<authors>
|
||||
<person name="Shane Curcuru" email="curcuru@apache.org"/>
|
||||
</authors>
|
||||
</header>
|
||||
<body>
|
||||
<section>
|
||||
<title>HEAR YE, HEAR YE!</title>
|
||||
<p>
|
||||
Software and documentation in this repository are covered under
|
||||
a number of different licenses.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Most files under xml-commons/java/external/ are covered
|
||||
under their respective LICENSE.*.txt files; see the matching
|
||||
README.*.txt files for descriptions.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Note that xml-commons/java/external/build.xml and
|
||||
xml-commons/java/external/src/manifest.commons are
|
||||
both covered under the Apache Software License.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
All files not otherwise noted are covered under the
|
||||
Apache Software License in LICENSE.txt including all
|
||||
files under xml-commons/java/src
|
||||
</p>
|
||||
</section>
|
||||
|
||||
<anchor id="license"/>
|
||||
<section>
|
||||
<title>General License</title>
|
||||
<source><![CDATA[
|
||||
xml-commons/LICENSE.txt
|
||||
See README.txt for additional licensing information.
|
||||
|
||||
/* ====================================================================
|
||||
* The Apache Software License, Version 1.1
|
||||
*
|
||||
* Copyright (c) 2001-2002 The Apache Software Foundation. All rights
|
||||
* reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in
|
||||
* the documentation and/or other materials provided with the
|
||||
* distribution.
|
||||
*
|
||||
* 3. The end-user documentation included with the redistribution,
|
||||
* if any, must include the following acknowledgment:
|
||||
* "This product includes software developed by the
|
||||
* Apache Software Foundation (http://www.apache.org/)."
|
||||
* Alternately, this acknowledgment may appear in the software itself,
|
||||
* if and wherever such third-party acknowledgments normally appear.
|
||||
*
|
||||
* 4. The names "Apache" and "Apache Software Foundation" must
|
||||
* not be used to endorse or promote products derived from this
|
||||
* software without prior written permission. For written
|
||||
* permission, please contact apache@apache.org.
|
||||
*
|
||||
* 5. Products derived from this software may not be called "Apache",
|
||||
* nor may "Apache" appear in their name, without prior written
|
||||
* permission of the Apache Software Foundation.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
|
||||
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
|
||||
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
||||
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
||||
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
* SUCH DAMAGE.
|
||||
* ====================================================================
|
||||
*
|
||||
* This software consists of voluntary contributions made by many
|
||||
* individuals on behalf of the Apache Software Foundation. For more
|
||||
* information on the Apache Software Foundation, please see
|
||||
* <http://www.apache.org/>.
|
||||
*/
|
||||
]]></source>
|
||||
</section>
|
||||
|
||||
<anchor id="info-about"/>
|
||||
<section>
|
||||
<title>Information about this document</title>
|
||||
<ul>
|
||||
<li>Version: $Id$</li>
|
||||
</ul>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
12
src/documentation/content/xdocs/tabs.xml
Normal file
12
src/documentation/content/xdocs/tabs.xml
Normal file
@ -0,0 +1,12 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE tabs PUBLIC "-//APACHE//DTD Cocoon Documentation Tab V1.0//EN" "tab-cocoon-v10.dtd">
|
||||
|
||||
<tabs software="xml-commons"
|
||||
title="Apache xml-commons"
|
||||
copyright="@year@ The Apache Foundation"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
|
||||
<tab label="Home" dir=""/>
|
||||
<tab label="Components" dir="components/"/>
|
||||
|
||||
</tabs>
|
||||
BIN
src/documentation/resources/images/group-logo.gif
Normal file
BIN
src/documentation/resources/images/group-logo.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.8 KiB |
BIN
src/documentation/resources/images/icon.png
Normal file
BIN
src/documentation/resources/images/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 696 B |
BIN
src/documentation/resources/images/project-logo.png
Normal file
BIN
src/documentation/resources/images/project-logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
90
src/documentation/skinconf.xml
Normal file
90
src/documentation/skinconf.xml
Normal file
@ -0,0 +1,90 @@
|
||||
<?xml version="1.0"?>
|
||||
|
||||
<!--
|
||||
Skin configuration file. This file contains details of your project, which will
|
||||
be used to configure the chosen Forrest skin.
|
||||
-->
|
||||
|
||||
<!DOCTYPE skinconfig [
|
||||
|
||||
<!ENTITY % links.att 'name CDATA #REQUIRED'>
|
||||
<!ENTITY % link.att 'name CDATA #REQUIRED href CDATA #REQUIRED'>
|
||||
<!ELEMENT skinconfig (disable-search?, searchsite-domain?, searchsite-name?, project-name, project-url, project-logo, group-name?, group-url?, group-logo?, host-url?, host-logo?, year?, vendor?, trail?, credits?)*>
|
||||
<!ELEMENT credits (credit*)>
|
||||
<!ELEMENT credit (name, url, image, width?, height?)>
|
||||
<!ELEMENT disable-search (#PCDATA)>
|
||||
<!ELEMENT searchsite-domain (#PCDATA)>
|
||||
<!ELEMENT searchsite-name (#PCDATA)>
|
||||
<!ELEMENT project-name (#PCDATA)>
|
||||
<!ELEMENT project-url (#PCDATA)>
|
||||
<!ELEMENT project-logo (#PCDATA)>
|
||||
<!ELEMENT group-name (#PCDATA)>
|
||||
<!ELEMENT group-url (#PCDATA)>
|
||||
<!ELEMENT group-logo (#PCDATA)>
|
||||
<!ELEMENT host-url (#PCDATA)>
|
||||
<!ELEMENT host-logo (#PCDATA)>
|
||||
<!ELEMENT year (#PCDATA)>
|
||||
<!ELEMENT vendor (#PCDATA)>
|
||||
<!ELEMENT trail (link1, link2, link3)>
|
||||
<!ELEMENT link1 EMPTY>
|
||||
<!-- Seems we can't use param entity refs until this is DTDified -->
|
||||
<!ATTLIST link1 name CDATA #REQUIRED href CDATA #IMPLIED>
|
||||
<!ELEMENT link2 EMPTY>
|
||||
<!ATTLIST link2 name CDATA #REQUIRED href CDATA #IMPLIED>
|
||||
<!ELEMENT link3 EMPTY>
|
||||
<!ATTLIST link3 name CDATA #REQUIRED href CDATA #IMPLIED>
|
||||
<!ELEMENT name (#PCDATA)>
|
||||
<!ELEMENT url (#PCDATA)>
|
||||
<!ELEMENT image (#PCDATA)>
|
||||
<!ELEMENT width (#PCDATA)>
|
||||
<!ELEMENT height (#PCDATA)>
|
||||
]>
|
||||
|
||||
<skinconfig>
|
||||
<!-- Do we want to disable the Google search box? -->
|
||||
<disable-search>false</disable-search>
|
||||
<searchsite-domain>xml.apache.org</searchsite-domain>
|
||||
<searchsite-name>Apache XML</searchsite-name>
|
||||
|
||||
<!-- mandatory project logo
|
||||
skin: forrest-site renders it at the top -->
|
||||
<project-name>xml-commons</project-name>
|
||||
<project-url>http://xml.apache.org/xml-commons/</project-url>
|
||||
<project-logo>images/project-logo.png</project-logo>
|
||||
|
||||
<!-- optional group logo
|
||||
skin: forrest-site renders it at the top-left corner -->
|
||||
<group-name>Apache XML</group-name>
|
||||
<group-url>http://xml.apache.org/</group-url>
|
||||
<group-logo>images/group-logo.gif</group-logo>
|
||||
|
||||
<!-- optional host logo (e.g. sourceforge logo)
|
||||
skin: forrest-site renders it at the bottom-left corner -->
|
||||
<host-url></host-url>
|
||||
<host-logo></host-logo>
|
||||
|
||||
<!-- The following are used to construct a copyright statement -->
|
||||
<year>2002</year>
|
||||
<vendor>The Apache Software Foundation.</vendor>
|
||||
|
||||
<!-- Some skins use this to form a 'breadcrumb trail' of links. If you don't
|
||||
want these, set the attributes to blank. The DTD purposefully requires them.
|
||||
-->
|
||||
<trail>
|
||||
<link1 name="apache" href="http://www.apache.org/"/>
|
||||
<link2 name="xml.apache" href="http://xml.apache.org/"/>
|
||||
<link3 name="commons" href="http://xml.apache.org/commons/"/>
|
||||
</trail>
|
||||
|
||||
<!-- Credits are typically rendered as a set of small clickable images in the
|
||||
page footer -->
|
||||
<credits>
|
||||
<credit>
|
||||
<name>Built with Apache Forrest</name>
|
||||
<url>http://xml.apache.org/forrest/</url>
|
||||
<image>images/built-with-forrest-button.png</image>
|
||||
<width>88</width>
|
||||
<height>31</height>
|
||||
</credit>
|
||||
</credits>
|
||||
</skinconfig>
|
||||
69
status.xml
Normal file
69
status.xml
Normal file
@ -0,0 +1,69 @@
|
||||
<?xml version="1.0"?>
|
||||
<status>
|
||||
|
||||
<developers>
|
||||
<person name="Shane Curcuru" email="curcuru@apache.org" id="curcuru" />
|
||||
<person name="David Crossley" email="crossley@apache.org" id="crossley" />
|
||||
<person name="Volunteer needed" email="commons-dev@xml.apache.org" id="open"/>
|
||||
<!-- Add more people here -->
|
||||
</developers>
|
||||
|
||||
<todo>
|
||||
<!-- Add todo items. @context is an arbitrary string. -->
|
||||
<actions priority="high">
|
||||
<action context="docs" dev="open">
|
||||
Finish initial website. Follow procedure in
|
||||
<link href="howto-forrest.html">How-to Forrest</link>
|
||||
</action>
|
||||
<action context="docs" dev="open">
|
||||
Tweak the initial content for the top-level docs.
|
||||
</action>
|
||||
<action context="build" dev="open">
|
||||
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:
|
||||
<link href="http://marc.theaimsgroup.com/?l=xml-commons-dev&m=103736060229424">draft website for xml-commons using Forrest</link>
|
||||
</action>
|
||||
</actions>
|
||||
<actions priority="medium">
|
||||
<action context="docs" dev="open">
|
||||
Add top-level documents about each resource that is provided by
|
||||
xml-commons.
|
||||
</action>
|
||||
<action context="build" dev="open">
|
||||
Decide directory layout. See email:
|
||||
<link href="http://marc.theaimsgroup.com/?l=xml-commons-dev&m=103734209214955">Repository layout</link>
|
||||
</action>
|
||||
<action context="docs" dev="open">
|
||||
Replace the README file at
|
||||
<link href="http://xml.apache.org/commons/dist/">http://xml.apache.org/commons/dist/</link>
|
||||
</action>
|
||||
</actions>
|
||||
</todo>
|
||||
|
||||
<changes>
|
||||
<!-- Add new releases here -->
|
||||
<release version="0.2" date="2002-11-16">
|
||||
<!-- Some action types have associated images. By default, images are
|
||||
defined for 'add', 'fix', 'remove' and 'update'. If you add
|
||||
src/documentation/resources/images/<foo>.jpg images, these will
|
||||
automatically be used for entries of type <foo>. -->
|
||||
<!-- Sample action:
|
||||
<action dev="JB" type="fix" due-to="Joe Contributor"
|
||||
due-to-email="joec@apache.org">
|
||||
Fixed a bug in the Foo class.
|
||||
</action>
|
||||
-->
|
||||
<action type="add" context="docs" dev="crossley">
|
||||
Added placeholder docs and tabs for components.
|
||||
</action>
|
||||
</release>
|
||||
|
||||
<release version="0.1" date="2002-11-14">
|
||||
<action type="add" context="docs" dev="crossley">
|
||||
Built demo website using Forrest. Gleaned content from
|
||||
<code>xml-commons/README.html</code>
|
||||
</action>
|
||||
</release>
|
||||
</changes>
|
||||
</status>
|
||||
Loading…
x
Reference in New Issue
Block a user