cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hu...@apache.org
Subject cvs commit: xml-cocoon2/src/documentation/xdocs/userdocs/serializers svgtiff-serializer.xml book.xml serializers.xml svg-serializer.xml svgjpeg-serializer.xml svgpng-serializer.xml
Date Mon, 23 Dec 2002 22:40:15 GMT
huber       2002/12/23 14:40:15

  Modified:    src/documentation/xdocs/userdocs/serializers book.xml
                        serializers.xml svg-serializer.xml
                        svgjpeg-serializer.xml svgpng-serializer.xml
  Added:       src/documentation/xdocs/userdocs/serializers
                        svgtiff-serializer.xml
  Log:
  Update SVG Serializer, SVG JPEG, and SVG PNG documentation, added
  SVG TIFF documentation in the serializer user documentation section.
  
  Revision  Changes    Path
  1.4       +1 -0      xml-cocoon2/src/documentation/xdocs/userdocs/serializers/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/serializers/book.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- book.xml	31 Oct 2002 16:48:55 -0000	1.3
  +++ book.xml	23 Dec 2002 22:40:14 -0000	1.4
  @@ -24,6 +24,7 @@
       <menu-item label="SVG/XML Serializer" href="svgxml-serializer.html"/>
       <menu-item label="SVG/JPEG Serializer" href="svgjpeg-serializer.html"/>
       <menu-item label="SVG/PNG Serializer" href="svgpng-serializer.html"/>
  +    <menu-item label="SVG/TIFF Serializer" href="svgtiff-serializer.html"/>
       <menu-item label="VRML Serializer" href="vrml-serializer.html"/>
       <menu-item label="Link Serializer" href="link-serializer.html"/>
       <menu-item label="Zip archive Serializer" href="ziparchive-serializer.html"/>
  
  
  
  1.4       +3 -1      xml-cocoon2/src/documentation/xdocs/userdocs/serializers/serializers.xml
  
  Index: serializers.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/serializers/serializers.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- serializers.xml	30 May 2002 17:50:21 -0000	1.3
  +++ serializers.xml	23 Dec 2002 22:40:14 -0000	1.4
  @@ -32,7 +32,7 @@
   				<li><link href="html-serializer.html">HTML Serializer</link> (The
default serializer)</li>
   				<li><link href="xml-serializer.html">XML Serializer</link></li>
   				<li><link href="text-serializer.html">Text Serializer</link></li>
  -                                                                <li><link href="xls-serializer.html">HSSF
(XLS) Serializer</link> (optional)</li>
  +                                <li><link href="xls-serializer.html">HSSF (XLS)
Serializer</link> (optional)</li>
   				<li><link href="pdf-serializer.html">PDF Serializer</link> (optional)</li>
   				<li><link href="ps-serializer.html">PS Serializer</link> (optional)</li>
   				<li><link href="pcl-serializer.html">PCL Serializer</link> (optional)</li>
  @@ -41,9 +41,11 @@
   				<li><link href="svgxml-serializer.html">SVG/XML Serializer</link></li>
   				<li><link href="svgjpeg-serializer.html">SVG/JPEG Serializer</link></li>
   				<li><link href="svgpng-serializer.html">SVG/PNG Serializer</link></li>
  +				<li><link href="svgtiff-serializer.html">SVG/TIFF Serializer</link></li>
   				<li><link href="vrml-serializer.html">VRML Serializer</link></li>
   				<li><link href="link-serializer.html">Link Serializer</link></li>
   			</ul>
   		</s1>
   	</body>
   </document>
  +
  
  
  
  1.2       +147 -93   xml-cocoon2/src/documentation/xdocs/userdocs/serializers/svg-serializer.xml
  
  Index: svg-serializer.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/serializers/svg-serializer.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- svg-serializer.xml	3 Jan 2002 12:31:05 -0000	1.1
  +++ svg-serializer.xml	23 Dec 2002 22:40:14 -0000	1.2
  @@ -2,54 +2,59 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd">
   
   <document>
  -	<header>
  -		<title>The SVG Serializer</title>
  -		<authors>
  -			<person name="Ross Burton" email="rossb@apache.org"/>
  -		</authors>
  -	</header>
  -	
  -	<body>
  -		<s1 title="SVG Serializer">
  -			<s2 title="Introduction">
  -				<p>
  -					The SVG Serializer is an advanced serializer which accepts
  -					valid Scalable Vector Graphic documents (currently to the
  -					2000-08-02 Candidate Recommendation specification) and
  -					renders it to an image which is served just like any other
  -					document in Cocoon.
  -				</p>
  -				<p>
  -					Why would you want to do this? Well, charts can be produced from the
  -					same data which generates tables, graphical images with text labels
  -					all following a standard theme can be generated or normal pages can be
  -					beautified.
  -				</p>
  -				<note>
  -					For examples of this serializer, see the Cocoon welcome
  -					page in the distribution (<code>[cocoon
  -					root]/welcome</code>).
  -				</note>
  -				<p>
  -					So how does this serializer work?
  -				</p>
  -				<ol>
  -					<li>Parse and validate SVG document</li>
  -					<li>Call Batik's <code>Transcoder</code> to encode this image as
