forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From je...@apache.org
Subject cvs commit: xml-forrest/src/documentation/content/xdocs primer.xml
Date Tue, 12 Nov 2002 12:47:39 GMT
jefft       2002/11/12 04:47:39

  Modified:    src/documentation/content/xdocs primer.xml
  Log:
  Reindent.  Sorry.. if I don't my editor does a half job on the fly.
  
  Revision  Changes    Path
  1.17      +140 -140  xml-forrest/src/documentation/content/xdocs/primer.xml
  
  Index: primer.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/primer.xml,v
  retrieving revision 1.16
  retrieving revision 1.17
  diff -u -r1.16 -r1.17
  --- primer.xml	12 Nov 2002 12:36:58 -0000	1.16
  +++ primer.xml	12 Nov 2002 12:47:39 -0000	1.17
  @@ -4,12 +4,12 @@
     <header> 
       <title>The Forrest Primer</title> 
       <subtitle>Don't panic!</subtitle><authors><person
  -      name="Steven Noels" email="stevenn@apache.org"/></authors> 
  +        name="Steven Noels" email="stevenn@apache.org"/></authors> 
       <abstract>Forrest is a so-called
         <link
  -      href="http://www.dictionary.com/cgi-bin/dict.pl?term=fledgling">fledgling</link>
  +        href="http://www.dictionary.com/cgi-bin/dict.pl?term=fledgling">fledgling</link>
         project that will have a broad impact on <link
  -      href="http://xml.apache.org/">xml.apache.org</link> projects. This document
  +        href="http://xml.apache.org/">xml.apache.org</link> projects. This document
         helps you to better understand the vision and scope of Forrest, so that you
         learn what to expect (or not) from it, and eventually will help you discovering
         places where your contribution could be valuable to all of us.</abstract> 
  @@ -20,31 +20,31 @@
         restructured and edited to provide an accessible entry point for new
         Forresteers. Please send all comments, patches and suggestions to
         <link href="mailto:forrest-dev@xml.apache.org">the Forrest
  -      developers</link>.</note> 
  +        developers</link>.</note> 
       <section>
         <title>History</title> 
         <p>Forrest has come into existence because of the abysmal state of the
           <link href="http://xml.apache.org/">xml.apache.org</link> website in
comparison
  -      with other open source community sites such as Sourceforge. The old site had no
  -      consistent visual look and feel, which was largely due to each and every
  -      sub-project managing its own site. Furthermore, much information which could
  -      potentially support community-based open source development was hidden inside
  -      CVS repositories, mailing lists or word of mouth. Once we experienced the
  -      usefullness of cross-project collaboration supported by the Jakarta
  -      <link href="http://jakarta.apache.org/gump">Gump</link> project, we reckoned
  -      having a single application responsible for the management of the
  -      xml.apache.org site could be of benefit to our visitors. And if we added
  -      aggregated access to other available resources such as download stats or
  -      mailing list archives, the new xml.apache.org website could be a true
  -      information clearinghouse for interested parties, both users and contributors
  -      alike.</p> 
  +        with other open source community sites such as Sourceforge. The old site had no
  +        consistent visual look and feel, which was largely due to each and every
  +        sub-project managing its own site. Furthermore, much information which could
  +        potentially support community-based open source development was hidden inside
  +        CVS repositories, mailing lists or word of mouth. Once we experienced the
  +        usefullness of cross-project collaboration supported by the Jakarta
  +        <link href="http://jakarta.apache.org/gump">Gump</link> project, we
reckoned
  +        having a single application responsible for the management of the
  +        xml.apache.org site could be of benefit to our visitors. And if we added
  +        aggregated access to other available resources such as download stats or
  +        mailing list archives, the new xml.apache.org website could be a true
  +        information clearinghouse for interested parties, both users and contributors
  +        alike.</p> 
         <p>The Forrest vision was articulated by Stefano Mazzocchi and Sam Ruby,
           both long-time contributors to Apache projects, in the beginning of 2002, and
           was rapidly picked up by a bunch of other <link
  -      href="who.html">contributors</link> as well, after a headstart by Nicola
Ken
  -      Barozzi. So here we are, plenty of work-in-progress to erect what eventually
  -      will become a true community website infrastructure for Apache open source
  -      development.</p> 
  +          href="who.html">contributors</link> as well, after a headstart by Nicola
