joerg 2003/05/30 18:25:04
Modified: src/documentation/xdocs/userdocs/generators
directory-generator.xml generators.xml
src/documentation/xdocs/userdocs/transformers
transformers.xml
Removed: src/documentation/xdocs/userdocs/generators
error-generator.xml linkstatus-generator.xml
profile-generator.xml textparser-generator.xml
wsproxy-generator.xml
src/documentation/xdocs/userdocs/transformers
augment-transformer.xml textparser-transformer.xml
Log:
fixing bug 15614: 2.0 documentation contains 2.1 stuff
- 2.1 generators and transformers removed from the lists, deleted their files
- DirectoryGenerator: restored old documentation file
Revision Changes Path
1.2 +86 -114
cocoon-2.0/src/documentation/xdocs/userdocs/generators/directory-generator.xml
Index: directory-generator.xml
===================================================================
RCS file:
/home/cvs/cocoon-2.0/src/documentation/xdocs/userdocs/generators/directory-generator.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- directory-generator.xml 9 Mar 2003 00:01:12 -0000 1.1
+++ directory-generator.xml 31 May 2003 01:25:04 -0000 1.2
@@ -2,125 +2,97 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"../../dtd/document-v10.dtd">
<document>
- <header>
- <title>Directory Generator</title>
- <version>0.9</version>
- <type>Technical document</type>
- <authors>
- <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
- <person name="Frank Ridderbusch" email="[EMAIL PROTECTED]"/>
- <person name="John Morrison" email="[EMAIL PROTECTED]"/>
- </authors>
- <abstract>This document describes the directory generator of
- Cocoon.</abstract>
- </header>
- <body>
- <s1 title="Directory Generator">
- <p>Generates an XML directory listing.</p>
- <p>The root node of the generated document will normally be a
- <code>directory</code> node, and a directory node can contain
- zero or more <code>file</code> or <code>directory</code> nodes.
- A file node has no children. Each node will contain the
- following attributes:
- </p>
- <ul>
- <li>name : the name of the file or directory</li>
- <li>lastModified : the time the file was last modified,
- measured as the number of milliseconds since the epoch (as
- in java.io.File.lastModified)</li>
- <li>size : the file size in bytes (as returned by
- java.io.File.length)</li>
- <li>date (optional) : the time the file was last modified in
- human-readable form</li>
- </ul>
- <p>All generated elements have the namespace
- <code>http://apache.org/cocoon/directory/2.0</code>. The root
- <code>directory</code> node has the attribute
- <code>requested</code> with the value <code>true</code>. The
- sort order is described by the attribute <code>sort</code>,
- which defaults to sorting according to <code>name</code>.
- </p>
- <ul>
- <li>Name : directory</li>
- <li>Class: org.apache.cocoon.generation.DirectoryGenerator</li>
- <li>Cacheable: no.</li>
- </ul>
- <source><![CDATA[
-<map:generate type="directory" src="the_directory"/>]]></source>
- </s1>
- <s1 title="Configuration">
- <p>The following parameter can be specified in the pipeline for the
- generate command:
- </p>
- <ul>
- <li>depth (optional) : Sets how deep Directory Generator should
- delve into the directory structure. If set to 1 (the
- default), only the starting directory's immediate contents
- will be returned.</li>
- <li>dateFormat (optional) : Sets the format for the date
- attribute of each node, as described in
- java.text.SimpleDateFormat. If unset, the default format
- for the current locale will be used.</li>
- <li>root (optional) : The root pattern. This is a regular
- expression as described
- <link
href="http://jakarta.apache.org/regexp/apidocs/org/apache/regexp/RE.html";>here.</link></li>
- <li>include (optional) : The include pattern. Also a
- regular expression.</li>
- <li>exclude (optional) : The exclude pattern. Also a
- regular expression.</li>
- <li>sort (optional) : This parameter determines the order in
- which the <code>file</code> and <code>directory</code> nodes
- are returned. Default sort order is as defined by the
- system. Possible values are "name", "size", "time", and
- "directory". "directory" is the same as "name", except that
- directory entries are listed first.</li>
- <li>reverse (optional) : This parameter reverses the sort order.
- reverse="false" is the default.</li>
- </ul>
- </s1>
- <s1 title="DTD">
- <p>XML generated by directory generator uses namespace
- <code>http://apache.org/cocoon/status/2.0</code>. The DTD
- of XML generated by directory generator:
- </p>
- <source><![CDATA[
-<!ELEMENT directory (directory|file)*>
-<!ATTLIST directory
+ <header>
+ <title>Directory Generator</title>
+ <version>0.9</version>
+ <type>Technical document</type>
+ <authors>
+ <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
+ </authors>
+ <abstract>This document describes the directory generator of
Cocoon.</abstract>
+ </header>
+ <body>
+ <s1 title="Directory Generator">
+ <p>Generates an XML directory listing.</p>
+ <p>
+ The root node of the generated document will normally be a
+ <code>directory</code> node, and a directory node can contain zero
+ or more <code>file</code> or <code>directory</code> nodes. A file node has
no
+ children. Each node will contain the following attributes:
+ </p>
+ <ul>
+ <li>name : the name of the file or directory</li>
+ <li>lastModified : the time the file was last modified, measured as the
number of
+ milliseconds since the epoch (as in java.io.File.lastModified)</li>
+ <li>date (optional) : the time the file was last modified in human-readable
form</li>
+ </ul>
+ <p>All generated elements have the namespace
+ <code>http://apache.org/cocoon/directory/2.0</code>.
+ The root <code>directory</code>
+ node has the attribute <code>requested</code> with the value
<code>true</code>.
+ </p>
+ <ul>
+ <li>Name : directory</li>
+ <li>Class: org.apache.cocoon.generation.DirectoryGenerator</li>
+ <li>Cacheable: no.</li>
+ </ul>
+<source><![CDATA[
+ <map:generate type="directory" src="the_directory"/>
+]]></source>
+ </s1>
+ <s1 title="Configuration">
+ <p>The following parameter can be specified in the pipeline for
+ the generate command:
+ </p>
+ <ul>
+ <li>depth (optional) : Sets how deep Directory Generator should delve into
the
+ directory structure. If set to 1 (the default), only the starting
+ directory's immediate contents will be returned.</li>
+ <li>dateFormat (optional) : Sets the format for the date attribute of each
node, as
+ described in java.text.SimpleDateFormat. If unset, the default
+ format for the current locale will be used.</li>
+ <li>root (optional) : The root pattern</li>
+ <li>include (optional) : The include pattern</li>
+ <li>exclude (optional) : The exclude pattern</li>
+ </ul>
+ </s1>
+ <s1 title="DTD">
+ <p>XML generated by directory generator uses namespace
+ <code>http://apache.org/cocoon/status/2.0</code>. The DTD
+ of XML generated by directory generator:
+ </p>
+<source><![CDATA[
+ <!ELEMENT directory (directory|file)*>
+ <!ATTLIST directroy
name CDATA #REQUIRED
lastModified CDATA #REQUIRED
date CDATA #IMPLIED
- size CDATA #IMPLIED
- sort CDATA #IMPLIED
- reverse CDATA #IMPLIED
requested CDATA #IMPLIED>
-
-<!ELEMENT file #EMPTY>
-<!ATTLIST file
+
+ <!ELEMENt file #EMPTY>
+ <!ATTLIST file
name CDATA #REQUIRED
lastModified CDATA #REQUIRED
- date CDATA #IMPLIED
- size CDATA #IMPLIED>
+ date CDATA #IMPLIED>
+]]></source>
+ </s1>
+ <s1 title="Example">
+ <p>
+ The current directory generator may generate following xml:
+ </p>
+<source><![CDATA[
+<directory xmlns="http://apache.org/cocoon/directory/2.0";
+ name="stylesheets" lastModified="999425490000"
+ date="02.09.01 12:11"
+ requested="true">
+ <directory name="sites"
+ lastModified="999425490000" date="02.09.01 12:11"/>
+ <file name="dynamic-page2html.xsl"
+ lastModified="999425490000" date="02.09.01 12:11"/>
+ <file name="simple-xml2html.xsl"
+ lastModified="999425490000" date="02.09.01 12:11"/>
+</directory>
]]></source>
- </s1>
- <s1 title="Example">
- <p>The current directory generator may generate following xml:</p>
- <source><![CDATA[
-<dir:directory xmlns:dir="http://apache.org/cocoon/directory/2.0";
- name="stylesheets"
- lastModified="1019666489000"
- date="24.04.02 18:41"
- size="461"
- sort="name"
- reverse="false"
- requested="true">
- <dir:directory name="sites" lastModified="1019666489000"
- date="24.04.02 18:41" size="118"/>
- <dir:file name="dynamic-page2html.xsl" lastModified="1019666489000"
- date="24.04.02 18:41" size="1832"/>
- <dir:file name="simple-xml2html.xsl" lastModified="1019666489000"
- date="24.04.02 18:41" size="12676"/>
-</dir:directory>
- ]]></source>
- </s1>
- </body>
+ </s1>
+</body>
</document>
1.2 +8 -11
cocoon-2.0/src/documentation/xdocs/userdocs/generators/generators.xml
Index: generators.xml
===================================================================
RCS file:
/home/cvs/cocoon-2.0/src/documentation/xdocs/userdocs/generators/generators.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- generators.xml 9 Mar 2003 00:01:12 -0000 1.1
+++ generators.xml 31 May 2003 01:25:04 -0000 1.2
@@ -28,26 +28,23 @@
</s1>
<s1 title="The Generators in Apache Cocoon">
<ul>
+ <li><link href="directory-generator.html">Directory
Generator</link></li>
<li><link href="file-generator.html">File
Generator</link> (The default generator)</li>
+ <li><link href="extractor-generator.html">Fragment
Extractor Generator</link></li>
<li><link href="html-generator.html">HTML
Generator</link> (optional)</li>
- <li><link href="directory-generator.html">Directory
Generator</link></li>
<li><link href="imagedirectory-generator.html">Image
Directory Generator</link></li>
- <li><link href="extractor-generator.html">Fragment
Extractor Generator</link></li>
<li><link href="jsp-generator.html">JSP
Generator</link></li>
+ <li>MP3 Directory Generator</li>
+ <li><link href="php-generator.html">PHP
Generator</link> (optional)</li>
+ <li><link href="request-generator.html">Request
Generator</link></li>
<li><link href="script-generator.html">Script
Generator</link></li>
+ <li><link href="search-generator.html">Search
Generator</link></li>
<li><link href="serverpages-generator.html">Server
Pages Generator</link></li>
- <li><link href="velocity-generator.html">Velocity
Generator</link></li>
- <li><link href="request-generator.html">Request
Generator</link></li>
<li><link href="status-generator.html">Status
Generator</link></li>
<li><link href="stream-generator.html">Stream
Generator</link></li>
- <li><link href="profile-generator.html">Profile
Generator</link></li>
- <li><link href="error-generator.html">Error
Generator</link></li>
- <li><link href="search-generator.html">Search
Generator</link></li>
- <li><link href="linkstatus-generator.html">LinkStatus
Generator</link></li>
- <li><link href="php-generator.html">Php
Generator</link> (optional)</li>
- <li><link href="xmldb-generator.html">XML:DB
Generator</link> (optional)</li>
+ <li><link href="velocity-generator.html">Velocity
Generator</link></li>
<li><link href="xmldbcollection-generator.html">XML:DB
Collection Generator</link> (optional)</li>
- <li><link href="textparser-generator.html">Text Parser Generator</link></li>
+ <li><link href="xmldb-generator.html">XML:DB
Generator</link> (optional)</li>
</ul>
</s1>
</body>
1.2 +0 -2
cocoon-2.0/src/documentation/xdocs/userdocs/transformers/transformers.xml
Index: transformers.xml
===================================================================
RCS file:
/home/cvs/cocoon-2.0/src/documentation/xdocs/userdocs/transformers/transformers.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- transformers.xml 9 Mar 2003 00:01:20 -0000 1.1
+++ transformers.xml 31 May 2003 01:25:04 -0000 1.2
@@ -41,10 +41,8 @@
<li><link href="cinclude-transformer.html">CInclude
Transformer</link></li>
<li><link href="encodeurl-transformer.html">EncodeURL
Transformer</link></li>
<li><link
href="sourcewriting-transformer.html">SourceWriting Transformer</link></li>
- <li><link href="augment-transformer.html">Augment
Transformer</link></li>
<li><link href="xt-transformer.html">XT
Transformer</link> (optional)</li>
<li><link href="ldap-transformer.html">LDAP
Transformer</link> (optional)</li>
- <li><link href="textparser-transformer.html">Text Parser
Transformer</link></li>
</ul>
</s1>
</body>