an image file, and return it to the user.</li>
  -				</ol>
  -			</s2>
  -
  -			<s2 title="Usage">
  -				<p>The best way to explain how this serializer works is to show some examples.</p>
  -				<s3 title="Basic Example">
  -					<p>This is a basic example of the serializer.</p>
  -					<source><![CDATA[
  +  <header>
  +  <title>The SVG Serializer</title>
  +  <authors>
  +    <person name="Ross Burton" email="rossb@apache.org"/>
  +  </authors>
  +  </header>
  +  
  +  <body>
  +    <s1 title="SVG Serializer">
  +      <s2 title="Introduction">
  +        <p>
  +          The SVG Serializer is an advanced serializer which accepts
  +          valid Scalable Vector Graphic documents (currently to the
  +          2000-08-02 Candidate Recommendation specification) and
  +          renders it to an image which is served just like any other
  +          document in Cocoon.
  +        </p>
  +        <p>
  +          Why would you want to do this? Well, charts can be produced from the
  +          same data which generates tables, graphical images with text labels
  +          all following a standard theme can be generated or normal pages can be
  +          beautified.
  +        </p>
  +        <note>
  +          For examples of this serializer, see the Cocoon welcome
  +          page in the distribution (<code>[cocoon
  +          root]/welcome</code>).
  +        </note>
  +        <p>
  +          So how does this serializer work?
  +        </p>
  +        <ol>
  +          <li>Parse and validate SVG document</li>
  +          <li>Call Batik's <code>Transcoder</code> to encode this image
as an image file, and return it to the user.</li>
  +        </ol>
  +        <p>
  +          The SVG xml document must have a root element &lt;svg&gt;, using xml
namespace
  +          it is recommended to use the prefix <em>em</em>, and the namespace
uri
  +          <em>http://www.w3.org/2000/svg</em>.
  +        </p>
  +      </s2>
  +  
  +      <s2 title="Usage">
  +        <p>The best way to explain how this serializer works is to show some examples.</p>
  +        <s3 title="Basic Example">
  +          <p>This is a basic example of the serializer.</p>
  +          <source><![CDATA[
   <map:serializers>
     <map:serializer>
       <map:serializer name="svg2jpeg" mime-type="image/jpeg" 
  -                    src="org.apache.cocoon.serialization.SVGSerializer">
  +        src="org.apache.cocoon.serialization.SVGSerializer">
         <parameter name="transcoder" 
  -                 value="org.apache.batik.transcoder.image.JPEGTranscoder"/>
  +          value="org.apache.batik.transcoder.image.JPEGTranscoder"/>
     </map:serializer>
   <map:serializers>
   ...
  @@ -59,27 +64,39 @@
       <map:serialize type="svg2jpeg"/>
     </map:match>	
   </map:pipeline>
  -						]]></source>
  -					<p>
  -						When the resource <code>sample.jpeg</code> is requested, a SAX event
  -						stream is generated from the file <code>sample.svg</code>, which is
  -						serialized using the <code>svg2jpeg</code> serializer. This
  -						serializer is configured to use a specific transcoder. The MIME type
  -						is specified so that Cocoon can tell the client which type the
  -						document is. It can be seen that in general the use of this
  -						serializer is identical to that of the other serializers.
  -					</p>
  -				</s3>
  -
  -				<s3 title="Advanced Example">
  -					<p>This is a more advanced sample of using the SVG Serializer.</p>
  -					<source><![CDATA[
  +       ]]></source>
  +          <p>
  +            When the resource <code>sample.jpeg</code> is requested, a SAX
event
  +            stream is generated from the file <code>sample.svg</code>, which
is
  +            serialized using the <code>svg2jpeg</code> serializer. This
  +            serializer is configured to use a specific transcoder. The MIME type
  +            is specified so that Cocoon can tell the client which type the
  +            document is. It can be seen that in general the use of this
  +            serializer is identical to that of the other serializers.
  +          </p>
  +          <p>
  +            The parameter <em>transcoder</em> selects explicitly a batik transcoder.
  +            You may want to rely on the default <em>mime-type</em> to 
  +            transcoder association, omitting the transcoder parameter
  +          </p>
  +          <table>
  +            <tr><th>mime-type</th><th>transcoder-class</th></tr>
  +            <tr><td>image/jpeg</td><td>org.apache.batik.transcoder.image.JPEGTranscoder</td></tr>
  +            <tr><td>image/jpg</td><td>org.apache.batik.transcoder.image.JPEGTranscoder</td></tr>
  +            <tr><td>image/png</td><td>org.apache.batik.transcoder.image.PNGTranscoder</td></tr>
  +            <tr><td>image/tiff</td><td>org.apache.batik.transcoder.image.TIFFTranscoder</td></tr>
  +          </table>
  +        </s3>
  +        
  +        <s3 title="Advanced Example">
  +          <p>This is a more advanced sample of using the SVG Serializer.</p>
  +          <source><![CDATA[
   <map:serializers>
     <map:serializer>
       <map:serializer name="svg2jpeg" mime-type="image/jpeg" 
  -                    src="org.apache.cocoon.serialization.SVGSerializer">
  +        src="org.apache.cocoon.serialization.SVGSerializer">
         <parameter name="transcoder" 
  -                 value="org.apache.batik.transcoder.image.JPEGTranscoder"/>
  +          value="org.apache.batik.transcoder.image.JPEGTranscoder"/>
         <parameter name="background_color" type="color" value="#00FF00"/>
     </map:serializer>
   <map:serializers>
  @@ -90,36 +107,73 @@
       <map:serialize type="svg2jpeg"/>
     </map:match>	
   </map:pipeline>
  -						]]></source>
  -					<p>
  -						In this example another parameter is given to the serializer,
  -						<code>background_color</code>. This parameter is passed to the
  -						transcoder. The <code>type</code> argument specifies the type of
  -						data to convert the <code>value</code> to. In this example the
  -						string "#00FF00" is converted to a <code>Color</code> object, which
  -						is passed to the transcoder as the background colour to
  -						use.
  -					</p>
  -					<p>
  -						For a list of the parameters available for each transcoder, refer to
  -						the Batik API docs.
  -					</p>
  -					<fixme author="rossb@apache.org">
  -						Create a document summarising the transcoder hints
  -					</fixme>
  -					<p>
  -						For this to work reliably with any transcoder, some magic must be
  -						done. First, the parameter name is transformed to upper-case and then "KEY_" is
  -						prepended. This is to match the internal naming scheme of the hints
  -						in the Batik <code>Transcoder</code> interfaces. This name is then
  -						looked up via Reflection to ensure it is a valid parameter on the
  -						specified transcoder. Then the value is converted to the type
  -						specified in the <code>type</code> attribute (currently supported
  -						types are string, float, integer, boolean and color) and passed to
  -						the transcoder.
  -					</p>
  -				</s3>
  -			</s2>
  -		</s1>
  -	</body>
  +       ]]></source>
  +          <p>
  +            In this example another parameter is given to the serializer,
  +            <code>background_color</code>. This parameter is passed to the
  +            transcoder. The <code>type</code> argument specifies the type of
  +            data to convert the <code>value</code> to. In this example the
  +            string "#00FF00" is converted to a <code>Color</code> object, which
  +            is passed to the transcoder as the background colour to
  +            use.
  +          </p>
  +          <p>
  +            For a list of the parameters available for each transcoder, refer to
  +            the Batik API docs.
  +          </p>
  +          <fixme author="rossb@apache.org">
  +                  Create a document summarising the transcoder hints
  +          </fixme>
  +          <p>
  +            The following table summarizes most useful general SVG ImageTranscoder parameters,
  +            all of these parameters are mapped to Batik's SVG ImageTranscoder hints.
  +          </p>
  +          <table>
  +            <tr><td>width</td><td>float</td><td>Specifies
