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 / readers.template < prev    next >
Encoding:
Extensible Markup Language  |  2004-07-12  |  3.6 KB  |  133 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" "../../dtd/document-v10.dtd">
  18.  
  19. <document>
  20.   <header>
  21.     <title>TemplateReader in Cocoon</title>
  22.     <version>0.9</version>
  23.     <type>Technical document</type>
  24.     <authors>
  25.       <person name="Your Name" email="your-email"/>
  26.     </authors>
  27.     <abstract>This document describes the TemplateReader of Cocoon.</abstract>
  28.   </header>
  29.   <body>
  30.     <s1 title="TemplateReader">
  31.       <table>
  32.         <tr>
  33.           <td>NAME</td><td>template</td>
  34.         </tr>
  35.         <tr>
  36.           <td>WHAT</td><td>The <code>TemplateReader</code> component is used 
  37.             to serve data in a sitemap pipeline.
  38.           </td>
  39.         </tr>
  40.         <tr>
  41.           <td>TYPE</td><td>Reader, Sitemap Component</td>
  42.         </tr>
  43.         <tr>
  44.           <!-- choose Core, the block name, or Scratchpad 
  45.             depending on where TemplateReader sources live
  46.           -->
  47.           <td>BLOCK</td><td>Core/Block-Name/Scratchpad</td>
  48.         </tr>
  49.         <tr>
  50.           <td>CLASS</td><td>org.apache.cocoon.reading.TemplateReader</td>
  51.         </tr>
  52.         <!-- uncomment following tr if TemplateReader is deprecated -->
  53.         <!--tr>
  54.           <td>DEPRECATED</td><td>Cocoon 2.0, 2.1</td>
  55.         </tr-->
  56.         <tr>
  57.           <td>SINCE</td><td>Cocoon X.Y</td>
  58.         </tr>
  59.         <tr>
  60.           <td>CACHEABLE</td><td>yes</td>
  61.         </tr>
  62.       </table>
  63.     </s1>
  64.     <s1 title="Description">
  65.       <p>
  66.         A general description of TemplateReader
  67.       </p>
  68.     </s1>
  69.     <s1 title="Usage">
  70.       <p>
  71.         A usage scenario of TemplateReader
  72.       </p>
  73.       <s2 title="Sitemap pipeline examples">
  74.         <p></p>
  75.         <source><![CDATA[
  76. <map:match pattern="*.xyz">
  77.   <map:read type="template" 
  78.     src="{1}" 
  79.     mime-type="type/sub-type">
  80.     <!-- option sitemap parameters -->
  81.   </map:read>
  82. </map:match>
  83.         ]]></source>
  84.       </s2>
  85.       
  86.       <s2 title="Sitemap component configuration example">
  87.         <p></p>
  88.         <source><![CDATA[
  89. <map:readers...
  90.   <map:reader name="template" 
  91.     src="org.apache.cocoon.reading.TemplateReader"
  92.     logger="sitemap.reader.template" 
  93.     pool-max="32" pool-min="1" pool-grow="4"/>
  94.     <!-- optional reader configuration -->
  95.     ...
  96.   </map:readers>
  97. ...
  98. ]]></source>
  99.       </s2>
  100.       <s2 title="Configuration">
  101.         <p>
  102.           Explain the sitemap reader configuration, options when declaring template reader
  103.         </p>
  104.       </s2>
  105.       <s2 title="Setup">
  106.         <p>
  107.           Explain the sitemap reader setup, ie options when using template reader
  108.         </p>
  109.       </s2>
  110.       <s2 title="Effect on Object Model and Sitemap Parameters">
  111.         <p>
  112.         
  113.         </p>
  114.       </s2>
  115.     </s1>
  116.     <s1 title="Bugs/Caveats">
  117.       <p>
  118.         Describe limitation, bugs of TemplateReader 
  119.       </p>
  120.     </s1>
  121.     <s1 title="History">
  122.       <p>
  123.         MM-DD-YY: initial creation by You
  124.       </p>
  125.     </s1>
  126.     <s1 title="See also">
  127.       <p>
  128.         Links to related components pages.
  129.       </p>
  130.     </s1>
  131.   </body>
  132. </document>
  133.