cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From blorit...@apache.org
Subject cvs commit: xml-cocoon/xdocs actions.xml datasources.xml docs-book.xml site-book.xml
Date Mon, 12 Feb 2001 05:56:50 GMT
bloritsch    01/02/11 21:56:50

  Modified:    .        Tag: xml-cocoon2 build.xml
               src/org/apache/cocoon/acting Tag: xml-cocoon2 Action.java
                        AddEmployeeAction.java ComposerAction.java
                        DelEmployeeAction.java LangSelect.java
               xdocs    Tag: xml-cocoon2 datasources.xml docs-book.xml
                        site-book.xml
  Added:       xdocs    Tag: xml-cocoon2 actions.xml
  Log:
  Documentation changes for Actions.  (Thanks Giacomo for your answers).
  I will put it to test, but hopefully it will help more than just me.
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.6.2.53  +1 -1      xml-cocoon/build.xml
  
  Index: build.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon/build.xml,v
  retrieving revision 1.6.2.52
  retrieving revision 1.6.2.53
  diff -u -r1.6.2.52 -r1.6.2.53
  --- build.xml	2001/01/10 15:20:58	1.6.2.52
  +++ build.xml	2001/02/12 05:56:49	1.6.2.53
  @@ -109,7 +109,7 @@
       <property name="Name"     value="Cocoon"/>
       <property name="name"     value="cocoon"/>
       <property name="version"  value="2.0a3"/>
  -    <property name="year"     value="1999-2000"/>
  +    <property name="year"     value="1999-2001"/>
   
       <echo message="------------------- ${fullname} ${version} [${year}] ----------------"/>
   
  
  
  
  No                   revision
  
  
  No                   revision
  
  
  1.1.2.6   +3 -3      xml-cocoon/src/org/apache/cocoon/acting/Attic/Action.java
  
  Index: Action.java
  ===================================================================
  RCS file: /home/cvs/xml-cocoon/src/org/apache/cocoon/acting/Attic/Action.java,v
  retrieving revision 1.1.2.5
  retrieving revision 1.1.2.6
  diff -u -r1.1.2.5 -r1.1.2.6
  --- Action.java	2000/12/15 20:35:08	1.1.2.5
  +++ Action.java	2001/02/12 05:56:49	1.1.2.6
  @@ -19,7 +19,7 @@
   /**
    *
    * @author <a href="mailto:Giacomo.Pati@pwr.ch">Giacomo Pati</a>
  - * @version CVS $Revision: 1.1.2.5 $ $Date: 2000/12/15 20:35:08 $
  + * @version CVS $Revision: 1.1.2.6 $ $Date: 2001/02/12 05:56:49 $
    */
   public interface Action extends Component, ThreadSafe {
       /**
  @@ -38,10 +38,10 @@
        *                    (ie HttpRequest, HttpResponse).
        * @param source      A source <code>String</code> to the Action
        * @param parameters  The <code>Parameters</code> for this invocation
  -     * @return List       The returned <code>List</code> object with
  +     * @return Map        The returned <code>Map</code> object with
        *                    sitemap substitution values which can be used
        *                    in subsequent elements attributes like src=
  -     *                    using a xpath like expression: src="mydir/{1}/foo"
  +     *                    using a xpath like expression: src="mydir/{myval}/foo"
        *                    If the return value is null the processing inside
        *                    the <map:act> element of the sitemap will
        *                    be skipped.
  
  
  
  1.1.2.9   +3 -1      xml-cocoon/src/org/apache/cocoon/acting/Attic/AddEmployeeAction.java
  
  Index: AddEmployeeAction.java
  ===================================================================
  RCS file: /home/cvs/xml-cocoon/src/org/apache/cocoon/acting/Attic/AddEmployeeAction.java,v
  retrieving revision 1.1.2.8
  retrieving revision 1.1.2.9
  diff -u -r1.1.2.8 -r1.1.2.9
  --- AddEmployeeAction.java	2001/02/09 20:51:10	1.1.2.8
  +++ AddEmployeeAction.java	2001/02/12 05:56:49	1.1.2.9
  @@ -37,7 +37,7 @@
    *
    * @author <a href="mailto:Giacomo.Pati@pwr.ch">Giacomo Pati</a>
    * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
  - * @version CVS $Revision: 1.1.2.8 $ $Date: 2001/02/09 20:51:10 $
  + * @version CVS $Revision: 1.1.2.9 $ $Date: 2001/02/12 05:56:49 $
    */
   public class AddEmployeeAction extends ComposerAction {
   
  @@ -47,6 +47,8 @@
        * Get the <code>Configuration</code> object for this <code>Component</code>
        */
       public void configure( Configuration configuration) throws ConfigurationException {
  +        super.configure(configuration);
  +
           Configuration connElement = configuration.getChild("use-connection");
   
           try {
  
  
  
  1.1.2.2   +3 -1      xml-cocoon/src/org/apache/cocoon/acting/Attic/ComposerAction.java
  
  Index: ComposerAction.java
  ===================================================================
  RCS file: /home/cvs/xml-cocoon/src/org/apache/cocoon/acting/Attic/ComposerAction.java,v
  retrieving revision 1.1.2.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- ComposerAction.java	2000/12/06 22:54:10	1.1.2.1
  +++ ComposerAction.java	2001/02/12 05:56:49	1.1.2.2
  @@ -12,9 +12,11 @@
   import org.apache.cocoon.Cocoon;
   
   /**
  + * The <code>ComposerAction</code> will allow any <code>Action</code>
  + * that extends this to access SitemapComponents.
    *
    * @author <a href="mailto:Giacomo.Pati@pwr.ch">Giacomo Pati</a>
  - * @version CVS $Revision: 1.1.2.1 $ $Date: 2000/12/06 22:54:10 $
  + * @version CVS $Revision: 1.1.2.2 $ $Date: 2001/02/12 05:56:49 $
    */
   public abstract class ComposerAction extends AbstractAction implements Composer {
   
  
  
  
  1.1.2.7   +2 -1      xml-cocoon/src/org/apache/cocoon/acting/Attic/DelEmployeeAction.java
  
  Index: DelEmployeeAction.java
  ===================================================================
  RCS file: /home/cvs/xml-cocoon/src/org/apache/cocoon/acting/Attic/DelEmployeeAction.java,v
  retrieving revision 1.1.2.6
  retrieving revision 1.1.2.7
  diff -u -r1.1.2.6 -r1.1.2.7
  --- DelEmployeeAction.java	2001/02/09 20:51:10	1.1.2.6
  +++ DelEmployeeAction.java	2001/02/12 05:56:49	1.1.2.7
  @@ -37,7 +37,7 @@
    *
    * @author <a href="mailto:Giacomo.Pati@pwr.ch">Giacomo Pati</a>
    * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
  - * @version CVS $Revision: 1.1.2.6 $ $Date: 2001/02/09 20:51:10 $
  + * @version CVS $Revision: 1.1.2.7 $ $Date: 2001/02/12 05:56:49 $
    */
   public class DelEmployeeAction extends ComposerAction {
   
  @@ -47,6 +47,7 @@
        * Get the <code>Configuration</code> object for this <code>Component</code>
        */
       public void configure( Configuration configuration) throws ConfigurationException {
  +        super.configure(configuration);
           Configuration connElement = configuration.getChild("use-connection");
   
           try {
  
  
  
  1.1.2.4   +13 -7     xml-cocoon/src/org/apache/cocoon/acting/Attic/LangSelect.java
  
  Index: LangSelect.java
  ===================================================================
  RCS file: /home/cvs/xml-cocoon/src/org/apache/cocoon/acting/Attic/LangSelect.java,v
  retrieving revision 1.1.2.3
  retrieving revision 1.1.2.4
  diff -u -r1.1.2.3 -r1.1.2.4
  --- LangSelect.java	2001/02/09 20:51:11	1.1.2.3
  +++ LangSelect.java	2001/02/12 05:56:49	1.1.2.4
  @@ -31,17 +31,21 @@
    * LangSelect Action returns two character language code to sitemap.
    *
    * Definition in sitemap:
  + * <pre>
    * &lt;map:actions&gt;
    *		&lt;map:action name="lang_select" src="org.apache.cocoon.acting.LangSelect"/&gt;
  + * </pre>
    *
    * And you use it in following way:
    *
  + * <pre>
    * &lt;map:match pattern="file"&gt;
    * &lt;map:act type="lang_select"&gt;
  - *		&lt;map:generate src="file_{1}.xml"/&gt;
  + *		&lt;map:generate src="file_{lang}.xml"/&gt;
    * &lt;/map:act&gt;
  + * </pre>
    *
  - * {1} is substituted with language code.
  + * {lang} is substituted with language code.
    * eg. if user selects url ../file?lang=en
    * then Sitemap engine generates file_en.xml source.
    *
  @@ -90,11 +94,13 @@
   
       /**
        * Returns two character language code by checking environment in following order
  -     * 1. Http request has parameter lang
  -     * 2. Http session has parameter lang
  -     * 3. Cookies has parameter lang
  -     * 4. User locales has matching language we are providing
  -     * 5. Otherwise we return default_lang from sitemap or if that is not found then 'en'
  +     * <ol>
  +     *   <li>Http request has parameter lang</li>
  +     *   <li>Http session has parameter lang</li>
  +     *   <li>Cookies has parameter lang</li>
  +     *   <li>User locales has matching language we are providing</li>
  +     *   <li>Otherwise we return default_lang from sitemap or if that is not found
then 'en'</li>
  +     * </ol>
        * @return java.lang.String
        * @param objectModel java.util.Map
        * @param par org.apache.avalon.Parameters
  
  
  
  No                   revision
  
  
  No                   revision
  
  
  1.1.2.4   +1 -1      xml-cocoon/xdocs/Attic/datasources.xml
  
  Index: datasources.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon/xdocs/Attic/datasources.xml,v
  retrieving revision 1.1.2.3
  retrieving revision 1.1.2.4
  diff -u -r1.1.2.3 -r1.1.2.4
  --- datasources.xml	2001/02/06 15:31:13	1.1.2.3
  +++ datasources.xml	2001/02/12 05:56:50	1.1.2.4
  @@ -5,7 +5,7 @@
   	 <title>Using Databases in Cocoon 2</title>
   	 <version>0.3</version> 
   	 <type>Overview document</type> 
  -	 <authors><person name="Tom Klaasen" email="tom.klaasen@the-ecorp.com"/> 
  +	 <authors><person name="Berin Loritsch" email="bloritsch@apache.org"/> 
   	 </authors> 
     </header> 
     <body> 
  
  
  
  1.4.2.12  +1 -0      xml-cocoon/xdocs/docs-book.xml
  
  Index: docs-book.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon/xdocs/docs-book.xml,v
  retrieving revision 1.4.2.11
  retrieving revision 1.4.2.12
  diff -u -r1.4.2.11 -r1.4.2.12
  --- docs-book.xml	2001/01/12 15:22:53	1.4.2.11
  +++ docs-book.xml	2001/02/12 05:56:50	1.4.2.12
  @@ -15,6 +15,7 @@
     <page id="xsp-internals" label="XSP Internals" source="xsp-internals.xml"/>
     <page id="logicsheet-concepts" label="XSP Logicsheets" source="logicsheet-concepts.xml"/>
   <separator/>
  +  <page id="actions" label="Actions" source="actions.xml"/>
     <page id="datasources" label="Using Databases" source="datasources.xml"/>
     <page id="sitemap" label="Sitemap" source="sitemap.xml"/>
     <page id="svg" label="SVG Serializer" source="svg-serializer.xml"/>
  
  
  
  1.4.2.6   +1 -0      xml-cocoon/xdocs/site-book.xml
  
  Index: site-book.xml
  ===================================================================
  RCS file: /home/cvs/xml-cocoon/xdocs/site-book.xml,v
  retrieving revision 1.4.2.5
  retrieving revision 1.4.2.6
  diff -u -r1.4.2.5 -r1.4.2.6
  --- site-book.xml	2001/01/04 22:39:35	1.4.2.5
  +++ site-book.xml	2001/02/12 05:56:50	1.4.2.6
  @@ -11,6 +11,7 @@
     <page id="install" label="Install" source="installing.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="actions" label="Actions" source="actions.xml"/>
     <page id="sitemap" label="Sitemap" source="sitemap.xml"/>
     <page id="svg" label="SVG Serializer" source="svg-serializer.xml"/>
   <separator/>
  
  
  
  No                   revision
  
  
  No                   revision
  
  
  1.1.2.1   +246 -0    xml-cocoon/xdocs/Attic/actions.xml
  
  
  
  

Mime
View raw message