Return-Path: Delivered-To: apmail-cocoon-cvs-archive@www.apache.org Received: (qmail 38802 invoked from network); 18 Nov 2005 04:30:24 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 18 Nov 2005 04:30:24 -0000 Received: (qmail 43615 invoked by uid 500); 18 Nov 2005 04:24:38 -0000 Delivered-To: apmail-cocoon-cvs-archive@cocoon.apache.org Received: (qmail 31340 invoked by uid 500); 18 Nov 2005 04:21:29 -0000 Mailing-List: contact cvs-help@cocoon.apache.org; run by ezmlm Precedence: bulk Reply-To: dev@cocoon.apache.org list-help: list-unsubscribe: List-Post: List-Id: Delivered-To: mailing list cvs@cocoon.apache.org Received: (qmail 23196 invoked by uid 99); 18 Nov 2005 04:19:55 -0000 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Thu, 17 Nov 2005 20:17:10 -0800 Received: (qmail 8285 invoked by uid 65534); 18 Nov 2005 04:15:53 -0000 Message-ID: <20051118041553.8284.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r345438 [241/286] - in /cocoon/site/site/2.1: ./ developing/ developing/portal/ developing/portal/coplets/ developing/webapps/ developing/webapps/authentication/ faq/ howto/ installing/ plan/ plan/documentation/ plan/otherplanning/ plan/ove... Date: Fri, 18 Nov 2005 04:13:22 -0000 To: cvs@cocoon.apache.org From: crossley@apache.org X-Mailer: svnmailer-1.0.5 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Added: cocoon/site/site/2.1/userdocs/text-serializer.html URL: http://svn.apache.org/viewcvs/cocoon/site/site/2.1/userdocs/text-serializer.html?rev=345438&view=auto ============================================================================== --- cocoon/site/site/2.1/userdocs/text-serializer.html (added) +++ cocoon/site/site/2.1/userdocs/text-serializer.html Thu Nov 17 20:00:02 2005 @@ -0,0 +1,1308 @@ + + + + + + + +Text Serializer + + + + + + + + + +
+ +
+apache > cocoon +
+ +
+ + + + + + + +
+
+  + +
+
+ + + + +
+
+
+
+ +
+ + +
+ +
+ +   +
+ + + + + +
+

Text Serializer

+ +

Text Serializer

+
+

The Text serializer serializes xml into plain text..

+
    + +
  • Name : text
    • + +
  • Class: org.apache.cocoon.serialization.TextSerializer
    • + +
  • Cacheable: yes.
    • + +
+ +

Sitemap Configuration

+

The text Serializer is declared in the sitemap serializers section.

+
+<map:serializers...
+...
+ <map:serializer name="text" 
+   src="org.apache.cocoon.serialization.TextSerializer"
+   mime-type="text/plain" 
+   logger="sitemap.serializer.text" 
+ />
+...
+
+

The text Serializer sets the method property of the XML serializer +to the value text.

+ +

Pipeline Usage

+

Using the text Serializer in a pipeline is just setting the serializer type +to text. The following code snippet uses the text Serializer:

+
+...
+<map:match pattern="announcement.txt">
+<map:generate...
+...
+<map:serialize type="text"/>
+...
+
+

The pipeline snippet above serializes the SAX events of the announcment +document resource to plain text.

+

Input document of the text serializer must be valid XML document. It should +have at least one element, root element, which will contain all the text of the +document. Root element will be ignored by text serializer and will not go into +the output stream.

+ +

Further Reading

+

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 +XML serializer user documentation.

+
+

+Errors and Improvements? + If you see any errors or potential improvements in this document + please help us: + + View, Edit or comment on + the latest development version (registration required). +

+
+
+
+ +
 
+
+ + + Propchange: cocoon/site/site/2.1/userdocs/text-serializer.html ------------------------------------------------------------------------------ svn:eol-style = native