cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cziege...@apache.org
Subject cvs commit: xml-cocoon2/xdocs cinclude-transformer.xml directory-generator.xml extractor-generator.xml extractor-transformer.xml file-generator.xml html-generator.xml html-serializer.xml i18n-transformer.xml imagedirectory-generator.xml jsp-generator.xml ldap-transformer.xml link-serializer.xml log-transformer.xml pdf-serializer.xml php-generator.xml request-generator.xml script-generator.xml serverpages-generator.xml status-generator.xml svgjpeg-serializer.xml svgpng-serializer.xml svgxml-serializer.xml text-serializer.xml velocity-generator.xml vrml-serializer.xml wap-serializer.xml xinclude-transformer.xml xml-serializer.xml xslt-transformer.xml xt-transformer.xml docs-book.xml generators.xml index.xml jars.xml livesites.xml serializers.xml site-book.xml sitemap.xml sql-transformer.xml stream-generator.xml transformers.xml i18n.xml
Date Thu, 12 Jul 2001 21:08:29 GMT
cziegeler    01/07/12 14:08:28

  Modified:    xdocs    Tag: cocoon_20_branch docs-book.xml generators.xml
                        index.xml jars.xml livesites.xml serializers.xml
                        site-book.xml sitemap.xml sql-transformer.xml
                        stream-generator.xml transformers.xml
  Added:       xdocs    Tag: cocoon_20_branch cinclude-transformer.xml
                        directory-generator.xml extractor-generator.xml
                        extractor-transformer.xml file-generator.xml
                        html-generator.xml html-serializer.xml
                        i18n-transformer.xml imagedirectory-generator.xml
                        jsp-generator.xml ldap-transformer.xml
                        link-serializer.xml log-transformer.xml
                        pdf-serializer.xml php-generator.xml
                        request-generator.xml script-generator.xml
                        serverpages-generator.xml status-generator.xml
                        svgjpeg-serializer.xml svgpng-serializer.xml
                        svgxml-serializer.xml text-serializer.xml
                        velocity-generator.xml vrml-serializer.xml
                        wap-serializer.xml xinclude-transformer.xml
                        xml-serializer.xml xslt-transformer.xml
                        xt-transformer.xml
  Removed:     xdocs    Tag: cocoon_20_branch i18n.xml
  Log:
  - A separate document for each generator, selector, transformer
    These documents must be completed
  - Revied some documentation, synced sitemap description with
    implementation
  - Syncing with HEAD will be done later
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.3.2.12  +42 -6     xml-cocoon2/xdocs/docs-book.xml
  
  Index: docs-book.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/docs-book.xml,v
  retrieving revision 1.3.2.11
  retrieving revision 1.3.2.12
  diff -u -r1.3.2.11 -r1.3.2.12
  --- docs-book.xml	2001/07/12 10:53:22	1.3.2.11
  +++ docs-book.xml	2001/07/12 21:05:56	1.3.2.12
  @@ -1,6 +1,6 @@
   <?xml version="1.0"?>
   
  -<book title="Cocoon documentation" copyright="@year@ The Apache Software Foundation">
  +<book title="Cocoon 2 documentation" copyright="@year@ The Apache Software Foundation">
   <separator/>
     <page id="index" label="Index" source="index.xml"/>
     <page id="license" label="License" source="license.xml"/>
  @@ -13,18 +13,56 @@
     <page id="sitemap" label="Sitemap" source="sitemap.xml"/>
     <page id="actions" label="Actions" source="actions.xml"/>
     <page id="matchers-selectors" label="Matchers and Selectors" source="matchers_selectors.xml"/>
  +
  +  <!-- The Generators -->
     <page id="generators" label="Generators" source="generators.xml"/>
  +  <hidden id="file-generator" label="File Generator" source="file-generator.xml"/>
  +  <hidden id="html-generator" label="HTML Generator" source="html-generator.xml"/>
  +  <hidden id="directory-generator" label="Directory Generator" source="directory-generator.xml"/>
  +  <hidden id="imagedirectory-generator" label="Image Directory" source="imagedirectory-generator.xml"/>
  +  <hidden id="extractor-generator" label="Fragment Extractor" source="extractor-generator.xml"/>
  +  <hidden id="jsp-generator" label="JSP Generator" source="jsp-generator.xml"/>
  +  <hidden id="script-generator" label="Script Generator" source="script-generator.xml"/>
  +  <hidden id="serverpages-generator" label="Server Pages Generator" source="serverpages-generator.xml"/>
  +  <hidden id="velocity-generator" label="Velocity Generator" source="velocity-generator.xml"/>
  +  <hidden id="request-generator" label="Request Generator" source="request-generator.xml"/>
  +  <hidden id="status-generator" label="Status Generator" source="status-generator.xml"/>
  +  <hidden id="stream-generator" label="Stream Generator" source="stream-generator.xml"/>
  +  <hidden id="php-generator" label="Php Generator" source="php-generator.xml"/>
  +
  +  <!-- The transformers -->
     <page id="transformers" label="Transformers" source="transformers.xml"/>
  +  <hidden id="xslt-transformer" label="XSLT Transformer" source="xslt-transformer.xml"/>
  +  <hidden id="extractor-transformer" label="Fragment Extractor Transformer" source="extractor-transformer.xml"/>
  +  <hidden id="i18n-transformer" label="I18n Transformer" source="i18n-transformer.xml"/>
  +  <hidden id="log-transformer" label="Log Transformer" source="log-transformer.xml"/>
  +  <hidden id="sql-transformer" label="SQL Transformer" source="sql-transformer.xml"/>
  +  <hidden id="xinclude-transformer" label="XInclude Transformer" source="xinclude-transformer.xml"/>
  +  <hidden id="cinclude-transformer" label="CInclude Transformer" source="cinclude-transformer.xml"/>
  +  <hidden id="xt-transformer" label="XT Transformer" source="xt-transformer.xml"/>
  +  <hidden id="ldap-transformer" label="LDAP Transformer" source="ldap-transformer.xml"/>
  +
  +  <!-- The serializers -->
     <page id="serializers" label="Serializers" source="serializers.xml"/>
  +  <hidden id="html-serializer" label="HTML Serializer" source="html-serializer.xml"/>
  +  <hidden id="xml-serializer" label="XML Serializer" source="xml-serializer.xml"/>
  +  <hidden id="text-serializer" label="Text Serializer" source="text-serializer.xml"/>
  +  <hidden id="pdf-serializer" label="PDF Serializer" source="pdf-serializer.xml"/>
  +  <hidden id="wap-serializer" label="WAP/WML Serializer" source="wap-serializer.xml"/>
  +  <hidden id="svg-serializer" label="SVG Serializer" source="svg-serializer.xml"/>
  +  <hidden id="svgxml-serializer" label="SVG/XML Serializer" source="svgxml-serializer.xml"/>
  +  <hidden id="svgjpeg-serializer" label="SVG/JPEG Serializer" source="svgjpeg-serializer.xml"/>
  +  <hidden id="svgpng-serializer" label="SVG/PNG Serializer" source="svgpng-serializer.xml"/>
  +  <hidden id="vrml-serializer" label="VRML Serializer" source="vrml-serializer.xml"/>
  +  <hidden id="link-serializer" label="Link Serializer" source="link-serializer.xml"/>
  +
     <page id="flow" label="Flow" source="httprequest.xml"/>
     <page id="caching" label="Caching" source="caching.xml"/>
     <page id="sessions" label="Sessions" source="sessions.xml"/>
     <page id="datasources" label="Using Databases" source="datasources.xml"/>
  -  <page id="svg" label="SVG Serializer" source="svg-serializer.xml"/>
     <page id="extending" label="Extending C2" source="extending.xml"/>
     <page id="avalon" label="Avalon" source="avalon.xml"/>
  -  <page id="i18n" label="Internationalization" source="i18n.xml"/>
  -  <page id="stream" label="Stream Generator" source="stream-generator.xml"/>
  +  <page id="i18n" label="Internationalization" source="i18n-transformer.xml"/>
   <separator/>
     <page id="xsp" label="XSP" source="xsp.xml"/>
     <page id="xsp-internals" label="XSP Internals" source="xsp-internals.xml"/>
  @@ -34,8 +72,6 @@
     <page id="logicsheet-request" label="Request Logicsheet" source="request.xml"/>
     <page id="logicsheet-esql" label="ESQL Logicsheet" source="esql.xml"/>
     <page id="logicsheet-forms" label="Forms" source="logicsheet-forms.xml"/>
  -<separator/>
  -  <page id="sql-transformer" label="SQL Transformer" source="sql-transformer.xml"/>
   <separator/>
     <external label="XML Links" href="http://dmoz.org/Computers/Data_Formats/Markup_Languages/XML/"/> 
   <separator/>
  
  
  
  1.1.2.2   +16 -252   xml-cocoon2/xdocs/generators.xml
  
  Index: generators.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/generators.xml,v
  retrieving revision 1.1.2.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- generators.xml	2001/07/12 10:56:07	1.1.2.1
  +++ generators.xml	2001/07/12 21:06:09	1.1.2.2
  @@ -8,8 +8,6 @@
   		<type>Technical document</type>
   		<authors>
   			<person name="Carsten Ziegeler" email="cziegeler@apache.org"/>
  -            	<person name="Kinga Dziembowska" email="kingadziembowska@msn.com"/>
  -			<person name="Davanum Srinivas" email="dims@yahoo.com"/>
   		 </authors>
   		 <abstract>This document describes all available generators of Cocoon 2.</abstract>
   	</header>
  @@ -21,260 +19,26 @@
   		 <s1 title="Overview">
   			<p>A generator is the starting point of an xml pipeline. It generates XML 
   	                              content as SAX events and initialize the pipeline processing. 
  +			   For more information on generators
  +                     see <link href="sitemap.html">the sitemap</link>.
         	      </p>
   		 </s1>
  -		 <s1 title="File Generator">
  -			<p>The file generator reads an xml document from the local file system or from any url.
  -	               Therefore it could better be named url generator, but the name has historical reasons.</p>
  -      	      <p>The file generator is the default generator.</p>
  +		 <s1 title="The Generators in Apache Cocoon 2">
   			<ul>
  -				<li>Name : file</li>
  -				<li>Class: org.apache.cocoon.generation.FileGenerator</li>
  -				<li>Cacheable: yes - uses the last modification date of the xml document for validation.</li>
  +				<li><link href="file-generator.html">File Generator</link></li>
  +				<li><link href="html-generator.html">HTML Generator</link></li>
  +				<li><link href="directory-generator.html">Directory Generator</link></li>
  +				<li><link href="imagedirectory-generator.html">Image Directory Generator</link></li>
  +				<li><link href="extractor-generator.html">Fragment Extractor Generator</link></li>
  +				<li><link href="jsp-generator.html">JSP Generator</link></li>
  +				<li><link href="script-generator.html">Script Generator</link></li>
  +				<li><link href="serverpages-generator.html">Server Pages Generator</link></li>
  +				<li><link href="velocity-generator.html">Velocity Generator</link></li>
  +				<li><link href="request-generator.html">Request Generator</link></li>
  +				<li><link href="status-generator.html">Status Generator</link></li>
  +				<li><link href="stream-generator.html">Stream Generator</link></li>
  +				<li><link href="php-generator.html">Php Generator</link></li>
   			</ul>
  -			<p>The location of the source xml document is specified in
  -                     the pipeline by the src attribute.</p>
  -<source>
  -     <![CDATA[
  -  <map:generate src="document.xml" type="file"/>
  -  <!-- The type attribute can be omitted as it is the default generator. -->
  -     ]]>
  -</source>
  -		</s1>
  -		<s1 title="HTML Generator">
  -			<p>The html generator reads an html document from the local file system or from any url.
  -	               It acts similar to the file generator with the difference that it reads
  -                     html documents and converts them using jtidy to xhtml.</p>
  -			<ul>
  -				<li>Name : html</li>
  -				<li>Class: org.apache.cocoon.generation.HTMLGenerator</li>
  -				<li>Cacheable: yes - uses the last modification date of the html document for validation.</li>
  -			</ul>
  -			<p>The location of the source html document is specified in
  -                     the pipeline by the src attribute.</p>
  -  <source>
  -   <![CDATA[
  -  <map:generate src="document.html" type="html"/>
  -     ]]>
  -</source>
  -		</s1>
  -		<s1 title="Directory Generator">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : directory</li>
  -				<li>Class: org.apache.cocoon.generation.DirectoryGenerator</li>
  -				<li>Cacheable: no.</li>
  -			</ul>
  -<source>
  -     <![CDATA[
  -  <map:generate type="directory"/>
  -     ]]>
  -</source>
  -		</s1>
  -		<s1 title="Image Directory Generator">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : ????</li>
  -				<li>Class: org.apache.cocoon.generation.ImageDirectoryGenerator</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -<source>
  -     <![CDATA[
  -  <map:generate type="????"/>
  -     ]]>
  -</source>
  -		</s1>
  -		<s1 title="Fragment Extractor Generator">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : extractor</li>
  -				<li>Class: org.apache.cocoon.generation.FragmentExtractorGenerator</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -<source>
  -     <![CDATA[
  -  <map:generate type="extractor"/>
  -     ]]>
  -</source>
  -		</s1>
  -		<s1 title="JSP Generator">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : jsp</li>
  -				<li>Class: org.apache.cocoon.generation.JspGenerator</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -<source>
  -     <![CDATA[
  -  <map:generate type="jsp"/>
  -     ]]>
  -</source>
  -		</s1>
  -		<s1 title="Script Generator">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : script</li>
  -				<li>Class: org.apache.cocoon.generation.ScriptGenerator</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -<source>
  -     <![CDATA[
  -  <map:generate type="script"/>
  -     ]]>
  -</source>
  -		</s1>
  -		<s1 title="Server Pages Generator">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : serverpages</li>
  -				<li>Class: org.apache.cocoon.generation.ServerPagesGenerator</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -<source>
  -     <![CDATA[
  -  <map:generate type="serverpages"/>
  -     ]]>
  -</source>
  -		</s1>
  -		<s1 title="Velocity Generator">
  -			<p>.</p>
  -			<ul>
  -				<li>Name : velocity</li>
  -				<li>Class: org.apache.cocoon.generation.VelocityGenerator</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -<source>
  -     <![CDATA[
  -  <map:generate type="velocity"/>
  -     ]]>
  -</source>
  -		</s1>
  -		<s1 title="Request Generator">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : request</li>
  -				<li>Class: org.apache.cocoon.generation.RequestGenerator</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -<source>
  -     <![CDATA[
  -  <map:generate type="request"/>
  -     ]]>
  -</source>
  -		</s1>
  -		<s1 title="Status Generator">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : status</li>
  -				<li>Class: org.apache.cocoon.generation.StatusGenerator</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -<source>
  -     <![CDATA[
  -  <map:generate type="status"/>
  -     ]]>
  -</source>
  -		</s1>
  -		<s1 title="Stream Generator">
  -	            <p>
  -      	      The StreamGenerator is a class that reads XML from an HttpRequest 
  -            	InputStream and generates SAX Events. StreamGenerator expects 
  -	            XML data coming as POST message. 
  -      	      </p>
  -			<ul>
  -				<li>Name : stream</li>
  -				<li>Class: org.apache.cocoon.generation.StreamGenerator</li>
  -				<li>Cacheable: no.</li>
  -			</ul>
  -           		<p>
  -         		For POST requests with mimetype of application/x-www-form-urlencoded, 
  -		      the xml data expects to be associated with the name specified 
  -            	in the sitemap parameter.
  -	            </p>
  -
  -      	      <p>
  -            	For POST requests with mimetypes: text/plain, text/xml, application/xml 
  -	            the xml data is in the body of the POST request and its length is 
  -      	      specified by the value returned by getContentLength() method.
  -            	</p>
  -			<s2 title="PostInputStream">
  -            	<p>
  -	            The StreamGenerator uses helper class org.apache.cocoon.util.PostInputStream 
  -      	      for InputStream reading operations. At the time that Parser reads the data 
  -            	out of InputStream - Parser has no knowledge about the length of data to be
  -	            read. The only way to signal to the Parser that all data was read from the 
  -      	      InputStream is to control reading   operation - PostInputStream- and to 
  -            	return to the requestor -1 when the number of bytes read is equal to the 
  -	            getContentLength() value.
  -      	      </p>
  -			</s2>
  -
  -			<s2 title="See it in Action">
  -	            <p>
  -            	The Generator is a generic object, i.e. it can process any stream out of the 
  -      	      POST message there are two ways to see StreamGenerator in action:
  -	            </p>
  -            
  -            	<ul>
  -	                <li>To invoke URL http://localhost:8080/cocoon/Order</li>
  -      	          <li>To use telnet program to generate POST request</li>
  -            	</ul>
  -            
  -      	      <p>  
  -	            The first option is not a "pure" stream invocation, but it is quick way to 
  -            	observe desired effects. The result of this invocation is a form containing 
  -      	      the XML document embedded in the textarea of the form. Submission of this 
  -	            form will invoke StreamGenerator. The testarea name/value par is specified 
  -            	as a parameter in the sitemap definition for the StreamGenerator. The expected 
  -      	      result is the submitted xml document send back to the browser.
  -	            </p>
  -            
  -            	<p>
  -      	      The second or "pure" option of testing StreamGenerator "in action," requires the 
  -	            use of Telnet program or any other process able to generate correct POST message. 
  -            	The procedure is:
  -      	      </p>
  -
  -	            <ul>
  -            	    <li>To invoke telnet, connect to localhost 8080 and to use content of 
  -      	              <link href="telnet.txt">telnet.txt</link> file as a post message. 
  -	                </li>
  -            	    <li>Here, the Copy-Paste method should be used.</li>
  -      	          <li>Remember to hit the enter button twice enter after the contents of the post are set in telnet.</li>
  -	            </ul>
  -
  -            	<p>
  -      	      It is important because Content-len is calculated assuming two "enter" in the end of http message. 
  -	            Once again, the performed task results in the mirror of the original document being sent back to the requestor. 
  -            	</p>
  -            
  -      	      <p>
  -	            The "pure" stream generation can be observed using the telnet utility where you can invoke a 
  -            	message targeting my processing. Any other method is good (URL object connection) as 
  -      	      long the message is well formed.
  -	            </p>
  -<source>
  -     <![CDATA[
  -  <map:generate type="stream"/>
  -     ]]>
  -</source>
  -        		</s2>
  -		</s1>
  -		<s1 title="Php Generator">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : php</li>
  -				<li>Class: org.apache.cocoon.generation.PhpGenerator</li>
  -				<li>Cacheable: no.</li>
  -			</ul>
  -			<p>This generator is optional and not available in the binary distribution.
  -                     However if you want to use it, you have to retrieve the php java servlet,
  -                     copy the jar file into the lib directory of cocoon and rebuild.</p>
  -<source>
  -     <![CDATA[
  -  <map:generate type="php"/>
  -     ]]>
  -</source>
   		</s1>
   	</body>
   </document>
  
  
  
  1.1.1.1.2.2 +8 -3      xml-cocoon2/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/index.xml,v
  retrieving revision 1.1.1.1.2.1
  retrieving revision 1.1.1.1.2.2
  diff -u -r1.1.1.1.2.1 -r1.1.1.1.2.2
  --- index.xml	2001/06/07 17:38:21	1.1.1.1.2.1
  +++ index.xml	2001/07/12 21:06:29	1.1.1.1.2.2
  @@ -281,7 +281,8 @@
     <p>The sitemap physically represents the central repository for web site
     administration, where the URI space and its handling is maintained.</p>
   
  -  <p>Please, refer to the Cocoon 2 CVS module for more information on this.</p>
  +  <p>Please, take a look at the <link href="sitemap.html">sitemap documentation</link>
  +     for more information on this.</p>
   
   </s1>
   
  @@ -316,7 +317,7 @@
   </s1>
   
   <s1 title="Development Status">
  -  <p>Cocoon 2 development has reached "near beta quality"
  +  <p>Cocoon 2 development has reached "beta quality"
     You might take a look at it on the <em>xml-cocoon2</em>
     CVS module. If you are not a CVS expert, this means
     typing:</p>
  @@ -325,10 +326,14 @@
       cvs -d :pserver:anoncvs@xml.apache.org:/home/cvspublic login
       Password: anoncvs
   
  -    cvs -d :pserver:anoncvs@xml.apache.org:/home/cvspublic checkout xml-cocoon2
  +    cvs -d :pserver:anoncvs@xml.apache.org:/home/cvspublic checkout -r cocoon_20_branch xml-cocoon2
     </source>
   
     <p>For more information on CVS access, refer to the CVS docs on this web site.</p>
  +  <note>To get the current version of Cocoon 2 you have to checkout the
  +        branch called cocoon_20_branch. The HEAD of the cvs repository is used
  +        for the developer team to store and test new ideas which will be
  +        perhaps included in later releases of Cocoon2.</note>
   </s1>
   
    </body>
  
  
  
  1.1.2.4   +2 -2      xml-cocoon2/xdocs/jars.xml
  
  Index: jars.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/jars.xml,v
  retrieving revision 1.1.2.3
  retrieving revision 1.1.2.4
  diff -u -r1.1.2.3 -r1.1.2.4
  --- jars.xml	2001/07/05 01:01:38	1.1.2.3
  +++ jars.xml	2001/07/12 21:06:32	1.1.2.4
  @@ -4,7 +4,7 @@
   
   <document>
    <header>
  -  <title>Cocoon JARs</title>
  +  <title>Cocoon 2 JARs</title>
     <authors>
      <person name="John Morrison" email="john.morrison@uk.experian.com"/>
     </authors>
  @@ -13,7 +13,7 @@
    <body>
   
    <s1 title="What, why and when...">
  -  <p>This is a list of the available Jars, what they are, where they come from,
  +  <p>This is a list of the available jars, what they are, where they come from,
      and what they do.</p>
   
     <table>
  
  
  
  1.1.2.3   +1 -1      xml-cocoon2/xdocs/livesites.xml
  
  Index: livesites.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/livesites.xml,v
  retrieving revision 1.1.2.2
  retrieving revision 1.1.2.3
  diff -u -r1.1.2.2 -r1.1.2.3
  --- livesites.xml	2001/07/10 15:56:33	1.1.2.2
  +++ livesites.xml	2001/07/12 21:06:45	1.1.2.3
  @@ -37,7 +37,6 @@
       <li><link href="http://www.derecho.com/">http://www.derecho.com</link></li>
       <li><link href="http://www.law.unc.edu/">http://www.law.unc.edu</link></li>
       <li><link href="http://www.cwinsurance.com/">http://www.cwinsurance.com</link></li>
  -    <li><link href="http://sunshine.sundn.de/">http://sunshine.sundn.de</link></li>
       <li><link href="http://www.stoneseeker.com/">http://www.stoneseeker.com</link></li>
       <li><link href="http://www.infoplanning.com/">http://www.infoplanning.com</link></li>
       <li><link href="http://www.visolve.com/xbeta/">http://www.visolve.com/xbeta</link></li>
  @@ -74,6 +73,7 @@
      </p>
      
      <ul>
  +    <li><link href="http://sunshine.sundn.de/">http://sunshine.sundn.de</link></li>
       <li><link href="http://www.sirvisetti.com/uddi/index.html">Sirvisetti UDDI Registrar WAP site</link></li>
       <li><link href="http://www.xslt-patterns.com/">XSLTPatterns.com</link></li>
   <!--<li><link href=""></link></li>-->
  
  
  
  1.1.2.2   +14 -81    xml-cocoon2/xdocs/serializers.xml
  
  Index: serializers.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/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	2001/07/12 10:56:10	1.1.2.1
  +++ serializers.xml	2001/07/12 21:07:05	1.1.2.2
  @@ -18,90 +18,23 @@
   		 </s1>
   		 <s1 title="Overview">
   			<p>A serializer is the end point of an xml pipeline. It transform SAX 
  -                                         events in binary or char streams for final client consumption. 
  +                     events in binary or char streams for final client consumption. For more information about transformers
  +                     see <link href="sitemap.html">the sitemap</link>.
         	      </p>
   		 </s1>
  -		 <s1 title="HTML Serializer">
  -			<p>The html serializer serializes xhtml into valid html.</p>
  -      	      <p>The html serializer is the default serializer .</p>
  +		 <s1 title="The Serializers in Apache Cocoon 2">
   			<ul>
  -				<li>Name : html</li>
  -				<li>Class: org.apache.cocoon.serialization.HtmlSerializer</li>
  -				<li>Cacheable: yes.</li>
  -			</ul>
  -		</s1>
  -		<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>
  -		<s1 title="PDF Serializer">
  -			<p>The pdf serializer takes fo xml events as input. By using the
  -                     FOP project it creates pdf out of the sax events.</p>
  -			<ul>
  -				<li>Name : fo2pdf</li>
  -				<li>Class: org.apache.cocoon.serialization.FOPSerializer</li>
  -				<li>Cacheable: yes.</li>
  -			</ul>
  -		</s1>
  -		<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>
  -		<s1 title="VRML Serializer">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : vrml</li>
  -				<li>Class: org.apache.cocoon.serialization.TextSerializer</li>
  -				<li>Cacheable: yes.</li>
  -			</ul>
  -		</s1>
  -		<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>
  -		<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>
  -		<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>
  -		<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>
  -		<s1 title="Link Serializer">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : links</li>
  -				<li>Class: org.apache.cocoon.serialization.LinkSerializer</li>
  -				<li>Cacheable: ????.</li>
  +				<li><link href="html-serializer.html">HTML 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="pdf-serializer.html">PDF Serializer</link></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>
  
  
  
  1.3.2.14  +41 -6     xml-cocoon2/xdocs/site-book.xml
  
  Index: site-book.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/site-book.xml,v
  retrieving revision 1.3.2.13
  retrieving revision 1.3.2.14
  diff -u -r1.3.2.13 -r1.3.2.14
  --- site-book.xml	2001/07/12 10:53:24	1.3.2.13
  +++ site-book.xml	2001/07/12 21:07:11	1.3.2.14
  @@ -1,6 +1,6 @@
   <?xml version="1.0"?>
   
  -<book title="Cocoon documentation" copyright="@year@ The Apache Software Foundation">
  +<book title="Cocoon 2 documentation" copyright="@year@ The Apache Software Foundation">
   
     <external href="../index.html"  label="Back"/>
   <separator/>
  @@ -17,18 +17,55 @@
     <page id="sitemap" label="Sitemap" source="sitemap.xml"/>
     <page id="actions" label="Actions" source="actions.xml"/>
     <page id="matchers-selectors" label="Matchers and Selectors" source="matchers_selectors.xml"/>
  +  <!-- The Generators -->
     <page id="generators" label="Generators" source="generators.xml"/>
  +  <hidden id="file-generator" label="File Generator" source="file-generator.xml"/>
  +  <hidden id="html-generator" label="HTML Generator" source="html-generator.xml"/>
  +  <hidden id="directory-generator" label="Directory Generator" source="directory-generator.xml"/>
  +  <hidden id="imagedirectory-generator" label="Image Directory" source="imagedirectory-generator.xml"/>
  +  <hidden id="extractor-generator" label="Fragment Extractor" source="extractor-generator.xml"/>
  +  <hidden id="jsp-generator" label="JSP Generator" source="jsp-generator.xml"/>
  +  <hidden id="script-generator" label="Script Generator" source="script-generator.xml"/>
  +  <hidden id="serverpages-generator" label="Server Pages Generator" source="serverpages-generator.xml"/>
  +  <hidden id="velocity-generator" label="Velocity Generator" source="velocity-generator.xml"/>
  +  <hidden id="request-generator" label="Request Generator" source="request-generator.xml"/>
  +  <hidden id="status-generator" label="Status Generator" source="status-generator.xml"/>
  +  <hidden id="stream-generator" label="Stream Generator" source="stream-generator.xml"/>
  +  <hidden id="php-generator" label="Php Generator" source="php-generator.xml"/>
  +
  +  <!-- The transformers -->
     <page id="transformers" label="Transformers" source="transformers.xml"/>
  +  <hidden id="xslt-transformer" label="XSLT Transformer" source="xslt-transformer.xml"/>
  +  <hidden id="extractor-transformer" label="Fragment Extractor Transformer" source="extractor-transformer.xml"/>
  +  <hidden id="i18n-transformer" label="I18n Transformer" source="i18n-transformer.xml"/>
  +  <hidden id="log-transformer" label="Log Transformer" source="log-transformer.xml"/>
  +  <hidden id="sql-transformer" label="SQL Transformer" source="sql-transformer.xml"/>
  +  <hidden id="xinclude-transformer" label="XInclude Transformer" source="xinclude-transformer.xml"/>
  +  <hidden id="cinclude-transformer" label="CInclude Transformer" source="cinclude-transformer.xml"/>
  +  <hidden id="xt-transformer" label="XT Transformer" source="xt-transformer.xml"/>
  +  <hidden id="ldap-transformer" label="LDAP Transformer" source="ldap-transformer.xml"/>
  +
  +  <!-- The serializers -->
     <page id="serializers" label="Serializers" source="serializers.xml"/>
  +  <hidden id="html-serializer" label="HTML Serializer" source="html-serializer.xml"/>
  +  <hidden id="xml-serializer" label="XML Serializer" source="xml-serializer.xml"/>
  +  <hidden id="text-serializer" label="Text Serializer" source="text-serializer.xml"/>
  +  <hidden id="pdf-serializer" label="PDF Serializer" source="pdf-serializer.xml"/>
  +  <hidden id="wap-serializer" label="WAP/WML Serializer" source="wap-serializer.xml"/>
  +  <hidden id="svg-serializer" label="SVG Serializer" source="svg-serializer.xml"/>
  +  <hidden id="svgxml-serializer" label="SVG/XML Serializer" source="svgxml-serializer.xml"/>
  +  <hidden id="svgjpeg-serializer" label="SVG/JPEG Serializer" source="svgjpeg-serializer.xml"/>
  +  <hidden id="svgpng-serializer" label="SVG/PNG Serializer" source="svgpng-serializer.xml"/>
  +  <hidden id="vrml-serializer" label="VRML Serializer" source="vrml-serializer.xml"/>
  +  <hidden id="link-serializer" label="Link Serializer" source="link-serializer.xml"/>
  +
     <page id="flow" label="Flow" source="httprequest.xml"/>
     <page id="caching" label="Caching" source="caching.xml"/>
     <page id="sessions" label="Sessions" source="sessions.xml"/>
     <page id="datasources" label="Using Databases" source="datasources.xml"/>
  -  <page id="svg" label="SVG Serializer" source="svg-serializer.xml"/>
     <page id="extending" label="Extending C2" source="extending.xml"/>
     <page id="avalon" label="Avalon" source="avalon.xml"/>
  -  <page id="i18n" label="Internationalization" source="i18n.xml"/>
  -  <page id="stream" label="Stream Generator" source="stream-generator.xml"/>
  +  <page id="i18n" label="Internationalization" source="i18n-transformer.xml"/>
   <separator/>
     <page id="xsp" label="XSP" source="xsp.xml"/>
     <page id="xsp-internals" label="XSP Internals" source="xsp-internals.xml"/>
  @@ -38,8 +75,6 @@
     <page id="logicsheet-request" label="Request Logicsheet" source="request.xml"/>
     <page id="logicsheet-esql" label="ESQL Logicsheet" source="esql.xml"/>
     <page id="logicsheet-forms" label="Forms" source="logicsheet-forms.xml"/>
  -<separator/>
  -  <page id="sql-transformer" label="SQL Transformer" source="sql-transformer.xml"/>
   <separator/>
     <external href="apidocs/index.html" label="API (Javadoc)"/>
   <separator/>
  
  
  
  1.1.1.1.2.2 +110 -142  xml-cocoon2/xdocs/sitemap.xml
  
  Index: sitemap.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/sitemap.xml,v
  retrieving revision 1.1.1.1.2.1
  retrieving revision 1.1.1.1.2.2
  diff -u -r1.1.1.1.2.1 -r1.1.1.1.2.2
  --- sitemap.xml	2001/07/09 12:48:20	1.1.1.1.2.1
  +++ sitemap.xml	2001/07/12 21:07:12	1.1.1.1.2.2
  @@ -131,6 +131,8 @@
          <map:serializers/>
          <map:selectors/>
          <map:matchers/>
  +       <map:readers/>
  +       <map:actions/>
         </map:components">
        ]]>
       </source>
  @@ -179,14 +181,6 @@
         ]]>
        </source>
    
  -     <note>
  -      The syntax <br/> <br/>
  -       <strong><code>&lt;xxx map:value="yyy"&gt;</code></strong> <br/> <br/>
  -      is completely equivalent to <br/> <br/>
  -       <strong><code>&lt;xxx&gt;yyy&lt;/xxx&gt;</code></strong> <br/> <br/>
  -       throughout the entire sitemap.. the "value" attribute is a reserved one.
  -     </note>
  -  
        <p>
         There is no given set of predefined parameters.
        </p>
  @@ -389,87 +383,6 @@
        ]]>
       </source>
   
  -    <s3 title="Common Attributes of Components">
  -     <p>
  -      All components have some common attributes. The list below will show and explain them:
  -     </p>
  -
  -     <dl>
  -      <dt>type</dt>
  -      <dd>The type attribute gives the component a reference which can be used to point to them in the pipeline section.</dd>
  -      <dt>src</dt>
  -      <dd>Specifies where Cocoon finds the class representing this component. Note that the content of 
  -       the src attribute must be specified as an URI. 
  -      </dd>
  -     </dl>
  -
  -     <p>
  -      The following protocols can be specified for all URI aware attributes:
  -     </p>
  -     <ul>
  -      <li>file:</li>
  -      <li>class:</li>
  -      <li>jar:</li>
  -      <li>http:</li>
  -     </ul>
  -    </s3>
  -
  -    <s3 title="Component Parameters">
  -     <p>
  -      All components will be configured with parameters specified from their child elements at component instantiation time. 
  -      The name of the parameters is dependant of the component. The following example shows how to specify a
  -      <code>&lt;compile-stylesheet&gt;</code> parameters to a component:
  -     </p>
  -  
  -     <source>
  -      <![CDATA[
  -       <map:components>
  -        <map:transformer type="xslt" 
  -                         src="class:///org.apache.cocoon.transformation.XSLTTransformer">
  -         <!-- This is a parameter to the transformer component -->
  -         <compile-stylesheets value="true"/>
  -        </map:transformer>
  -       </map:components>
  -      ]]>
  -     </source>
  - 
  -     <note>
  -      The syntax <br/> <br/>
  -       <strong><code>&lt;xxx map:value="yyy"&gt;</code></strong> <br/> <br/>
  -      is completely equivalent to <br/> <br/>
  -       <strong><code>&lt;xxx&gt;yyy&lt;/xxx&gt;</code></strong> <br/> <br/>
  -       throughout the entire sitemap.. the "value" attribute is a reserved one.
  -     </note>
  -  
  -     <p>
  -      There is no given set of predefined parameters.
  -     </p>
  -    </s3>
  -
  -    <s3 title="Generators">
  -     <p>
  -      Generators generate XML content as SAX events and initialize the 
  -      pipeline processing. 
  -     </p>
  -
  -     <source>
  -      <![CDATA[
  -       <map:generators default="parser">
  -        <map:generator type="parser" src="class:///org.apache.cocoon.generator.FileGenerator"/>
  -        <map:generator type="dir"    src="file:///home/mystuff/java/MyDirGenerator.class"/>
  -        <map:generator type="xsp"    src="class:///org.apache.cocoon.generators.XSPGenerator">
  -         ...
  -        </map:generator>
  -       </map:generators>
  -      ]]>
  -     </source>
  -
  -     <p>
  -      The <code>default</code> attribute on <code>&lt;map:generators&gt;</code> specifies the type 
  -      of generator to use if none is specified in a pipeline.
  -     </p>
  -   
  -    </s3>
      </s2>
     </s1>
    
  @@ -608,11 +521,10 @@
   
     <s1 title="Interface specifications">
      <anchor id="interface-XMLProducer"/>
  -   <s2 title="XMLProduces">
  +   <s2 title="XMLProducer">
       <p>
        This interfaces identifies classes that produce XML data, sending SAX
  -     events to the configured <code>XMLConsumer</code> (or SAX 
  -     <code>ContentHandler</code> and <code>LexicalHandler</code>).<br/>
  +     events to the configured <code>XMLConsumer</code>.<br/>
        It's beyond the scope of this interface to specify a way in wich the XML
        data production is started.
       </p>
  @@ -623,11 +535,6 @@
             /** Set the <code>XMLConsumer</code> that will receive XML data. */
             public void setConsumer(XMLConsumer consumer);
   
  -          /** Set the <code>ContentHandler</code> that will receive XML data. */
  -          public void setContentHandler(ContentHandler content);
  -
  -          /** Set the <code>LexicalHandler</code> that will receive XML data. */
  -          public void setLexicalHandler(LexicalHandler lexical);
         }
        ]]>
       </source>
  @@ -649,27 +556,75 @@
        ]]>
       </source>
      </s2>
  +
  +   <anchor id="interface-XMLPipe"/>
  +   <s2 title="XMLPipe">
  +    <p>
  +     This interfaces identifies classes that consume XML data, receiving 
  +     notification of SAX events, and also that produce XML data, sending SAX
  +     events to the configured <code>XMLConsumer</code>.<br/>
  +     This interface unites the idea of <code>XMLProducer</code> and
  +     <code>XMLConsumer</code>.
  +    </p>
  +
  +    <source>
  +     <![CDATA[
  +      public interface XMLPipe extends XMLConsumer , XMLProducer {
  +      }
  +     ]]>
  +    </source>
  +   </s2>
   
  -   <anchor id="interface-sitemap-component"/>
  -   <s2 title="SitemapComponent">
  +   <anchor id="interface-sitemap-model-component"/>
  +   <s2 title="SitemapModelComponent">
       <p>
  -     Every component in the sitemap must implement the following interface:
  +     All sitemap components producing xml must implement this interface:
       </p>
   
       <source>
        <![CDATA[
  -      public interface SitemapComponent extends Component {
  +      public interface SitemapModelComponent extends Component {
  +      
             /**
  -           * Set the <code>Request</code>, <code>Response</code> and sitemap
  -           * <code>Parameters</code> used to process the request.
  +           * Set the <code>SourceResolver</code>, objectModel <code>Map</code>,
  +           * the source and sitemap <code>Parameters</code> used to process the request.
              */
  -          public void setup(Request req, Response res, String src, Parameters par)
  -                  throws ProcessingException, SAXException, IOException;
  -          }
  +          void setup(SourceResolver resolver, Map objectModel, String src, Parameters par) 
  +          throws ProcessingException, SAXException, IOException;
  +      }
        ]]>
       </source>
      </s2>
   
  +   <anchor id="interface-sitemap-output-component"/>
  +   <s2 title="SitemapOutputComponent">
  +    <p>
  +     All sitemap components creating the output must implement this interface:
  +    </p>
  +
  +    <source>
  +     <![CDATA[
  +      public interface SitemapOutputComponent extends Component {
  +      
  +          /**
  +           * Set the <code>OutputStream</code> where the requested resource should
  +           * be serialized.
  +           */
  +          void setOutputStream(OutputStream out) throws IOException;
  +
  +          /**
  +           * Get the mime-type of the output of this <code>Component</code>.
  +           */
  +          String getMimeType();
  +
  +          /**
  +           * Test if the component wants to set the content length
  +           */
  +          boolean shouldSetContentLength();
  +      }
  +     ]]>
  +    </source>
  +   </s2>
      <anchor id="interface-generator"/>
      <s2 title="Generator">
       <p>
  @@ -678,7 +633,7 @@
   
       <source>
        <![CDATA[
  -      public interface Generator extends XMLProducer, SitemapComponent {
  +      public interface Generator extends XMLProducer, SitemapModelComponent {
             public void generate()
                     throws IOException, SAXException, ProcessingException;
         }
  @@ -695,7 +650,7 @@
       <source>
        <![CDATA[
         public interface Transformer 
  -             extends   XMLProducer, XMLConsumer, SitemapModelComponent {
  +      extends   XMLPipe, SitemapModelComponent {
         }
        ]]>
       </source>
  @@ -710,12 +665,8 @@
   
       <source>
        <![CDATA[
  -      public interface Serializer extends XMLConsumer, SitemapComponent {
  +      public interface Serializer extends XMLConsumer, SitemapOutputComponent {
   
  -    /**
  -     * Set the <code>OutputStream</code> where the XML should be serialized.
  -     */
  -    public void setOutputStream(OutputStream out);
         }
        ]]>
       </source>
  @@ -724,14 +675,24 @@
      <anchor id="interface-selector"/>
      <s2 title="Selector">
       <p>
  -     A <code>Selector</code> gets a expression to evaluate and signals the evaluation with a 
  +     A <code>Selector</code> gets an expression to evaluate and signals the evaluation with a 
        boolean value.
       </p>
   
       <source>
        <![CDATA[
  -      public interface Selector implements Component {
  -            boolean select (String expression, Map objectModel);
  +      public interface Selector extends Component {
  +         /**
  +          * Selectors test pattern against some objects in a <code>Map</code>
  +          * model and signals success with the returned boolean value
  +          * @param expression  The expression to test.
  +          * @param objectModel The <code>Map</code> containing object of the
  +          *                    calling environment which may be used
  +          *                    to select values to test the expression.
  +          * @param parameters  The sitemap parameters, as specified by &lt;parameter/&gt; tags.
  +          * @return boolean    Signals successfull test.
  +          */
  +         boolean select (String expression, Map objectModel, Parameters parameters);      
         }
        ]]>
       </source>
  @@ -740,19 +701,28 @@
      <anchor id="interface-code-factory"/>
      <s2 title="CodeFactory">
       <p>
  -     A <code>CodeFactory</code> is capable to return the java source code of the evaluate method of a
  -     <link href="#interface-selector"><code>Selector</code></link> object. It gets the value of the test 
  -     attribute from the sitemap.
  +      Interface a class has to implement that produces java source code
  +      representing logic for class methods. The
  +      returned source code will be directly integrated into a method of the
  +      generated sitemap code.
  +      This <code>CodeFactory</code>s generate method will be called during
  +      sitemap code generation.
  +      A <code>CodeFactory</code> is capable to return the java source code of the evaluate method of a
  +     <link href="#interface-selector"><code>Selector</code></link> or <link href="#interface-matcher"><code>Matcher</code></link>object. 
  +     It gets the value of the test attribute from the sitemap.
       </p>
   
       <source>
        <![CDATA[
         public interface CodeFactory {
  -            String generateParameterSource (NodeList conf);
  +          String generateParameterSource (NodeList conf)
  +          throws ConfigurationException;
   
  -            String generateClassSource (String prefix, String test, NodeList conf);
  +          String generateClassSource (String prefix, String test, NodeList conf)
  +          throws ConfigurationException;
   
  -            String generateMethodSource (NodeList conf);
  +          String generateMethodSource (NodeList conf)
  +          throws ConfigurationException;      
         }
        ]]>
       </source>
  @@ -761,35 +731,33 @@
      <anchor id="interface-matcher"/>
      <s2 title="Matcher">
       <p>
  -     A <code>Matcher</code> gets the <code>OutputStream</code> where the XML should 
  -     be serialized with the following interface:
  +     A <code>Matcher</code> matches a pattern against any value:
       </p>
   
       <source>
        <![CDATA[
  -      public interface Matcher implements Component {
  -          public Map match(...);
  +      public interface Matcher extends Component {
  +          /**
  +           * Matches the pattern against some <code>Request</code> values
  +           * and returns a <code>Map</code> object with replacements
  +           * for wildcards contained in the pattern.
  +           * @param pattern     The pattern to match against. Depending on the
  +           *                    implementation the pattern can contain wildcards
  +           *                    or regular expressions.
  +           * @param objectModel The <code>Map</code> with object of the
  +           *                    calling environment which can be used
  +           *                    to select values this matchers matches against.
  +           * @return Map        The returned <code>Map</code> object with
  +           *                    replacements for wildcards/regular-expressions
  +           *                    contained in the pattern.
  +           *                    If the return value is null there was no match.
  +           */
  +          Map match (String pattern, Map objectModel, Parameters parameters);      
         }
        ]]>
       </source>
      </s2>
   
  -   <anchor id="interface-matcher-factory"/>
  -   <s2 title="MatcherFactory">
  -    <p>
  -     A <code>MatcherFactory</code> is capable to return the java source code of the match method of a
  -     <link href="#interface-matcher"><code>Matcher</code></link> object. It gets the value of the pattern 
  -     attribute from the sitemap.
  -    </p>
  -
  -    <source>
  -     <![CDATA[
  -      public interface MatcherFactory {
  -          public String generateCode(String pattern);
  -      }
  -     ]]>
  -    </source>
  -   </s2>
     </s1>
    
    </body>
  
  
  
  1.2.2.2   +7 -0      xml-cocoon2/xdocs/sql-transformer.xml
  
  Index: sql-transformer.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/sql-transformer.xml,v
  retrieving revision 1.2.2.1
  retrieving revision 1.2.2.2
  diff -u -r1.2.2.1 -r1.2.2.2
  --- sql-transformer.xml	2001/07/10 14:05:45	1.2.2.1
  +++ sql-transformer.xml	2001/07/12 21:07:14	1.2.2.2
  @@ -5,6 +5,8 @@
   <document>
   <header>
   <title>SQL Transformer</title>
  +		<subtitle>in Cocoon 2</subtitle>
  +		<version>0.9</version>
   <authors>
     <person name="Sven Beauprez" email="Sven.Beauprez@the-ecorp.com"/>
     <person name="Davanum Srinivas" email="dims@yahoo.com"/>
  @@ -21,6 +23,11 @@
   possible to use stored procedures. In combination with other transformers (eg 
   FilterTransformer), this one can be very powerful.
   </p>
  +			<ul>
  +				<li>Name : sql</li>
  +				<li>Class: org.apache.cocoon.transformation.SQLTransformer</li>
  +				<li>Cacheable: no.</li>
  +			</ul>
   </s1>
   
   <s1 title="Basic functionallity">
  
  
  
  1.1.2.2   +89 -79    xml-cocoon2/xdocs/stream-generator.xml
  
  Index: stream-generator.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/stream-generator.xml,v
  retrieving revision 1.1.2.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- stream-generator.xml	2001/06/21 12:59:18	1.1.2.1
  +++ stream-generator.xml	2001/07/12 21:07:19	1.1.2.2
  @@ -1,92 +1,102 @@
   <?xml version="1.0"?>
  -<!DOCTYPE document SYSTEM "./dtd/document-v10.dtd">
  -<?xml-stylesheet href="document2html.xsl" type="text/xsl"?>
  -
  +<!DOCTYPE document SYSTEM "dtd/document-v10.dtd">
   <document>
   	<header>
  -		<title>The Stream Generator</title>
  +		<title>Stream Generator</title>
  +		<subtitle>in Cocoon 2</subtitle>
  +		<version>0.9</version>
  +		<type>Technical document</type>
   		<authors>
  -            <person name="Kinga Dziembowska" email="kingadziembowska@msn.com"/>
  +            	<person name="Kinga Dziembowska" email="kingadziembowska@msn.com"/>
   			<person name="Davanum Srinivas" email="dims@yahoo.com"/>
  -		</authors>
  +		 </authors>
  +		 <abstract>This document describes the stream generator of Cocoon 2.</abstract>
   	</header>
  -	
   	<body>
  -		<s1 title="StreamGenerator">
  -            <p>
  -            The StreamGenerator is a class that reads XML from an HttpRequest 
  -            InputStream and generates SAX Events. StreamGenerator expects 
  -            XML data coming as POST message. 
  -            </p>
  -
  -            <p>
  -            For POST requests with mimetype of application/x-www-form-urlencoded, 
  -            the xml data expects to be associated with the name specified 
  -            in the sitemap parameter.
  -            </p>
  -
  -            <p>
  -            For POST requests with mimetypes: text/plain, text/xml, application/xml 
  -            the xml data is in the body of the POST request and its length is 
  -            specified by the value returned by getContentLength() method.
  -            </p>
  -        </s1>
  -		<s1 title="PostInputStream">
  -            <p>
  -            The StreamGenerator uses helper class org.apache.cocoon.util.PostInputStream 
  -            for InputStream reading operations. At the time that Parser reads the data 
  -            out of InputStream - Parser has no knowledge about the length of data to be
  -            read. The only way to signal to the Parser that all data was read from the 
  -            InputStream is to control reading   operation - PostInputStream- and to 
  -            return to the requestor -1 when the number of bytes read is equal to the 
  -            getContentLength() value.
  -            </p>
  -        </s1>
  -
  -		<s1 title="See it in Action">
  -            <p>
  -            The Generator is a generic object, i.e. it can process any stream out of the 
  -            POST message there are two ways to see StreamGenerator in action:
  -            </p>
  +		<s1 title="Stream Generator">
  +	            <p>
  +      	      The StreamGenerator is a class that reads XML from an HttpRequest 
  +            	InputStream and generates SAX Events. StreamGenerator expects 
  +	            XML data coming as POST message. 
  +      	      </p>
  +			<ul>
  +				<li>Name : stream</li>
  +				<li>Class: org.apache.cocoon.generation.StreamGenerator</li>
  +				<li>Cacheable: no.</li>
  +			</ul>
  +           		<p>
  +         		For POST requests with mimetype of application/x-www-form-urlencoded, 
  +		      the xml data expects to be associated with the name specified 
  +            	in the sitemap parameter.
  +	            </p>
  +
  +      	      <p>
  +            	For POST requests with mimetypes: text/plain, text/xml, application/xml 
  +	            the xml data is in the body of the POST request and its length is 
  +      	      specified by the value returned by getContentLength() method.
  +            	</p>
  +			<s2 title="PostInputStream">
  +            	<p>
  +	            The StreamGenerator uses helper class org.apache.cocoon.util.PostInputStream 
  +      	      for InputStream reading operations. At the time that Parser reads the data 
  +            	out of InputStream - Parser has no knowledge about the length of data to be
  +	            read. The only way to signal to the Parser that all data was read from the 
  +      	      InputStream is to control reading   operation - PostInputStream- and to 
  +            	return to the requestor -1 when the number of bytes read is equal to the 
  +	            getContentLength() value.
  +      	      </p>
  +			</s2>
  +
  +			<s2 title="See it in Action">
  +	            <p>
  +            	The Generator is a generic object, i.e. it can process any stream out of the 
  +      	      POST message there are two ways to see StreamGenerator in action:
  +	            </p>
               
  -            <ol>
  -                <li>To invoke URL http://localhost:8080/cocoon/Order</li>
  -                <li>To use telnet program to generate POST request</li>
  -            </ol>
  +            	<ul>
  +	                <li>To invoke URL http://localhost:8080/cocoon/Order</li>
  +      	          <li>To use telnet program to generate POST request</li>
  +            	</ul>
               
  -            <p>  
  -            The first option is not a "pure" stream invocation, but it is quick way to 
  -            observe desired effects. The result of this invocation is a form containing 
  -            the XML document embedded in the textarea of the form. Submission of this 
  -            form will invoke StreamGenerator. The testarea name/value par is specified 
  -            as a parameter in the sitemap definition for the StreamGenerator. The expected 
  -            result is the submitted xml document send back to the browser.
  -            </p>
  +      	      <p>  
  +	            The first option is not a "pure" stream invocation, but it is quick way to 
  +            	observe desired effects. The result of this invocation is a form containing 
  +      	      the XML document embedded in the textarea of the form. Submission of this 
  +	            form will invoke StreamGenerator. The testarea name/value par is specified 
  +            	as a parameter in the sitemap definition for the StreamGenerator. The expected 
  +      	      result is the submitted xml document send back to the browser.
  +	            </p>
               
  -            <p>
  -            The second or "pure" option of testing StreamGenerator "in action," requires the 
  -            use of Telnet program or any other process able to generate correct POST message. 
  -            The procedure is:
  -            </p>
  -
  -            <ol>
  -                <li>To invoke telnet, connect to localhost 8080 and to use content of 
  -                    <link href="telnet.txt">telnet.txt</link> file as a post message. 
  -                </li>
  -                <li>Here, the Copy-Paste method should be used.</li>
  -                <li>Remember to hit the enter button twice enter after the contents of the post are set in telnet.</li>
  -            </ol>
  -
  -            <p>
  -            It is important because Content-len is calculated assuming two "enter" in the end of http message. 
  -            Once again, the performed task results in the mirror of the original document being sent back to the requestor. 
  -            </p>
  +            	<p>
  +      	      The second or "pure" option of testing StreamGenerator "in action," requires the 
  +	            use of Telnet program or any other process able to generate correct POST message. 
  +            	The procedure is:
  +      	      </p>
  +
  +	            <ul>
  +            	    <li>To invoke telnet, connect to localhost 8080 and to use content of 
  +      	              <link href="telnet.txt">telnet.txt</link> file as a post message. 
  +	                </li>
  +            	    <li>Here, the Copy-Paste method should be used.</li>
  +      	          <li>Remember to hit the enter button twice enter after the contents of the post are set in telnet.</li>
  +	            </ul>
  +
  +            	<p>
  +      	      It is important because Content-len is calculated assuming two "enter" in the end of http message. 
  +	            Once again, the performed task results in the mirror of the original document being sent back to the requestor. 
  +            	</p>
               
  -            <p>
  -            The "pure" stream generation can be observed using the telnet utility where you can invoke a 
  -            message targeting my processing. Any other method is good (URL object connection) as 
  -            long the message is well formed.
  -            </p>
  -        </s1>
  +      	      <p>
  +	            The "pure" stream generation can be observed using the telnet utility where you can invoke a 
  +            	message targeting my processing. Any other method is good (URL object connection) as 
  +      	      long the message is well formed.
  +	            </p>
  +<source>
  +     <![CDATA[
  +  <map:generate type="stream"/>
  +     ]]>
  +</source>
  +        		</s2>
  +		</s1>
   	</body>
   </document>
  
  
  
  1.1.2.2   +12 -113   xml-cocoon2/xdocs/transformers.xml
  
  Index: transformers.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/transformers.xml,v
  retrieving revision 1.1.2.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- transformers.xml	2001/07/12 10:56:13	1.1.2.1
  +++ transformers.xml	2001/07/12 21:07:35	1.1.2.2
  @@ -18,122 +18,21 @@
   		 </s1>
   		 <s1 title="Overview">
   			<p>A transformer is the central point in the pipeline. It transform 
  -                                          SAX events in SAX events. 
  +                     SAX events in SAX events. For more information about transformers
  +                     see <link href="sitemap.html">the sitemap</link>.
         	      </p>
   		 </s1>
  -		 <s1 title="Trax/XSLT Transformer">
  -			<p>The xslt transformer reads an xsl document from the local file system or from any url.
  -	               It transformes the sax stream using this stylesheet.</p>
  -      	      <p>The xslt transformer is the default transformer .</p>
  +		 <s1 title="The Transformers in Apache Cocoon 2">
   			<ul>
  -				<li>Name : xslt</li>
  -				<li>Class: org.apache.cocoon.transformation.TraxTransformer</li>
  -				<li>Cacheable: yes - uses the last modification date of the xsl document for validation.</li>
  -			</ul>
  -			<p>The xslt transformer is configurable. You can specify one or more of 
  -                     the following configuration information:</p>
  -			<ul>
  -				<li>use-store: true|false -  If set to true it forces the transformer 
  -                        to put the generated templates from the XSLT stylesheet into the
  - 				system store. This property is true by default.</li>
  -				<li>use-request-parameters: true|false - Setting this to true makes all
  -                        request parameters available in the XSLT stylesheet. Note that this might 
  -                        have issues concerning cachability of the generated output of this transformer,
  -                        the caching algorithm not only checks the last modification date but also
  -                        all values of the request parameters.
  -                        This property is false by default. If set to true the values of a request
  -                        parameter is available using a variable in the xslt with the name of the parameter.</li>
  -				<li>use-browser-capabilities-db: true|false - This configuration forces the transformer to make all
  -                        properties from the browser capability database available in the XSLT stylesheetas.
  -                        Note that this might have issues concerning cachability of the generated output of this
  -                        transformer as the caching algorithm adds this values to the validation phase.
  -                        The default for this property is false.</li>
  -			</ul>
  -			<p>The "use-request-parameters" and "use-browser-capabilities-db" configuration
  -                     of a transformer can be changed for one single pipeline by specifying
  -                     parameters with the same name:</p>
  -<source>
  -     <![CDATA[
  -  <map:transform src="stylesheet.xsl" type="xslt"/>
  -  <!-- The type attribute can be omitted as it is the default transformer. -->
  -     ]]>
  -</source>
  -			<p>The "use-request-parameters" and "use-browser-capabilities-db" configuration
  -                     of a transformer can be changed for one single pipeline by specifying
  -                     parameters with the same name:</p>
  -<source>
  -     <![CDATA[
  -  <map:transform src="stylesheet.xsl">
  -	<map:parameter name="use-request-parameters" value="true"/>
  -  </map:transform>
  -     ]]>
  -</source>
  -			<p>In addition all other parameters to the transformer are
  -                  available in the stylesheet as xsl:variables (These values
  -                  are also used in the caching algorithm.)</p>
  -		</s1>
  -		<s1 title="Fragment Extractor Transformer">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : extractor</li>
  -				<li>Class: org.apache.cocoon.transformation.FragmentExtractorTransformer</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -		</s1>
  -		<s1 title="I18n Transformer">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : i18n</li>
  -				<li>Class: org.apache.cocoon.transformation.I18nTransformer</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -		</s1>
  -		<s1 title="Log Transformer">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : log</li>
  -				<li>Class: org.apache.cocoon.transformation.LogTransformer</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -		</s1>
  -		<s1 title="SQL Transformer">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : sql</li>
  -				<li>Class: org.apache.cocoon.transformation.SQLTransformer</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -		</s1>
  -		<s1 title="XInclude Transformer">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : xinclude</li>
  -				<li>Class: org.apache.cocoon.transformation.XIncludeTransformer</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -		</s1>
  -		<s1 title="CInclude Transformer">
  -			<p>????.</p>
  -			<ul>
  -				<li>Name : cinclude</li>
  -				<li>Class: org.apache.cocoon.transformation.CIncludeTransformer</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -		</s1>
  -		<s1 title="XT Transformer">
  -			<p>???? - optional.</p>
  -			<ul>
  -				<li>Name : xinclude</li>
  -				<li>Class: org.apache.cocoon.transformation.XTTransformer</li>
  -				<li>Cacheable: ????.</li>
  -			</ul>
  -		</s1>
  -		<s1 title="LDAP Transformer">
  -			<p>???? - optional.</p>
  -			<ul>
  -				<li>Name : ldap</li>
  -				<li>Class: org.apache.cocoon.transformation.LDAPTransformer</li>
  -				<li>Cacheable: ????.</li>
  +				<li><link href="xslt-transformer.html">XSLT Transformer</link></li>
  +				<li><link href="extractor-transformer.html">Fragment Extractor Transformer</link></li>
  +				<li><link href="i18n-transformer.html">I18n Transformer</link></li>
  +				<li><link href="log-transformer.html">Log Transformer</link></li>
  +				<li><link href="sql-transformer.html">SQL Transformer</link></li>
  +				<li><link href="xinclude-transformer.html">XInclude Transformer</link></li>
  +				<li><link href="cinclude-transformer.html">CInclude Transformer</link></li>
  +				<li><link href="xt-transformer.html">XT Transformer</link></li>
  +				<li><link href="ldap-transformer.html">LDAP Transformer</link></li>
   			</ul>
   		</s1>
   	</body>
  
  
  
  No                   revision
  
  
  No                   revision
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/cinclude-transformer.xml
  
  
  
  
  1.1.2.1   +29 -0     xml-cocoon2/xdocs/Attic/directory-generator.xml
  
  
  
  
  1.1.2.1   +29 -0     xml-cocoon2/xdocs/Attic/extractor-generator.xml
  
  
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/extractor-transformer.xml
  
  
  
  
  1.1.2.1   +34 -0     xml-cocoon2/xdocs/Attic/file-generator.xml
  
  
  
  
  1.1.2.1   +34 -0     xml-cocoon2/xdocs/Attic/html-generator.xml
  
  
  
  
  1.1.2.1   +25 -0     xml-cocoon2/xdocs/Attic/html-serializer.xml
  
  
  
  
  1.1.2.1   +368 -0    xml-cocoon2/xdocs/Attic/i18n-transformer.xml
  
  
  
  
  1.1.2.1   +30 -0     xml-cocoon2/xdocs/Attic/imagedirectory-generator.xml
  
  
  
  
  1.1.2.1   +29 -0     xml-cocoon2/xdocs/Attic/jsp-generator.xml
  
  
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/ldap-transformer.xml
  
  
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/link-serializer.xml
  
  
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/log-transformer.xml
  
  
  
  
  1.1.2.1   +25 -0     xml-cocoon2/xdocs/Attic/pdf-serializer.xml
  
  
  
  
  1.1.2.1   +32 -0     xml-cocoon2/xdocs/Attic/php-generator.xml
  
  
  
  
  1.1.2.1   +29 -0     xml-cocoon2/xdocs/Attic/request-generator.xml
  
  
  
  
  1.1.2.1   +29 -0     xml-cocoon2/xdocs/Attic/script-generator.xml
  
  
  
  
  1.1.2.1   +29 -0     xml-cocoon2/xdocs/Attic/serverpages-generator.xml
  
  
  
  
  1.1.2.1   +29 -0     xml-cocoon2/xdocs/Attic/status-generator.xml
  
  
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/svgjpeg-serializer.xml
  
  
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/svgpng-serializer.xml
  
  
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/svgxml-serializer.xml
  
  
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/text-serializer.xml
  
  
  
  
  1.1.2.1   +29 -0     xml-cocoon2/xdocs/Attic/velocity-generator.xml
  
  
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/vrml-serializer.xml
  
  
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/wap-serializer.xml
  
  
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/xinclude-transformer.xml
  
  
  
  
  1.1.2.1   +25 -0     xml-cocoon2/xdocs/Attic/xml-serializer.xml
  
  
  
  
  1.1.2.1   +67 -0     xml-cocoon2/xdocs/Attic/xslt-transformer.xml
  
  
  
  
  1.1.2.1   +24 -0     xml-cocoon2/xdocs/Attic/xt-transformer.xml
  
  
  
  

----------------------------------------------------------------------
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