crossley 2002/08/14 19:27:46
Modified: src/documentation/xdocs/userdocs/serializers
link-serializer.xml
Log:
Filling holes in documentation.
Submitted by: Torsten Knodt <[EMAIL PROTECTED]>
Revision Changes Path
1.2 +34 -8
xml-cocoon2/src/documentation/xdocs/userdocs/serializers/link-serializer.xml
Index: link-serializer.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/serializers/link-serializer.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- link-serializer.xml 3 Jan 2002 12:31:05 -0000 1.1
+++ link-serializer.xml 15 Aug 2002 02:27:46 -0000 1.2
@@ -4,21 +4,47 @@
<document>
<header>
<title>Link Serializer</title>
- <version>0.9</version>
+ <version>1.0</version>
<type>Technical document</type>
<authors>
- <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
+ <person name="Carsten Ziegeler" email="[EMAIL PROTECTED]"/>
+ <person name="Torsten Knodt" email="[EMAIL PROTECTED]"/>
</authors>
<abstract>This document describes the link serializer of
Cocoon.</abstract>
</header>
<body>
<s1 title="Link Serializer">
- <p>????.</p>
- <ul>
- <li>Name : links</li>
- <li>Class:
org.apache.cocoon.serialization.LinkSerializer</li>
- <li>Cacheable: ????.</li>
- </ul>
+ <p>The link serializer generates a list of links
+ using XLINK from the sax events. Most XHTML attributes
+ are also supported (href, src, longdesc, background).
+ The mime-type of the output is
+ <code>application/x-cocoon-links</code>. This serializer is
+ required by the link status generator and the command line
+ mode to follow links.</p>
+ <ul>
+ <li>Name: links</li>
+ <li>Class: org.apache.cocoon.serialization.LinkSerializer</li>
+ <li>Cacheable: no</li>
+ </ul>
</s1>
+ <s1 title="Usage">
+ <p>To use the link serializer for the command-line or the
+ link status generator, you need the following entries in
+ your sitemap:</p>
+<source><![CDATA[
+<map:components>
+ <map:serializers>
+ <map:serializer logger="sitemap.serializer.links" name="links"
+ src="org.apache.cocoon.serialization.LinkSerializer" />
+ </map:serializers>
+</map:components>
+
+<map:views>
+ <map:view from-position="last" name="links">
+ <map:serialize type="links" />
+ </map:view>
+</map:views>
+]]></source>
+ </s1>
</body>
</document>
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
