crossley 2002/12/27 23:06:53
Modified: . Tag: cocoon_2_0_3_branch changes.xml
src/documentation/xdocs/userdocs Tag: cocoon_2_0_3_branch
book.xml
src/documentation/xdocs/userdocs/serializers Tag:
cocoon_2_0_3_branch book.xml html-serializer.xml
serializers.xml svg-serializer.xml
svgjpeg-serializer.xml svgpng-serializer.xml
svgxml-serializer.xml text-serializer.xml
wap-serializer.xml xml-serializer.xml
Added: src/documentation/xdocs/userdocs/readers Tag:
cocoon_2_0_3_branch axisrpc-reader.xml book.xml
byterangeresource-reader.xml database-reader.xml
directoryziparchiver-reader.xml image-reader.xml
jsp-reader.xml readers.xml resource-reader.xml
template-reader.xml
Log:
Sync with new docs from head.
Revision Changes Path
No revision
No revision
1.138.2.81 +9 -1 xml-cocoon2/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/changes.xml,v
retrieving revision 1.138.2.80
retrieving revision 1.138.2.81
diff -u -r1.138.2.80 -r1.138.2.81
--- changes.xml 23 Dec 2002 08:21:59 -0000 1.138.2.80
+++ changes.xml 28 Dec 2002 07:06:51 -0000 1.138.2.81
@@ -40,6 +40,14 @@
</devs>
<release version="@version@" date="@date@">
+ <action dev="BH" type="update">
+ Update XML Serializer, HTML Serializer , and Text Serializer documentation,
+ added XHTML Serializer documentation in the serializer user documentation
section.
+ </action>
+ <action dev="BH" type="update">
+ Update SVG Serializer, SVG JPEG, and SVG PNG documentation, added
+ SVG TIFF documentation in the serializer user documentation section.
+ </action>
<action dev="DC" type="update">
Fixed "build test" (was missing tools/lib/excalibur-testcase-1.0.jar).
The Junit tests now work again.
No revision
No revision
1.1.2.1 +1 -0 xml-cocoon2/src/documentation/xdocs/userdocs/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/book.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- book.xml 3 Jan 2002 12:31:04 -0000 1.1
+++ book.xml 28 Dec 2002 07:06:51 -0000 1.1.2.1
@@ -20,6 +20,7 @@
<menu-item label="Matchers" href="matchers/matchers.html"/>
<menu-item label="Selectors" href="selectors/selectors.html"/>
<menu-item label="Actions" href="actions/actions.html"/>
+ <menu-item label="Readers" href="readers/readers.html"/>
<menu-item label="XSP" href="xsp/index.html"/>
</menu>
No revision
No revision
1.1.2.1 +0 -0
xml-cocoon2/src/documentation/xdocs/userdocs/readers/axisrpc-reader.xml
Index: axisrpc-reader.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/readers/axisrpc-reader.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
1.1.2.1 +0 -0 xml-cocoon2/src/documentation/xdocs/userdocs/readers/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/readers/book.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
1.1.2.1 +0 -0
xml-cocoon2/src/documentation/xdocs/userdocs/readers/byterangeresource-reader.xml
Index: byterangeresource-reader.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/readers/byterangeresource-reader.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
1.1.2.1 +0 -0
xml-cocoon2/src/documentation/xdocs/userdocs/readers/database-reader.xml
Index: database-reader.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/readers/database-reader.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
1.1.2.1 +0 -0
xml-cocoon2/src/documentation/xdocs/userdocs/readers/directoryziparchiver-reader.xml
Index: directoryziparchiver-reader.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/readers/directoryziparchiver-reader.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
1.1.2.1 +0 -0
xml-cocoon2/src/documentation/xdocs/userdocs/readers/image-reader.xml
Index: image-reader.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/readers/image-reader.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
1.1.2.1 +0 -0
xml-cocoon2/src/documentation/xdocs/userdocs/readers/jsp-reader.xml
Index: jsp-reader.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/readers/jsp-reader.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
1.1.2.1 +0 -0 xml-cocoon2/src/documentation/xdocs/userdocs/readers/readers.xml
Index: readers.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/readers/readers.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
1.1.2.1 +0 -0
xml-cocoon2/src/documentation/xdocs/userdocs/readers/resource-reader.xml
Index: resource-reader.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/readers/resource-reader.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
1.1.2.1 +0 -0
xml-cocoon2/src/documentation/xdocs/userdocs/readers/template-reader.xml
Index: template-reader.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/readers/template-reader.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
No revision
No revision
1.1.2.3 +4 -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.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- book.xml 31 Oct 2002 16:22:49 -0000 1.1.2.2
+++ book.xml 28 Dec 2002 07:06:52 -0000 1.1.2.3
@@ -17,6 +17,9 @@
<menu-item label="HTML Serializer" href="html-serializer.html"/>
</menu>
<menu label="Core">
+<!--
+ <menu-item label="XHTML Serializer" href="xhtml-serializer.html"/>
+-->
<menu-item label="XML Serializer" href="xml-serializer.html"/>
<menu-item label="Text Serializer" href="text-serializer.html"/>
<menu-item label="WAP/WML Serializer" href="wap-serializer.html"/>
@@ -24,6 +27,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.1.2.1 +232 -20
xml-cocoon2/src/documentation/xdocs/userdocs/serializers/html-serializer.xml
Index: html-serializer.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/serializers/html-serializer.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- html-serializer.xml 3 Jan 2002 12:31:05 -0000 1.1
+++ html-serializer.xml 28 Dec 2002 07:06:52 -0000 1.1.2.1
@@ -1,25 +1,237 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"../../dtd/document-v10.dtd">
+<!--
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd";>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN"
"http://www.w3.org/TR/REC-html40/frameset.dtd";>
+
+-->
+
<document>
- <header>
- <title>HTML Serializer</title>
- <version>0.9</version>
- <type>Technical document</type>
- <authors>
- <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
- </authors>
- <abstract>This document describes the html serializer of
Cocoon.</abstract>
- </header>
- <body>
- <s1 title="HTML Serializer">
- <p>The html serializer serializes xhtml into valid html.</p>
- <p>The html serializer is the default serializer .</p>
- <ul>
- <li>Name : html</li>
- <li>Class:
org.apache.cocoon.serialization.HtmlSerializer</li>
- <li>Cacheable: yes.</li>
- </ul>
- </s1>
- </body>
+ <header>
+ <title>HTML Serializer</title>
+ <version>0.9</version>
+ <type>Technical document</type>
+ <authors>
+ <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
+ <person name="Bernhard Huber" email="[EMAIL PROTECTED]"/>
+ </authors>
+ <abstract>This document describes the html serializer of Cocoon.</abstract>
+ </header>
+ <body>
+ <s1 title="HTML Serializer">
+ <p>
+ The HTML serializer serializes xml content to html.
+ It is the default serializer.
+ </p>
+ <ul>
+ <li>Name : html</li>
+ <li>Class: org.apache.cocoon.serialization.HtmlSerializer</li>
+ <li>Cacheable: yes.</li>
+ </ul>
+ <s2 title="Sitemap Configuration">
+ <p>
+ The HTML Serializer is declared in the sitemap serializers section.
+ </p>
+ <source><![CDATA[
+<map:serializers default="html">
+...
+ <map:serializer name="html"
+ src="org.apache.cocoon.serialization.HTMLSerializer"
+ mime-type="text/html"
+ logger="sitemap.serializer.html"
+ pool-grow="4" pool-max="32" pool-min="4">
+ <!-- serializer configurations -->
+...
+ </map:serializer>
+...
+ ]]></source>
+ <p>
+ HTML Serializer can be configured, specifying elements inside of
+ the <map:serializer> body.
+ </p>
+ <s3 title="Configuration Example">
+ <p>
+ The following HTML Serializer snippet is setting
+ doctype, and encoding configuration for the HTML Serializer
+ </p>
+ <source><![CDATA[
+<map:serializer name="html"
+ src="org.apache.cocoon.serialization.HTMLSerializer"
+ mime-type="text/html">
+ <doctype-public>-//W3C//DTD HTML 4.01 Transitional//EN</doctype-public>
+ <encoding>ISO-8859-1</encoding>
+</map:serializer>
+ ]]></source>
+ <p>
+ This configuration will result in HTML output of the form
+ </p>
+ <source><![CDATA[
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title...
+...
+ ]]></source>
+ </s3>
+ <p>
+ The HTML Serializer accepts following configuration parameters.
+ These configurations are not Xalan specific.
+ </p>
+<!--
+# XSLT properties do not need namespace qualification.
+method=xml
+indent=yes
+media-type=text/html
+version=4.0
+
+# Xalan-specific output properties. These can be overridden in the stylesheet
+# assigning a xalan namespace. For example:
+# <xsl:stylesheet version="1.0"
+# xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
+# xmlns:xalan="http://xml.apache.org/xslt";>
+# <xsl:output method="html" encoding="UTF-8"
+# xalan:content-handler="MyContentHandler"/>
+# ...
+# Note that the colon after the protocol needs to be escaped.
+{http\u003a//xml.apache.org/xslt}indent-amount=0
+{http\u003a//xml.apache.org/xslt}content-handler=org.apache.xalan.serialize.SerializerToHTML
+{http\u003a//xml.apache.org/xslt}entities=HTMLEntities.res
+{http\u003a//xml.apache.org/xslt}use-url-escaping=yes
+-->
+ <table>
+ <tr><th>Name</th><th>Xalan Default Value</th><th>Comment</th></tr>
+ <tr><td>cdata-section-elements</td>
+ <td>none</td>
+ <td><code>cdata-section-elements</code> specifies a whitespace delimited
+ list of the names of elements whose text node children should be
output
+ using CDATA sections.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation.</link>
+ </td>
+ </tr>
+ <tr><td>doctype-public</td>
+ <td>none</td>
+ <td><code>doctype-public</code> specifies the public identifier
+ to be used in the document type declaration.
+ </td>
+ </tr>
+ <tr><td>doctype-system</td>
+ <td>none</td>
+ <td>
+ <code>doctype-system</code> specifies the system identifier
+ to be used in the document type declaration.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ <tr><td>encoding</td>
+ <td>none</td>
+ <td><code>encoding</code> specifies the preferred character
+ encoding that the Transformer should use to encode sequences of
+ characters as sequences of bytes. The value of the attribute should be
+ treated case-insensitively. The value must only contain characters in
+ the range #x21 to #x7E (i.e., printable ASCII characters). The value
+ should either be a <code>charset</code> registered with the Internet
+ Assigned Numbers Authority <link href="#IANA">[IANA]</link>,
+ <link href="#RFC2278">[RFC2278]</link> or start with <code>X-</code>.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ <tr><td>indent</td>
+ <td>
+ yes
+ </td>
+ <td>
+ A Flag for toggling indent. This flag toggles only if some elements
+ should trigger a line break.
+ </td>
+ </tr>
+ <tr><td>media-type</td>
+ <td>
+ </td>
+ <td>
+ <code>media-type</code> specifies the media type (MIME
+ content type) of the data that results from outputting the result
+ tree. The <code>charset</code> parameter should not be specified
+ explicitly; instead, when the top-level media type is
+ <code>text</code>, a <code>charset</code> parameter should be added
+ according to the character encoding actually used by the output
+ method.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ <tr><td>method</td>
+ <td>
+ </td>
+ <td>
+ The method attribute identifies the overall method that
+ should be used for outputting the result tree. Other non-namespaced
+ values may be used, such as "xhtml", but, if accepted, the handling
+ of such values is implementation defined. If any of the method values
+ are not accepted and are not namespace qualified,
+ then {@link javax.xml.transform.Transformer#setOutputProperty}
+ or {@link javax.xml.transform.Transformer#setOutputProperties} will
+ throw a {@link java.lang.IllegalArgumentException}.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ <tr><td>omit-xml-declaration</td>
+ <td></td>
+ <td>
+ <code>omit-xml-declaration</code> specifies whether the XSLT
+ processor should output an XML declaration; the value must be
+ <code>yes</code> or <code>no</code>.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ <tr><td>standalone</td>
+ <td></td>
+ <td>
+ <code>standalone</code> specifies whether the Transformer
+ should output a standalone document declaration; the value must be
+ <code>yes</code> or <code>no</code>.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ <tr><td>version</td>
+ <td>
+ </td>
+ <td>
+ <code>version</code> specifies the version of the output
+ method.
+ When the output method is "xml", the version value specifies the
+ version of XML to be used for outputting the result tree. The default
+ value for the xml output method is 1.0. When the output method is
+ "html", the version value indicates the version of the HTML.
+ The default value for the xml output method is 4.0, which specifies
+ that the result should be output as HTML conforming to the HTML 4.0
+ Recommendation [HTML]. If the output method is "text", the version
+ property is ignored.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ </table>
+ <note>
+ Former property <code>buffer-size</code> is deprecated, and is ignored.
+ </note>
+ <p>
+ The HTML Serializer sets the <code>method</code> property
+ to <code>html</code>.
+ </p>
+ </s2>
+ <s2 title="Pipeline Usage">
+ <source><![CDATA[
+...
+<map:match pattern="*.html">
+<map:generate...
+...
+<map:serialize type="html"/>
+...
+ ]]></source>
+ </s2>
+ <s2 title="Further Reading">
+ </s2>
+ </s1>
+ </body>
</document>
+
1.1.2.2 +59 -44
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.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- serializers.xml 7 Jun 2002 19:58:28 -0000 1.1.2.1
+++ serializers.xml 28 Dec 2002 07:06:52 -0000 1.1.2.2
@@ -2,48 +2,63 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"../../dtd/document-v10.dtd">
<document>
- <header>
- <title>Serializers</title>
- <version>0.9</version>
- <type>Technical document</type>
- <authors>
- <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
- </authors>
- <abstract>This document describes all of the available serializers of
Cocoon.</abstract>
- </header>
- <body>
- <s1 title="Goal">
- <p>This document lists all of the available serializers of
Apache Cocoon and
- describes their purpose.</p>
- </s1>
- <s1 title="Overview">
- <p>
-A serializer is the end point of an xml pipeline. It transforms SAX events into
binary or char streams for final client consumption. Every pipeline match containing a
generator must be terminated by a serializer.
- </p>
- <p>
-In the sitemap file, each serializer has a unique name which is mapped to a java
class. One serializer name must be declared as the default serialzer. Each serializer
may have additional configuration information specified in child elements.
- </p>
- <p>
- For more conceptual information about serializers see <link
href="../concepts/sitemap.html">the sitemap</link>.
- </p>
- </s1>
- <s1 title="The Serializers in Apache Cocoon">
- <ul>
- <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="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>
- <li><link href="wap-serializer.html">WAP/WML
Serializer</link></li>
- <li><link href="svg-serializer.html">SVG
Serializer</link></li>
- <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="vrml-serializer.html">VRML
Serializer</link></li>
- <li><link href="link-serializer.html">Link
Serializer</link></li>
- </ul>
- </s1>
- </body>
+ <header>
+ <title>Serializers</title>
+ <version>0.9</version>
+ <type>Technical document</type>
+ <authors>
+ <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
+ <person name="Bernhard Huber" email="[EMAIL PROTECTED]"/>
+ </authors>
+ <abstract>This document describes all of the available serializers of
Cocoon.</abstract>
+ </header>
+ <body>
+ <s1 title="Goal">
+ <p>
+ This document lists all of the available serializers of Apache Cocoon and
+ describes their purpose.
+ </p>
+ </s1>
+ <s1 title="Overview">
+ <p>
+ A serializer is the end point of an xml pipeline.
+ It transforms SAX events into binary or char streams for
+ final client consumption.
+ Every pipeline match containing a generator must be terminated
+ by a serializer.
+ </p>
+ <p>
+ In the sitemap file, each serializer has a unique name which
+ is mapped to a java class.
+ One serializer name must be declared as the default serialzer.
+ Each serializer may have additional configuration information
+ specified in child elements.
+ </p>
+ <p>
+ For more conceptual information about serializers
+ see <link href="../concepts/sitemap.html">the sitemap</link>.
+ </p>
+ </s1>
+ <s1 title="The Serializers in Apache Cocoon">
+ <ul>
+ <li><link href="html-serializer.html">HTML Serializer</link> (The default
serializer)</li>
+ <li><link href="xhtml-serializer.html">XHTML Serializer</link></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="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>
+ <li><link href="wap-serializer.html">WAP/WML Serializer</link></li>
+ <li><link href="svg-serializer.html">SVG Serializer</link></li>
+ <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.1.2.1 +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.1.2.1
diff -u -r1.1 -r1.1.2.1
--- svg-serializer.xml 3 Jan 2002 12:31:05 -0000 1.1
+++ svg-serializer.xml 28 Dec 2002 07:06:52 -0000 1.1.2.1
@@ -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="[EMAIL PROTECTED]"/>
- </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="[EMAIL PROTECTED]"/>
+ </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 <svg>, 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="[EMAIL PROTECTED]">
- 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="[EMAIL PROTECTED]">
+ 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 <switch> 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.1.2.1 +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.1.2.1
diff -u -r1.1 -r1.1.2.1
--- svgjpeg-serializer.xml 3 Jan 2002 12:31:05 -0000 1.1
+++ svgjpeg-serializer.xml 28 Dec 2002 07:06:52 -0000 1.1.2.1
@@ -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="[EMAIL PROTECTED]"/>
- </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="[EMAIL PROTECTED]"/>
+ <person name="Bernhard Huber" email="[EMAIL PROTECTED]"/>
+ </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.1.2.1 +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.1.2.1
diff -u -r1.1 -r1.1.2.1
--- svgpng-serializer.xml 3 Jan 2002 12:31:05 -0000 1.1
+++ svgpng-serializer.xml 28 Dec 2002 07:06:52 -0000 1.1.2.1
@@ -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="[EMAIL PROTECTED]"/>
- </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="[EMAIL PROTECTED]"/>
+ <person name="Bernhard Huber" email="[EMAIL PROTECTED]"/>
+ </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.2.1 +85 -19
xml-cocoon2/src/documentation/xdocs/userdocs/serializers/svgxml-serializer.xml
Index: svgxml-serializer.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/serializers/svgxml-serializer.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- svgxml-serializer.xml 3 Jan 2002 12:31:05 -0000 1.1
+++ svgxml-serializer.xml 28 Dec 2002 07:06:52 -0000 1.1.2.1
@@ -2,23 +2,89 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"../../dtd/document-v10.dtd">
<document>
- <header>
- <title>SVG/XML Serializer</title>
- <version>0.9</version>
- <type>Technical document</type>
- <authors>
- <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
- </authors>
- <abstract>This document describes the svg/xml serializer of
Cocoon.</abstract>
- </header>
- <body>
- <s1 title="SVG/XML Serializer">
- <p>????.</p>
- <ul>
- <li>Name : svgxml</li>
- <li>Class:
org.apache.cocoon.serialization.XMLSerializer</li>
- <li>Cacheable: ????.</li>
- </ul>
- </s1>
- </body>
+ <header>
+ <title>SVG/XML Serializer</title>
+ <version>0.9</version>
+ <type>Technical document</type>
+ <authors>
+ <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
+ <person name="Bernhard Huber" email="[EMAIL PROTECTED]"/>
+ </authors>
+ <abstract>This document describes the svg/xml serializer of Cocoon.</abstract>
+ </header>
+ <body>
+ <s1 title="SVG/XML Serializer">
+ <p>
+ The SVG serializer serializes sax events to SVG XML.
+ The output of the SVG serializer is SVG XML; the SVG XML is not
+ rasterized to any image format by this serializer.
+ </p>
+ <ul>
+ <li>Name : svgxml</li>
+ <li>Class: org.apache.cocoon.serialization.XMLSerializer</li>
+ <li>Cacheable: yes</li>
+ </ul>
+ <s2 title="Sitemap Configuration">
+ <p>
+ The SVG XML serializer is declared in the sitemap serializers section.
+ </p>
+ <source><![CDATA[
+<map:serializers ...
+...
+ <map:serializer name="xml"
+ src="org.apache.cocoon.serialization.XMLSerializer"
+ mime-type="text/xml"
+ doctype-public="-//W3C//DTD SVG 1.0//EN"
+ doctype-system="http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd";;
+ logger="sitemap.serializer.xml"
+ pool-grow="4" pool-max="32" pool-min="4">
+ <!-- serializer configurations -->
+...
+ </map:serializer>
+...
+ ]]></source>
+ <p>
+ The declaration of the SVG serializer shall use following
+ XML serializer configuration parameters
+ </p>
+ <table>
+ <tr><th>Name</th><th>Value</th><th>Comment</th></tr>
+ <tr><td>doctype-public</td><td>-//W3C//DTD SVG 1.0//EN</td>
+ <td>specifies the SVG XML public document type</td>
+ </tr>
+
<tr><td>doctype-system</td><td>http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd</td>
+ <td>specifies the SVG XML system document type</td>
+ </tr>
+ <tr><td>mime-type</td><td>text/xml</td>
+ <td>Following mime-type may be used, too:
+ <code>image/svg+xml</code>, <code>application/xml</code>.
+ The mime-type <code>text/xml</code> is the most general one.
+ </td>
+ </tr>
+ </table>
+ </s2>
+ <s2 title="Pipeline Usage">
+ <p>
+ Using the SVG XML serializer in a pipeline is just setting the
+ serializer type to svgxml. The following code snippet uses the svxml
serializer:
+ </p>
+ <source><![CDATA[
+<map:match pattern="svg">
+...
+ <map:serialize type="svgxml"/>
+</map:match>
+...
+ ]]></source>
+ </s2>
+ <s2 title="Further Reading">
+ <p>
+ As SVG serializer uses the XML serializer internally, you might
+ want to read the complete list of valid XML configuration parameters.
+ It is available at <link href="xml-serializer.html">XML serializer</link>
+ user documentation.
+ </p>
+ </s2>
+ </s1>
+ </body>
</document>
+
1.1.2.1 +68 -19
xml-cocoon2/src/documentation/xdocs/userdocs/serializers/text-serializer.xml
Index: text-serializer.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/serializers/text-serializer.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- text-serializer.xml 3 Jan 2002 12:31:05 -0000 1.1
+++ text-serializer.xml 28 Dec 2002 07:06:52 -0000 1.1.2.1
@@ -2,23 +2,72 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"../../dtd/document-v10.dtd">
<document>
- <header>
- <title>Text Serializer</title>
- <version>0.9</version>
- <type>Technical document</type>
- <authors>
- <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
- </authors>
- <abstract>This document describes the text serializer of
Cocoon.</abstract>
- </header>
- <body>
- <s1 title="Text Serializer">
- <p>????.</p>
- <ul>
- <li>Name : text</li>
- <li>Class:
org.apache.cocoon.serialization.TextSerializer</li>
- <li>Cacheable: yes.</li>
- </ul>
- </s1>
- </body>
+<header>
+ <title>Text Serializer</title>
+ <version>0.9</version>
+ <type>Technical document</type>
+ <authors>
+ <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
+ <person name="Bernhard Huber" email="[EMAIL PROTECTED]"/>
+ </authors>
+ <abstract>This document describes the text serializer of Cocoon.</abstract>
+</header>
+<body>
+ <s1 title="Text Serializer">
+ <p>
+ The Text serializer serializes xml into plain text..
+ </p>
+ <ul>
+ <li>Name : text</li>
+ <li>Class: org.apache.cocoon.serialization.TextSerializer</li>
+ <li>Cacheable: yes.</li>
+ </ul>
+ <s2 title="Sitemap Configuration">
+ <p>
+ The text Serializer is declared in the sitemap serializers section.
+ </p>
+ <source><![CDATA[
+<map:serializers...
+...
+ <map:serializer name="text"
+ src="org.apache.cocoon.serialization.TextSerializer"
+ mime-type="text/plain"
+ logger="sitemap.serializer.text"
+ />
+...
+ ]]></source>
+ <p>
+ The text Serializer sets the <code>method</code> property
+ to <code>text</code>.
+ </p>
+ </s2>
+ <s2 title="Pipeline Usage">
+ <p>
+ Using the text Serializer in a pipeline is just setting the
+ serializer type to text.
+ The following code snippet uses the text Serializer:
+ </p>
+ <source><![CDATA[
+...
+<map:match pattern="announcement.txt">
+<map:generate...
+...
+<map:serialize type="text"/>
+...
+ ]]></source>
+ <p>
+ The pipeline snippet above serializes the SAX events of the
+ announcment document resource to plain text.
+ </p>
+ </s2>
+ <s2 title="Further Reading">
+ <p>
+ As text Serializer uses the XML serializer internally, you might
+ want to read the complete list of valid XML configuration parameters.
+ It is available at <link href="xml-serializer.html">XML serializer</link>
+ user docuementation.
+ </p>
+ </s2>
+ </s1>
+</body>
</document>
1.1.2.1 +80 -19
xml-cocoon2/src/documentation/xdocs/userdocs/serializers/wap-serializer.xml
Index: wap-serializer.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/serializers/wap-serializer.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- wap-serializer.xml 3 Jan 2002 12:31:05 -0000 1.1
+++ wap-serializer.xml 28 Dec 2002 07:06:52 -0000 1.1.2.1
@@ -2,23 +2,84 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"../../dtd/document-v10.dtd">
<document>
- <header>
- <title>WAP/WML Serializer</title>
- <version>0.9</version>
- <type>Technical document</type>
- <authors>
- <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
- </authors>
- <abstract>This document describes the wap/wml serializer of
Cocoon.</abstract>
- </header>
- <body>
- <s1 title="WML/WAP Serializer">
- <p>????.</p>
- <ul>
- <li>Name : wap</li>
- <li>Class:
org.apache.cocoon.serialization.XMLSerializer</li>
- <li>Cacheable: yes.</li>
- </ul>
- </s1>
- </body>
+ <header>
+ <title>WML Serializer</title>
+ <version>0.9</version>
+ <type>Technical document</type>
+ <authors>
+ <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
+ <person name="Bernhard Huber" email="[EMAIL PROTECTED]"/>
+ </authors>
+ <abstract>This document describes the WML serializer of Cocoon.</abstract>
+ </header>
+ <body>
+ <s1 title="WML Serializer">
+ <p>
+ The WML serializer serializes sax events to WML.
+ The output of the WML serializer is a WML document.
+ </p>
+ <ul>
+ <li>Name : wml</li>
+ <li>Class: org.apache.cocoon.serialization.XMLSerializer</li>
+ <li>Cacheable: yes</li>
+ </ul>
+ <s2 title="Sitemap Configuration">
+ <p>
+ The WML serializer is declared in the sitemap serializers section.
+ </p>
+ <source><![CDATA[
+<map:serializers ...
+...
+ <map:serializer name="wml"
+ src="org.apache.cocoon.serialization.XMLSerializer"
+ mime-type="text/vnd.wap.wml"
+ logger="sitemap.serializer.wml">
+ <doctype-public>-//WAPFORUM//DTD WML 1.1//EN</doctype-public>
+ <doctype-system>http://www.wapforum.org/DTD/wml_1.1.xml</doctype-system>
+ </map:serializer>
+...
+ ]]></source>
+ <p>
+ The declaration of the WML serializer shall use following
+ XML serializer configuration parameters
+ </p>
+ <table>
+ <tr><th>Name</th><th>Value</th><th>Comment</th></tr>
+ <tr><td>doctype-public</td><td>-//WAPFORUM//DTD WML 1.1//EN</td>
+ <td>specifies the WML public document type</td>
+ </tr>
+ <tr><td>doctype-system</td><td>http://www.wapforum.org/DTD/wml_1.1.xml</td>
+ <td>specifies the WML system document type</td>
+ </tr>
+ <tr><td>mime-type</td><td>text/vnd.wap.wml</td>
+ <td>specifies mime-type of the serialized WML document.
+ </td>
+ </tr>
+ </table>
+ </s2>
+ <s2 title="Pipeline Usage">
+ <p>
+ Using the WML Serializer in a pipeline is just setting the
+ serializer type to wml.
+ The following code snippet uses the WML Serializer:
+ </p>
+ <source><![CDATA[
+<map:match pattern="*.wml">
+...
+ <map:serialize type="wml"/>
+</map:match>
+...
+ ]]></source>
+ </s2>
+ <s2 title="Further Reading">
+ <p>
+ As WML serializer uses the XML serializer internally, you might
+ want to read the complete list of valid XML configuration parameters.
+ It is available at <link href="xml-serializer.html">XML serializer</link>
+ user docuementation.
+ </p>
+ </s2>
+ </s1>
+ </body>
</document>
+
1.1.2.1 +258 -20
xml-cocoon2/src/documentation/xdocs/userdocs/serializers/xml-serializer.xml
Index: xml-serializer.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/serializers/xml-serializer.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- xml-serializer.xml 3 Jan 2002 12:31:05 -0000 1.1
+++ xml-serializer.xml 28 Dec 2002 07:06:52 -0000 1.1.2.1
@@ -2,24 +2,262 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"../../dtd/document-v10.dtd">
<document>
- <header>
- <title>XML Serializer</title>
- <version>0.9</version>
- <type>Technical document</type>
- <authors>
- <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
- </authors>
- <abstract>This document describes the xml serializer of
Cocoon.</abstract>
- </header>
- <body>
- <s1 title="XML Serializer">
- <p>The xml serializer is the simplest possible serializer. It
- generates an xml document from the sax events.</p>
- <ul>
- <li>Name : xml</li>
- <li>Class:
org.apache.cocoon.serialization.XMLSerializer</li>
- <li>Cacheable: yes.</li>
- </ul>
- </s1>
- </body>
+ <header>
+ <title>XML Serializer</title>
+ <version>0.9</version>
+ <type>Technical document</type>
+ <authors>
+ <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
+ <person name="Bernhard Huber" email="[EMAIL PROTECTED]"/>
+ </authors>
+ <abstract>This document describes the xml serializer of Cocoon.</abstract>
+ </header>
+ <body>
+ <s1 title="XML Serializer">
+ <p>
+ The xml serializer is the simplest possible serializer.
+ It generates an xml document from the sax events.
+ This serializer is used for serializing to any XML document
+ format, ie. SVG, WML, VRML, et. al.
+ </p>
+ <ul>
+ <li>Name : xml</li>
+ <li>Class: org.apache.cocoon.serialization.XMLSerializer</li>
+ <li>Cacheable: yes.</li>
+ </ul>
+ <s2 title="Sitemap Configuration">
+ <p>
+ The XML Serializer is declared in the sitemap serializers section.
+ </p>
+ <source><![CDATA[
+<map:serializers ...
+...
+ <map:serializer name="xml"
+ src="org.apache.cocoon.serialization.XMLSerializer"
+ mime-type="text/xml"
+ logger="sitemap.serializer.xml"
+ pool-grow="4" pool-max="32" pool-min="4">
+ <!-- serializer configurations -->
+...
+ </map:serializer>
+...
+ ]]></source>
+ <p>
+ XML Serializer can be configured, specifying elements inside of
+ the <map:serializer> body.
+ </p>
+ <s3 title="Configuration Example">
+ <p>
+ The following XML Serializer snippet is setting
+ encoding configuration for the XML Serializer
+ </p>
+ <source><![CDATA[
+<map:serializer name="xml"
+ src="org.apache.cocoon.serialization.XMLSerializer"
+ mime-type="text/xml">
+ <encoding>ISO-8859-1</encoding>
+</map:serializer>
+ ]]></source>
+ <p>
+ This configuration will result in xml output of the form
+ </p>
+ <source><![CDATA[
+<?xml version="1.0" encoding="ISO-8859-1"?>
+...
+ ]]></source>
+ </s3>
+ <p>
+ The XML Serializer accepts following configuration parameters.
+ These configurations are not Xalan specific.
+ </p>
+<!--
+#
+# Specify defaults when method="xml". These defaults serve as a base for
+# other defaults, such as output_html and output_text.
+#
+
+# XSLT properties do not need namespace qualification.
+method=xml
+version=1.0
+encoding=UTF-8
+indent=no
+omit-xml-declaration=no
+standalone=no
+media-type=text/xml
+
+# Xalan-specific output properties. These can be overridden in the stylesheet
+# assigning a xalan namespace. For example:
+# <xsl:stylesheet version="1.0"
+# xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
+# xmlns:xalan="http://xml.apache.org/xslt";>
+# <xsl:output method="html" encoding="UTF-8"
+# xalan:content-handler="MyContentHandler"/>
+# ...
+# Note that the colon after the protocol needs to be escaped.
+{http\u003a//xml.apache.org/xslt}indent-amount=0
+{http\u003a//xml.apache.org/xslt}content-handler=org.apache.xalan.serialize.SerializerToXML
+
+-->
+ <table>
+ <tr><th>Name</th><th>Xalan Default Value</th><th>Comment</th></tr>
+ <tr><td>cdata-section-elements</td>
+ <td>none</td>
+ <td><code>cdata-section-elements</code> specifies a whitespace delimited
+ list of the names of elements whose text node children should be
output
+ using CDATA sections.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation.</link>
+ </td>
+ </tr>
+ <tr><td>doctype-public</td>
+ <td>none</td>
+ <td><code>doctype-public</code> specifies the public identifier
+ to be used in the document type declaration.
+ </td>
+ </tr>
+ <tr><td>doctype-system</td>
+ <td>none</td>
+ <td>
+ <code>doctype-system</code> specifies the system identifier
+ to be used in the document type declaration.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ <tr><td>encoding</td>
+ <td>none</td>
+ <td><code>encoding</code> specifies the preferred character
+ encoding that the Transformer should use to encode sequences of
+ characters as sequences of bytes. The value of the attribute should be
+ treated case-insensitively. The value must only contain characters in
+ the range #x21 to #x7E (i.e., printable ASCII characters). The value
+ should either be a <code>charset</code> registered with the Internet
+ Assigned Numbers Authority <link href="#IANA">[IANA]</link>,
+ <link href="#RFC2278">[RFC2278]</link> or start with <code>X-</code>.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ <tr><td>indent</td>
+ <td>
+ yes
+ </td>
+ <td>
+ A Flag for toggling indent. This flag toggles only if some elements
+ should trigger a line break.
+ </td>
+ </tr>
+ <tr><td>media-type</td>
+ <td>
+ </td>
+ <td>
+ <code>media-type</code> specifies the media type (MIME
+ content type) of the data that results from outputting the result
+ tree. The <code>charset</code> parameter should not be specified
+ explicitly; instead, when the top-level media type is
+ <code>text</code>, a <code>charset</code> parameter should be added
+ according to the character encoding actually used by the output
+ method.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ <tr><td>method</td>
+ <td>
+ </td>
+ <td>
+ The method attribute identifies the overall method that
+ should be used for outputting the result tree. Other non-namespaced
+ values may be used, such as "xhtml", but, if accepted, the handling
+ of such values is implementation defined. If any of the method values
+ are not accepted and are not namespace qualified,
+ then {@link javax.xml.transform.Transformer#setOutputProperty}
+ or {@link javax.xml.transform.Transformer#setOutputProperties} will
+ throw a {@link java.lang.IllegalArgumentException}.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ <tr><td>omit-xml-declaration</td>
+ <td></td>
+ <td>
+ <code>omit-xml-declaration</code> specifies whether the XSLT
+ processor should output an XML declaration; the value must be
+ <code>yes</code> or <code>no</code>.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ <tr><td>standalone</td>
+ <td></td>
+ <td>
+ <code>standalone</code> specifies whether the Transformer
+ should output a standalone document declaration; the value must be
+ <code>yes</code> or <code>no</code>.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ <tr><td>version</td>
+ <td>
+ </td>
+ <td>
+ <code>version</code> specifies the version of the output
+ method.
+ When the output method is "xml", the version value specifies the
+ version of XML to be used for outputting the result tree. The default
+ value for the xml output method is 1.0. When the output method is
+ "html", the version value indicates the version of the HTML.
+ The default value for the xml output method is 4.0, which specifies
+ that the result should be output as HTML conforming to the HTML 4.0
+ Recommendation [HTML]. If the output method is "text", the version
+ property is ignored.
+ See <link href="http://www.w3.org/TR/xslt#output";>section 16 of the
XSL Transformations (XSLT) W3C Recommendation</link>
+ </td>
+ </tr>
+ </table>
+ <note>
+ Former property <code>buffer-size</code> is deprecated, and is ignored.
+ </note>
+ <p>
+ The XML Serializer sets the <code>method</code> property
+ to <code>xml</code>.
+ </p>
+ </s2>
+ <s2 title="Pipeline Usage">
+ <p>
+ Using the XML Serializer in a pipeline is just setting the
+ serializer type to xml.
+ The following code snippet uses the XML Serializer:
+ </p>
+ <source><![CDATA[
+...
+<map:match pattern="*.xml">
+<map:generate...
+...
+<map:serialize type="xml"/>
+...
+ ]]></source>
+ </s2>
+ <s2 title="Further Reading">
+ <p>
+ The XML serializer is usable for serializing any SAX events
+ to a plain xml output. The various xml documents
+ requires in most cases a proper configuration of following
+ parameters
+ </p>
+ <ul>
+ <li>doctype-public</li>
+ <li>doctype-system</li>
+ </ul>
+ <p>
+ Moreover the mime-type, and name attribute of the serializer definition
+ shall be set propertly.
+ </p>
+ <p>
+ Read the XML serializer configuration user documentation
+ for
+ <link href="svgxml-serializer.html">SVG/XML</link>,
+ and
+ <link href="wap-serializer.html">WML</link> in order
+ to understand using the XML serialiazer for
+ serializing to some specific XML content type.
+ </p>
+ </s2>
+ </s1>
+ </body>
</document>
+
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