the width of the rasterized image explictly.
  +              If no height is specified the aspect ratio is kept.</td>
  +            </tr>
  +            <tr><td>height</td><td>float</td><td>Specifies
the width of the rasterized image explictly.
  +              If no width is specified the aspect ration is kept.</td>
  +            </tr>
  +            <tr><td>background_color</td><td>color</td><td>
  +              Defines the background color
  +              to use for opaque image formats, or the background color that may
  +              be used for image formats that support alpha channel.
  +              A color value of format <code>RRGGBB</code>, 
  +              or <code>#RRGGBB</code> sets the background color of the rasterized
image, by default
  +              the background color is white.</td>
  +            </tr>
  +            <tr><td>language</td><td>string</td><td>to
set the default language to use 
  +              (may be used by a &lt;switch&gt; SVG element for example), by default
language is
  +              set to <code>en</code>.</td>
  +            </tr>
  +            <tr><td>user_stylesheet_ur</td><td>string</td><td>to
fix the URI of a user stylesheet</td>
  +            </tr>
  +            <tr><td>pixel_to_mm</td><td>float</td><td>to
specify the pixel to millimeter conversion factor, by default
  +              its value is <code>0.264583</code> (96dpi).</td>
  +            </tr>
  +          </table>
  +          <p>
  +            For this to work reliably with any transcoder, some magic must be
  +            done.
  +          </p>
  +          <ol>
  +            <li>First, the parameter name is transformed to upper-case and then "KEY_"
