cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cziege...@apache.org
Subject cvs commit: xml-cocoon2/xdocs directory-generator.xml
Date Mon, 16 Jul 2001 14:12:47 GMT
cziegeler    01/07/16 07:12:47

  Modified:    xdocs    directory-generator.xml
  Log:
  Doc for DirectoryGenerator
  
  Revision  Changes    Path
  1.3       +30 -2     xml-cocoon2/xdocs/directory-generator.xml
  
  Index: directory-generator.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/directory-generator.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- directory-generator.xml	2001/07/13 09:56:21	1.2
  +++ directory-generator.xml	2001/07/16 14:12:46	1.3
  @@ -13,7 +13,20 @@
   	</header>
   	<body>
   		<s1 title="Directory Generator">
  -			<p>????.</p>
  +			<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>.</p>
   			<ul>
   				<li>Name : directory</li>
   				<li>Class: org.apache.cocoon.generation.DirectoryGenerator</li>
  @@ -21,9 +34,24 @@
   			</ul>
   <source>
        <![CDATA[
  -  <map:generate type="directory"/>
  +  <map:generate type="directory" src="the_directory"/>
        ]]>
   </source>
   		</s1>
  +<s1 title="Configuration">
  +<p>The following parmeter can be specified in the pipeline for 
  +   the generate command:</p>
  +<ul>
  +<li>depth (optional) : Sets how deep DirectoryGenerator 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>
   </body>
   </document>
  
  
  

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


Mime
View raw message