cvs commit: cocoon-2.0/src/documentation/xdocs/userdocs/generators directory-generator.xml

2003-06-26 Thread joerg
joerg   2003/06/26 17:48:46

  Modified:src/documentation/xdocs/userdocs/generators
directory-generator.xml
  Log:
  some re-formulations/restatements
  
  Revision  ChangesPath
  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 -  1.3
  +++ directory-generator.xml   27 Jun 2003 00:48:45 -  1.4
  @@ -8,9 +8,9 @@
   Technical document
   
 
  -
  +  
   
  - This document describes the directory generator of Cocoon.
  +This document describes the directory generator of Cocoon.
 
 
   
  @@ -33,15 +33,16 @@
   date: the time the file was last modified in 
human-readable form.
   size: the file size (or 0 for directories).
 
  -  Furthermore the requested directory has an attribute 
requested with the value
  -  set to true. This needs not to be the root node as you will see later.
  -
  +  Additionally the node for the requested directory has an attribute 
requested
  +  with the value set to true. This node needs not to be the root node as 
you will see
  +  later.
   
   
  +  
 The src attribute on the  must 
be set to the
 directory the XML listing should be created of. This is the 
requested directory.
 
  @@ -52,11 +53,11 @@
   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.
  -dateFormat: Sets the format for the date attribute of each node, as 
described in
  +dateFormat: 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.
  -refreshDelay: Sets the delay (in seconds, default is 1) between checks 
for
  -updates on the file system.
  +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.
   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 @@
   
   
 The current directory generator may generate following xml:
  -
  +  
   
  -
  +  
   
  
  
  


cvs commit: cocoon-2.0/src/documentation/xdocs/userdocs/generators directory-generator.xml

2003-06-21 Thread joerg
joerg   2003/06/21 04:48:00

  Modified:src/documentation/xdocs/userdocs/generators
directory-generator.xml
  Log:
  updated the documentation (file size + caching)
  
  Revision  ChangesPath
  1.3   +71 -61
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.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- directory-generator.xml   31 May 2003 01:25:04 -  1.2
  +++ directory-generator.xml   21 Jun 2003 11:48:00 -  1.3
  @@ -2,95 +2,105 @@
   
   
   
  - 
  - Directory Generator
  - 0.9
  - Technical document
  - 
  - 
  -  
  -  This document describes the directory generator of 
Cocoon.
  - 
  - 
  - 
  - Generates an XML directory listing.
  -  
  -The root node of the generated document will normally be a
  -directory node, and a directory node can contain zero
  -or more file or directory nodes. A file node has 
no
  -children. Each node will contain the following attributes:
  -  
  +  
  +Directory Generator
  +0.9
  +Technical document
  +
  +  
  +
  +
  + This document describes the directory generator of Cocoon.
  +  
  +  
  +
  +  Generates an XML directory listing.
 
  -name : the name of the file or directory
  -lastModified : the time the file was last modified, measured as the 
number of
  -milliseconds since the epoch (as in java.io.File.lastModified)
  -date (optional) : the time the file was last modified in human-readable 
form
  +Name: directory
  +Class: org.apache.cocoon.generation.DirectoryGenerator
  +Cacheable: yes
 
  -  All generated elements have the namespace
  -http://apache.org/cocoon/directory/2.0.
  -The root directory
  -node has the attribute requested with the value 
true.
  +  The root node of the generated document will normally be a 
directory node. A
  +  directory node can contain zero or more file or 
directory nodes.
  +  A file node has no children. All generated elements have the namespace
  +  http://apache.org/cocoon/directory/2.0.
 
  +  Each node will contain the following attributes:
 
  -Name : directory
  -Class: org.apache.cocoon.generation.DirectoryGenerator
  -Cacheable: no.
  +name: the name of the file or directory.
  +lastModified: the time the file was last modified, 
measured as the number
  +of milliseconds since the epoch (as in 
java.io.File.lastModified).
  +date: the time the file was last modified in 
human-readable form.
  +size: the file size (or 0 for directories).
 
  +  Furthermore the requested directory has an attribute 
requested with the value
  +  set to true. This needs not to be the root node as you will see later.
   
  - 
  +
   
  -  The following parameter can be specified in the pipeline for 
  - the generate command:
  +  The src attribute on the  must 
be set to the
  +  directory the XML listing should be created of. This is the 
requested directory.
  +  
  +  The following parameter are all optional and can be specified in the 
pipeline for the
  +  generate command (as seen in the example above for the parameter 
depth):
 
 
  -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.
  -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.
  -root (optional) : The root pattern
  -include (optional) : The include pattern
  -exclude (optional) : The exclude pattern
  +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.
  +dateFormat: 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.
  +refreshDelay: Sets the delay (in seconds, default is 1) between checks 
for
  +updates on the