is
  +            prepended. This is to match the internal naming scheme of the hints
  +            in the Batik <code>Transcoder</code> interfaces.
  +            </li>
  +            <li>This name is then
  +            looked up via Reflection to ensure it is a valid parameter on the
  +            specified transcoder.
  +            </li>
  +            <li>Then the value is converted to the type
  +            specified in the <code>type</code> attribute (currently supported
  +            types are string, float, integer, boolean and color) and passed to
  +            the transcoder.
  +            </li>
  +          </ol>
  +      </s3>
  +    </s2>
  +  </s1>
  +</body>
   </document>
  
  
  
  1.2       +82 -19    xml-cocoon2/src/documentation/xdocs/userdocs/serializers/svgjpeg-serializer.xml
  
  Index: svgjpeg-serializer.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/serializers/svgjpeg-serializer.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- svgjpeg-serializer.xml	3 Jan 2002 12:31:05 -0000	1.1
  +++ svgjpeg-serializer.xml	23 Dec 2002 22:40:14 -0000	1.2
  @@ -2,23 +2,86 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd">
   
   <document>
  -	<header>
  -		<title>SVG/JPEG Serializer</title>
  -		<version>0.9</version>
  -		<type>Technical document</type>
  -		<authors>
  -			<person name="Carsten Ziegeler" email="cziegeler@apache.org"/>
  -		 </authors>
  -		 <abstract>This document describes the svg/jpeg serializer of Cocoon.</abstract>
  -	</header>
  -	<body>
  -		<s1 title="SVG/JPEG Serializer">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : svg2jpeg</li>
  -				<li>Class: org.apache.cocoon.serialization.SVGSerializer</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -		</s1>
  -	</body>
  +  <header>
  +    <title>SVG/JPEG Serializer</title>
  +    <version>0.9</version>
  +    <type>Technical document</type>
  +    <authors>
  +      <person name="Carsten Ziegeler" email="cziegeler@apache.org"/>
  +      <person name="Bernhard Huber" email="huber@apache.org"/>
  +    </authors>
  +    <abstract>This document describes the svg/jpeg serializer of Cocoon.</abstract>
  +  </header>
  +  <body>
  +  <s1 title="SVG/JPEG Serializer">
  +    <p>
  +      The SVG/JPEG serializes an xml svg document to a jpeg image.
  +      The serialization uses the Batik's JPEGTranscoder internally.
  +    </p>
  +    <ul>
  +      <li>Name : svg2jpeg</li>
  +      <li>Class: org.apache.cocoon.serialization.SVGSerializer</li>
  +      <li>Cacheable: yes</li>
  +    </ul>
  +    <s2 title="Sitemap Configuration">
  +      <p>
  +        A minimal sitemap configuration snippet declaring the svg2jpeg serializer:
  +      </p>
  +      <source><![CDATA[
  +<map:serializers..
  +  <map:serializer name="svg2jpeg"
  +    src="org.apache.cocoon.serialization.SVGSerializer"
  +    mime-type="image/jpeg"
  +    logger="sitemap.serializer.svg2jpeg"
  +  >
  +  </map:serializer>
  +]]></source>
  +      <p>
  +        A sitemap pipeline snippet using the svg2jpeg serializer:
  +      </p>
  +      <source><![CDATA[
  +<map:match pattern="svg/*.jpg">
  +  <map:generate src="docs/samples/svg/{1}.svg"/>
  +  <map:serialize type="svg2jpeg"/>
  +</map:match>
  +]]></source>
  +      <p>
  +        In the declaration section of the svg2jpeg a number of parameters can be specified.
  +        The following snippet set the background color explicitly:
  +      </p>
  +      <source><![CDATA[
  +<map:serializers..
  +  <map:serializer name="svg2jpeg"
  +    src="org.apache.cocoon.serialization.SVGSerializer"
  +    mime-type="image/jpeg"
  +    logger="sitemap.serializer.svg2jpeg"
  +  >
  +    <parameter name="background_color" type="color" value="#ff00ff"/>
  +  </map:serializer>
  +]]></source>
  +    </s2>
  +    <s2 title="JPEGTranscoder Parameters">
  +      <p>
  +        General ImageTranscoder parameters are described
  +        at the <link href="svg-serializer.html">SVG Serializer</link> user
