stephan     2003/02/04 06:54:27

  Modified:    src/blocks/chaperon/samples sitemap.xmap
               src/documentation/xdocs/howto book.xml index.xml
               src/documentation/xdocs/userdocs/generators book.xml
                        generators.xml
               src/documentation/xdocs/userdocs/transformers book.xml
                        transformers.xml
  Added:       src/documentation/xdocs/userdocs/transformers
                        lexer-transformer.xml parser-transformer.xml
                        pattern-transformer.xml
  Removed:     src/documentation/xdocs/howto/chaperon book.xml
                        howto-chaperon-grm.xml howto-chaperon-intro.xml
                        howto-chaperon-txtgrm.xml
               src/documentation/xdocs/userdocs/generators
                        textparser-generator.xml
               src/documentation/xdocs/userdocs/transformers
                        textparser-transformer.xml
  Log:
  Update docs for the chaperon components.
  
  Revision  Changes    Path
  1.4       +4 -4      xml-cocoon2/src/blocks/chaperon/samples/sitemap.xmap
  
  Index: sitemap.xmap
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/blocks/chaperon/samples/sitemap.xmap,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- sitemap.xmap      4 Feb 2003 13:26:34 -0000       1.3
  +++ sitemap.xmap      4 Feb 2003 14:54:27 -0000       1.4
  @@ -194,11 +194,11 @@
        <map:part                    src="cocoon:/packages.xml"/>
        <map:part                    src="misc/{1}/{2}.java"/>
       </map:aggregate>
  -    <!--<map:transform type="lexer"  src="cocoon:/java.xlex"/>-->
  -    <map:transform type="lexer"   src="grammars/java.xlex"/>
  +    <map:transform type="lexer"  src="cocoon:/java.xlex"/>
  +<!--    <map:transform type="lexer"   src="grammars/java.xlex"/>-->
       <map:transform                src="stylesheets/text4javadoc.xsl"/>
  -    <!--<map:transform type="lexer" src="cocoon:/javadoc.xlex"/>-->
  -    <map:transform type="lexer"   src="grammars/javadoc.xlex"/>
  +    <map:transform type="lexer" src="cocoon:/javadoc.xlex"/>
  +<!--    <map:transform type="lexer"   src="grammars/javadoc.xlex"/>-->
       <map:transform                src="stylesheets/java2html.xsl">
        <map:parameter name="package" value="{1}"/>
        <map:parameter name="class"   value="{2}"/>
  
  
  
  1.13      +0 -1      xml-cocoon2/src/documentation/xdocs/howto/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/howto/book.xml,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- book.xml  11 Dec 2002 18:55:28 -0000      1.12
  +++ book.xml  4 Feb 2003 14:54:27 -0000       1.13
  @@ -12,7 +12,6 @@
       <menu-item label="Paginator" href="howto-paginator-transformer.html"/>
       <menu-item label="HTML-PDF" href="howto-html-pdf-publishing.html"/>
       <menu-item label="Web Syndication" 
href="../userdocs/generators/wsproxy-generator.html"/>    
  -    <menu-item label="Chaperon" href="chaperon/howto-chaperon-intro.html"/>
       <menu-item label="i18n XMLForm" href="howto-i18n-xmlform.html"/>
       <menu-item label="Flow Debugger" href="howto-flow-debugger.html"/>
     </menu>
  
  
  
  1.13      +0 -1      xml-cocoon2/src/documentation/xdocs/howto/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/howto/index.xml,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- index.xml 11 Dec 2002 18:55:28 -0000      1.12
  +++ index.xml 4 Feb 2003 14:54:27 -0000       1.13
  @@ -24,7 +24,6 @@
   <li><link href="xmlform-wizard/howto-xmlform-wizard.html">XMLForm Wizard</link></li>
   <li><link href="howto-paginator-transformer.html">Paginator Transformer</link></li>
   <li><link href="howto-html-pdf-publishing.html">HTML-PDF Publishing</link></li>
  -<li><link href="chaperon/howto-chaperon-intro.html">Chaperon Text Parser</link></li>
   <li><link href="howto-i18n-xmlform.html">i18n XMLForm</link></li>
   <li><link href="howto-flow-debugger.html">Flow Debugger</link></li>
        </ul>
  
  
  
  1.5       +0 -1      xml-cocoon2/src/documentation/xdocs/userdocs/generators/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: 
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/book.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- book.xml  1 Sep 2002 05:06:17 -0000       1.4
  +++ book.xml  4 Feb 2003 14:54:27 -0000       1.5
  @@ -28,7 +28,6 @@
       <menu-item label="Search Generator" href="search-generator.html"/>
       <menu-item label="LinkStatus Generator" href="linkstatus-generator.html"/>
       <menu-item label="Web Service Proxy Generator" href="wsproxy-generator.html"/>
  -    <menu-item label="Text Parser Generator" href="textparser-generator.html"/>
     </menu>
     <menu label="Optional">
       <menu-item label="Php Generator" href="php-generator.html"/>
  
  
  
  1.5       +0 -1      
