xml-commons-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From curc...@apache.org
Subject cvs commit: xml-commons/src/documentation/content/xdocs/components external.xml book.xml index.xml resolver.xml which.xml
Date Wed, 20 Nov 2002 01:02:55 GMT
curcuru     2002/11/19 17:02:55

  Modified:    src/documentation/content/xdocs/components book.xml
                        index.xml resolver.xml which.xml
  Added:       src/documentation/content/xdocs/components external.xml
  Log:
  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
  
  Revision  Changes    Path
  1.2       +1 -0      xml-commons/src/documentation/content/xdocs/components/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: /home/cvs/xml-commons/src/documentation/content/xdocs/components/book.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- book.xml	16 Nov 2002 12:59:48 -0000	1.1
  +++ book.xml	20 Nov 2002 01:02:55 -0000	1.2
  @@ -14,6 +14,7 @@
       <menu-item label="Overview" href="index.html"/>
       <menu-item label="Resolver" href="resolver.html"/>
       <menu-item label="Which" href="which.html"/>
  +    <menu-item label="External" href="external.html"/>
     </menu>
   
   </book>
  
  
  
  1.2       +8 -4      xml-commons/src/documentation/content/xdocs/components/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/xml-commons/src/documentation/content/xdocs/components/index.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- index.xml	16 Nov 2002 12:59:48 -0000	1.1
  +++ index.xml	20 Nov 2002 01:02:55 -0000	1.2
  @@ -4,6 +4,7 @@
     <header> 
       <title>Components of xml-commons</title> 
       <authors>
  +      <person name="Shane Curcuru" email="curcuru@apache.org"/> 
         <person name="David Crossley" email="crossley@apache.org"/> 
       </authors> 
     </header> 
  @@ -12,15 +13,18 @@
       <section>
         <title>Overview</title>
         <p>
  -        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.
         </p>
         <ul>
           <li><link href="resolver.html">Resolver</link>
  -          - ### Fixme: add concise description here.
  +          An XML Entity and URI Resolver donated by Norman Walsh.
           </li>
           <li><link href="which.html">Which</link>
  -          - ### Fixme: add concise description here.
  +          A simple environment checking utility for Apache projects by Shane Curcuru
  +        </li>
  +        <li><link href="external.html">External Interfaces (xml-apis)</link>
  +          An Apache-hosted set of externally-defined standards interfaces, namely DOM,
SAX, and JAXP.
           </li>
         </ul>
       </section>
  
  
  
  1.2       +8 -2      xml-commons/src/documentation/content/xdocs/components/resolver.xml
  
  Index: resolver.xml
  ===================================================================
  RCS file: /home/cvs/xml-commons/src/documentation/content/xdocs/components/resolver.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- resolver.xml	16 Nov 2002 12:59:48 -0000	1.1
  +++ resolver.xml	20 Nov 2002 01:02:55 -0000	1.2
  @@ -11,9 +11,15 @@
       <anchor id="overview"/>
       <section>
         <title>Overview</title>
  -      <p>
  -        ### Fixme: add overview of Resolver here.
  +      <p>See the current set of resolver docs java/docs/resolver.html
  +      See the current /java/docs/releasenotes.html.
         </p>
  +      <fixme author="curcuru">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.
  +      </fixme>
  +
       </section>
   
     </body>
  
  
  
  1.2       +8 -1      xml-commons/src/documentation/content/xdocs/components/which.xml
  
  Index: which.xml
  ===================================================================
  RCS file: /home/cvs/xml-commons/src/documentation/content/xdocs/components/which.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- which.xml	16 Nov 2002 12:59:48 -0000	1.1
  +++ which.xml	20 Nov 2002 01:02:55 -0000	1.2
  @@ -12,8 +12,15 @@
       <section>
         <title>Overview</title>
         <p>
  -        ### 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.
         </p>
  +      <p>Currently, most of the documentation about Which is in it's Javadoc, which
you can 
  +      build via <code>build docs</code>.</p>
  +      <fixme author="curcuru">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.
  +      </fixme>
       </section>
   
     </body>
  
  
  
  1.1                  xml-commons/src/documentation/content/xdocs/components/external.xml
  
  Index: external.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>
  
  
  

Mime
View raw message