documentation.
  +      </p>
  +      <p>
  +        The following section presents JPEGTranscoder specific parameters configurable
for the JPEGTranscoder.
  +      </p>
  +      <table>
  +        <tr><th>Parameter</th><th>Type</th><th>Comment</th></tr>
  +        <tr><td>quality</td><td>float</td><td>Specifies
the JPEG quality as value between 0.0 and 1.0,
  +          1.0 specifies highest quality. Usually a value of 0.9 is choosen.</td>
  +        </tr>
  +      </table>
  +    </s2>
  +    <s2 title="Further Reading">
  +      <p>
  +        Further details about JPEGTranscoder, ImageTranscoder is available 
  +        at <link href="http://xml.apache.org/batik">Batik</link>.
  +      </p>
  +    </s2>
  +  </s1>
  +  </body>
   </document>
  +
  
  
  
  1.2       +93 -19    xml-cocoon2/src/documentation/xdocs/userdocs/serializers/svgpng-serializer.xml
  
  Index: svgpng-serializer.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/serializers/svgpng-serializer.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- svgpng-serializer.xml	3 Jan 2002 12:31:05 -0000	1.1
  +++ svgpng-serializer.xml	23 Dec 2002 22:40:14 -0000	1.2
  @@ -2,23 +2,97 @@
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd">
   
   <document>
  -	<header>
  -		<title>SVG/PNG Serializer</title>
  -		<version>0.9</version>
  -		<type>Technical document</type>
  -		<authors>
  -			<person name="Carsten Ziegeler" email="cziegeler@apache.org"/>
  -		 </authors>
  -		 <abstract>This document describes the svg/png serializer of Cocoon.</abstract>
  -	</header>
  -	<body>
  -		<s1 title="SVG/PNG Serializer">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : svg2png</li>
  -				<li>Class: org.apache.cocoon.serialization.SVGSerializer</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -		</s1>
  -	</body>
  +  <header>
  +    <title>SVG/PNG Serializer</title>
  +    <version>0.9</version>
  +    <type>Technical document</type>
  +    <authors>
  +      <person name="Carsten Ziegeler" email="cziegeler@apache.org"/>
  +      <person name="Bernhard Huber" email="huber@apache.org"/>
  +    </authors>
  +    <abstract>This document describes the svg/png serializer of Cocoon.</abstract>
  +  </header>
  +  <body>
  +  <s1 title="SVG/PNG Serializer">
  +    <p>
  +      The SVG/PNG serializes an xml svg document to a png image.
  +      The serialization uses the Batik's PNGTranscoder internally.
  +    </p>
  +    <ul>
  +      <li>Name : svg2png</li>
  +      <li>Class: org.apache.cocoon.serialization.SVGSerializer</li>
  +      <li>Cacheable: yes</li>
  +    </ul>
  +    <s2 title="Sitemap Configuration">
  +      <p>
  +        A minimal sitemap configuration snippet declaring the svg2png serializer:
  +      </p>
  +      <source><![CDATA[
  +<map:serializers..
  +  <map:serializer name="svg2png"
  +    src="org.apache.cocoon.serialization.SVGSerializer"
  +    mime-type="image/png"
  +    logger="sitemap.serializer.svg2png"
  +  >
  +  </map:serializer>
  +]]></source>
  +      <p>
  +        A sitemap pipeline snippet using the svg2png serializer:
  +      </p>
  +      <source><![CDATA[
  +<map:match pattern="svg/*.png">
  +  <map:generate src="docs/samples/svg/{1}.svg"/>
  +  <map:serialize type="svg2png"/>
  +</map:match>
  +]]></source>
  +      <p>
  +        In the declaration section of the svg2png a number of parameters can be specified.
  +        The following snippet set the background color explicitly:
  +      </p>
  +      <source><![CDATA[
  +<map:serializers..
  +  <map:serializer name="svg2png"
  +    src="org.apache.cocoon.serialization.SVGSerializer"
  +    mime-type="image/png"
  +    logger="sitemap.serializer.svg2png"
  +  >
  +    <parameter name="background_color" type="color" value="#ff00ff"/>
  +  </map:serializer>
  +]]></source>
  +    </s2>
  +    <s2 title="PNGTranscoder Parameters">
  +      <p>
  +        General ImageTranscoder parameters are described
  +        at the <link href="svg-serializer.html">SVG Serializer</link> user
