cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject cvs commit: xml-cocoon2/src/documentation/xdocs/plan samples.xml book.xml index.xml release.xml
Date Sun, 16 Jun 2002 08:40:49 GMT
crossley    2002/06/16 01:40:49

  Modified:    .        changes.xml todo.xml
               src/documentation/xdocs/plan book.xml index.xml release.xml
  Added:       src/documentation/xdocs/plan samples.xml
  Log:
  Encourage people to help with the refactoring of Cocoon samples.
  Provide a "refactoring guidelines" document.
  
  Revision  Changes    Path
  1.190     +7 -2      xml-cocoon2/changes.xml
  
  Index: changes.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/changes.xml,v
  retrieving revision 1.189
  retrieving revision 1.190
  diff -u -r1.189 -r1.190
  --- changes.xml	16 Jun 2002 07:27:02 -0000	1.189
  +++ changes.xml	16 Jun 2002 08:40:49 -0000	1.190
  @@ -38,11 +38,16 @@
    </devs>
   
    <release version="@version@" date="@date@">
  +  <action dev="DC" type="add">
  +   Encourage people to help with the refactoring of Cocoon samples.
  +   Provide a 
  +   <link href="plan/samples.html">refactoring guidelines</link> document.
  +  </action>
     <action dev="DC" type="update">
      Moved the old sample for Catalog Entity Resolver in to the new
      webapp/samples structure. Added new sample for Simplified DocBook DTDs
      configuration. Added section for other miscellaneous samples.
  -  </action>  
  +  </action>
     <action dev="NKB" type="update">
       Moved linkstatus sample and LinkStatusGenerator to core from scratchpad;
       added a link to test the documentation links on the Cocoon demo webapp frontpage.
  
  
  
  1.36      +3 -2      xml-cocoon2/todo.xml
  
  Index: todo.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/todo.xml,v
  retrieving revision 1.35
  retrieving revision 1.36
  diff -u -r1.35 -r1.36
  --- todo.xml	29 May 2002 09:12:04 -0000	1.35
  +++ todo.xml	16 Jun 2002 08:40:49 -0000	1.36
  @@ -96,7 +96,8 @@
     </action>  
     
     <action context="code" assigned-to="NKB">
  -   Make all the samples in WIP (Work In Progress) work again, and finish refactoring.
  +   Make all the samples work again, and 
  +   <link href="plan/samples.html">finish refactoring</link>.
     </action>
       
    </actions>
  
  
  
  1.6       +1 -0      xml-cocoon2/src/documentation/xdocs/plan/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/book.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- book.xml	24 May 2002 13:14:11 -0000	1.5
  +++ book.xml	16 Jun 2002 08:40:49 -0000	1.6
  @@ -21,6 +21,7 @@
   
     <menu label="Other Planning">
       <menu-item label="Release Plan" href="release.html"/>
  +    <menu-item label="Cocoon Samples" href="samples.html"/>
       <menu-item label="Entity Catalogs" href="catalog.html"/>
     </menu>
   </book>
  
  
  
  1.6       +3 -0      xml-cocoon2/src/documentation/xdocs/plan/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/index.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- index.xml	15 Jun 2002 05:41:31 -0000	1.5
  +++ index.xml	16 Jun 2002 08:40:49 -0000	1.6
  @@ -56,6 +56,9 @@
     </ul>
   
     <ul>
  +   <li><link href="samples.html">Refactoring of Cocoon Samples</link>
  +    - there are still some old samples that are not yet moved under the
  +    new webapp/samples/ structure ... you can help</li>
      <li><link href="catalog.html">Entity Catalogs</link>
       - stuff that needs to happen the to entity resolver after the move to
       Avalon of Source resolving</li>
  
  
  
  1.5       +3 -1      xml-cocoon2/src/documentation/xdocs/plan/release.xml
  
  Index: release.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/release.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- release.xml	15 Jun 2002 05:41:31 -0000	1.4
  +++ release.xml	16 Jun 2002 08:40:49 -0000	1.5
  @@ -6,6 +6,7 @@
     <title>Release Plan</title>
     <subtitle>Planning Documentation</subtitle>
     <authors>
  +   <person name="Carsten Ziegeler" email="cziegeler@apache.org"/>
      <person name="David Crossley" email="crossley@apache.org"/>
     </authors>
    </header>
  @@ -31,7 +32,8 @@
    <link href="../installing/updating.html">Updating Cocoon</link>
   which describes the major changes since 2.0.2
   </li>
  -<li>finish example refactoring</li>
  +<li>finish the
  + <link href="samples.html">refactoring of samples</link></li>
   <li>finish to move scratchpad stuff in main trunk</li>
   <li>switch to LogEnabled</li>
   <li>extended sitemap variable substitution, i.e. {request:foo}.</li>
  
  
  
  1.1                  xml-cocoon2/src/documentation/xdocs/plan/samples.xml
  
  Index: samples.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../dtd/document-v10.dtd">
  
  <document>
   <header>
    <title>Refactoring of Cocoon Samples</title>
    <subtitle>Planning Documentation</subtitle>
    <authors>
     <person name="David Crossley" email="crossley@apache.org"/>
    </authors>
   </header>
  
   <body>
   <s1 title="Overview">
   <p>
    The Cocoon samples are now under <code>src/webapp/samples/</code> and have
    been refactored to be self contained, to have their own sitemaps, and to
    utilise some common resources.
   </p>
  
   <p>
    However, there are still some old samples that have not yet been moved into
    this new structure. They are at <code>src/webapp/docs/samples/</code> and
so
    are not available from the samples page. Please help to bring them back.
   </p>
  
   <p>
    The main page of the samples is becoming rather cluttered again. The aim
    is to have various samples pages, rather than just one big page.
   </p>
  
   <p>There are some missing groups of samples, e.g.</p>
  
  <ul>
  <li>Welcome => Samples => More Samples => Static Content</li>
  <li>Welcome => Samples => More Samples => Server Pages</li>
  <li>Welcome => Samples => More Samples => Sources</li>
  <li>Welcome => Samples => More Samples => Web Applications</li>
  </ul>
   </s1>
  
   <s1 title="Procedure">
  
  <ul>
  <li>Choose your favourite missing sample.</li>
  <li>Create a new directory under <code>webapp/samples</code></li>
  <li>Follow the example of some other samples,
  e.g. <code>poi/</code> or <code>i18n/</code> or <code>misc/</code></li>
  <li><code>cp samples/misc/sitemap.xmap samples/yours/sitemap.xmap</code>
  and edit it to suit your own matches.
  </li>
  <li><code>cp samples/misc/samples.xml samples/yours/samples.xml</code>
  and edit it to become the front page to your collection of samples.</li>
  <li>Move the documents from the old sample at <code>webapp/docs/samples</code></li>
  <li>Make links to your new samples from other pages.</li>
  <li>Remove the old sample from <code>webapp/docs/samples</code></li>
  <li>Send a <link href="../howto/index.html">patch via Bugzilla</link></li>
  </ul>
   </s1>
  
   <s1 title="Other discussion">
   <p>
    There has been some discussion on cocoon-dev ...
   </p>
  
   <ul>
    <li><link href="http://marc.theaimsgroup.com/?l=xml-cocoon-dev&amp;m=102259446212331">Samples
Refactoring: Documentation Structure</link></li>
   </ul>
   </s1>
  
   </body>
  </document>
  
  
  

----------------------------------------------------------------------
In case of troubles, e-mail:     webmaster@xml.apache.org
To unsubscribe, e-mail:          cocoon-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: cocoon-cvs-help@xml.apache.org


Mime
View raw message