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