Ken
  +        Barozzi. So here we are, plenty of work-in-progress to erect what eventually
  +        will become a true community website infrastructure for Apache open source
  +        development.</p> 
       </section> 
       <section>
         <title>What is Forrest</title>
  @@ -62,20 +62,20 @@
           format.</p> 
         <p>Forrest is currently based on an
           <link href="http://jakarta.apache.org/ant/">Ant</link>-based project
build
  -      system called <link href="http://www.krysalis.org/centipede/">Centipede</link>
  -      that drives a <link href="http://xml.apache.org/cocoon/">Cocoon</link>-based
  -      document publication system. It contains a set of standard XML document type
  -      declarations (DTDs) for project documentation, and different 'skins' consisting
  -      of XSLT stylesheets that produce HTML renditions of XML documents using these
  -      DTDs.</p> 
  +        system called <link href="http://www.krysalis.org/centipede/">Centipede</link>
  +        that drives a <link href="http://xml.apache.org/cocoon/">Cocoon</link>-based
  +        document publication system. It contains a set of standard XML document type
  +        declarations (DTDs) for project documentation, and different 'skins' consisting
  +        of XSLT stylesheets that produce HTML renditions of XML documents using these
  +        DTDs.</p> 
         <p>The primary mode of operations for Forrest will be as follows:</p>

         <note>This process is not quite ready for prime time yet, but it gives
           you an idea where we are heading to. Website generation with skins currently
           works, try using the <code>docs</code> target when invoking the
           <code>build</code> script. Add a <code>use.skin</code>
property when invoking
           the build script to experience Forrest skins: <code>build{.bat|.sh}
  -        -Duse.skin=&lt;thenameoftheskintouse&gt; docs</code>. Read our <link
  -        href="#cvs">CVS crash course</link> to get hold of the current codebase
and
  +          -Duse.skin=&lt;thenameoftheskintouse&gt; docs</code>. Read our
<link
  +          href="#cvs">CVS crash course</link> to get hold of the current codebase
and
           start playing with it.</note> 
         <ol> 
           <li>Forrest will harvest documentation and related source files from
  @@ -117,7 +117,7 @@
             the Forrest CVS repository and become an Apache committer. The first stage
             towards becoming a contributor is to join the forrest dev
             <link href="mail-lists.html">mailing list</link>, the second is to
