home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / xampp / xampp-cocoon-addon-1.4.9-installer.exe / samples.xml < prev    next >
Encoding:
Extensible Markup Language  |  2004-07-12  |  3.1 KB  |  91 lines
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3.   Copyright 1999-2004 The Apache Software Foundation
  4.  
  5.   Licensed under the Apache License, Version 2.0 (the "License");
  6.   you may not use this file except in compliance with the License.
  7.   You may obtain a copy of the License at
  8.  
  9.       http://www.apache.org/licenses/LICENSE-2.0
  10.  
  11.   Unless required by applicable law or agreed to in writing, software
  12.   distributed under the License is distributed on an "AS IS" BASIS,
  13.   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.   See the License for the specific language governing permissions and
  15.   limitations under the License.
  16. -->
  17. <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "document-v10.dtd">
  18.  
  19. <document>
  20.  <header>
  21.   <title>Refactoring of Cocoon Samples</title>
  22.   <subtitle>Planning Documentation</subtitle>
  23.   <authors>
  24.    <person name="David Crossley" email="crossley@apache.org"/>
  25.   </authors>
  26.  </header>
  27.  
  28.  <body>
  29.  <s1 title="Overview">
  30.  <p>
  31.   The Cocoon samples are now under <code>src/webapp/samples/</code> and have
  32.   been refactored to be self contained, to have their own sitemaps, and to
  33.   utilise some common resources.
  34.  </p>
  35.  
  36.  <p>
  37.   However, there are still some old samples that have not yet been moved into
  38.   this new structure. They are at <code>src/webapp/docs/samples/</code> and so
  39.   are not available from the samples page. Please help to bring them back.
  40.  </p>
  41.  
  42.  <p>
  43.   The main page of the samples is becoming rather cluttered again. The aim
  44.   is to have various samples pages, rather than just one big page.
  45.  </p>
  46.  
  47.  <p>There are some missing groups of samples, e.g.</p>
  48.  
  49. <ul>
  50. <li>Welcome => Samples => More Samples => Static Content</li>
  51. <li>Welcome => Samples => More Samples => Server Pages</li>
  52. <li>Welcome => Samples => More Samples => Sources</li>
  53. <li>Welcome => Samples => More Samples => Web Applications</li>
  54. </ul>
  55.  </s1>
  56.  
  57.  <s1 title="Procedure">
  58.  
  59. <ul>
  60. <li>Choose your favourite missing sample.</li>
  61. <li>Create a new directory under <code>webapp/samples</code></li>
  62. <li>Follow the example of some other samples,
  63. e.g. <code>poi/</code> or <code>i18n/</code> or <code>misc/</code></li>
  64. <li><code>cp samples/misc/sitemap.xmap samples/yours/sitemap.xmap</code>
  65. and edit it to suit your own matches.
  66. </li>
  67. <li><code>cp samples/misc/samples.xml samples/yours/samples.xml</code>
  68. and edit it to become the front page to your collection of samples.</li>
  69. <li>Move the documents from the old sample at <code>webapp/docs/samples</code></li>
  70. <li>Make links to your new samples from other pages.</li>
  71. <li>Remove the old sample from <code>webapp/docs/samples</code></li>
  72. <li>Ensure that the new sample works as expected.</li>
  73. <li>Send a <link href="../howto/index.html">patch via Bugzilla</link></li>
  74. </ul>
  75.  
  76. <fixme author="DC">Explain how to retain CVS history when moving the files.</fixme>
  77.  </s1>
  78.  
  79.  <s1 title="Other discussion">
  80.  <p>
  81.   There has been some discussion on cocoon-dev ...
  82.  </p>
  83.  
  84.  <ul>
  85.   <li><link href="http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=102259446212331">Samples Refactoring: Documentation Structure</link></li>
  86.  </ul>
  87.  </s1>
  88.  
  89.  </body>
  90. </document>
  91.