Return-Path: Delivered-To: apmail-xml-cocoon-cvs-archive@xml.apache.org Received: (qmail 90394 invoked by uid 500); 31 May 2003 01:25:06 -0000 Mailing-List: contact cocoon-cvs-help@xml.apache.org; run by ezmlm Precedence: bulk Reply-To: cocoon-dev@xml.apache.org list-help: list-unsubscribe: list-post: Delivered-To: mailing list cocoon-cvs@xml.apache.org Received: (qmail 90383 invoked by uid 500); 31 May 2003 01:25:06 -0000 Delivered-To: apmail-cocoon-2.0-cvs@apache.org Received: (qmail 90378 invoked from network); 31 May 2003 01:25:06 -0000 Received: from icarus.apache.org (208.185.179.13) by daedalus.apache.org with SMTP; 31 May 2003 01:25:06 -0000 Received: (qmail 57926 invoked by uid 1672); 31 May 2003 01:25:04 -0000 Date: 31 May 2003 01:25:04 -0000 Message-ID: <20030531012504.57924.qmail@icarus.apache.org> From: joerg@apache.org To: cocoon-2.0-cvs@apache.org Subject: cvs commit: cocoon-2.0/src/documentation/xdocs/userdocs/transformers transformers.xml augment-transformer.xml textparser-transformer.xml X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N 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 @@ -
- 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: -

-
    -
  • 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)
    • -
  • size : the file size in bytes (as returned by - java.io.File.length)
    • -
  • date (optional) : the time the file was last modified in - human-readable form
    • -
-

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 - sort order is described by the attribute sort, - which defaults to sorting according to name. -

-
    -
  • Name : directory
    • -
  • Class: org.apache.cocoon.generation.DirectoryGenerator
    • -
  • Cacheable: no.
    • -
- ]]> - - -

The following parameter can be specified in the pipeline for the - generate command: -

-
    -
  • 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. This is a regular - expression as described - here.
    • -
  • include (optional) : The include pattern. Also a - regular expression.
    • -
  • exclude (optional) : The exclude pattern. Also a - regular expression.
    • -
  • sort (optional) : This parameter determines the order in - which the file and directory 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.
    • -
  • reverse (optional) : This parameter reverses the sort order. - reverse="false" is the default.
    • -
- - -

XML generated by directory generator uses namespace - http://apache.org/cocoon/status/2.0. The DTD - of XML generated by directory generator: -

- - + 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: +

+
    +
  • 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
    • +
+

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. +

+
    +
  • Name : directory
    • +
  • Class: org.apache.cocoon.generation.DirectoryGenerator
    • +
  • Cacheable: no.
    • +
+ +]]> + + +

The following parameter can be specified in the pipeline for + the generate command: +

+
    +
  • 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
    • +
+ + +

XML generated by directory generator uses namespace + http://apache.org/cocoon/status/2.0. The DTD + of XML generated by directory generator: +

+ + - - - + + date CDATA #IMPLIED> +]]> + + +

+ The current directory generator may generate following xml: +

+ + + + + ]]> - - -

The current directory generator may generate following xml:

- - - - - - ]]> - - + + 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 @@
    +
  • Directory Generator
  • File Generator (The default generator)
    • +
  • Fragment Extractor Generator
  • HTML Generator (optional)
    • -
  • Directory Generator
  • Image Directory Generator
    • -
  • Fragment Extractor Generator
  • JSP Generator
    • +
  • MP3 Directory Generator
    • +
  • PHP Generator (optional)
    • +
  • Request Generator
  • Script Generator
    • +
  • Search Generator
  • Server Pages Generator
    • -
  • Velocity Generator
    • -
  • Request Generator
  • Status Generator
  • Stream Generator
    • -
  • Profile Generator
    • -
  • Error Generator
    • -
  • Search Generator
    • -
  • LinkStatus Generator
    • -
  • Php Generator (optional)
    • -
  • XML:DB Generator (optional)
    • +
  • Velocity Generator
  • XML:DB Collection Generator (optional)
    • -
  • Text Parser Generator
    • +
  • XML:DB Generator (optional)
 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 @@
  • CInclude Transformer
  • EncodeURL Transformer
  • SourceWriting Transformer
    • -
  • Augment Transformer
  • XT Transformer (optional)
  • LDAP Transformer (optional)
    • -
  • Text Parser Transformer