download
  -      Forrest and start playing with it (see below).</li> 
  +          Forrest and start playing with it (see below).</li> 
         </ul> 
         <p>Depending on your role, your potential area of interest in Forrest
           will vary:</p> 
  @@ -163,27 +163,27 @@
           <ol> 
             <li>Download a recent release of WinCVS (homepage is
               <link href="http://www.wincvs.org/">http://www.wincvs.org/</link>);
</li> 
  -        <li>Install it;</li> 
  -        <li>Start it;</li> 
  -        <li>Click on Admin-&gt;Preferences;</li> 
  -        <li> In "Enter the CVSROOT:" enter
  -          "<code>:pserver:anoncvs@cvs.apache.org:/home/cvspublic</code>" (without
  -          quotes);</li> 
  -        <li>In "Authentication:" choose "passwd file on the cvs server";</li>

  -        <li>Click "Ok";</li> 
  -        <li>Click Admin-&gt;Login;</li> 
  -        <li> When asked for the password: answer "<code>anoncvs</code>"
  -          (without quotes);</li> 
  -        <li> Click "Create-&gt;Checkout module";</li> 
  -        <li>Module name and path on the server is "<code>xml-forrest</code>"
  -          (no quotes);</li> 
  -        <li>Choose a dir to put the source code in;</li> 
  -        <li>Click "Ok";</li> 
  -        <li>If everything goes well, messages will start to appear in the log
  -          window;</li> 
  -        <li>Wait until you see "<code>*****CVS exited normally with code
  -          0*****</code>" in the log window;</li> 
  -        <li>The Forrest source is now on your harddrive.</li> 
  +          <li>Install it;</li> 
  +          <li>Start it;</li> 
  +          <li>Click on Admin-&gt;Preferences;</li> 
  +          <li> In "Enter the CVSROOT:" enter
  +            "<code>:pserver:anoncvs@cvs.apache.org:/home/cvspublic</code>"
(without
  +            quotes);</li> 
  +          <li>In "Authentication:" choose "passwd file on the cvs server";</li>

  +          <li>Click "Ok";</li> 
  +          <li>Click Admin-&gt;Login;</li> 
  +          <li> When asked for the password: answer "<code>anoncvs</code>"
  +            (without quotes);</li> 
  +          <li> Click "Create-&gt;Checkout module";</li> 
  +          <li>Module name and path on the server is "<code>xml-forrest</code>"
  +            (no quotes);</li> 
  +          <li>Choose a dir to put the source code in;</li> 
  +          <li>Click "Ok";</li> 
  +          <li>If everything goes well, messages will start to appear in the log
  +            window;</li> 
  +          <li>Wait until you see "<code>*****CVS exited normally with code
  +              0*****</code>" in the log window;</li> 
  +          <li>The Forrest source is now on your harddrive.</li> 
           </ol> 
         </section> 
         <section>
  @@ -193,11 +193,11 @@
               system.</li> 
             <li>Start the shell of your choice.</li> 
             <li>Enter "<code>cvs -d
  -            :pserver:anoncvs@cvs.apache.org:/home/cvspublic login</code>".</li>

  +              :pserver:anoncvs@cvs.apache.org:/home/cvspublic login</code>".</li>

             <li>When asked for the password: answer "<code>anoncvs</code>".</li>

             <li>Enter "<code>cvs -d
  -            :pserver:anoncvs@cvs.apache.org:/home/cvspublic -z3 checkout
  -            xml-forrest</code>". This will create a directory called
  +              :pserver:anoncvs@cvs.apache.org:/home/cvspublic -z3 checkout
  +              xml-forrest</code>". This will create a directory called
               "<code>xml-forrest</code>" where the Forrest source will be stored.</li>

             <li>Wait until cvs has finished.</li> 
             <li>The Forrest source is now on your harddrive.</li> 
  @@ -255,7 +255,7 @@
   +---tools                           Tools used to build Forrest
       +---ant                         Ant 1.6-dev scripts and jars
   +---stylesheets                     Stylesheets used for project root XML files
  -    ]]></source> 
  +]]></source> 
         <p>The <code>xml-forrest</code> home directory consists of the
main Ant
           build script (<code>build.xml</code>) and platform-specific batch files/shell
           scripts to invoke it. Forrest comes with Ant included, so you do not need to
  @@ -285,12 +285,12 @@
           DTDs. Special care is taken to provide a set of modular, extensible and
           well-maintained DTDs for project documentation purposes. This modularity is
           ensured using the <link
  -      href="http://www.oasis-open.org/committees/entity/">OASIS catalog</link>
  -      mechanism, extensive use of external parameter entities and an entity resolver
  -      capable of resolving entities through the aforementioned catalog mechanism. For
  -      the docheads amongst us, this means we adhere to the strict use of
  -      <code>PUBLIC</code> entity identifiers both in document instances and
DTD
  -      modules.</p> 
  +          href="http://www.oasis-open.org/committees/entity/">OASIS catalog</link>
  +        mechanism, extensive use of external parameter entities and an entity resolver
  +        capable of resolving entities through the aforementioned catalog mechanism. For
  +        the docheads amongst us, this means we adhere to the strict use of
  +        <code>PUBLIC</code> entity identifiers both in document instances and
DTD
  +        modules.</p> 
         <p>We have currently identified the following document types:</p> 
         <ul> 
           <li>General documents (<code>document-v11.dtd</code>),</li>

  @@ -314,7 +314,7 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
   <document>
     ...
  -]]></source> 
  +  ]]></source> 
         <p>The exact local location of the DTD for validation purposes is
           obtained by the entity resolver evaluating the mapping scheme as defined in the
           <code>catalog</code> file. This makes sure that you can move and re-arrange
  @@ -328,7 +328,7 @@
           project's documentation. It is not within the scope of this document to explain
           the Cocoon internals, please read its own
           <link href="http://xml.apache.org/cocoon/">documentation</link> to
fully
  -      understand the power of Cocoon.</p> 
  +        understand the power of Cocoon.</p> 
         <p>Cocoon's site rendition behaviour is configured in a so-called
           <em>sitemap</em>, a switchboard that binds URLs to an XML processing
