cvs commit: cocoon-2.1/src/documentation/xdocs/userdocs/readers image-reader.xml

[cr...@apache.org]

crossley    2004/03/20 20:01:08

  Modified:    src/documentation/xdocs/userdocs/readers image-reader.xml
  Log:
  Fix some incorrect comments and examples.
  Add notes about missing parameter descriptions:
   grayscale
   scale(Red|Green|Blue)
   offset(Red|Green|Blue)
  
  Revision  Changes    Path
  1.6       +50 -13    cocoon-2.1/src/documentation/xdocs/userdocs/readers/image-reader.xml
  
  Index: image-reader.xml
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/readers/image-reader.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- image-reader.xml	6 Mar 2004 02:25:39 -0000	1.5
  +++ image-reader.xml	21 Mar 2004 04:01:08 -0000	1.6
  @@ -73,9 +73,9 @@
             pipeline snippet below:
           </p>
           <source><![CDATA[
  -<map:match pattern="*.png">
  +<map:match pattern="*.jpg">
     <map:read type="image" 
  -    src="resources/styles/{1}.css" 
  +    src="resources/images/{1}.jpg" 
       mime-type="image/jpeg">
       <!-- optional setup parameters -->
     </map:read>
  @@ -113,42 +113,77 @@
         <s2 title="Sitemap Parameters">
           <p>
             The <code>ImageReader</code> accepts following sitemap
  -          setup parameters
  +          setup parameters:
           </p>
           <table>
             <tr><th>Parameter Name</th><th>Type</th><th>Comment</th></tr>
  -          <tr><td>expires</td><td>Time in milliseconds</td>
  +          <tr>
  +            <td>expires</td>
  +            <td>Time in milliseconds</td>
               <td>
                 This parameter is optional. When specified it determines how long
                 in miliseconds the resources can be cached by any proxy or browser
                 between Cocoon2 and the requesting visitor.
               </td>
             </tr>
  -          <tr><td>width</td><td>Image width in pixels</td>
  +          <tr>
  +            <td>width</td>
  +            <td>Image width in pixels</td>
               <td>
  -              This parameter is optional. When specified it determines the width
  -              of the binary image.
  +              This parameter is optional. When specified it determines the
  +              width of the binary image.
                 If no height parameter is specified the aspect ratio
                 of the image is kept.
               </td>
             </tr>
  -          <tr><td>height</td><td>Image height in pixels</td>
  +          <tr>
  +            <td>height</td>
  +            <td>Image height in pixels</td>
               <td>
  -              This parameter is optional. When specified it determines the width
  -              of the binary image.
  +              This parameter is optional. When specified it determines the
  +              height of the binary image.
                 If no width parameter is specified the aspect ratio
                 of the image is kept.
               </td>
             </tr>
  -          <tr><td>allow-enlarging</td><td>Allow or prevent the enlarging of images</td>
  +          <tr>
  +            <td>allow-enlarging</td>
  +            <td>Allow or prevent the enlarging of images</td>
               <td>
                 This parameter is optional. The <code>width</code> and <code>height</code> parameters allow an image 
                 to be resized. By default, if the image is smaller than the specified 
                 width and height, the image will be enlarged. In some circumstances, this
                 behaviour is undesirable, and can be switched off by setting this parameter
  -              to <code>no</code>. With this parameter set to <code>no</code>, images will 
  +              to "<code>no</code>". With this parameter set to "<code>no</code>", images will 
                 be reduced in size, but not enlarged. The default for this parameter is 
  -              <code>yes</code>.
  +              "<code>yes</code>".
  +            </td>
  +          </tr>
  +          <tr>
  +            <td>grayscale</td>
  +            <td>Render the colour as a scale of gray.</td>
  +            <td>
  +              This parameter is optional. When specified and set to true it
  +              will cause each image pixel to be normalized.
  +              The default for this parameter is "<code>false</code>".
  +            </td>
  +          </tr>
  +          <tr>
  +            <td>scale(Red|Green|Blue)</td>
  +            <td>Scale the RGB colour components by a multiplication factor.</td>
  +            <td>
  +              These parameters are optional. When specified it will cause the
  +              specified color component in the image to be multiplied by the
  +              specified floating point value.
  +            </td>
  +          </tr>
  +          <tr>
  +            <td>offset(Red|Green|Blue)</td>
  +            <td>Scale the RGB colour components by an increment.</td>
  +            <td>
  +              These parameters are optional. When specified it will cause the
  +              specified color component in the image to be incremented by the
  +              specified floating point value.
               </td>
             </tr>
           </table>
  @@ -189,6 +224,8 @@
           1.2.x and 1.3.x on all OS!), <code>ImageReader</code> must buffer 
           the JPEG generation to avoid that connection resetting by the peer 
           (user pressing the stop button, for example) crashes the entire JVM. 
  +        This is evidently fixed in Sun JVM 1.3.1_04 however our workaround
  +        remains for JVM less than 1.4
         </p>
       </s1>
       <s1 title="History">