You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by cz...@apache.org on 2001/07/16 16:41:18 UTC

cvs commit: xml-cocoon2/xdocs directory-generator.xml imagedirectory-generator.xml

cziegeler    01/07/16 07:41:18

  Modified:    webapp   Tag: cocoon_20_branch sitemap.xmap
               xdocs    Tag: cocoon_20_branch directory-generator.xml
                        imagedirectory-generator.xml
  Log:
  Added missing image directory generartor and added docs for directory and image directory generator
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.11.2.21 +1 -0      xml-cocoon2/webapp/sitemap.xmap
  
  Index: sitemap.xmap
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/webapp/sitemap.xmap,v
  retrieving revision 1.11.2.20
  retrieving revision 1.11.2.21
  diff -u -r1.11.2.20 -r1.11.2.21
  --- sitemap.xmap	2001/07/16 13:23:35	1.11.2.20
  +++ sitemap.xmap	2001/07/16 14:41:18	1.11.2.21
  @@ -9,6 +9,7 @@
     <map:generators default="file">
      <map:generator  name="file"        src="org.apache.cocoon.generation.FileGenerator" label="content"/>
      <map:generator  name="directory"   src="org.apache.cocoon.generation.DirectoryGenerator" label="content"/>
  +   <map:generator  name="imagedirectory"   src="org.apache.cocoon.generation.ImageDirectoryGenerator" label="content"/>
      <map:generator  name="serverpages" src="org.apache.cocoon.generation.ServerPagesGenerator" label="content"/>
      <map:generator  name="request"     src="org.apache.cocoon.generation.RequestGenerator"/>
      <map:generator  name="status"      src="org.apache.cocoon.generation.StatusGenerator"/>
  
  
  
  No                   revision
  
  
  No                   revision
  
  
  1.1.2.3   +3 -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.1.2.2
  retrieving revision 1.1.2.3
  diff -u -r1.1.2.2 -r1.1.2.3
  --- directory-generator.xml	2001/07/16 14:13:13	1.1.2.2
  +++ directory-generator.xml	2001/07/16 14:41:18	1.1.2.3
  @@ -26,7 +26,8 @@
         <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>
  +         <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>
  @@ -42,7 +43,7 @@
   <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
  +<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
  
  
  
  1.1.2.2   +38 -4     xml-cocoon2/xdocs/imagedirectory-generator.xml
  
  Index: imagedirectory-generator.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/imagedirectory-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
  --- imagedirectory-generator.xml	2001/07/12 21:06:27	1.1.2.1
  +++ imagedirectory-generator.xml	2001/07/16 14:41:18	1.1.2.2
  @@ -13,18 +13,52 @@
   	</header>
   	<body>
   		<s1 title="Image Directory Generator">
  -			<p>????.</p>
  +			<p>Generates an XML directory listing. This is an extension of
  +                     the <link href="directory-generator.html">Directory Generator</link>.
  +                     It checks if the contained files are images and adds their size
  +                     to the attributes.</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>
  +      <li>width (optional) : the width of the image if it is an image file</li>
  +      <li>height (optional) : the height of the image if it is an image file</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 : ????</li>
  +				<li>Name : imagedirectory</li>
   				<li>Class: org.apache.cocoon.generation.ImageDirectoryGenerator</li>
  -				<li>Cacheable: ????.</li>
  +				<li>Cacheable: no.</li>
   			</ul>
   <source>
        <![CDATA[
  -  <map:generate type="????"/>
  +  <map:generate type="imagedirectory" 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 Image 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>
   
   	</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