You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by jo...@apache.org on 2003/07/14 22:16:02 UTC
cvs commit: cocoon-2.1/src/documentation/xdocs/userdocs/readers readers.template
joerg 2003/07/14 13:16:02
Modified: src/documentation/xdocs/userdocs/selectors book.xml
Added: src/documentation/xdocs/userdocs/selectors date-selector.xml
selector.template
src/documentation/xdocs/userdocs/readers readers.template
Removed: src/documentation/xdocs/userdocs/selectors
template-selector.xml
Log:
After having searched for TemplateReader the last time (I didn't find one :-) ), I deleted the file template-reader.xml. Now there is also a template-selector.xml and I didn't search for it :). I rename them to *.template.
DateSelector skeleton added.
Revision Changes Path
1.2 +5 -4 cocoon-2.1/src/documentation/xdocs/userdocs/selectors/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/selectors/book.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- book.xml 9 Mar 2003 00:08:23 -0000 1.1
+++ book.xml 14 Jul 2003 20:16:01 -0000 1.2
@@ -18,14 +18,15 @@
</menu>
<menu label="Core">
<menu-item label="Host Selector" href="host-selector.html"/>
- <menu-item label="Request Parameter Selector" href="requestparameter-selector.html"/>
+ <menu-item label="Parameter Selector" href="parameter-selector.html"/>
<menu-item label="Request Attribute Selector" href="requestattribute-selector.html"/>
- <menu-item label="Parameter" href="parameter-selector.html"/>
+ <menu-item label="Request Parameter Selector" href="requestparameter-selector.html"/>
</menu>
<menu label="Optional">
</menu>
-
-
+ <menu label="Scratchpad">
+ <menu-item label="Date Selector" href="date-selector.xml"/>
+ </menu>
</book>
1.1 cocoon-2.1/src/documentation/xdocs/userdocs/selectors/date-selector.xml
Index: date-selector.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd">
<!--
<![CDATA[ CVS Version: $Id: date-selector.xml,v 1.1 2003/07/14 20:16:01 joerg Exp $
]]>
-->
<document>
<header>
<title>DateSelector in Cocoon</title>
<version>0.9</version>
<type>Technical document</type>
<authors>
<person name="Your Name" email="your-email"/>
</authors>
<abstract>This document describes the DateSelector of Cocoon.</abstract>
</header>
<body>
<s1 title="DateSelector">
<table>
<tr>
<td>NAME</td><td>date</td>
</tr>
<tr>
<td>WHAT</td><td>The <code>DateSelector</code> component is used to
select...
</td>
</tr>
<tr>
<td>TYPE</td><td>Selector, Sitemap Component</td>
</tr>
<tr>
<!-- choose Core, the block name, or Scratchpad
depending on where DateSelector sources live
-->
<td>BLOCK</td><td>Scratchpad</td>
</tr>
<tr>
<td>CLASS</td><td>org.apache.cocoon.reading.DateSelector</td>
</tr>
<!-- uncomment following tr if DateSelector is deprecated -->
<!--tr>
<td>DEPRECATED</td><td>Cocoon 2.0, 2.1</td>
</tr-->
<tr>
<td>SINCE</td><td>Cocoon X.Y</td>
</tr>
<tr>
<td>CACHEABLE</td><td>not applicable</td>
</tr>
</table>
</s1>
<s1 title="Description">
<p>
A general description of DateSelector
</p>
</s1>
<s1 title="Usage">
<p>
A usage scenario of DateSelector
</p>
<s2 title="Sitemap pipeline examples">
<p></p>
<source><![CDATA[
<map:match pattern="*.xyz">
<map:read type="date" src="{1}" mime-type="type/sub-type">
<!-- option sitemap parameters -->
</map:read>
</map:match>
]]></source>
</s2>
<s2 title="Sitemap component configuration example">
<p></p>
<source><![CDATA[
<map:selectors...
<map:selector name="date"
src="org.apache.cocoon.reading.DateSelector"
logger="sitemap.selector.date"
/>
<!-- optional selector configuration -->
...
</map:selectors>
...
]]></source>
</s2>
<s2 title="Configuration">
<p>
Explain the sitemap selector configuration, options when declaring date selector
</p>
</s2>
<s2 title="Setup">
<p>
Explain the sitemap selector setup, ie options when using date selector
</p>
</s2>
<s2 title="Effect on Object Model and Sitemap Parameters">
<p>
</p>
</s2>
</s1>
<s1 title="Bugs/Caveats">
<p>
Describe limitation, bugs of DateSelector
</p>
</s1>
<s1 title="History">
<p>
MM-DD-YY: initial creation
</p>
</s1>
<s1 title="Copyright">
<p>
Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
</p>
</s1>
<s1 title="See also">
<p>
<!-- Links to related components pages. -->
A general documentation about selectors is available at
<link href="../concepts/matchers_selectors.html">Matchers and Selectors</link>.
</p>
</s1>
</body>
</document>
1.1 cocoon-2.1/src/documentation/xdocs/userdocs/selectors/selector.template
Index: selector.template
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd">
<!--
<![CDATA[ CVS Version: $Id: template-selector.xml,v 1.1 2003/03/09 00:08:23 pier Exp $
]]>
Using this TemplateSelector:
* replace TemplateSelector by the name of the selector you are describing
* write concrete description
-->
<document>
<header>
<title>TemplateSelector in Cocoon</title>
<version>0.9</version>
<type>Technical document</type>
<authors>
<person name="Your Name" email="your-email"/>
</authors>
<abstract>This document describes the TemplateSelector of Cocoon.</abstract>
</header>
<body>
<s1 title="TemplateSelector">
<table>
<tr>
<td>NAME</td><td>template</td>
</tr>
<tr>
<td>WHAT</td><td>The <code>TemplateSelector</code> component is used to
select...
</td>
</tr>
<tr>
<td>TYPE</td><td>Selector, Sitemap Component</td>
</tr>
<tr>
<!-- choose Core, the block name, or Scratchpad
depending on where TemplateSelector sources live
-->
<td>BLOCK</td><td>Core/Block-Name/Scratchpad</td>
</tr>
<tr>
<td>CLASS</td><td>org.apache.cocoon.reading.TemplateSelector</td>
</tr>
<!-- uncomment following tr if TemplateSelector is deprecated -->
<!--tr>
<td>DEPRECATED</td><td>Cocoon 2.0, 2.1</td>
</tr-->
<tr>
<td>SINCE</td><td>Cocoon X.Y</td>
</tr>
<tr>
<td>CACHEABLE</td><td>not applicable</td>
</tr>
</table>
</s1>
<s1 title="Description">
<p>
A general description of TemplateSelector
</p>
</s1>
<s1 title="Usage">
<p>
A usage scenario of TemplateSelector
</p>
<s2 title="Sitemap pipeline examples">
<p></p>
<source><![CDATA[
<map:match pattern="*.xyz">
<map:read type="template"
src="{1}"
mime-type="type/sub-type">
<!-- option sitemap parameters -->
</map:read>
</map:match>
]]></source>
</s2>
<s2 title="Sitemap component configuration example">
<p></p>
<source><![CDATA[
<map:selectors...
<map:selector name="template"
src="org.apache.cocoon.reading.TemplateSelector"
logger="sitemap.selector.template"
/>
<!-- optional selector configuration -->
...
</map:selectors>
...
]]></source>
</s2>
<s2 title="Configuration">
<p>
Explain the sitemap selector configuration, options when declaring template selector
</p>
</s2>
<s2 title="Setup">
<p>
Explain the sitemap selector setup, ie options when using template selector
</p>
</s2>
<s2 title="Effect on Object Model and Sitemap Parameters">
<p>
</p>
</s2>
</s1>
<s1 title="Bugs/Caveats">
<p>
Describe limitation, bugs of TemplateSelector
</p>
</s1>
<s1 title="History">
<p>
MM-DD-YY: initial creation
</p>
</s1>
<s1 title="Copyright">
<p>
Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
</p>
</s1>
<s1 title="See also">
<p>
<!-- Links to related components pages. -->
A general documentation about selectors is available at
<link href="../concepts/matchers_selectors.html">Matchers and Selectors</link>.
</p>
</s1>
</body>
</document>
1.1 cocoon-2.1/src/documentation/xdocs/userdocs/readers/readers.template
Index: readers.template
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd">
<document>
<header>
<title>TemplateReader in Cocoon</title>
<version>0.9</version>
<type>Technical document</type>
<authors>
<person name="Your Name" email="your-email"/>
</authors>
<abstract>This document describes the TemplateReader of Cocoon.</abstract>
</header>
<body>
<s1 title="TemplateReader">
<table>
<tr>
<td>NAME</td><td>template</td>
</tr>
<tr>
<td>WHAT</td><td>The <code>TemplateReader</code> component is used
to serve data in a sitemap pipeline.
</td>
</tr>
<tr>
<td>TYPE</td><td>Reader, Sitemap Component</td>
</tr>
<tr>
<!-- choose Core, the block name, or Scratchpad
depending on where TemplateReader sources live
-->
<td>BLOCK</td><td>Core/Block-Name/Scratchpad</td>
</tr>
<tr>
<td>CLASS</td><td>org.apache.cocoon.reading.TemplateReader</td>
</tr>
<!-- uncomment following tr if TemplateReader is deprecated -->
<!--tr>
<td>DEPRECATED</td><td>Cocoon 2.0, 2.1</td>
</tr-->
<tr>
<td>SINCE</td><td>Cocoon X.Y</td>
</tr>
<tr>
<td>CACHEABLE</td><td>yes</td>
</tr>
</table>
</s1>
<s1 title="Description">
<p>
A general description of TemplateReader
</p>
</s1>
<s1 title="Usage">
<p>
A usage scenario of TemplateReader
</p>
<s2 title="Sitemap pipeline examples">
<p></p>
<source><![CDATA[
<map:match pattern="*.xyz">
<map:read type="template"
src="{1}"
mime-type="type/sub-type">
<!-- option sitemap parameters -->
</map:read>
</map:match>
]]></source>
</s2>
<s2 title="Sitemap component configuration example">
<p></p>
<source><![CDATA[
<map:readers...
<map:reader name="template"
src="org.apache.cocoon.reading.TemplateReader"
logger="sitemap.reader.template"
pool-max="32" pool-min="1" pool-grow="4"/>
<!-- optional reader configuration -->
...
</map:readers>
...
]]></source>
</s2>
<s2 title="Configuration">
<p>
Explain the sitemap reader configuration, options when declaring template reader
</p>
</s2>
<s2 title="Setup">
<p>
Explain the sitemap reader setup, ie options when using template reader
</p>
</s2>
<s2 title="Effect on Object Model and Sitemap Parameters">
<p>
</p>
</s2>
</s1>
<s1 title="Bugs/Caveats">
<p>
Describe limitation, bugs of TemplateReader
</p>
</s1>
<s1 title="History">
<p>
MM-DD-YY: initial creation by You
</p>
</s1>
<s1 title="Copyright">
<p>
Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
</p>
</s1>
<s1 title="See also">
<p>
Links to related components pages.
</p>
</s1>
</body>
</document>