You are viewing a plain text version of this content. The canonical link for it is here.
Posted to slide-dev@jakarta.apache.org by cm...@apache.org on 2002/03/19 18:25:18 UTC

cvs commit: jakarta-slide/src/doc/stylesheets project.xml

cmlenz      02/03/19 09:25:18

  Modified:    src/doc  struts-taglib.xml
               src/doc/stylesheets project.xml
  Added:       src/doc  jstl-taglib.xml
  Log:
  - Added docs on the JSTL-based taglib
  - Some cleanup/fixes for the Struts-based taglib documentation
  
  Revision  Changes    Path
  1.6       +21 -6     jakarta-slide/src/doc/struts-taglib.xml
  
  Index: struts-taglib.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-slide/src/doc/struts-taglib.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- struts-taglib.xml	29 Sep 2001 13:12:52 -0000	1.5
  +++ struts-taglib.xml	19 Mar 2002 17:25:18 -0000	1.6
  @@ -23,18 +23,33 @@
         <uri>http://jakarta.apache.org/slide/tags-struts-1.0</uri>
         <info>
           <p>
  -          The Slide Tag Library for Struts provides many tags for building a 
  -          web interface to Slide. These tags are designed to integrate well 
  +          The <a href="http://jakarta.apache.org/slide/">Jakarta Slide</a> 
  +          project includes JSP tag libraries to support the creation of 
  +          web-based presentation layers accessing and displaying content 
  +          stored in Slide repositories.
  +        </p>
  +        <p>
  +          To keep the tag library code lean, we have to decided to rely on 
  +          existing tag libraries to support basic functionality like iteration 
  +          and conditionals. Two such libraries are currently supported: 
  +          <strong>Struts 1.x</strong> and the <strong>JSP Standard Tag Library 
  +          (JSTL) Early Access</strong> releases. The Slide tag library cannot 
  +          effectively be used on its own, but requires one of the above 
  +          fundamental libraries.
  +        </p>
  +        <p>
  +          The tag library for Struts provides many tags for building a web 
  +          interface to Slide. These tags are designed to integrate well 
             with the Struts tag library and application framework.
           </p>
           <p>
  -          For more information on Struts see the 
  +          For more information on Struts see 
             <a href="http://jakarta.apache.org/struts/">
             http://jakarta.apache.org/struts/</a>.
           </p>
           <p>
  -          <b>WARNING:</b> This tag library should be considered experimental 
  -          and might undergo some drastic changes in the future.
  +          <strong>WARNING:</strong> This tag library should be considered 
  +          experimental and might undergo some drastic changes in the future.
           </p>
         </info>
         
  @@ -253,7 +268,7 @@
           </attribute>
           <attribute>
             <name>resolveLinks</name>
  -          <required>true</required>
  +          <required>false</required>
             <rtexprvalue>true</rtexprvalue>
             <info>
               <p>
  
  
  
  1.1                  jakarta-slide/src/doc/jstl-taglib.xml
  
  Index: jstl-taglib.xml
  ===================================================================
  <?xml version="1.0" encoding="ISO-8859-1"?>
  
  <!DOCTYPE document [
    <!ENTITY project SYSTEM "stylesheets/project.xml">
  ]>
  
  <document>
    
    &project;
    
    <properties>
      <author email="cmlenz@apache.org">Christopher Lenz</author>
      <title>Slide Tag Library Reference - JSTL</title>
    </properties>
    
    <body>
      
      <taglib>
        <tlibversion>1.0</tlibversion>
        <jspversion>1.2</jspversion>
        <shortname></shortname>
        <display-name>Slide Tags for JSTL</display-name>
        <uri>http://jakarta.apache.org/slide/tags-jstl-1.0</uri>
        <info>
          <p>
            The <a href="http://jakarta.apache.org/slide/">Jakarta Slide</a> 
            project includes JSP tag libraries to support the creation of 
            web-based presentation layers accessing and displaying content 
            stored in Slide repositories.
          </p>
          <p>
            To keep the tag library code lean, we have to decided to rely on 
            existing tag libraries to support basic functionality like iteration 
            and conditionals. Two such libraries are currently supported: 
            <strong>Struts 1.x</strong> and the <strong>JSP Standard Tag Library 
            (JSTL) Early Access</strong> releases. The Slide tag library cannot 
            effectively be used on its own, but requires one of the above 
            fundamental libraries.
          </p>
          <p>
            The tag library for the JSP Standard Tag Library (JSTL) provides 
            many tags for building a web interface to Slide. These tags are 
            designed to integrate well with the tags and expression language 
            support provided by JSTL.
          </p>
          <p>
            For more information on JSTL see 
            <a href="http://jakarta.apache.org/taglibs/doc/standard-doc/intro.html">
            http://jakarta.apache.org/taglibs/doc/standard-doc/intro.html</a>.
          </p>
          <p>
            <strong>WARNING:</strong> This tag library should be considered 
            experimental and might undergo some drastic changes in the future.
          </p>
        </info>
        
        <tag>
          <name>domain</name>
          <summary>
            Expose the Slide domain as bean.
          </summary>
          <tagclass>
            org.apache.slide.taglib.tag.jstl.DomainTag
          </tagclass>
          <bodycontent>JSP</bodycontent>
          <info>
            <p>
              The main purpose of this tag is to provide means to iterate over
              the list of defined namespaces. 
            </p>
            <p>
              The <code>DomainBean</code> exposed by this tag provides the 
              following properties:
              <ul>
                <li>
                  <strong>defaultNamespace:</strong> a <code>NamespaceBean</code> that 
                  represents the domain's default namespace
                </li>
                <li>
                  <strong>defaultNamespaceName:</strong> the name of the domain's default 
                  namespace
                </li>
                <li>
                  <strong>namespaces:</strong> a collection of all the domain's namespaces 
                  as <code>NamespaceBean</code> objects
                </li>
                <li>
                  <strong>namespaceNames:</strong> a collection of the names of all the 
                  defined namespaces
                </li>
              </ul>
              The bean is only exposed inside the body of the domain tag.
            </p>
          </info>
          <attribute>
            <name>var</name>
            <required>true</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the name of the page scope attribute under which the 
                <code>DomainBean</code> will be made available.
              </p>
            </info>
          </attribute>
        </tag>
        
        <tag>
          <name>namespace</name>
          <summary>
            Expose a specific Slide namespace as bean.
          </summary>
          <tagclass>
            org.apache.slide.taglib.tag.jstl.NamespaceTag
          </tagclass>
          <bodycontent>JSP</bodycontent>
          <info>
            <p>
              This tag lets you select the namespace that should be accessed.
            </p>
            <p>
              The namespace tag can optionally expose a 
              <code>NamespaceBean</code> that has the following properties:
              <ul>
                <li>
                  <strong>name:</strong> the name of the namespace
                </li>
                <li>
                  <strong>usersPath:</strong> the path at which user nodes are stored
                </li>
              </ul>
              The bean is only exposed inside the body of the namespace tag.
            </p>
          </info>
          <attribute>
            <name>var</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the name of the page scope attribute under which the 
                <code>NamespaceBean</code> will be made available.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>name</name>
            <required>true</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the name of the namespace that should be accessed.
              </p>
            </info>
          </attribute>
        </tag>
        
        <tag>
          <name>node</name>
          <summary>
            Expose a particular ObjectNode in the Slide namespace as bean.
          </summary>
          <tagclass>
            org.apache.slide.taglib.tag.jstl.NodeTag
          </tagclass>
          <bodycontent>JSP</bodycontent>
          <info>
            <p>
              The node tag lets you access a particular <code>ObjectNode</code> 
              of a Slide namespace. You have to specify the URI of the node that 
              should be accessed.
            </p>
            <p>
              This tag can optionally expose a <code>NodeBean</code> with the 
              following properties:
              <ul>
                <li>
                  <strong>branches:</strong> a collection of the names of the branches 
                  that exist for the node
                </li>
                <li>
                  <strong>children:</strong> a collection of the children of the node as 
                  <code>NodeBean</code> objects
                </li>
                <li>
                  <strong>hasChildren:</strong> whether the node has children
                </li>
                <li>
                  <strong>hasRevisions:</strong> whether the node has revisions
                </li>
                <li>
                  <strong>isLocked:</strong> whether the node is locked
                </li>
                <li>
                  <strong>isVersioned:</strong> whether the node is versioned
                </li>
                <li>
                  <strong>locks:</strong> a collection of active locks on the node as
                  <code>LockBean</code> objects
                </li>
                <li>
                  <strong>name:</strong> the leaf name of the node
                </li>
                <li>
                  <strong>parent:</strong> the parent node as <code>NodeBean</code>
                </li>
                <li>
                  <strong>permissions:</strong> a collection of permissions defined for 
                  the node as <code>PermissionBean</code> objects
                </li>
                <li>
                  <strong>revisions:</strong> a collection of revisions of the node as
                  <code>RevisionBean</code> objects
                </li>
                <li>
                  <strong>initialRevision:</strong> the initial revision of the node as
                  <code>RevisionBean</code>
                </li>
                <li>
                  <strong>latestRevision:</strong> the latest revision of the node as
                  <code>RevisionBean</code>
                </li>
                <li>
                  <strong>roles:</strong> a collection of the names of the roles the node 
                  has
                </li>
                <li>
                  <strong>type:</strong> the type of the node as string
                </li>
                <li>
                  <strong>uri:</strong> the node's URI
                </li>
              </ul>
              The bean is only exposed inside the body of the node tag.
            </p>
          </info>
          <attribute>
            <name>var</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the name of the page scope attribute under which the 
                <code>NodeBean</code> will be made available.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>uri</name>
            <required>true</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the URI of the node to access.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>resolveLinks</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies whether links should be resolved when retrieving the 
                node.
              </p>
            </info>
          </attribute>
        </tag>
        
        <tag>
          <name>revision</name>
          <summary>
            Expose a revision-descriptor of an ObjectNode as bean.
          </summary>
          <tagclass>
            org.apache.slide.taglib.tag.jstl.RevisionTag
          </tagclass>
          <bodycontent>JSP</bodycontent>
          <info>
            <p>
              The revision tag lets you access a specific revision of a node, 
              either identified by the version number or the branch name. It must
              be nested inside a node tag.
            </p>
            <p>
              This tag can optionally expose a <code>RevisionBean</code> with 
              the following properties:
              <ul>
                <li>
                  <strong>branch:</strong> the name of the branch the revision belongs to
                </li>
                <li>
                  <strong>number:</strong> the version number of the revision
                </li>
                <li>
                  <strong>properties:</strong> a collection of properties of the revision 
                  as <code>PropertyBean</code> objects
                </li>
              </ul>
              The bean is only exposed inside the body of the revision tag.
            </p>
          </info>
          <attribute>
            <name>var</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the name of the page scope attribute under which the 
                <code>RevisionBean</code> will be made available.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>number</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the version number of the revision to retrieve.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>branch</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the branch name of the revision to retrieve.
              </p>
            </info>
          </attribute>
        </tag>
        
        <tag>
          <name>property</name>
          <summary>
            Expose a property of a node as bean.
          </summary>
          <tagclass>
            org.apache.slide.taglib.tag.jstl.PropertyTag
          </tagclass>
          <bodycontent>JSP</bodycontent>
          <info>
            <p>
              This tag lets you access a specific property of a node or node 
              revision. It must be nested inside a node or revision tag.
            </p>
            <p>
              If you provide the 'id' attribute, the property tag will expose 
              a <code>PropertyBean</code> with the following attributes:
              <ul>
                <li>
                  <strong>name:</strong> the name of the property
                </li>
                <li>
                  <strong>namespace:</strong> the namespace of the property
                </li>
                <li>
                  <strong>value:</strong> the value of the property as string
                </li>
              </ul>
              The bean is only exposed inside the body of the property tag.
            </p>
          </info>
          <attribute>
            <name>var</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the name of the page scope attribute under which the 
                <code>PropertyBean</code> will be made available.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>namespace</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the namespace of the property.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>name</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the name of the property.
              </p>
            </info>
          </attribute>
        </tag>
        
      </taglib>
      
    </body>
    
  </document>
  
  
  
  1.7       +1 -0      jakarta-slide/src/doc/stylesheets/project.xml
  
  Index: project.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-slide/src/doc/stylesheets/project.xml,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- project.xml	3 Jan 2002 21:49:24 -0000	1.6
  +++ project.xml	19 Mar 2002 17:25:18 -0000	1.7
  @@ -55,6 +55,7 @@
       <item name="UML" href="uml/index.html"/>
       <item name="JavaDoc" href="javadoc/index.html"/>
       <item name="WebDAV Client Javadoc" href="clientjavadoc/index.html"/>
  +    <item name="Tag Library (JSTL)" href="jstl-taglib.html"/>
       <item name="Tag Library (Struts)" href="struts-taglib.html"/>
     </menu>
   
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>