xml-cocoon2/src/documentation/xdocs/userdocs/generators/generators.xml
  
  Index: generators.xml
  ===================================================================
  RCS file: 
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/generators/generators.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- generators.xml    15 Aug 2002 13:43:18 -0000      1.4
  +++ generators.xml    4 Feb 2003 14:54:27 -0000       1.5
  @@ -47,7 +47,6 @@
                                <li><link href="php-generator.html">Php 
Generator</link> (optional)</li>
                                <li><link href="xmldb-generator.html">XML:DB 
Generator</link> (optional)</li>
                                <li><link href="xmldbcollection-generator.html">XML:DB 
Collection Generator</link> (optional)</li>
  -        <li><link href="textparser-generator.html">Text Parser Generator</link></li>
                        </ul>
                </s1>
        </body>
  
  
  
  1.6       +3 -1      
xml-cocoon2/src/documentation/xdocs/userdocs/transformers/book.xml
  
  Index: book.xml
  ===================================================================
  RCS file: 
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/transformers/book.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- book.xml  15 Aug 2002 13:43:18 -0000      1.5
  +++ book.xml  4 Feb 2003 14:54:27 -0000       1.6
  @@ -29,11 +29,13 @@
       <menu-item label="EncodeURL Transformer" href="encodeurl-transformer.html"/>
       <menu-item label="SourceWriting Transformer" 
href="sourcewriting-transformer.html"/>
       <menu-item label="Augment Transformer" href="augment-transformer.html"/>
  -    <menu-item label="Text Parser Transformer" href="textparser-transformer.html"/>
     </menu>
     <menu label="Optional">
       <menu-item label="XT Transformer" href="xt-transformer.html"/>
       <menu-item label="LDAP Transformer" href="ldap-transformer.html"/>
  +    <menu-item label="Lexical Transformer" href="lexer-transformer.html"/>
  +    <menu-item label="Parser Transformer" href="parser-transformer.html"/>
  +    <menu-item label="Pattern Transformer" href="pattern-transformer.html"/>
     </menu>
   
   </book>
  
  
  
  1.7       +3 -1      
xml-cocoon2/src/documentation/xdocs/userdocs/transformers/transformers.xml
  
  Index: transformers.xml
  ===================================================================
  RCS file: 
/home/cvs/xml-cocoon2/src/documentation/xdocs/userdocs/transformers/transformers.xml,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- transformers.xml  15 Aug 2002 13:43:18 -0000      1.6
  +++ transformers.xml  4 Feb 2003 14:54:27 -0000       1.7
  @@ -44,7 +44,9 @@
                                   <li><link href="augment-transformer.html">Augment 
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>
  -        <li><link href="textparser-transformer.html">Text Parser 
Transformer</link></li>
  +        <li><link href="lexer-transformer.html">Lexical Transformer</link> 
(optional)</li>
  +        <li><link href="parser-transformer.html">Parser Transformer</link> 
(optional)</li>
  +        <li><link href="pattern-transformer.html">Pattern Transformer</link> 
(optional)</li>
                        </ul>
                </s1>
        </body>
  
  
  
  1.1                  
xml-cocoon2/src/documentation/xdocs/userdocs/transformers/lexer-transformer.xml
  
  Index: lexer-transformer.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" 
"../../dtd/document-v10.dtd">
  
  <document>
   <header>
    <title>Lexical Transformer</title>
    <version>0.1</version>
    <type>Technical document</type>
    <authors>
     <person id="SMS" name="Stephan Michels" email="[EMAIL PROTECTED]"/>
    </authors>
    <abstract>This document describes the lexical transformer of Cocoon.</abstract>
   </header>
   <body>
    <s1 title="Lexical Transformer">
     <p>The lexical transformer tokenize the content of special marked elements of a 
SAX stream, by using
        a lexicon file.</p>
  
     <ul>
      <li>Name : lexer</li>
      <li>Class: org.apache.cocoon.transformation.LexicalTransformer</li>
      <li>Cacheable: yes - uses the last modification date of the lexicon document for 
validation.</li>
     </ul>
  
     <p>The lexer parse following elements from the SAX stream, and replace them 
through
        generated documents.</p>
  
     <source><![CDATA[
  <text xmlns="http://chaperon.sourceforge.net/schema/text/1.0";>
   [Text, which should be parsed]
  </text>
  ]]></source>
  
     <p>The lexical transformer will replace these elemens by a list of 
