vgritsenko    01/09/30 20:14:14

  Modified:    documentation/xdocs sitemap.xml
               webapp/stylesheets/documents root2html.xsl
               xdocs    docs-book.xml site-book.xml sitemap.xml xsp.xml
  Log:
  Patches from Jeff Turner [[EMAIL PROTECTED]]
  
  Revision  Changes    Path
  1.2       +104 -89   xml-cocoon2/documentation/xdocs/sitemap.xml
  
  Index: sitemap.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/documentation/xdocs/sitemap.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- sitemap.xml       2001/09/28 13:41:29     1.1
  +++ sitemap.xml       2001/10/01 03:14:13     1.2
  @@ -91,7 +91,7 @@
   <![CDATA[
     <?xml version="1.0"?>
   
  -  <map:sitemap xmlns:map="http://xml.apache.org/cocoon/sitemap/1.0";>
  +  <map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0";>
       <map:components/>
       <map:views/>
       <map:resources/>
  @@ -105,7 +105,7 @@
      <s2 title="The &lt;map:sitemap&gt;">
       <source>
   <![CDATA[
  -  <map:sitemap xmlns:map="http://xml.apache.org/cocoon/sitemap/1.0";>
  +  <map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0";>
   ]]>
       </source>
   
  @@ -118,9 +118,9 @@
   
       <p>  
        The versioning schema will be "major.minor" where major will be increased
  -     by one each time a new release breaks back compatibility, while minor
  +     by one each time a new release breaks backwards compatibility, while minor
        is increased each time a change has been made that doesn't create
  -     back incompatible problems.
  +     backwards compatibility problems.
       </p>
      </s2>
   
  @@ -146,48 +146,46 @@
   
        <dl>
         <dt>name</dt>
  -      <dd>The name attribute gives the component a reference which can be used to 
point to them in the pipeline section.</dd>
  +      <dd>Gives the component an identifying name by which it may be referenced in 
the pipeline section.</dd>
         <dt>src</dt>
  -      <dd>Specifies class representing this component.</dd>
  +      <dd>Specifies the class implementing this component.</dd>
        </dl>
       </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;use-store&gt;</code> parameter to a component:
  -     </p>
  +      All components are configured with parameters specified in their child 
elements at component instantiation time.
  +      The following example shows how to specify a 
<code>&lt;use-request-parameter&gt;</code> parameter for an XSLT
  +      transformation component: </p>
     
        <source>
   <![CDATA[
   <map:components>
     <map:transformer name="xslt"
  -     src="org.apache.cocoon.transformation.XSLTTransformer">
  -    <!-- This is a parameter to the transformer component -->
  -    <use-store>true</use-store>
  +     src="org.apache.cocoon.transformation.TraxTransformer">
  +     <!-- This is a parameter to the transformer component -->
  +     <use-request-parameters>false</use-request-parameters>
     </map:transformer>
   </map:components>
   ]]>
        </source>
  - 
        <p>
  -      There is no given set of predefined parameters.
  +       The name and meaning of the parameters are dependent on the component.
        </p>
       </s3>
   
       <s3 title="Generators">
        <p>
  -      A <link href="#interface-generator"><code>Generator</code></link> generates 
XML content as SAX events and initialize the 
  -      pipeline processing. 
  +      A <link href="#interface-generator"><code>Generator</code></link> generates 
XML content as SAX events and initializes the pipeline processing. 
        </p>
   
        <source>
   <![CDATA[
  -<map:generators default="parser">
  -  <map:generator name="parser" src="org.apache.cocoon.generator.FileGenerator"/>
  -  <map:generator name="dir"    src="MyDirGenerator"/>
  -  <map:generator name="xsp"    src="org.apache.cocoon.generators.XSPGenerator">
  +<map:generators default="file">
  +  <map:generator name="file"  src="org.apache.cocoon.generation.FileGenerator"/>
  +  <map:generator name="dir"  src="MyDirGenerator"/>
  +  <map:generator name="serverpages"
  +                 src="org.apache.cocoon.generation.ServerPagesGenerator">
      ...
     </map:generator>
   </map:generators>
  @@ -202,15 +200,16 @@
   
       <s3 title="Transformers">
        <p>
  -      A <link href="#interface-transformer"><code>Transformer</code></link> 
transform SAX events in SAX events.
  +      A <link href="#interface-transformer"><code>Transformer</code></link> 
transforms SAX events into other SAX events.
        </p>
   
        <source>
   <![CDATA[
   <map:transformers default="xslt">
     <map:transformer name="xslt" 
  -                   src="org.apache.cocoon.transformation.XSLTTransformer">
  -    <use-store>true</use-store>
  +                   src="org.apache.cocoon.transformation.TraxTransformer">
  +    <use-request-parameters>false</use-request-parameters>
  +    <use-browser-capabilities-db>false</use-browser-capabilities-db>
     </map:transformer>
     <map:transformer name="xinclude" 
                      src="org.apache.cocoon.transformation.XIncludeTransformer"/>
  @@ -226,7 +225,7 @@
   
       <s3 title="Serializers">
        <p>
  -      A <link href="#interface-serializer"><code>Serializers</code></link> 
transform SAX events 
  +      A <link href="#interface-serializer"><code>Serializer</code></link> 
transforms SAX events 
         in binary or char streams for final client consumption.
        </p>
   
  @@ -234,7 +233,7 @@
   <![CDATA[
   <map:serializers default="html">
     <map:serializer name="html" mime-type="text/html" 
  -                  src="org.apache.cocoon.serializer.HTMLSerializer">
  +                  src="org.apache.cocoon.serialization.HTMLSerializer">
       <doctype-public>-//W3C//DTD HTML 4.0 Transitional//EN</doctype-public>
       <doctype-system>http://www.w3.org/TR/REC-html40/loose.dtd</doctype-system>
       <omit-xml-declaration>true</omit-xml-declaration>
  @@ -243,19 +242,19 @@
     </map:serializer>
   
     <map:serializer name="wap" mime-type="text/vnd.wap.wml" 
  -     src="org.apache.cocoon.serializer.XMLSerializer">
  +     src="org.apache.cocoon.serialization.XMLSerializer">
       <doctype-public>-//WAPFORUM//DTD WML 1.1//EN</doctype-public>
       <doctype-system>http://www.wapforum.org/DTD/wml_1.1.xml</doctype-system>
       <encoding>UTF-8</encoding>
     </map:serializer>
   
     <map:serializer name="svg2jpeg" mime-type="image/jpeg" 
  -                  src="org.apache.cocoon.serializer.SVGSerializer">
  +                  src="org.apache.cocoon.serialization.SVGSerializer">
       <parameter name="background_color" type="color" value="#00FF00"/>
     </map:serializer>
   
     <map:serializer name="svg2png" mime-type="image/png" 
  -                  src="org.apache.cocoon.serializer.SVGSerializer">
  +                  src="org.apache.cocoon.serialization.SVGSerializer">
     </map:serializer>
   </map:serializers>
   ]]>
  @@ -269,8 +268,11 @@
   
       <s3 title="Selectors">
        <p>
  -      A <link href="#interface-selector"><code>Selector</code></link> evaluate a 
boolean expression.
  -     </p>
  +       A <link href="#interface-selector"><code>Selector</code></link> is used to 
implement basic
  +       conditional logic (<code>if-then-else</code> or <code>switch</code>) inside 
the sitemap.
  +       As can be seen in the <link 
href="#interface-selector"><code>Selector</code></link>
  +       interface, this functionality decomposes into the ability to evaluate a 
boolean
  +       condition.</p>
        <source>
   <![CDATA[
   <map:selectors default="browser">
  @@ -286,6 +288,11 @@
   
     <map:selector name="browser" 
                   src="org.apache.cocoon.selection.BrowserSelectorFactory">
  +    <browser name="explorer" useragent="MSIE"/>
  +    <browser name="lynx" useragent="Lynx"/>
  +    <browser name="mozilla5" useragent="Mozilla/5"/>
  +    <browser name="mozilla5" useragent="Netscape6/"/>
  +    <browser name="netscape" useragent="Mozilla"/>
      ...
     </map:selection>
   </map:selection>
  @@ -297,13 +304,14 @@
         of selector to use if none is specified in a pipeline.
        </p>
   
  -     <p> 
  -      Because the sitemap will be translated and compiled into a java class at 
runtime a 
  +     <p>
  +      Because the sitemap will be translated and compiled into a Java class at 
runtime, a 
         <link href="#interface-selector"><code>Selector</code></link> can specify a 
class 
         implementing <link 
href="#interface-code-factory"><code>CodeFactory</code></link>
  -      instead of <link href="#interface-selector"><code>Selector</code></link> 
interface.
  -      This class must be capable to return a java source code fragment that can be 
embedded into a method corresponding 
  -      to the <link href="#interface-selector"><code>Selector</code></link>s 
evaluate method.
  +      instead of the <link href="#interface-selector"><code>Selector</code></link> 
interface.
  +      This class must be capable of returning a Java source code fragment that can 
be embedded into a
  +      method corresponding to the <link 
href="#interface-selector"><code>Selector</code></link>'s
  +      evaluate method.
        </p>
       </s3>
   
  @@ -313,14 +321,14 @@
        </p>
        <source>
   <![CDATA[
  -<map:matchers default="uri-wildcard">
  -  <map:matcher name="uri-wildcard" 
  -               src="org.apache.cocoon.matcher.WildcardURIMatcherFactory">
  +<map:matchers default="wildcard">
  +  <map:matcher name="wildcard" 
  +               src="org.apache.cocoon.matching.WildcardURIMatcherFactory">
      ...
     </map:matcher>
   
  -  <map:matcher name="uri-regexp" 
  -               src="org.apache.cocoon.matcher.RegexpURIMatcher">
  +  <map:matcher name="regexp" 
  +               src="org.apache.cocoon.matching.RegexpURIMatcherFactory">
      ...
     </map:matcher>
   </map:matchers>
  @@ -333,12 +341,13 @@
        </p>
   
        <p> 
  -      Because the sitemap will be translated and compiled into a java class at 
runtime a 
  +      Because the sitemap will be translated and compiled into a Java class at 
runtime, a 
         <link href="#interface-matcher"><code>Matcher</code></link> can specify a 
class
         implementing <link 
href="#interface-code-factory"><code>CodeFactory</code></link>
  -      instead of <link href="#interface-matcher"><code>Matcher</code></link> 
interface.
  -      This class must be capable to return a java source code fragment that can be 
embedded into a method corresponding 
  -      to the <link href="#interface-matcher"><code>Matcher</code></link>s match 
method.
  +      instead of the <link href="#interface-matcher"><code>Matcher</code></link> 
interface.
  +      This class must be capable of returning a Java source code fragment that can 
be embedded into
  +      a method corresponding to the <link 
href="#interface-matcher"><code>Matcher</code></link>'s
  +      match method.
        </p>
       </s3>
   
  @@ -346,8 +355,9 @@
        <p>
         An <link href="#interface-action"><code>Action</code></link> is a sitemap 
component
         that manipulates runtime parameters based on request and application state.
  -      Action's result is available in the sitemap as map of name/value pairs.
  -      Detailed information on actions is <link href="actions.html">here</link>.
  +      An Action's result is available in the sitemap as map of name/value pairs.
  +      Detailed information on actions may be found in <link href="actions.html">the 
Actions
  +      section</link>.
        </p>
        <source>
   <![CDATA[
  @@ -371,8 +381,8 @@
       <p>
        The <code>&lt;map:view&gt;</code> element defines different view
        of the site. Views are defined independent of pipelines and might
  -     be used with any pipeline defined in the sitemap. More on views 
  -     read "<link href="views.html">Views</link>".
  +     be used with any pipeline defined in the sitemap. For more on views 
  +     read <link href="views.html">the Views section</link>.
       </p>
      
       <source>
  @@ -421,10 +431,10 @@
       </source>
      </s2>
   
  -   <s2 title="The &lt;map:action-set&gt;">
  +   <s2 title="The &lt;map:action-sets&gt;">
       <p>
        The <code>&lt;map:action-set&gt;</code> element is used to arrange actions in
  -     a groups (See "<link href="actions.html">Actions</link>" for details).
  +     groups (See <link href="actions.html">the Actions section</link> for details).
       </p>
   
       <source>
  @@ -449,11 +459,11 @@
       <p>
          Mount points allow sitemaps to be cascaded and site management
          workload to be parallelized. This creates a tree of sitemaps with
  -       the main sitemap at the root and possibly several subsitemaps
  +       the main sitemap at the root and possibly several sub-sitemaps
          as nodes and leaves.
        </p>
  -     <p>The subsitemaps serve two important goals: scalability and
  -      simplification of maintainance. The different subsitemaps are independent
  +     <p>The sub-sitemaps serve two important goals: scalability and
  +      simplification of maintenance. The different sub-sitemaps are independent
         and don't affect each other.
       </p>
        <source>
  @@ -464,20 +474,20 @@
   ]]>
       </source>
       <p>
  -     The src attribute is where the subsitemap is located. If it ends in a slash
  -     "sitemap.xmap" is appended to find the sitemap otherwise the src
  +     The src attribute is where the sub-sitemap is located. If it ends in a slash
  +     "sitemap.xmap" is appended to find the sitemap, otherwise the src
        value is used. A check-reload attribute can be used to determine if the
  -     modification date of the subsitemap file should be checked. 
  +     modification date of the sub-sitemap file should be checked. 
        The uri-prefix is the part that should be removed from the request URI.
        The engine will correctly check for a trailing slash (which you may
        write, of course).
        If in the example above "faq/cocoon" is requested, "faq/" is removed from
  -     the URI and "cocoon" is passed to the subsitemap which is loaded
  +     the URI and "cocoon" is passed to the sub-sitemap which is loaded
        from "faq/sitemap.xmap".
        </p>
        <p>
        Sitemap components (generators, transformers, etc.) in a sitemap are 
accessible 
  -     by a sub-sitemap by their names. This is due to the fact that each sitemap has 
its 
  +     from a sub-sitemap by their names. This is due to the fact that each sitemap 
has its 
        own SitemapComponentManager and they are arranged in the same hierarchical 
        structure as the sitemaps are and thus knows which are their parent 
        SitemapComponentManager and can ask it for a SitemapComponent it doesn't know 
about.
  @@ -491,7 +501,7 @@
        If you break a sitemap all its sub-sitemaps are broken as well (because of the 
hierarchical arrangement).
        </p>
        <p>
  -     However you can create independent subsitemaps, which meet the following goals:
  +     However you can create independent sub-sitemaps, which meet the following 
goals:
        </p>
        <ol>
         <li>Simplify site construction</li>
  @@ -508,7 +518,7 @@
        any error in that sitemap does not kill any other sitemap. 
        </p>
        <p>
  -     Here is an example of a main sitemap. You will notice that it  is using a 
selector that
  +     Here is an example of a main sitemap. You will notice that it is using a 
selector that
        matches on host name of the request, but any matcher or selector would work
        at this point. Both sub-sitemaps are mounted at the root level.
        </p>
  @@ -552,28 +562,32 @@
        </source>
       </s3>
       <s3 title="Reloading">
  -     <p>The reloading of the subsitemaps can be configured by two attributes.    
</p>
  +     <p>The reloading of the sub-sitemaps can be configured by two attributes,
  +       "check-reload" and "reload-method".</p>
        <source>
   <![CDATA[
  -  <map:match pattern="faq/*"> 
  -    <map:mount uri-prefix="faq/" check-reload="no" 
  -               src="faq/sitemap.xmap" reload-method="asynchron"/> 
  -  </map:match> 
  -]]>
  -</source>
  -     <p>
  -     The "check-reload" attribute specifies if the sitemap is reloaded, this means 
regenerated, if
  -     it changes. If it set to "no", the sitemap is only generated on the first 
request for this
  -     sitemap.
  -     If it is set to "yes" (the default), the reload-method determines who the 
sitemap is regenerated
  -     if it had changed. If it set to "asynchron" (the default), the next request 
for the changed
  -     sitemap, regenerates the sitemap in the background and the request is served 
with the old
  -     one. All subsequent requests are served with the old sitemap until the 
regeneration in the 
  -     background has finished. If the reload-method is set to "synchron", the 
sitemap is first
  -     regenerated and then the request is responded.
  +<map:match pattern="faq/*"> 
  +  <map:mount uri-prefix="faq/" check-reload="no" 
  +     src="faq/sitemap.xmap" reload-method="asynchron"/> 
  +</map:match> 
  +]]>
  +     </source>
  +     <p>
  +      The "check-reload" attribute specifies whether the sitemap should be reloaded 
(regenerated) if
  +      it's source XML (sitemap.xmap) is modified.  If "check-reload" is set to 
"no", the sitemap is
  +      only generated on the first request for this sitemap.  If "check-reload" is 
set to "yes" (the
  +      default), the "reload-method" attribute determines how the sitemap is
  +      regenerated if it had changed.
  +    </p>
  +    <p>
  +      If "reload-method" is set to "asynchron" (the default), then the next request 
for the changed
  +      sitemap causes it to be regenerated in the background, and the request is 
served with the old
  +      one. All subsequent requests are served with the old sitemap until the 
regeneration in the
  +      background has finished. If the reload-method is set to "synchron", the 
sitemap is first
  +      regenerated and then the request is processed.
        </p>
  -     </s3>
  -    </s2>
  +    </s3>
  +   </s2>
     </s1>
   
     <s1 title="Interface specifications">
  @@ -582,7 +596,7 @@
       <p>
        This interfaces identifies classes that produce XML data, sending SAX
        events to the configured <code>XMLConsumer</code>.<br/>
  -     It's beyond the scope of this interface to specify a way in which the XML
  +     It is beyond the scope of this interface to specify a way in which the XML
        data production is started.
       </p>
   
  @@ -638,7 +652,7 @@
      <anchor id="interface-sitemap-model-component"/>
      <s2 title="SitemapModelComponent">
       <p>
  -     All sitemap components producing xml must implement this interface:
  +     All sitemap components producing XML must implement this interface:
       </p>
   
       <source>
  @@ -808,15 +822,16 @@
      <anchor id="interface-code-factory"/>
      <s2 title="CodeFactory">
       <p>
  -      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
  +     The <code>CodeFactory</code> interface must be implemented by classes that 
produce Java source
  +     code representing logic for class methods. The returned source code will be 
directly integrated
  +     into a method of the generated sitemap code.
  +     The <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
  +      A <code>CodeFactory</code> implementation is capable to return the Java 
source code of the
  +      <code>evaluate</code> 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.
  +     object. It gets passed the value of the "test" attribute of <code>&lt;map:when 
test=".."&gt;</code>
  +     sections from the sitemap.
       </p>
   
       <source>
  
  
  
  1.10      +10 -0     xml-cocoon2/webapp/stylesheets/documents/root2html.xsl
  
  Index: root2html.xsl
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/webapp/stylesheets/documents/root2html.xsl,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- root2html.xsl     2001/07/28 21:52:27     1.9
  +++ root2html.xsl     2001/10/01 03:14:13     1.10
  @@ -74,6 +74,16 @@
     <xsl:apply-templates/>
   </xsl:template>
   
  +<xsl:template match="body//s3">
  +  <h3><xsl:value-of select="@title"/></h3>
  +  <xsl:apply-templates/>
  +</xsl:template>
  +
  +<xsl:template match="body//s4">
  +  <h4><xsl:value-of select="@title"/></h4>
  +  <xsl:apply-templates/>
  +</xsl:template>
  +
   <xsl:template match="body//link">
     <a>
       <xsl:copy-of select="@href"/>
  
  
  
  1.31      +9 -9      xml-cocoon2/xdocs/docs-book.xml
  
  Index: docs-book.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/docs-book.xml,v
  retrieving revision 1.30
  retrieving revision 1.31
  diff -u -r1.30 -r1.31
  --- docs-book.xml     2001/09/26 12:48:57     1.30
  +++ docs-book.xml     2001/10/01 03:14:13     1.31
  @@ -80,13 +80,13 @@
     <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"/>
  -  <page id="logicsheet-concepts" label="XSP Logicsheets" 
source="logicsheet-concepts.xml"/>
  -  <page id="logicsheet-guide" label="XSP Guide" source="logicsheet.xml"/>
  -  <page id="logicsheet-sessions" label="Session Logicsheet" source="session.xml"/>
  -  <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"/>
  +  <hidden id="logicsheet-concepts" label="XSP Logicsheets" 
source="logicsheet-concepts.xml"/>
  +  <hidden id="xsp-internals" label="XSP Internals" source="xsp-internals.xml"/>
  +  <hidden id="logicsheet-guide" label="XSP Guide" source="logicsheet.xml"/>
  +  <hidden id="logicsheet-sessions" label="Session Logicsheet" source="session.xml"/>
  +  <hidden id="logicsheet-request" label="Request Logicsheet" source="request.xml"/>
  +  <hidden id="logicsheet-esql" label="ESQL Logicsheet" source="esql.xml"/>
  +  <hidden id="logicsheet-forms" label="Forms" source="logicsheet-forms.xml"/>
   <separator/>
     <external label="XML Links" 
href="http://dmoz.org/Computers/Data_Formats/Markup_Languages/XML/"/> 
   <separator/>
  @@ -95,8 +95,8 @@
     <page id="3rdparty" label="3rd Party" source="3rdparty.xml"/>
     <page id="patches" label="Patch Queue" source="patches.xml"/>
   <separator/>
  -  <faq    id="faq"       label="FAQ File"   source="faq.xml"      />
  -  <changes id="changes" label="Changes" source="changes.xml"/>
  +  <faq     id="faq"     label="FAQ File" source="faq.xml"    />
  +  <changes id="changes" label="Changes"  source="changes.xml"/>
     <todo    id="todo" label="Todo" source="todo.xml"/>
   <separator/>
     <page id="livesites" label="Live Sites" source="livesites.xml"/>
  
  
  
  1.33      +8 -8      xml-cocoon2/xdocs/site-book.xml
  
  Index: site-book.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/site-book.xml,v
  retrieving revision 1.32
  retrieving revision 1.33
  diff -u -r1.32 -r1.33
  --- site-book.xml     2001/09/26 12:48:58     1.32
  +++ site-book.xml     2001/10/01 03:14:13     1.33
  @@ -81,13 +81,13 @@
     <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"/>
  -  <page id="logicsheet-concepts" label="XSP Logicsheets" 
source="logicsheet-concepts.xml"/>
  -  <page id="logicsheet-guide" label="XSP Guide" source="logicsheet.xml"/>
  -  <page id="logicsheet-sessions" label="Session Logicsheet" source="session.xml"/>
  -  <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"/>
  +  <hidden id="logicsheet-concepts" label="XSP Logicsheets" 
source="logicsheet-concepts.xml"/>
  +  <hidden id="xsp-internals" label="XSP Internals" source="xsp-internals.xml"/>
  +  <hidden id="logicsheet-guide" label="XSP Guide" source="logicsheet.xml"/>
  +  <hidden id="logicsheet-sessions" label="Session Logicsheet" source="session.xml"/>
  +  <hidden id="logicsheet-request" label="Request Logicsheet" source="request.xml"/>
  +  <hidden id="logicsheet-esql" label="ESQL Logicsheet" source="esql.xml"/>
  +  <hidden id="logicsheet-forms" label="Forms" source="logicsheet-forms.xml"/>
   <separator/>
     <external href="apidocs/index.html" label="API (Javadoc)"/>
   <separator/>
  @@ -98,7 +98,7 @@
     <page id="3rdparty" label="3rd Party" source="3rdparty.xml"/>
     <page id="patches" label="Patch Queue" source="patches.xml"/>
   <separator/>
  -  <external href="../cocoon/index.html"  label="@docname@ 1 Site"/>
  +  <external href="http://xml.apache.org/cocoon/";  label="@docname@ 1 Site"/>
   <separator/>
     <faq    id="faq"       label="FAQ File"   source="faq.xml"      />
     <changes id="changes" label="Changes" source="changes.xml"/>
  
  
  
  1.8       +104 -89   xml-cocoon2/xdocs/sitemap.xml
  
  Index: sitemap.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/sitemap.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- sitemap.xml       2001/09/26 12:48:58     1.7
  +++ sitemap.xml       2001/10/01 03:14:13     1.8
  @@ -91,7 +91,7 @@
   <![CDATA[
     <?xml version="1.0"?>
   
  -  <map:sitemap xmlns:map="http://xml.apache.org/cocoon/sitemap/1.0";>
  +  <map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0";>
       <map:components/>
       <map:views/>
       <map:resources/>
  @@ -105,7 +105,7 @@
      <s2 title="The &lt;map:sitemap&gt;">
       <source>
   <![CDATA[
  -  <map:sitemap xmlns:map="http://xml.apache.org/cocoon/sitemap/1.0";>
  +  <map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0";>
   ]]>
       </source>
   
  @@ -118,9 +118,9 @@
   
       <p>  
        The versioning schema will be "major.minor" where major will be increased
  -     by one each time a new release breaks back compatibility, while minor
  +     by one each time a new release breaks backwards compatibility, while minor
        is increased each time a change has been made that doesn't create
  -     back incompatible problems.
  +     backwards compatibility problems.
       </p>
      </s2>
   
  @@ -146,48 +146,46 @@
   
        <dl>
         <dt>name</dt>
  -      <dd>The name attribute gives the component a reference which can be used to 
point to them in the pipeline section.</dd>
  +      <dd>Gives the component an identifying name by which it may be referenced in 
the pipeline section.</dd>
         <dt>src</dt>
  -      <dd>Specifies class representing this component.</dd>
  +      <dd>Specifies the class implementing this component.</dd>
        </dl>
       </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;use-store&gt;</code> parameter to a component:
  -     </p>
  +      All components are configured with parameters specified in their child 
elements at component instantiation time.
  +      The following example shows how to specify a 
<code>&lt;use-request-parameter&gt;</code> parameter for an XSLT
  +      transformation component: </p>
     
        <source>
   <![CDATA[
   <map:components>
     <map:transformer name="xslt"
  -     src="org.apache.cocoon.transformation.XSLTTransformer">
  -    <!-- This is a parameter to the transformer component -->
  -    <use-store>true</use-store>
  +     src="org.apache.cocoon.transformation.TraxTransformer">
  +     <!-- This is a parameter to the transformer component -->
  +     <use-request-parameters>false</use-request-parameters>
     </map:transformer>
   </map:components>
   ]]>
        </source>
  - 
        <p>
  -      There is no given set of predefined parameters.
  +       The name and meaning of the parameters are dependent on the component.
        </p>
       </s3>
   
       <s3 title="Generators">
        <p>
  -      A <link href="#interface-generator"><code>Generator</code></link> generates 
XML content as SAX events and initialize the 
  -      pipeline processing. 
  +      A <link href="#interface-generator"><code>Generator</code></link> generates 
XML content as SAX events and initializes the pipeline processing. 
        </p>
   
        <source>
   <![CDATA[
  -<map:generators default="parser">
  -  <map:generator name="parser" src="org.apache.cocoon.generator.FileGenerator"/>
  -  <map:generator name="dir"    src="MyDirGenerator"/>
  -  <map:generator name="xsp"    src="org.apache.cocoon.generators.XSPGenerator">
  +<map:generators default="file">
  +  <map:generator name="file"  src="org.apache.cocoon.generation.FileGenerator"/>
  +  <map:generator name="dir"  src="MyDirGenerator"/>
  +  <map:generator name="serverpages"
  +                 src="org.apache.cocoon.generation.ServerPagesGenerator">
      ...
     </map:generator>
   </map:generators>
  @@ -202,15 +200,16 @@
   
       <s3 title="Transformers">
        <p>
  -      A <link href="#interface-transformer"><code>Transformer</code></link> 
transform SAX events in SAX events.
  +      A <link href="#interface-transformer"><code>Transformer</code></link> 
transforms SAX events into other SAX events.
        </p>
   
        <source>
   <![CDATA[
   <map:transformers default="xslt">
     <map:transformer name="xslt" 
  -                   src="org.apache.cocoon.transformation.XSLTTransformer">
  -    <use-store>true</use-store>
  +                   src="org.apache.cocoon.transformation.TraxTransformer">
  +    <use-request-parameters>false</use-request-parameters>
  +    <use-browser-capabilities-db>false</use-browser-capabilities-db>
     </map:transformer>
     <map:transformer name="xinclude" 
                      src="org.apache.cocoon.transformation.XIncludeTransformer"/>
  @@ -226,7 +225,7 @@
   
       <s3 title="Serializers">
        <p>
  -      A <link href="#interface-serializer"><code>Serializers</code></link> 
transform SAX events 
  +      A <link href="#interface-serializer"><code>Serializer</code></link> 
transforms SAX events 
         in binary or char streams for final client consumption.
        </p>
   
  @@ -234,7 +233,7 @@
   <![CDATA[
   <map:serializers default="html">
     <map:serializer name="html" mime-type="text/html" 
  -                  src="org.apache.cocoon.serializer.HTMLSerializer">
  +                  src="org.apache.cocoon.serialization.HTMLSerializer">
       <doctype-public>-//W3C//DTD HTML 4.0 Transitional//EN</doctype-public>
       <doctype-system>http://www.w3.org/TR/REC-html40/loose.dtd</doctype-system>
       <omit-xml-declaration>true</omit-xml-declaration>
  @@ -243,19 +242,19 @@
     </map:serializer>
   
     <map:serializer name="wap" mime-type="text/vnd.wap.wml" 
  -     src="org.apache.cocoon.serializer.XMLSerializer">
  +     src="org.apache.cocoon.serialization.XMLSerializer">
       <doctype-public>-//WAPFORUM//DTD WML 1.1//EN</doctype-public>
       <doctype-system>http://www.wapforum.org/DTD/wml_1.1.xml</doctype-system>
       <encoding>UTF-8</encoding>
     </map:serializer>
   
     <map:serializer name="svg2jpeg" mime-type="image/jpeg" 
  -                  src="org.apache.cocoon.serializer.SVGSerializer">
  +                  src="org.apache.cocoon.serialization.SVGSerializer">
       <parameter name="background_color" type="color" value="#00FF00"/>
     </map:serializer>
   
     <map:serializer name="svg2png" mime-type="image/png" 
  -                  src="org.apache.cocoon.serializer.SVGSerializer">
  +                  src="org.apache.cocoon.serialization.SVGSerializer">
     </map:serializer>
   </map:serializers>
   ]]>
  @@ -269,8 +268,11 @@
   
       <s3 title="Selectors">
        <p>
  -      A <link href="#interface-selector"><code>Selector</code></link> evaluate a 
boolean expression.
  -     </p>
  +       A <link href="#interface-selector"><code>Selector</code></link> is used to 
implement basic
  +       conditional logic (<code>if-then-else</code> or <code>switch</code>) inside 
the sitemap.
  +       As can be seen in the <link 
href="#interface-selector"><code>Selector</code></link>
  +       interface, this functionality decomposes into the ability to evaluate a 
boolean
  +       condition.</p>
        <source>
   <![CDATA[
   <map:selectors default="browser">
  @@ -286,6 +288,11 @@
   
     <map:selector name="browser" 
                   src="org.apache.cocoon.selection.BrowserSelectorFactory">
  +    <browser name="explorer" useragent="MSIE"/>
  +    <browser name="lynx" useragent="Lynx"/>
  +    <browser name="mozilla5" useragent="Mozilla/5"/>
  +    <browser name="mozilla5" useragent="Netscape6/"/>
  +    <browser name="netscape" useragent="Mozilla"/>
      ...
     </map:selection>
   </map:selection>
  @@ -297,13 +304,14 @@
         of selector to use if none is specified in a pipeline.
        </p>
   
  -     <p> 
  -      Because the sitemap will be translated and compiled into a java class at 
runtime a 
  +     <p>
  +      Because the sitemap will be translated and compiled into a Java class at 
runtime, a 
         <link href="#interface-selector"><code>Selector</code></link> can specify a 
class 
         implementing <link 
href="#interface-code-factory"><code>CodeFactory</code></link>
  -      instead of <link href="#interface-selector"><code>Selector</code></link> 
interface.
  -      This class must be capable to return a java source code fragment that can be 
embedded into a method corresponding 
  -      to the <link href="#interface-selector"><code>Selector</code></link>s 
evaluate method.
  +      instead of the <link href="#interface-selector"><code>Selector</code></link> 
interface.
  +      This class must be capable of returning a Java source code fragment that can 
be embedded into a
  +      method corresponding to the <link 
href="#interface-selector"><code>Selector</code></link>'s
  +      evaluate method.
        </p>
       </s3>
   
  @@ -313,14 +321,14 @@
        </p>
        <source>
   <![CDATA[
  -<map:matchers default="uri-wildcard">
  -  <map:matcher name="uri-wildcard" 
  -               src="org.apache.cocoon.matcher.WildcardURIMatcherFactory">
  +<map:matchers default="wildcard">
  +  <map:matcher name="wildcard" 
  +               src="org.apache.cocoon.matching.WildcardURIMatcherFactory">
      ...
     </map:matcher>
   
  -  <map:matcher name="uri-regexp" 
  -               src="org.apache.cocoon.matcher.RegexpURIMatcher">
  +  <map:matcher name="regexp" 
  +               src="org.apache.cocoon.matching.RegexpURIMatcherFactory">
      ...
     </map:matcher>
   </map:matchers>
  @@ -333,12 +341,13 @@
        </p>
   
        <p> 
  -      Because the sitemap will be translated and compiled into a java class at 
runtime a 
  +      Because the sitemap will be translated and compiled into a Java class at 
runtime, a 
         <link href="#interface-matcher"><code>Matcher</code></link> can specify a 
class
         implementing <link 
href="#interface-code-factory"><code>CodeFactory</code></link>
  -      instead of <link href="#interface-matcher"><code>Matcher</code></link> 
interface.
  -      This class must be capable to return a java source code fragment that can be 
embedded into a method corresponding 
  -      to the <link href="#interface-matcher"><code>Matcher</code></link>s match 
method.
  +      instead of the <link href="#interface-matcher"><code>Matcher</code></link> 
interface.
  +      This class must be capable of returning a Java source code fragment that can 
be embedded into
  +      a method corresponding to the <link 
href="#interface-matcher"><code>Matcher</code></link>'s
  +      match method.
        </p>
       </s3>
   
  @@ -346,8 +355,9 @@
        <p>
         An <link href="#interface-action"><code>Action</code></link> is a sitemap 
component
         that manipulates runtime parameters based on request and application state.
  -      Action's result is available in the sitemap as map of name/value pairs.
  -      Detailed information on actions is <link href="actions.html">here</link>.
  +      An Action's result is available in the sitemap as map of name/value pairs.
  +      Detailed information on actions may be found in <link href="actions.html">the 
Actions
  +      section</link>.
        </p>
        <source>
   <![CDATA[
  @@ -371,8 +381,8 @@
       <p>
        The <code>&lt;map:view&gt;</code> element defines different view
        of the site. Views are defined independent of pipelines and might
  -     be used with any pipeline defined in the sitemap. More on views 
  -     read "<link href="views.html">Views</link>".
  +     be used with any pipeline defined in the sitemap. For more on views 
  +     read <link href="views.html">the Views section</link>.
       </p>
      
       <source>
  @@ -421,10 +431,10 @@
       </source>
      </s2>
   
  -   <s2 title="The &lt;map:action-set&gt;">
  +   <s2 title="The &lt;map:action-sets&gt;">
       <p>
        The <code>&lt;map:action-set&gt;</code> element is used to arrange actions in
  -     a groups (See "<link href="actions.html">Actions</link>" for details).
  +     groups (See <link href="actions.html">the Actions section</link> for details).
       </p>
   
       <source>
  @@ -449,11 +459,11 @@
       <p>
          Mount points allow sitemaps to be cascaded and site management
          workload to be parallelized. This creates a tree of sitemaps with
  -       the main sitemap at the root and possibly several subsitemaps
  +       the main sitemap at the root and possibly several sub-sitemaps
          as nodes and leaves.
        </p>
  -     <p>The subsitemaps serve two important goals: scalability and
  -      simplification of maintainance. The different subsitemaps are independent
  +     <p>The sub-sitemaps serve two important goals: scalability and
  +      simplification of maintenance. The different sub-sitemaps are independent
         and don't affect each other.
       </p>
        <source>
  @@ -464,20 +474,20 @@
   ]]>
       </source>
       <p>
  -     The src attribute is where the subsitemap is located. If it ends in a slash
  -     "sitemap.xmap" is appended to find the sitemap otherwise the src
  +     The src attribute is where the sub-sitemap is located. If it ends in a slash
  +     "sitemap.xmap" is appended to find the sitemap, otherwise the src
        value is used. A check-reload attribute can be used to determine if the
  -     modification date of the subsitemap file should be checked. 
  +     modification date of the sub-sitemap file should be checked. 
        The uri-prefix is the part that should be removed from the request URI.
        The engine will correctly check for a trailing slash (which you may
        write, of course).
        If in the example above "faq/cocoon" is requested, "faq/" is removed from
  -     the URI and "cocoon" is passed to the subsitemap which is loaded
  +     the URI and "cocoon" is passed to the sub-sitemap which is loaded
        from "faq/sitemap.xmap".
        </p>
        <p>
        Sitemap components (generators, transformers, etc.) in a sitemap are 
accessible 
  -     by a sub-sitemap by their names. This is due to the fact that each sitemap has 
its 
  +     from a sub-sitemap by their names. This is due to the fact that each sitemap 
has its 
        own SitemapComponentManager and they are arranged in the same hierarchical 
        structure as the sitemaps are and thus knows which are their parent 
        SitemapComponentManager and can ask it for a SitemapComponent it doesn't know 
about.
  @@ -491,7 +501,7 @@
        If you break a sitemap all its sub-sitemaps are broken as well (because of the 
hierarchical arrangement).
        </p>
        <p>
  -     However you can create independent subsitemaps, which meet the following goals:
  +     However you can create independent sub-sitemaps, which meet the following 
goals:
        </p>
        <ol>
         <li>Simplify site construction</li>
  @@ -508,7 +518,7 @@
        any error in that sitemap does not kill any other sitemap. 
        </p>
        <p>
  -     Here is an example of a main sitemap. You will notice that it  is using a 
selector that
  +     Here is an example of a main sitemap. You will notice that it is using a 
selector that
        matches on host name of the request, but any matcher or selector would work
        at this point. Both sub-sitemaps are mounted at the root level.
        </p>
  @@ -552,28 +562,32 @@
        </source>
       </s3>
       <s3 title="Reloading">
  -     <p>The reloading of the subsitemaps can be configured by two attributes.    
</p>
  +     <p>The reloading of the sub-sitemaps can be configured by two attributes,
  +       "check-reload" and "reload-method".</p>
        <source>
   <![CDATA[
  -  <map:match pattern="faq/*"> 
  -    <map:mount uri-prefix="faq/" check-reload="no" 
  -               src="faq/sitemap.xmap" reload-method="asynchron"/> 
  -  </map:match> 
  -]]>
  -</source>
  -     <p>
  -     The "check-reload" attribute specifies if the sitemap is reloaded, this means 
regenerated, if
  -     it changes. If it set to "no", the sitemap is only generated on the first 
request for this
  -     sitemap.
  -     If it is set to "yes" (the default), the reload-method determines who the 
sitemap is regenerated
  -     if it had changed. If it set to "asynchron" (the default), the next request 
for the changed
  -     sitemap, regenerates the sitemap in the background and the request is served 
with the old
  -     one. All subsequent requests are served with the old sitemap until the 
regeneration in the 
  -     background has finished. If the reload-method is set to "synchron", the 
sitemap is first
  -     regenerated and then the request is responded.
  +<map:match pattern="faq/*"> 
  +  <map:mount uri-prefix="faq/" check-reload="no" 
  +     src="faq/sitemap.xmap" reload-method="asynchron"/> 
  +</map:match> 
  +]]>
  +     </source>
  +     <p>
  +      The "check-reload" attribute specifies whether the sitemap should be reloaded 
(regenerated) if
  +      it's source XML (sitemap.xmap) is modified.  If "check-reload" is set to 
"no", the sitemap is
  +      only generated on the first request for this sitemap.  If "check-reload" is 
set to "yes" (the
  +      default), the "reload-method" attribute determines how the sitemap is
  +      regenerated if it had changed.
  +    </p>
  +    <p>
  +      If "reload-method" is set to "asynchron" (the default), then the next request 
for the changed
  +      sitemap causes it to be regenerated in the background, and the request is 
served with the old
  +      one. All subsequent requests are served with the old sitemap until the 
regeneration in the
  +      background has finished. If the reload-method is set to "synchron", the 
sitemap is first
  +      regenerated and then the request is processed.
        </p>
  -     </s3>
  -    </s2>
  +    </s3>
  +   </s2>
     </s1>
   
     <s1 title="Interface specifications">
  @@ -582,7 +596,7 @@
       <p>
        This interfaces identifies classes that produce XML data, sending SAX
        events to the configured <code>XMLConsumer</code>.<br/>
  -     It's beyond the scope of this interface to specify a way in which the XML
  +     It is beyond the scope of this interface to specify a way in which the XML
        data production is started.
       </p>
   
  @@ -638,7 +652,7 @@
      <anchor id="interface-sitemap-model-component"/>
      <s2 title="SitemapModelComponent">
       <p>
  -     All sitemap components producing xml must implement this interface:
  +     All sitemap components producing XML must implement this interface:
       </p>
   
       <source>
  @@ -808,15 +822,16 @@
      <anchor id="interface-code-factory"/>
      <s2 title="CodeFactory">
       <p>
  -      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
  +     The <code>CodeFactory</code> interface must be implemented by classes that 
produce Java source
  +     code representing logic for class methods. The returned source code will be 
directly integrated
  +     into a method of the generated sitemap code.
  +     The <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
  +      A <code>CodeFactory</code> implementation is capable to return the Java 
source code of the
  +      <code>evaluate</code> 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.
  +     object. It gets passed the value of the "test" attribute of <code>&lt;map:when 
test=".."&gt;</code>
  +     sections from the sitemap.
       </p>
   
       <source>
  
  
  
  1.5       +29 -14    xml-cocoon2/xdocs/xsp.xml
  
  Index: xsp.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon2/xdocs/xsp.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- xsp.xml   2001/09/26 12:48:58     1.4
  +++ xsp.xml   2001/10/01 03:14:13     1.5
  @@ -10,19 +10,34 @@
    </header>
   
     <body> 
  -         <s1 title="XSP learning map">
  -                <p>As I find that there is enough information about XSP available 
(only
  -                  not together), I give you a list of pointers in the sequence you 
should read
  -                  them.</p> 
  -                <ol>
  -                  <li>Get @doctitle@ <link href="installing.html">up and 
running</link>. Surf
  -                to <code>[webhost]/cocoon/slides/slides?section=4</code> and 
following. This
  -                gives you a first insight in the XSP ground idea.</li>
  -                <li>Read the XSP Logicsheets page. This tells you how to use and 
make
  -                  your own XSP logicsheets and XSP pages.</li>
  -                <li>If you're still hungry for more, read the XSP Internals page. 
This
  -                  describes how XSP's are handled internally by @docname@.</li>
  -                </ol>
  -         </s1> 
  +      <s1 title="XSP learning map">
  +        <p>As I find that there is enough information about XSP available (only
  +          not together), I give you a list of pointers in the sequence you should 
read
  +          them.</p> 
  +        <ol>
  +        <li>Get @doctitle@ <link href="installing.html">up and running</link>. Surf
  +          to <code>[webhost]/cocoon/slides/slides?section=4</code> and following. 
This
  +          gives you a first insight in the XSP ground idea.</li>
  +        <li>Read the XSP Logicsheets page. This tells you how to use and make
  +          your own XSP logicsheets and XSP pages.</li>
  +        <li>If you're still hungry for more, read the XSP Internals page. This
  +          describes how XSP's are handled internally by @docname@.</li>
  +        </ol>
  +      </s1> 
  +      <s1 title="XSP resources">
  +             <ul>
  +             <li><link href="logicsheet-concepts.html">XSP Logicsheets</link> 
concepts page helps you get started.</li>
  +             <li><link href="xsp-internals.html">XSP Internals</link> page gives 
deeper explanation of XSP technology.</li>
  +             <li><link href="logicsheet.html">XSP Guide</link> page is a tutorial 
to using and creating @docname@ XSP logicsheets.</li>
  +             </ul>
  +             <s2 title="Logicsheets documentation">
  +                     <ul>
  +                     <li><link href="logicsheet-sessions.html">Sessions 
Logicsheet</link></li>
  +                     <li><link href="logicsheet-request.html">Request 
Logicsheet</link></li>
  +                     <li><link href="logicsheet-esql.html">ESQL 
Logicsheet</link></li>
  +                     <li><link href="logicsheet-forms.html">Forms 
Logicsheet</link></li>
  +                     </ul>
  +             </s2>
  +      </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