documentation.
  +      </p>
  +      <p>
  +        The following section presents PNGTranscoder specific parameters configurable 
  +        for the PNGTranscoder.
  +      </p>
  +      <table>
  +        <tr><th>Parameter</th><th>Type</th><th>Comment</th></tr>
  +        <tr><td>force_transparent_white</td><td>boolean</td><td>It
controls whether the encoder should
  +          force the image's fully transparent pixels to be fully transparent
  +          white instead of fully transparent black.  This is usefull when the
  +          encoded PNG is displayed in a browser which does not support PNG
  +          transparency and lets the image display with a white background instead
  +          of a black background. <br /> However, note that the modified image
  +          will display differently over a white background in a viewer that
  +          supports transparency.</td>
  +        </tr>
  +        <tr><td>gamma</td><td>float</td><td>Controls
the gamma correction of the png image;
  +          by default its value is approx <code>2.22</code>.
  +          </td>
  +        </tr>
  +      </table>
  +    </s2>
  +    <s2 title="Further Reading">
  +      <p>
  +        Further details about PNGTranscoder, ImageTranscoder is available 
  +        at <link href="http://xml.apache.org/batik">Batik</link>.
  +      </p>
  +    </s2>
  +  </s1>
  +  </body>
   </document>
  +
  
  
  
  1.1                  xml-cocoon2/src/documentation/xdocs/userdocs/serializers/svgtiff-serializer.xml
  
  Index: svgtiff-serializer.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "../../dtd/document-v10.dtd">
  
  <document>
    <header>
      <title>SVG/TIFF Serializer</title>
      <version>0.9</version>
      <type>Technical document</type>
      <authors>
        <person name="Carsten Ziegeler" email="cziegeler@apache.org"/>
        <person name="Bernhard Huber" email="huber@apache.org"/>
      </authors>
      <abstract>This document describes the svg/tiff serializer of Cocoon.</abstract>
    </header>
    <body>
    <s1 title="SVG/TIFF Serializer">
      <p>
        The SVG/TIFF serializes an xml svg document to a tiff image.
        The serialization uses the Batik's TIFFTranscoder internally.
      </p>
      <ul>
        <li>Name : svg2tiff</li>
        <li>Class: org.apache.cocoon.serialization.SVGSerializer</li>
        <li>Cacheable: yes</li>
      </ul>
      <s2 title="Sitemap Configuration">
        <p>
          A minimal sitemap configuration snippet declaring the svg2tiff serializer:
        </p>
        <source><![CDATA[
  <map:serializers..
    <map:serializer name="svg2tiff"
      src="org.apache.cocoon.serialization.SVGSerializer"
      mime-type="image/tiff"
      logger="sitemap.serializer.svg2tiff"
    >
    </map:serializer>
  ]]></source>
        <p>
          A sitemap pipeline snippet using the svg2tiff serializer:
        </p>
        <source><![CDATA[
  <map:match pattern="svg/*.tiff">
    <map:generate src="docs/samples/svg/{1}.svg"/>
    <map:serialize type="svg2tiff"/>
  </map:match>
  ]]></source>
        <p>
          In the declaration section of the svg2tiff a number of parameters can be specified.
          The following snippet set the background color explicitly:
        </p>
        <source><![CDATA[
  <map:serializers..
    <map:serializer name="svg2tiff"
      src="org.apache.cocoon.serialization.SVGSerializer"
      mime-type="image/tiff"
      logger="sitemap.serializer.svg2tiff"
    >
      <parameter name="background_color" type="color" value="#ff00ff"/>
    </map:serializer>
  ]]></source>
      </s2>
      <s2 title="TIFFTranscoder Parameters">
        <p>
          General ImageTranscoder parameters are described
          at the <link href="svg-serializer.html">SVG Serializer</link> user documentation.
        </p>
        <p>
          The following section presents TIFFTranscoder specific parameters configurable 
          for the TIFFTranscoder.
        </p>
        <table>
          <tr><th>Parameter</th><th>Type</th><th>Comment</th></tr>
  	<tr><td>force_transparent_white</td><td>boolean</td><td>It
controls whether the encoder should
            force the image's fully transparent pixels to be fully transparent
            white instead of fully transparent black.  This is usefull when the
            encoded TIFF is displayed in a viewer which does not support TIFF
            transparency and lets the image display with a white background instead
            of a black background.
            However, note that the modified image will display differently
            over a white background in a viewer that supports
            transparency.</td>
          </tr>
       </table>
      </s2>
      <s2 title="Further Reading">
        <p>
          Further details about TIFFTranscoder, ImageTranscoder is available 
          at <link href="http://xml.apache.org/batik">Batik</link>.
        </p>
      </s2>
    </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