lexemes(tokens).</p>
  
     <source><![CDATA[
  <lexemes xmlns="http://chaperon.sourceforge.net/schema/lexemes/1.0";>
   <lexeme symbol="..." text="..."/>
   <lexeme symbol="..." text="..."/>
   <lexeme symbol="..." text="..."/>
  </lexemes>
  ]]></source>
  
     <p>A detailed explanation of function and the lexicon format can be found at <link
       href="http://chaperon.sourceforge.net/";>Chaperon</link>.</p>
  
    </s1>
   </body>
  </document>
  
  
  
  1.1                  
xml-cocoon2/src/documentation/xdocs/userdocs/transformers/parser-transformer.xml
  
  Index: parser-transformer.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" 
"../../dtd/document-v10.dtd">
  
  <document>
   <header>
    <title>Parser Transformer</title>
    <version>0.1</version>
    <type>Technical document</type>
    <authors>
     <person id="SMS" name="Stephan Michels" email="[EMAIL PROTECTED]"/>
    </authors>
    <abstract>This document describes the parser transformer of Cocoon.</abstract>
   </header>
   <body>
    <s1 title="Parser Transformer">
     <p>The parser transformer builds a syntax tree of a list of lexemes(tokens), by 
using
        a grammar file.</p>
  
     <ul>
      <li>Name : parser</li>
      <li>Class: org.apache.cocoon.transformation.ParserTransformer</li>
      <li>Cacheable: yes - uses the last modification date of the grammar document for 
validation.</li>
     </ul>
  
     <p>The parser use following elements from the SAX stream, and replace them through
        a syntax tree.</p>
  
     <source><![CDATA[
  <lexemes xmlns="http://chaperon.sourceforge.net/schema/lexemes/1.0";>
   <lexeme symbol="word" text="..."/>
   <lexeme symbol="word" text="..."/>
   <lexeme symbol="word" text="..."/>
   <lexeme symbol="punctation" text="..."/>
  </lexemes>
  ]]></source>
  
     <p>The parser transformer will replace these elemens by a syntax tree.</p>
  
     <source><![CDATA[
  <paragraph xmlns="http://chaperon.sourceforge.net/schema/syntaxtree/1.0";>
   <sentence>
    <word>...</word>
    <word>...</word>
    <word>...</word>
    <punctation>...</punctation>
   </sentence>
  </paragraph>
  ]]></source>
  
     <p>A detailed explanation of function and the grammar format can be found at <link
       href="http://chaperon.sourceforge.net/";>Chaperon</link>.</p>
  
    </s1>
   </body>
  </document>
  
  
  
  1.1                  
xml-cocoon2/src/documentation/xdocs/userdocs/transformers/pattern-transformer.xml
  
  Index: pattern-transformer.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" 
"../../dtd/document-v10.dtd">
  
  <document>
   <header>
    <title>Pattern Transformer</title>
    <version>0.1</version>
    <type>Technical document</type>
    <authors>
     <person id="SMS" name="Stephan Michels" email="[EMAIL PROTECTED]"/>
    </authors>
    <abstract>This document describes the pattern transformer of Cocoon.</abstract>
   </header>
   <body>
    <s1 title="Pattern Transformer">
     <p>The pattern transformer recognized special text part by a pattern, and replace 
them by a XML
        element. This transformer use a lexicon file to specify the pattern.</p>
  
     <ul>
      <li>Name : pattern</li>
      <li>Class: org.apache.cocoon.transformation.PatternTransformer</li>
      <li>Cacheable: yes - uses the last modification date of the lexicon document for 
validation.</li>
     </ul>
  
     <p>The pattern transformer parse all text elements from the SAX stream, and 
replace the 
      special text parts.</p>
  
     <source><![CDATA[
  <myelement>
   bla blah Hello World bla
  </myelement>
  ]]></source>
  
     <p>The pattern transformer will replace these special text parts by a 
lexeme(token).</p>
  
     <source><![CDATA[
  <myelement>
   bla blah <lexeme xmlns="http://chaperon.sourceforge.net/schema/lexemes/1.0"; 
                    symbol="Hello World"
                    text="Hello World"/> bla
  </myelement>
  ]]></source>
  
     <p>A detailed explanation of function and the lexicon format can be found at <link
       href="http://chaperon.sourceforge.net/";>Chaperon</link>.</p>
  
    </s1>
   </body>
  </document>
  
  
  

----------------------------------------------------------------------
In case of troubles, e-mail:     [EMAIL PROTECTED]
To unsubscribe, e-mail:          [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to