Directory Generator

Return-Path: Delivered-To: apmail-xml-cocoon-cvs-archive@xml.apache.org Received: (qmail 29581 invoked by uid 500); 7 Jun 2002 19:59:49 -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 29572 invoked by uid 500); 7 Jun 2002 19:59:49 -0000 Delivered-To: apmail-xml-cocoon2-cvs@apache.org Date: 7 Jun 2002 19:59:48 -0000 Message-ID: <20020607195948.15915.qmail@icarus.apache.org> From: shannon@apache.org To: xml-cocoon2-cvs@apache.org Subject: cvs commit: xml-cocoon2/src/documentation/xdocs/userdocs/generators directory-generator.xml error-generator.xml file-generator.xml generators.xml jsp-generator.xml X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N shannon 2002/06/07 12:59:48 Modified: src/documentation/xdocs/userdocs/generators Tag: cocoon_2_0_3_branch directory-generator.xml error-generator.xml file-generator.xml generators.xml jsp-generator.xml Log: sync with head Revision Changes Path No revision No revision 1.1.2.1 +114 -86 xml-cocoon2/src/documentation/xdocs/userdocs/generators/directory-generator.xml Index: directory-generator.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/directory-generator.xml,v retrieving revision 1.1 retrieving revision 1.1.2.1 diff -u -r1.1 -r1.1.2.1 --- directory-generator.xml 3 Jan 2002 12:31:04 -0000 1.1 +++ directory-generator.xml 7 Jun 2002 19:59:47 -0000 1.1.2.1 @@ -2,97 +2,125 @@ -

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

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

+ + - - - + -]]> - - -

- The current directory generator may generate following xml: -

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

The current directory generator may generate following xml:

+ + + + + + ]]> + + 1.1.2.1 +19 -23 xml-cocoon2/src/documentation/xdocs/userdocs/generators/error-generator.xml Index: error-generator.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/error-generator.xml,v retrieving revision 1.1 retrieving revision 1.1.2.1 diff -u -r1.1 -r1.1.2.1 --- error-generator.xml 3 Jan 2002 12:31:04 -0000 1.1 +++ error-generator.xml 7 Jun 2002 19:59:47 -0000 1.1.2.1 @@ -15,13 +15,9 @@

The error generator creates xml content describing an error condition. - This generator is activated by the sitemap manager in case of an - error condition. -

- If a pipeline has defined an error handler, and an error occurs the - sitemap manager activates an error generator, feeding the cause of - the error into the error generator. + When an error occurs in a pipeline with a defined an error handler, the + sitemap manager activates the error generator, feeding it the cause of + the error.

Name : !error-notifier!

- The error generator generates xml content, having - namespace http://apache.org/cocoon/error/2.0, and - prefix error. + XML generated by error generator uses the + namespace http://apache.org/cocoon/error/2.0 and + the error prefix.

- Usually the error condition is described by an throwable object. + Usually the error condition is described by a throwable object. The information of this throwable object is used by the - error generator producing the xml content. - The various elements of the xml content: + error generator to produce the xml content. + The various elements of the xml content include the following.

- The element notify is the root element, having. - attribute type, and sender. + The element notify is the root element, having + attributes type and sender. The attribute type has fixed value error. The attribute sender describes the sender of the - error notification object, in the current implementation it has + error notification object. In the current implementation, it has fixed value org.apache.cocoon.sitemap.ErrorNotifier.
- The element title stores some title of this eror notification. - In the current implementation it has fixed value Cocoon error. + The element title stores the title of the eror notification. + In the current implementation, it has fixed value Cocoon error.
- The source element stores the class name of the throwable object + The source element stores the class name of the throwable object of the error notification.
- The message element stores the getMessage() result - of the throwable object of the error notification, and maybe empty. + The message element stores the getMessage() result + of the throwable object of the error notification, and may be empty.
- The description element stores the toString() result + The description element stores the toString() result of the throwable object of the error notification.
- The optional extra elements stores optional nested exceptions + Optional extra elements stores nested exceptions of the throwable object of the error notification.

1.1.2.2 +2 -2 xml-cocoon2/src/documentation/xdocs/userdocs/generators/file-generator.xml Index: file-generator.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/file-generator.xml,v retrieving revision 1.1.2.1 retrieving revision 1.1.2.2 diff -u -r1.1.2.1 -r1.1.2.2 --- file-generator.xml 17 May 2002 05:03:09 -0000 1.1.2.1 +++ file-generator.xml 7 Jun 2002 19:59:47 -0000 1.1.2.2 @@ -14,7 +14,7 @@

The file generator reads an xml document from the local file system or from any url. - Therefore it could better be named url generator, but the name has historical reasons.

+ While url generator may appear to be a more suitable name, it's known as the file generator for historical reasons.

The file generator is the default generator.

Name : file

- You can use an absolute filesystem pathname. See explanation of + You can use an absolute filesystem pathname. See the explanation of file: URLs

This document describes all available generators of Cocoon.

This document describes all of the available generators of Cocoon.

This document lists all available generators of Apache Cocoon and +

This document lists all of the available generators of Apache Cocoon and describes their purpose.

A generator is the starting point of an xml pipeline. It generates XML - content as SAX events and initialize the pipeline processing. - For more information on generators - see the sitemap. -

A generator is the starting point of an xml pipeline. It generates XML content as SAX events and initializes pipeline processing. Every pipeline match containing a generator must be terminated by a serializer. +

+In the sitemap file, each generator has a unique name which is mapped to a java class. One generator name must be declared as the default generator. Each generator may have additional configuration information specified in child elements. +

+For conceptual information on generators see the user's guide document The Sitemap. +

The JSPEngine component of Tomcat's JSPEngine is implemented in JSPEngineImpl. If you want to use another JSPEngine component, you may specify it in a my.roles file. ---------------------------------------------------------------------- In case of troubles, e-mail: webmaster@xml.apache.org To unsubscribe, e-mail: cocoon-cvs-unsubscribe@xml.apache.org For additional commands, e-mail: cocoon-cvs-help@xml.apache.org