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 / selector.template < prev    next >
Encoding:
Extensible Markup Language  |  2004-07-12  |  4.0 KB  |  146 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. <!--
  20.   <![CDATA[ CVS Version: $Id: selector.template,v 1.6 2004/04/21 00:35:27 crossley Exp $ 
  21.   ]]>
  22.  
  23.   Using this TemplateSelector:
  24.   
  25.   * replace TemplateSelector by the name of the selector you are describing
  26.   * write concrete description
  27.   
  28. -->
  29. <document>
  30.   <header>
  31.     <title>TemplateSelector in Cocoon</title>
  32.     <version>0.9</version>
  33.     <type>Technical document</type>
  34.     <authors>
  35.       <person name="Your Name" email="your-email"/>
  36.     </authors>
  37.     <abstract>This document describes the TemplateSelector of Cocoon.</abstract>
  38.   </header>
  39.   <body>
  40.     <s1 title="TemplateSelector">
  41.       <table>
  42.         <tr>
  43.           <td>NAME</td><td>template</td>
  44.         </tr>
  45.         <tr>
  46.           <td>WHAT</td><td>The <code>TemplateSelector</code> component is used to 
  47.             select...
  48.           </td>
  49.         </tr>
  50.         <tr>
  51.           <td>TYPE</td><td>Selector, Sitemap Component</td>
  52.         </tr>
  53.         <tr>
  54.           <!-- choose Core, the block name, or Scratchpad 
  55.             depending on where TemplateSelector sources live
  56.           -->
  57.           <td>BLOCK</td><td>Core/Block-Name/Scratchpad</td>
  58.         </tr>
  59.         <tr>
  60.           <td>CLASS</td><td>org.apache.cocoon.reading.TemplateSelector</td>
  61.         </tr>
  62.         <!-- uncomment following tr if TemplateSelector is deprecated -->
  63.         <!--tr>
  64.           <td>DEPRECATED</td><td>Cocoon 2.0, 2.1</td>
  65.         </tr-->
  66.         <tr>
  67.           <td>SINCE</td><td>Cocoon X.Y</td>
  68.         </tr>
  69.         <tr>
  70.           <td>CACHEABLE</td><td>not applicable</td>
  71.         </tr>
  72.       </table>
  73.     </s1>
  74.     <s1 title="Description">
  75.       <p>
  76.         A general description of TemplateSelector
  77.       </p>
  78.     </s1>
  79.     <s1 title="Usage">
  80.       <p>
  81.         A usage scenario of TemplateSelector
  82.       </p>
  83.       <s2 title="Sitemap pipeline examples">
  84.         <p></p>
  85.         <source><![CDATA[
  86. <map:match pattern="*.xyz">
  87.   <map:read type="template" 
  88.     src="{1}" 
  89.     mime-type="type/sub-type">
  90.     <!-- option sitemap parameters -->
  91.   </map:read>
  92. </map:match>
  93.         ]]></source>
  94.       </s2>
  95.       
  96.       <s2 title="Sitemap component configuration example">
  97.         <p></p>
  98.         <source><![CDATA[
  99. <map:selectors...
  100.   <map:selector name="template" 
  101.     src="org.apache.cocoon.reading.TemplateSelector"
  102.     logger="sitemap.selector.template" 
  103.   />
  104.     <!-- optional selector configuration -->
  105.     ...
  106.   </map:selectors>
  107. ...
  108. ]]></source>
  109.       </s2>
  110.       <s2 title="Configuration">
  111.         <p>
  112.           Explain the sitemap selector configuration, options when declaring template selector
  113.         </p>
  114.       </s2>
  115.       <s2 title="Setup">
  116.         <p>
  117.           Explain the sitemap selector setup, ie options when using template selector
  118.         </p>
  119.       </s2>
  120.       <s2 title="Effect on Object Model and Sitemap Parameters">
  121.         <p>
  122.         
  123.         </p>
  124.       </s2>
  125.     </s1>
  126.     <s1 title="Bugs/Caveats">
  127.       <p>
  128.         Describe limitation, bugs of TemplateSelector 
  129.       </p>
  130.     </s1>
  131.     <s1 title="History">
  132.       <p>
  133.         MM-DD-YY: initial creation
  134.       </p>
  135.     </s1>
  136.     <s1 title="See also">
  137.       <p>
  138.         <!-- Links to related components pages. -->
  139.         A general documentation about selectors is available at
  140.         <link href="../concepts/matchers_selectors.html">Matchers and Selectors</link>.
  141.       </p>
  142.     </s1>
  143.   </body>
  144. </document>
  145.  
  146.