pipeline.
           This pipeline typically consists of a Generator, one or more Transformers and a
  @@ -380,20 +380,20 @@
             values of the first wildcard in the matching pattern above. These
             'sub-requests' are passed through the cocoon pipeline just like any other
             request. This results in the following flow:</li> 
  -      <ol> 
  -        <li>The first 'sub-request' (for <code>book-index.xml</code>
is matched
  -          by the <code>**book-**.xml</code> pattern. This results in the file
  -          <code>content/xdocs/book.xml</code> being read. This document is
then run
  -          through the <code>book2menu</code> stylesheet (which produces an
HTML fragment
  -          comprising the site navigation, the red area in the image above.</li> 
  -        <li>The second 'sub-request' is matched by the <code>body-**.xml</code>
  -          pattern. This results in the file <code>index.xml</code> being transformed
  -          using the <code>document2html</code> stylesheet, the yellow area
in the
  -          screenshot.</li> 
  -      </ol> 
  -      <li>The aggregation result is then transformed using the
  -        <code>site2xhtml</code> stylesheet which adds the cherries to the cake.
The
  -        grey zone.</li> 
  +        <ol> 
  +          <li>The first 'sub-request' (for <code>book-index.xml</code>
is matched
  +            by the <code>**book-**.xml</code> pattern. This results in the
file
  +            <code>content/xdocs/book.xml</code> being read. This document is
then run
  +            through the <code>book2menu</code> stylesheet (which produces an
HTML fragment
  +            comprising the site navigation, the red area in the image above.</li>

  +          <li>The second 'sub-request' is matched by the <code>body-**.xml</code>
  +            pattern. This results in the file <code>index.xml</code> being
transformed
  +            using the <code>document2html</code> stylesheet, the yellow area
in the
  +            screenshot.</li> 
  +        </ol> 
  +        <li>The aggregation result is then transformed using the
  +          <code>site2xhtml</code> stylesheet which adds the cherries to the
cake. The
  +          grey zone.</li> 
         </ol> 
         <p>These <em>skin-specific</em> stylesheets are located in
           <code>src/documentation/skins/&lt;nameoftheskin&gt;/xslt/html</code>,
so if you
  @@ -437,67 +437,67 @@
             <td>Forrest will offer access to a broad set of information resources
               using durable URIs: please review
               <link href="http://www.w3.org/Provider/Style/URI.html">Tim Berners-Lee</link>'s
  -      and <link href="http://www.useit.com/alertbox/990321.html">Jakob
  -      Nielsen</link>'s opinion on this. We need a unified URI Namespace management
  -      approach, bearing in mind mirroring and 'hackable' URIs.</td> 
  -      </tr> 
  -      <tr> 
  -        <th>Skins</th> 
  -        <td>We currently have a nice set of skins which should be solidified.
  -          Furthermore, we need some serious finetuning of the <code>forrest-site</code>
  -          skin that will become the new xml.apache.org look&amp;feel.</td> 
  -      </tr> 
  -      <tr> 
  -        <th>Aggregation<br/>and Syndication</th> 
  -        <td>We plan to aggregate on a per-project basis a number of relevant
  -          developer resources, such as project-related news, download statistics,
  -          committer bio pages (with photos!), navigable source code listings and the
  -          like. Some of these resources need to be made available across content
  -          syndication methods such as <link
  -      href="http://blogspace.com/rss/">RSS</link>.</td> 
  -      </tr> 
  -      <tr> 
  -        <th>Build Management</th> 
  -        <td>Fool-proof automation of Forrest runs and site publication using
  -          secure transfer methods and <code>cron</code> jobs.</td> 
  -      </tr> 
  -      <tr> 
  -        <th>Document Types</th> 
  -        <td>Expanding the collection of DTDs, documenting them using formal
  -          How-Tos and example documents.</td> 
  -      </tr> 
  -      <tr> 
  -        <th>xml.apache.org</th> 
  -        <td>Formation of an editorial team for the main xml.apache.org website,
  -          working in close collaboration with the
  -          <link href="http://xml.apache.org/whoweare.html">PMC</link> and the
different
  -      sub-project leads.</td> 
  -      </tr> 
  -      <tr> 
  -        <th>Integration</th> 
  -        <td> Forrest needs to coexist with existing cross-project collaboration
  -          tools such as <link href="http://jakarta.apache.org/gump/">Gump</link>,
  -      <link href="http://scarab.tigris.org/">Scarab</link> and
  -      <link href="http://eyebrowse.tigris.org/">Eyebrowse</link> and provide
  -      integrated access to them.</td> 
  -      </tr> 
  -      <tr> 
  -        <th>Authoring support</th> 
  -        <td>Supporting document authors with preconfigured XML editing
  -          solutions.</td> 
  -      </tr> 
  -      <tr> 
  -        <th>Content Management</th> 
  -        <td>Establish an efficient content management practice, supporting
  -          versioning, remote access and work flow, presumably supported by a CMS such as
  -          <link href="http://jakarta.apache.org/slide/">Slide</link>.</td>

  -      </tr> 
  -      <tr> 
  -        <th>Information Accessibility</th> 
  -        <td>We need to be accessible using a wide range of browsing devices
  -          operating on different platforms. Special care should be taken to support the
  -          <link href="http://www.w3.org/WAI/">WAI</link> guidelines.</td>

  -      </tr> 
  +            and <link href="http://www.useit.com/alertbox/990321.html">Jakob
  +              Nielsen</link>'s opinion on this. We need a unified URI Namespace management
  +            approach, bearing in mind mirroring and 'hackable' URIs.</td> 
  +        </tr> 
  +        <tr> 
  +          <th>Skins</th> 
  +          <td>We currently have a nice set of skins which should be solidified.
  +            Furthermore, we need some serious finetuning of the <code>forrest-site</code>
  +            skin that will become the new xml.apache.org look&amp;feel.</td>

  +        </tr> 
  +        <tr> 
  +          <th>Aggregation<br/>and Syndication</th> 
  +          <td>We plan to aggregate on a per-project basis a number of relevant
  +            developer resources, such as project-related news, download statistics,
  +            committer bio pages (with photos!), navigable source code listings and the
  +            like. Some of these resources need to be made available across content
  +            syndication methods such as <link
  +              href="http://blogspace.com/rss/">RSS</link>.</td> 
  +        </tr> 
  +        <tr> 
  +          <th>Build Management</th> 
  +          <td>Fool-proof automation of Forrest runs and site publication using
  +            secure transfer methods and <code>cron</code> jobs.</td>

  +        </tr> 
  +        <tr> 
  +          <th>Document Types</th> 
  +          <td>Expanding the collection of DTDs, documenting them using formal
  +            How-Tos and example documents.</td> 
  +        </tr> 
  +        <tr> 
  +          <th>xml.apache.org</th> 
  +          <td>Formation of an editorial team for the main xml.apache.org website,
  +            working in close collaboration with the
  +            <link href="http://xml.apache.org/whoweare.html">PMC</link> and
the different
  +            sub-project leads.</td> 
  +        </tr> 
  +        <tr> 
  +          <th>Integration</th> 
  +          <td> Forrest needs to coexist with existing cross-project collaboration
  +            tools such as <link href="http://jakarta.apache.org/gump/">Gump</link>,
  +            <link href="http://scarab.tigris.org/">Scarab</link> and
  +            <link href="http://eyebrowse.tigris.org/">Eyebrowse</link> and
provide
  +            integrated access to them.</td> 
  +        </tr> 
  +        <tr> 
  +          <th>Authoring support</th> 
  +          <td>Supporting document authors with preconfigured XML editing
  +            solutions.</td> 
  +        </tr> 
  +        <tr> 
  +          <th>Content Management</th> 
  +          <td>Establish an efficient content management practice, supporting
  +            versioning, remote access and work flow, presumably supported by a CMS such
as
  +            <link href="http://jakarta.apache.org/slide/">Slide</link>.</td>

  +        </tr> 
  +        <tr> 
  +          <th>Information Accessibility</th> 
  +          <td>We need to be accessible using a wide range of browsing devices
  +            operating on different platforms. Special care should be taken to support the
  +            <link href="http://www.w3.org/WAI/">WAI</link> guidelines.</td>

  +        </tr> 
         </table> 
       </section> 
       <section>
  @@ -520,8 +520,8 @@
           <li>Unix shell scripting / CVS / cron gurus, preferably bearded</li>

         </ul> 
         <p>Just drop us a line at <link
  -      href="mailto:forrest-dev@xml.apache.org">forrest-dev@xml.apache.org</link>.</p>
  -      
  +          href="mailto:forrest-dev@xml.apache.org">forrest-dev@xml.apache.org</link>.</p>
  +
       </section> 
       <p>That is all, folks.</p> 
       <table> 
  
  
  

Mime
View raw message