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 / howto-explore-samples.xml < prev    next >
Encoding:
Extensible Markup Language  |  2004-07-12  |  7.1 KB  |  167 lines
  1. <?xml version="1.0"?>
  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>How to run and explore the Cocoon samples</title>
  22.         <authors>
  23.             <person name="Bertrand Delacrétaz" email="bdelacretaz@codeconsult.ch"/>
  24.         </authors>
  25.     </header>
  26.  
  27.     <body>
  28.  
  29.         <s1 title="Overview">
  30.             <p>
  31.                 This How-To shows you how to run and explore the Cocoon samples. It requires no
  32.                 prior knowledge of Cocoon.
  33.             </p>
  34.         </s1>
  35.  
  36.         <s1 title="Purpose">
  37.             <p>
  38.                 You will learn how install and run Cocoon in the simplest way, in order to run the Cocoon samples, and
  39.                 also how to study the samples from the inside to see how their are built.
  40.             </p>
  41.         </s1>
  42.  
  43.         <s1 title="Intended Audience">
  44.             <p>
  45.                 Beginning Cocoon users or people evaluating Cocoon for the first time.
  46.             </p>
  47.         </s1>
  48.  
  49.         <s1 title="Prerequisites">
  50.             <p>You only need a JDK (1.3 or later) installed on your computer, and an Internet connection
  51.                 to download Cocoon.</p>
  52.  
  53.         </s1>
  54.  
  55.         <s1 title="Steps">
  56.             <p>
  57.                 Here's how to proceed.
  58.             </p>
  59.  
  60.             <s2 title="1. Get Cocoon">
  61.                 <p>
  62.                     Download Cocoon from the location listed on the
  63.                     <link href="http://cocoon.apache.org">cocoon.apache.org</link>
  64.                     web site.
  65.                 </p>
  66.                 <note>
  67.                     If you want the latest bleeding edge version, you can get it from CVS, this is described on
  68.                     the site as well, but more complicated if you're not familiar with CVS.
  69.                 </note>
  70.             </s2>
  71.  
  72.             <s2 title="2. Build and start Cocoon">
  73.                 <p>
  74.                     Unpack the Cocoon distribution and follow the instructions found in the
  75.                     <em>INSTALL.txt</em> file to build
  76.                     Cocoon.
  77.                 </p>
  78.                 <note>
  79.                     If you have done this previously, make sure to remove any local.* configuration files that you
  80.                     might have created. You usually want to activate all Cocoon components to look at the samples,
  81.                     and local.* files might disable some components or even disable the samples.
  82.                 </note>
  83.                 <note>
  84.                     Also, if you have already built Cocoon with a different configuration before, you might need to
  85.                     do a "build clean" first, to prevent any conflicts between different configurations.
  86.  
  87.                 </note>
  88.                 <p>
  89.                     The INSTALL.txt file also contains instructions for starting Cocoon with the <em>cocoon.sh</em> or
  90.                     <em>cocoon.bat</em> script, which is the simplest way and is sufficient to explore the samples.
  91.                 </p>
  92.  
  93.             </s2>
  94.  
  95.             <s2 title="3. Access the samples">
  96.                 <p>
  97.                     Once Cocoon starts (and assuming you have kept the standard configuration), point your browser
  98.                     at http://localhost:8888, this should show the "Welcome to Apache Cocoon" page. On this page,
  99.                     click the
  100.                     <em>samples</em> link.
  101.                 </p>
  102.                 <p>
  103.                     You should now see a page with links to many samples (
  104.                     <em>Hello World!</em>, etc.), which show you what Cocoon is about.
  105.                     Note that there are several categories of samples: do not forget to look at the
  106.                     <em>blocks
  107.                         with samples</em> page, which contains samples based on components which are not part of the Cocoon core.
  108.                 </p>
  109.                 <p>
  110.                     Another category is the
  111.                     <em>scratchpad</em> samples , these are based on experimental
  112.                     components that might or might not be included later in the Cocoon core or in a Cocoon block.
  113.                 </p>
  114.             </s2>
  115.  
  116.             <s2 title="4. Study the samples">
  117.                 <p>
  118.                     Now comes the interesting part: looking at the samples innards to find out how they are built.
  119.                 </p>
  120.                 <p>
  121.                     This is fairly simple as the directory structure of the samples is similar to the URLs
  122.                     used to access the samples. These simple rules should help you find out much more about
  123.                     the samples:
  124.                 </p>
  125.                     <ul>
  126.                         <li>If using the standard build configuration, samples are found under the
  127.                             <em>build/webapp/samples</em> directory. That's where you want to look
  128.                             to find out how a particular sample works.
  129.                         </li>
  130.                         <li>Under this directory, the pathnames are the same than after the
  131.                             <em>http://localhost:8888/samples</em> base URL. The
  132.                             midi block samples, for example, are accessed from
  133.                             <em>http://localhost:8888/samples/midi</em>
  134.                             and the corresponding files are found under
  135.                             <em>build/webapp/samples/midi</em>.
  136.                         </li>
  137.                         <li>
  138.                             When studying how a sample is built, it is recommended to first study its <em>sitemap.xmap</em>
  139.                             files, which map incoming requests to pipelines.
  140.                         </li>
  141.                     </ul>
  142.             </s2>
  143.         </s1>
  144.  
  145.         <s1 title="Conclusion">
  146.             <p>
  147.                 We hope that this How-To will help you explore the samples yourself, as this
  148.                 is probably the best way of learning about Cocoon.
  149.             </p>
  150.             <p>
  151.                 Do not forget to look at the reference documentation though, once you have found
  152.                 out which Cocoon components you need for your application.
  153.             </p>
  154.         </s1>
  155.  
  156.         <s1 title="Comments">
  157.           <p>
  158.               Care to comment on this How-To?
  159.               Help keep this document relevant by passing along any constructive feedback to the
  160.               <link href="mailto:docs@cocoon.apache.org?subject=howto-explore-samples:">cocoon-docs</link>
  161.               mailing list.
  162.           </p>
  163.         </s1>
  164.  
  165.     </body>
  166. </document>
  167.