cvs commit: cocoon-2.1/src/documentation/xdocs/userdocs/flow api.xml jpath.xml

[coliver]

coliver     2003/06/01 11:23:36

  Modified:    src/documentation/xdocs/userdocs/flow api.xml jpath.xml
  Log:
  documented the log object and a couple of other corrections
  
  Revision  Changes    Path
  1.12      +40 -1     cocoon-2.1/src/documentation/xdocs/userdocs/flow/api.xml
  
  Index: api.xml
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/flow/api.xml,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- api.xml   1 Jun 2003 15:49:04 -0000       1.11
  +++ api.xml   1 Jun 2003 18:23:36 -0000       1.12
  @@ -49,7 +49,7 @@
       </s2>
     </s1>
       <s1 title="Objects">
  -    <s2 title = "cocoon">
  +    <s2 title = "cocoon object">
       <p>The <code>cocoon</code> object represents the current Cocoon sitemap and 
provides the following readonly properties:</p> 
       <s3 title="request">
       <p>The current Cocoon request:</p>
  @@ -129,6 +129,45 @@
       <p>
         Load the JavaScript script specified by <code>uri</code>. The Cocoon
        source resolver is used to resolve <code>uri</code>. 
  +    </p>
  +    </s3>
  +    </s2>
  +    <s2 title="log object"><anchor id="log"/>
  +    <p> The <code>log</code> object provides an interface to the Cocoon logging 
system.
  +    </p>
  +    <p>
  +        It supports the following functions:
  +    </p>
  +    <s3 title="error">
  +    <p>
  +        <em>Function</em> <code>error([String] message)</code>
  +    </p>
  +    <p>
  +      Log an error message.
  +    </p>
  +    </s3>
  +    <s3 title="debug">
  +    <p>
  +        <em>Function</em> <code>debug([String] message)</code>
  +    </p>
  +    <p>
  +      Log a debug message.
  +    </p>
  +    </s3>
  +    <s3 title="warn">
  +    <p>
  +        <em>Function</em> <code>warn([String] message)</code>
  +    </p>
  +    <p>
  +      Log a warning message.
  +    </p>
  +    </s3>
  +    <s3 title="info">
  +    <p>
  +        <em>Function</em> <code>info([String] message)</code>
  +    </p>
  +    <p>
  +      Log an information message.
       </p>
       </s3>
       </s2>
  
  
  
  1.12      +1 -2      cocoon-2.1/src/documentation/xdocs/userdocs/flow/jpath.xml
  
  Index: jpath.xml
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/flow/jpath.xml,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- jpath.xml 1 Jun 2003 17:22:47 -0000       1.11
  +++ jpath.xml 1 Jun 2003 18:23:36 -0000       1.12
  @@ -24,8 +24,7 @@
       <p>The JPath tags are defined in the namespace</p>
       <source>http://apache.org/xsp/jpath/1.0</source>
       <s2 title ="if">
  -     <p>The <code>if</code> tag allows the conditional execution of its body 
according to value of
  -        a <code>test</code> attribute:</p>
  +     <p>The <code>if</code> tag allows the conditional execution of its body 
according to value of its <code>test</code> attribute:</p>
        <source>
   &lt;if test="XPathExpression"&gt;
     body