You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by cz...@apache.org on 2001/07/18 09:42:21 UTC

cvs commit: xml-cocoon2/xdocs filter-transformer.xml readdomsession-transformer.xml writedomsession-transformer.xml docs-book.xml extractor-generator.xml extractor-transformer.xml generators.xml ldap-transformer.xml serializers.xml site-book.xml transformers.xml

cziegeler    01/07/18 00:42:21

  Modified:    .        Tag: cocoon_20_branch build.xml
               webapp   Tag: cocoon_20_branch sitemap.xmap
               xdocs    Tag: cocoon_20_branch docs-book.xml
                        extractor-generator.xml extractor-transformer.xml
                        generators.xml ldap-transformer.xml serializers.xml
                        site-book.xml transformers.xml
  Added:       xdocs    Tag: cocoon_20_branch filter-transformer.xml
                        readdomsession-transformer.xml
                        writedomsession-transformer.xml
  Log:
  - Updated docs for transformers and generators
  - Added ldap transformer to optional components
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.8.2.17  +16 -1     xml-cocoon2/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/build.xml,v
  retrieving revision 1.8.2.16
  retrieving revision 1.8.2.17
  diff -u -r1.8.2.16 -r1.8.2.17
  --- build.xml	2001/07/17 09:28:09	1.8.2.16
  +++ build.xml	2001/07/18 07:42:20	1.8.2.17
  @@ -106,7 +106,10 @@
   - XT transformer : Requires the XT package (included in the dist)
                      <map:transformer name="xt" src="org.apache.cocoon.transformation.XTTransformer"/>
   
  +- LDAP transformer: Requires the jndi package (not included in the dist)
  +                   <map:transformer name="ldap" src="org.apache.cocoon.transformation.LDAPTransformer"/>
   
  +
   Serializers
   
   fo2pdf serializer : Requires the FOP package (included in the dist)
  @@ -480,9 +483,21 @@
     </target>
   
     <!-- =================================================================== -->
  +  <!-- Prepares the webapp sitemap if jndi is available                   -->
  +  <!-- =================================================================== -->
  +  <target name="prepare-webapp-naming" depends="copy-webapp" if="naming.present">
  +    <java classname="st">
  +        <arg line="-i ${build.war}/sitemap.xmap -o ${build.war}/sitemap.xmap -a transformers ldap org.apache.cocoon.transformation.LDAPTransformer"/>
  +        <classpath>
  +          <pathelement location="${bin.dir}"/>
  +        </classpath>
  +    </java>
  +  </target>
  +
  +  <!-- =================================================================== -->
     <!-- Prepares the webapp directories                                       -->
     <!-- =================================================================== -->
  -  <target name="prepare-webapp" depends="copy-webapp, prepare-webapp-php, prepare-webapp-xt, prepare-webapp-fop, prepare-webapp-tidy">
  +  <target name="prepare-webapp" depends="copy-webapp, prepare-webapp-php, prepare-webapp-xt, prepare-webapp-fop, prepare-webapp-tidy, prepare-webapp-naming">
         <!-- Simply do nothing, just invoke all dependencies -->
     </target>
   
  
  
  
  No                   revision
  
  
  No                   revision
  
  
  1.11.2.23 +3 -0      xml-cocoon2/webapp/sitemap.xmap
  
  Index: sitemap.xmap
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/webapp/sitemap.xmap,v
  retrieving revision 1.11.2.22
  retrieving revision 1.11.2.23
  diff -u -r1.11.2.22 -r1.11.2.23
  --- sitemap.xmap	2001/07/17 09:28:15	1.11.2.22
  +++ sitemap.xmap	2001/07/18 07:42:20	1.11.2.23
  @@ -32,6 +32,9 @@
      <map:transformer     name="i18n"      src="org.apache.cocoon.transformation.I18nTransformer"/>
      <map:transformer     name="xinclude"  src="org.apache.cocoon.transformation.XIncludeTransformer"/>
      <map:transformer     name="cinclude"  src="org.apache.cocoon.transformation.CIncludeTransformer"/>
  +   <map:transformer     name="filter"  src="org.apache.cocoon.transformation.FilterTransformer"/>
  +   <map:transformer     name="writeDOMsession"  src="org.apache.cocoon.transformation.WriteDOMSessionTransformer"/>
  +   <map:transformer     name="readDOMsession"  src="org.apache.cocoon.transformation.ReadDOMSessionTransformer"/>
     </map:transformers>
   
     <map:readers default="resource">
  
  
  
  No                   revision
  
  
  No                   revision
  
  
  1.3.2.13  +3 -0      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.12
  retrieving revision 1.3.2.13
  diff -u -r1.3.2.12 -r1.3.2.13
  --- docs-book.xml	2001/07/12 21:05:56	1.3.2.12
  +++ docs-book.xml	2001/07/18 07:42:20	1.3.2.13
  @@ -37,6 +37,9 @@
     <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="filter-transformer" label="Filter Transformer" source="filter-transformer.xml"/>
  +  <hidden id="writedomsession-transformer" label="Write DOM Session Transformer" source="writedomsession-transformer.xml"/>
  +  <hidden id="readdomsession-transformer" label="Read DOM Session Transformer" source="readdomsession-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"/>
  
  
  
  1.1.2.2   +6 -2      xml-cocoon2/xdocs/extractor-generator.xml
  
  Index: extractor-generator.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/extractor-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
  --- extractor-generator.xml	2001/07/12 21:06:00	1.1.2.1
  +++ extractor-generator.xml	2001/07/18 07:42:20	1.1.2.2
  @@ -13,11 +13,15 @@
   	</header>
   	<body>
   		<s1 title="Fragment Extractor Generator">
  -			<p>????.</p>
  +			<p> FragmentExtractor is a transformer-generator pair which is designed to allow
  + sitemap managers to extract certain nodes from a SAX stream and move them
  + into a separate pipeline. The main use for this is to extract inline SVG
  + images and serve them up through a separate pipeline, usually serializing
  + them to PNG or JPEG format first.</p>
   			<ul>
   				<li>Name : extractor</li>
   				<li>Class: org.apache.cocoon.generation.FragmentExtractorGenerator</li>
  -				<li>Cacheable: ????.</li>
  +				<li>Cacheable: no.</li>
   			</ul>
   <source>
        <![CDATA[
  
  
  
  1.1.2.2   +3 -2      xml-cocoon2/xdocs/extractor-transformer.xml
  
  Index: extractor-transformer.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/extractor-transformer.xml,v
  retrieving revision 1.1.2.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- extractor-transformer.xml	2001/07/12 21:06:04	1.1.2.1
  +++ extractor-transformer.xml	2001/07/18 07:42:20	1.1.2.2
  @@ -13,11 +13,12 @@
   	</header>
   	<body>
   		<s1 title="Fragment Extractor Transformer">
  -			<p>????.</p>
  +			<p>This transformer sieves an incoming stream of xml with embedded SVG images
  + and replaces the images with an xlink locator pointing to the image.</p>
   			<ul>
   				<li>Name : extractor</li>
   				<li>Class: org.apache.cocoon.transformation.FragmentExtractorTransformer</li>
  -				<li>Cacheable: ????.</li>
  +				<li>Cacheable: no.</li>
   			</ul>
   		</s1>
   	</body>
  
  
  
  1.1.2.4   +2 -2      xml-cocoon2/xdocs/generators.xml
  
  Index: generators.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/generators.xml,v
  retrieving revision 1.1.2.3
  retrieving revision 1.1.2.4
  diff -u -r1.1.2.3 -r1.1.2.4
  --- generators.xml	2001/07/17 12:31:52	1.1.2.3
  +++ generators.xml	2001/07/18 07:42:20	1.1.2.4
  @@ -26,7 +26,7 @@
   		 <s1 title="The Generators in Apache Cocoon 2">
   			<ul>
   				<li><link href="file-generator.html">File Generator</link> (The default generator)</li>
  -				<li><link href="html-generator.html">HTML Generator</link></li>
  +				<li><link href="html-generator.html">HTML Generator</link> (optional)</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>
  @@ -37,7 +37,7 @@
   				<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>
  +				<li><link href="php-generator.html">Php Generator</link> (optional)</li>
   			</ul>
   		</s1>
   	</body>
  
  
  
  1.1.2.2   +46 -2     xml-cocoon2/xdocs/ldap-transformer.xml
  
  Index: ldap-transformer.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/ldap-transformer.xml,v
  retrieving revision 1.1.2.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- ldap-transformer.xml	2001/07/12 21:06:40	1.1.2.1
  +++ ldap-transformer.xml	2001/07/18 07:42:20	1.1.2.2
  @@ -13,12 +13,56 @@
   	</header>
   	<body>
   		<s1 title="LDAP Transformer">
  -			<p>???? - optional.</p>
  +			<p>
  +                   The <code>LDAPTransformer</code> is a class that can be plugged into a pipeline
  +                   to transform the SAX events which passes through this transformer into queries
  +                   to an ldap interface and transforms the response to SAX events which are passed
  +                   on in the pipeline.
  +                  </p>
   			<ul>
   				<li>Name : ldap</li>
   				<li>Class: org.apache.cocoon.transformation.LDAPTransformer</li>
  -				<li>Cacheable: ????.</li>
  +				<li>Cacheable: no.</li>
   			</ul>
  +			<p>This transformer is optional and not available in the binary distribution.
  +                     However if you want to use it, you have to retrieve the jndi package,
  +                     copy the jar file into the lib directory of cocoon and rebuild.
  +                  </p>
  +                  <p>
  + The file will be specified in a parameter tag in the sitemap pipeline to the
  + transformer as follows:
  +</p>
  + <source>
  +  &lt;map:transform type="ldap"/&gt;
  +  </source>
  +  <p>
  + The following DTD is valid:<br/>
  + &lt;!ELEMENT execute-query (attribute+ | show-attribute? | scope? | initializer? | authentication? | error-element? | sax-error?  doc-element? | row-element? | version? | serverurl? | rootdn? | password? | deref-link? | count-limit? | searchbase, filter)&gt;<br/>
  + &lt;!ELEMENT execute-increment (attribute | show-attribute? | scope? | initializer? | authentication? | error-element? | sax-error? | doc-element? | row-element? | version? | serverurl? | rootdn? | password? | deref-link? | count-limit? | searchbase, filter)&gt;<br/>
  + increments (+1) an integer attribute on a directory-server (ldap)<br/>
  + <br/>
  + &lt;!ELEMENT initializer (#PCDATA)&gt;* (default: "com.sun.jndi.ldap.LdapCtxFactory")<br/>
  + &lt;!ELEMENT authentication (#PCDATA)&gt;* (default: "simple")<br/>
  + &lt;!ELEMENT version (#PCDATA)&gt;* (default: "2")<br/>
  + &lt;!ELEMENT serverurl (#PCDATA)&gt;*<br/>
  + &lt;!ELEMENT port (#PCDATA)&gt;* (default: 389)<br/>
  + &lt;!ELEMENT rootdn (#PCDATA)&gt;*<br/>
  + &lt;!ELEMENT password (#PCDATA)&gt;*<br/>
  + &lt;!ELEMENT scope (ONELEVEL_SCOPE | SUBTREE_SCOPE | OBJECT_SCOPE)&gt;* (default: ONELEVEL_SCOPE)<br/>
  + &lt;!ELEMENT searchbase (#PCDATA)&gt;*<br/>
  + &lt;!ELEMENT doc-element (#PCDATA)&gt;* (default: "doc-element")<br/>
  + &lt;!ELEMENT row-element (#PCDATA)&gt;* (default: "row-element")<br/>
  + &lt;!ELEMENT error-element (#PCDATA)&gt;* (default: "ldap-error") (in case of error returned error tag)<br/>
  + &lt;!ELEMENT sax_error (TRUE  | FALSE)&gt;* (default: FALSE) (throws SAX-Exception instead of error tag)<br/>
  + &lt;!ELEMENT attribute (#PCDATA)&gt;<br/>
  + &lt;!ELEMENT show-attribute (TRUE | FALSE)&gt; (default: TRUE)<br/>
  + &lt;!ELEMENT filter (#PCDATA | execute-query)&gt;<br/>
  + &lt;!ELEMENT deref-link (TRUE | FALSE)&gt; (default: FALSE)<br/>
  + &lt;!ELEMENT count-limit (#PCDATA)&gt; (integer default: 0 -> no limit)<br/>
  + &lt;!ELEMENT time-limit (#PCDATA)&gt; (integer default: 0 -> infinite)<br/>
  + &lt;!ELEMENT debug (TRUE  | FALSE)&gt;* (default: FALSE)<br/> 
  +can also be defined as parameter in the sitemap.
  +</p>
   		</s1>
   	</body>
   </document>
  
  
  
  1.1.2.4   +1 -1      xml-cocoon2/xdocs/serializers.xml
  
  Index: serializers.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/serializers.xml,v
  retrieving revision 1.1.2.3
  retrieving revision 1.1.2.4
  diff -u -r1.1.2.3 -r1.1.2.4
  --- serializers.xml	2001/07/17 12:31:53	1.1.2.3
  +++ serializers.xml	2001/07/18 07:42:20	1.1.2.4
  @@ -27,7 +27,7 @@
   				<li><link href="html-serializer.html">HTML Serializer</link> (The default serializer)</li>
   				<li><link href="xml-serializer.html">XML Serializer</link></li>
   				<li><link href="text-serializer.html">Text Serializer</link></li>
  -				<li><link href="pdf-serializer.html">PDF Serializer</link></li>
  +				<li><link href="pdf-serializer.html">PDF 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>
  
  
  
  1.3.2.15  +3 -0      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.14
  retrieving revision 1.3.2.15
  diff -u -r1.3.2.14 -r1.3.2.15
  --- site-book.xml	2001/07/12 21:07:11	1.3.2.14
  +++ site-book.xml	2001/07/18 07:42:21	1.3.2.15
  @@ -40,6 +40,9 @@
     <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="filter-transformer" label="Filter Transformer" source="filter-transformer.xml"/>
  +  <hidden id="writedomsession-transformer" label="Write DOM Session Transformer" source="writedomsession-transformer.xml"/>
  +  <hidden id="readdomsession-transformer" label="Read DOM Session Transformer" source="readdomsession-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"/>
  
  
  
  1.1.2.4   +5 -2      xml-cocoon2/xdocs/transformers.xml
  
  Index: transformers.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/transformers.xml,v
  retrieving revision 1.1.2.3
  retrieving revision 1.1.2.4
  diff -u -r1.1.2.3 -r1.1.2.4
  --- transformers.xml	2001/07/17 12:31:53	1.1.2.3
  +++ transformers.xml	2001/07/18 07:42:21	1.1.2.4
  @@ -29,10 +29,13 @@
   				<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="filter-transformer.html">Filter Transformer</link></li>
  +				<li><link href="readdomsession-transformer.html">Read DOM Session Transformer</link></li>
  +				<li><link href="writedomsession-transformer.html">Write DOM Session 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>
  +				<li><link href="xt-transformer.html">XT Transformer</link> (optional)</li>
  +				<li><link href="ldap-transformer.html">LDAP Transformer</link> (optional)</li>
   			</ul>
   		</s1>
   	</body>
  
  
  
  No                   revision
  
  
  No                   revision
  
  
  1.1.2.1   +118 -0    xml-cocoon2/xdocs/Attic/filter-transformer.xml
  
  
  
  
  1.1.2.1   +69 -0     xml-cocoon2/xdocs/Attic/readdomsession-transformer.xml
  
  
  
  
  1.1.2.1   +62 -0     xml-cocoon2/xdocs/Attic/writedomsession-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