joerg 2003/06/26 17:48:46
Modified: src/documentation/xdocs/userdocs/generators
directory-generator.xml
Log:
some re-formulations/restatements
Revision Changes Path
1.4 +22 -21
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.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- directory-generator.xml 21 Jun 2003 11:48:00 -0000 1.3
+++ directory-generator.xml 27 Jun 2003 00:48:45 -0000 1.4
@@ -8,9 +8,9 @@
<type>Technical document</type>
<authors>
<person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
- <person name="Jörg Heinicke" email="[EMAIL PROTECTED]"/>
+ <person name="Jörg Heinicke" email="[EMAIL PROTECTED]"/>
</authors>
- <abstract>This document describes the directory generator of Cocoon.</abstract>
+ <abstract>This document describes the directory generator of Cocoon.</abstract>
</header>
<body>
<s1 title="Directory Generator">
@@ -33,15 +33,16 @@
<li><code>date</code>: the time the file was last modified in
human-readable form.</li>
<li><code>size</code>: the file size (or 0 for directories).</li>
</ul>
- <p>Furthermore the requested directory has an attribute
<code>requested</code> with the value
- set to true. This needs not to be the root node as you will see later.</p>
-<source><![CDATA[
- <map:generate type="directory" src="the_directory">
- <map:parameter name="depth" value="2"/>
- </map:generate>
-]]></source>
+ <p>Additionally the node for the requested directory has an attribute
<code>requested</code>
+ with the value set to true. This node needs not to be the root node as
you will see
+ later.</p>
</s1>
<s1 title="Configuration">
+ <source><![CDATA[
+ <map:generate type="directory" src="the/requested/directory">
+ <map:parameter name="depth" value="2"/>
+ </map:generate>
+ ]]></source>
<p>The <code>src</code> attribute on the <code><map:generate/></code> must
be set to the
directory the XML listing should be created of. This is the
<em>requested</em> directory.
</p>
@@ -52,11 +53,11 @@
<li>depth: 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: Sets the format for the date attribute of each node, as
described in
+ <li>dateFormat: Sets the format for the date attribute of each node as
described in
<code>java.text.SimpleDateFormat</code>. If unset, the default format
for the current
locale will be used.</li>
- <li>refreshDelay: Sets the delay (in seconds, default is 1) between checks
for
- updates on the file system.</li>
+ <li>refreshDelay: Sets the delay (in seconds, default is 1) between checks
for updates on
+ the file system. So this option influences the caching of the directory
listing.</li>
<li>root: The root pattern. From the requested director upwards a directory
is searched
using this pattern, that is added as root node to the document. The
path from this root
node down to the requested directory will also be in the output. If no
root pattern is
@@ -95,14 +96,14 @@
</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" size="0"
requested="true">
- <directory name="sites" lastModified="999425490000" date="02.09.01 12:11"
size="0"/>
- <file name="dynamic-page2html.xsl" lastModified="999425490000" date="02.09.01
12:11" size="0"/>
- <file name="simple-xml2html.xsl" lastModified="999425490000" date="02.09.01
12:11" size="1234"/>
-</directory>
-]]></source>
+ <source><![CDATA[
+<dir:directory xmlns:dir="http://apache.org/cocoon/directory/2.0";
+ name="stylesheets" lastModified="1056668768203" date="27.06.03 01:06" size="0"
requested="true">
+ <dir:directory name="sites" lastModified="1056668768203" date="27.06.03 01:06"
size="0"/>
+ <dir:file name="dynamic-page2html.xsl" lastModified="1056668768203"
date="27.06.03 01:06" size="0"/>
+ <dir:file name="simple-xml2html.xsl" lastModified="1056668768203" date="27.06.03
01:06" size="1234"/>
+</dir:directory>
+ ]]></source>
</s1>
-</body>
+ </body>
</document>
