cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jo...@apache.org
Subject cvs commit: cocoon-2.1/src/documentation/xdocs/userdocs/generators imagedirectory-generator.xml
Date Thu, 03 Jul 2003 22:17:21 GMT
joerg       2003/07/03 15:17:21

  Modified:    src/documentation/xdocs/userdocs/generators
                        imagedirectory-generator.xml
  Log:
  shortened the documentation to the ImageDirectoryGenerator's specific part
  
  Revision  Changes    Path
  1.2       +25 -60    cocoon-2.1/src/documentation/xdocs/userdocs/generators/imagedirectory-generator.xml
  
  Index: imagedirectory-generator.xml
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/generators/imagedirectory-generator.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- imagedirectory-generator.xml	9 Mar 2003 00:08:19 -0000	1.1
  +++ imagedirectory-generator.xml	3 Jul 2003 22:17:21 -0000	1.2
  @@ -2,64 +2,29 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd">
   
   <document>
  -	<header>
  -		<title>Image Directory Generator</title>
  -		<version>0.9</version>
  -		<type>Technical document</type>
  -		<authors>
  -			<person name="Carsten Ziegeler" email="cziegeler@apache.org"/>
  -		 </authors>
  -		 <abstract>This document describes the image directory generator of Cocoon.</abstract>
  -	</header>
  -	<body>
  -		<s1 title="Image Directory Generator">
  -			<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>
  -      <li>comment (optional) : the comment of the image if there is one inside the
image file (jpeg only)</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 : imagedirectory</li>
  -				<li>Class: org.apache.cocoon.generation.ImageDirectoryGenerator</li>
  -				<li>Cacheable: no.</li>
  -			</ul>
  -<source>
  -     <![CDATA[
  -  <map:generate type="imagedirectory" 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 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>
  +  <header>
  +    <title>Image Directory Generator</title>
  +    <version>1.0</version>
  +    <type>Technical document</type>
  +    <authors>
  +      <person name="Carsten Ziegeler" email="cziegeler@apache.org"/>
  +    </authors>
  +    <abstract>This document describes the Image Directory Generator of Cocoon.</abstract>
  +  </header>
  +  <body>
  +    <s1 title="Image Directory Generator">
  +      <p>Generates an XML directory listing. This is an extension of the
  +      	<link href="directory-generator.html">Directory Generator</link>.</p>
  +      <ul>
  +        <li>Name: imagedirectory</li>
  +        <li>Class: org.apache.cocoon.generation.ImageDirectoryGenerator</li>
  +        <li>Cacheable: yes</li>
  +      </ul>
  +      <p>The Image Directory provides all the functionality of the
  +      	<link href="directory-generator.html">Directory Generator</link>. Additionally
it
  +        checks if the files are images and adds their dimensions (<code>width</code>
  +        and <code>height</code>) to the attributes. It's configured just as
the
  +        Directory Generator.</p>
  +    </s1>
  +  </body>
   </document>
  
  
  

Mime
View raw message