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 @@ <!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]"/> - </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 + <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 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> -]]></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> + date CDATA #IMPLIED + size CDATA #IMPLIED> ]]></source> - </s1> -</body> + </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> </document> 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 @@ <s1 title="Error Generator"> <p> The error generator creates xml content describing an error condition. - This generator is activated by the sitemap manager in case of an - error condition. - </p> - <p> - 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. </p> <ul> <li>Name : !error-notifier!</li> @@ -32,43 +28,43 @@ </s1> <s1 title="DTD"> <p> - The error generator generates xml content, having - namespace <code>http://apache.org/cocoon/error/2.0</code>, and - prefix <code>error</code>. + XML generated by error generator uses the + namespace <code>http://apache.org/cocoon/error/2.0</code> and + the <code>error</code> prefix. </p> <p> - 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. </p> <ul> <li> - The element <code>notify</code> is the root element, having. - attribute <code>type</code>, and <code>sender</code>. + The element <code>notify</code> is the root element, having + attributes <code>type</code> and <code>sender</code>. The attribute <code>type</code> has fixed value <code>error</code>. The attribute <code>sender</code> 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 <code>org.apache.cocoon.sitemap.ErrorNotifier</code>. </li> <li> - The element <code>title</code> stores some title of this eror notification. - In the current implementation it has fixed value <code>Cocoon error</code>. + The element <code>title</code> stores the title of the eror notification. + In the current implementation, it has fixed value <code>Cocoon error</code>. </li> <li> - The source element stores the class name of the throwable object + The <code>source</code> element stores the class name of the throwable object of the error notification. </li> <li> - The message element stores the <code>getMessage()</code> result - of the throwable object of the error notification, and maybe empty. + The <code>message</code> element stores the <code>getMessage()</code> result + of the throwable object of the error notification, and may be empty. </li> <li> - The description element stores the <code>toString()</code> result + The <code>description</code> element stores the <code>toString()</code> result of the throwable object of the error notification. </li> <li> - The optional extra elements stores optional nested exceptions + Optional <code>extra</code> elements stores nested exceptions of the throwable object of the error notification. </li> </ul> 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 @@ <body> <s1 title="File Generator"> <p>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.</p> + While url generator may appear to be a more suitable name, it's known as the file generator for historical reasons.</p> <p>The file generator is the default generator.</p> <ul> <li>Name : file</li> @@ -30,7 +30,7 @@ ]]> </source> <p> - You can use an absolute filesystem pathname. See explanation of + You can use an absolute filesystem pathname. See the explanation of <link href="../concepts/sitemap.html#file-url">file: URLs</link> </p> </s1> 1.1.2.1 +10 -7 xml-cocoon2/src/documentation/xdocs/userdocs/generators/generators.xml Index: generators.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/generators.xml,v retrieving revision 1.1 retrieving revision 1.1.2.1 diff -u -r1.1 -r1.1.2.1 --- generators.xml 3 Jan 2002 12:31:04 -0000 1.1 +++ generators.xml 7 Jun 2002 19:59:47 -0000 1.1.2.1 @@ -9,19 +9,22 @@ <authors> <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/> </authors> - <abstract>This document describes all available generators of Cocoon.</abstract> + <abstract>This document describes all of the available generators of Cocoon.</abstract> </header> <body> <s1 title="Goal"> - <p>This document lists all available generators of Apache Cocoon and + <p>This document lists all of the available generators of Apache Cocoon and describes their purpose.</p> </s1> <s1 title="Overview"> - <p>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 <link href="../concepts/sitemap.html">the sitemap</link>. - </p> + <p>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. + </p> + <p> +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. + </p> + <p> +For conceptual information on generators see the user's guide document <link href="../concepts/sitemap.html">The Sitemap</link>. + </p> </s1> <s1 title="The Generators in Apache Cocoon"> <ul> 1.2.2.1 +1 -1 xml-cocoon2/src/documentation/xdocs/userdocs/generators/jsp-generator.xml Index: jsp-generator.xml =================================================================== RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/jsp-generator.xml,v retrieving revision 1.2 retrieving revision 1.2.2.1 diff -u -r1.2 -r1.2.2.1 --- jsp-generator.xml 5 Feb 2002 01:46:44 -0000 1.2 +++ jsp-generator.xml 7 Jun 2002 19:59:47 -0000 1.2.2.1 @@ -39,7 +39,7 @@ select the appropriate JSPEngine component. The default is a JSPEngine working with Tomcat's JSP servlet engine Jasper. You may override the cocoon.roles by your own my.roles, as described - in the <link href="../../faq.html">FAQs</link>. + in the <link href="../../faq/index.html">FAQs</link>. </p> <p>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: [EMAIL PROTECTED] To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]