[prev in list] [next in list] [prev in thread] [next in thread] 

List:       slide-dev
Subject:    cvs commit: jakarta-slide/src/doc/stylesheets project.xml slide.xsl
From:       cmlenz () apache ! org
Date:       2001-09-24 21:59:43
[Download RAW message or body]

cmlenz      01/09/24 14:59:43

  Modified:    src/doc/stylesheets project.xml slide.xsl
  Added:       src/doc  struts-taglib.xml
  Log:
  - Added some preliminary documentation on the Slide tag library
  - Copied the taglib documentation templates from the Struts stylesheet
  
  Revision  Changes    Path
  1.1                  jakarta-slide/src/doc/struts-taglib.xml
  
  Index: struts-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</author>
      <title>Slide Tag Library Reference - Struts</title>
    </properties>
    
    <body>
      
      <taglib>
        <tlibversion>1.0</tlibversion>
        <jspversion>1.1</jspversion>
        <shortname></shortname>
        <display-name>Slide Tags for Struts</display-name>
        <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 cooperate with 
            the Struts tag library and application framework.
          </p>
          <p>
            For more information on Struts see the 
            <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.
          </p>
        </info>
        
        <tag>
          <name>domain</name>
          <summary>
            Expose the Slide domain as bean.
          </summary>
          <tagclass>org.apache.slide.taglib.tag.struts.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>
                  <b>defaultNamespace:</b> a <code>NamespaceBean</code> that 
                  represents the domain's default namespace
                </li>
                <li>
                  <b>defaultNamespaceName:</b> the name of the domain's default 
                  namespace
                </li>
                <li>
                  <b>namespaces:</b> a collection of all the domain's namespaces 
                  as <code>NamespaceBean</code> objects
                </li>
                <li>
                  <b>namespaceNames:</b> 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>id</name>
            <required>true</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the name of the scripting variable (and associated 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.struts.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>
                  <b>name:</b> the name of the namespace
                </li>
                <li>
                  <b>usersPath:</b> 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>id</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the name of the scripting variable (and associated page
                scope attribute) under which the <code>NamespaceBean</code> will 
                be made available.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>name</name>
            <required>true</required>
            <rtexprvalue>true</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.struts.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>
                  <b>branches:</b> a collection of the names of the branches 
                  that exist for the node
                </li>
                <li>
                  <b>children:</b> a collection of the children of the node as 
                  <code>NodeBean</code> objects
                </li>
                <li>
                  <b>hasChildren:</b> whether the node has children
                </li>
                <li>
                  <b>hasRevisions:</b> whether the node has revisions
                </li>
                <li>
                  <b>isLocked:</b> whether the node is locked
                </li>
                <li>
                  <b>isVersioned:</b> whether the node is versioned
                </li>
                <li>
                  <b>locks:</b> a collection of active locks on the node as
                  <code>LockBean</code> objects
                </li>
                <li>
                  <b>name:</b> the leaf name of the node
                </li>
                <li>
                  <b>parent:</b> the parent node as <code>NodeBean</code>
                </li>
                <li>
                  <b>permissions:</b> a collection of permissions defined for 
                  the node as <code>PermissionBean</code> objects
                </li>
                <li>
                  <b>revisions:</b> a collection of revisions of the node as
                  <code>RevisionBean</code> objects
                </li>
                <li>
                  <b>initialRevision:</b> the initial revision of the node as
                  <code>RevisionBean</code>
                </li>
                <li>
                  <b>latestRevision:</b> the latest revision of the node as
                  <code>RevisionBean</code>
                </li>
                <li>
                  <b>roles:</b> a collection of the names of the roles the node 
                  has
                </li>
                <li>
                  <b>type:</b> the type of the node as string
                </li>
                <li>
                  <b>uri:</b> the node's URI
                </li>
              </ul>
            </p>
          </info>
          <attribute>
            <name>id</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the name of the scripting variable (and associated page
                scope attribute) under which the <code>NodeBean</code> will be 
                made available.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>uri</name>
            <required>true</required>
            <rtexprvalue>true</rtexprvalue>
            <info>
              <p>
                Specifies the URI of the node to access.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>resolveLinks</name>
            <required>true</required>
            <rtexprvalue>true</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.struts.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>
                  <b>branch:</b> the name of the branch the revision belongs to
                </li>
                <li>
                  <b>number:</b> the version number of the revision
                </li>
                <li>
                  <b>properties:</b> a collection of properties of the revision 
                  as <code>PropertyBean</code> objects
                </li>
              </ul>
            </p>
          </info>
          <attribute>
            <name>id</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the name of the scripting variable (and associated page
                scope attribute) under which the <code>RevisionBean</code> will 
                be made available.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>number</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <info>
              <p>
                Specifies the version number of the revision to retrieve.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>branch</name>
            <required>false</required>
            <rtexprvalue>true</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.struts.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>
                  <b>name:</b> the name of the property
                </li>
                <li>
                  <b>namespace:</b> the namespace of the property
                </li>
                <li>
                  <b>value:</b> the value of the property as string
                </li>
              </ul>
            </p>
          </info>
          <attribute>
            <name>id</name>
            <required>false</required>
            <rtexprvalue>false</rtexprvalue>
            <info>
              <p>
                Specifies the name of the scripting variable (and associated page
                scope attribute) under which the <code>PropertyBean</code> will 
                be made available.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>namespace</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <info>
              <p>
                Specifies the namespace of the property.
              </p>
            </info>
          </attribute>
          <attribute>
            <name>name</name>
            <required>false</required>
            <rtexprvalue>true</rtexprvalue>
            <info>
              <p>
                Specifies the name of the property.
              </p>
            </info>
          </attribute>
        </tag>
        
      </taglib>
      
    </body>
    
  </document>
  
  
  
  1.4       +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.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- project.xml	2001/09/11 06:48:09	1.3
  +++ project.xml	2001/09/24 21:59:43	1.4
  @@ -57,6 +57,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 (Struts)" href="struts-taglib.html"/>
     </menu>
   
     </body>
  
  
  
  1.4       +92 -2     jakarta-slide/src/doc/stylesheets/slide.xsl
  
  Index: slide.xsl
  ===================================================================
  RCS file: /home/cvs/jakarta-slide/src/doc/stylesheets/slide.xsl,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- slide.xsl	2001/09/14 02:29:28	1.3
  +++ slide.xsl	2001/09/24 21:59:43	1.4
  @@ -1,6 +1,6 @@
   <?xml version="1.0" encoding="ISO-8859-1"?>
   <!-- Temporary Stylesheet for Catalina Developer Documentation -->
  -<!-- $Id: slide.xsl,v 1.3 2001/09/14 02:29:28 remm Exp $ -->
  +<!-- $Id: slide.xsl,v 1.4 2001/09/24 21:59:43 cmlenz Exp $ -->
   
   <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
     version="1.0">
  @@ -99,7 +99,7 @@
   
           <xsl:comment>RIGHT SIDE MAIN BODY</xsl:comment>
           <td width="80%" valign="top" align="left">
  -          <xsl:apply-templates select="body/section"/>
  +          <xsl:apply-templates select="body"/>
           </td>
   
         </tr>
  @@ -341,6 +341,96 @@
           </tr>
           </xsl:for-each>
         </tr>
  +    </table>
  +  </xsl:template>
  +
  +  <!-- Process a tag library section -->
  +  <xsl:template match="taglib">
  +    <table border="0" cellspacing="5" cellpadding="5" width="100%">
  +      <tr><td bgcolor="{$banner-bg}">
  +        <font color="{$banner-fg}" face="arial,helvetica,sanserif" size="+1">
  +          <strong><xsl:value-of select="display-name"/></strong>
  +        </font>
  +      </td></tr>
  +      <tr><td>
  +        <blockquote>
  +          <xsl:apply-templates select="info"/>
  +        </blockquote>
  +      </td></tr>
  +      <tr><td>
  +        <blockquote>
  +          <table border="1" cellspacing="2" cellpadding="2">
  +            <tr>
  +              <th width="15%">Tag Name</th>
  +              <th>Description</th>
  +            </tr>
  +            <xsl:for-each select="tag">
  +              <tr>
  +                <td align="center">
  +                  <xsl:variable name="name">
  +                    <xsl:value-of select="name"/>
  +                  </xsl:variable>
  +                  <a href="#{$name}"><xsl:value-of select="name"/></a>
  +                </td>
  +                <td>
  +                  <xsl:value-of select="summary"/>
  +                </td>
  +              </tr>
  +            </xsl:for-each>
  +          </table>
  +        </blockquote>
  +      </td></tr>
  +    </table>
  +    <xsl:apply-templates select="tag"/>
  +  </xsl:template>
  +
  +  <!-- Process an individual tag -->
  +  <xsl:template match="tag">
  +    <xsl:variable name="name">
  +      <xsl:value-of select="name"/>
  +    </xsl:variable>
  +    <a name="{$name}"></a>
  +    <table border="0" cellspacing="2" cellpadding="2">
  +      <tr><td bgcolor="{$banner-bg}">
  +        <font color="{$banner-fg}" face="arial,helvetica,sanserif">
  +          <strong><xsl:value-of select="name"/></strong> -
  +          <xsl:value-of select="summary"/>
  +        </font>
  +      </td></tr>
  +      <tr><td>
  +        <blockquote>
  +          <xsl:apply-templates select="info"/>
  +        </blockquote>
  +      </td></tr>
  +      <tr><td>
  +        <blockquote>
  +          <table border="1" cellspacing="2" cellpadding="2">
  +            <tr>
  +              <th width="15%">Attribute Name</th>
  +              <th>Description</th>
  +            </tr>
  +            <xsl:for-each select="attribute">
  +              <tr>
  +                <td align="center">
  +                  <xsl:value-of select="name"/>
  +                </td>
  +                <td>
  +                  <xsl:apply-templates select="info"/>
  +                  <xsl:variable name="required">
  +                    <xsl:value-of select="required"/>
  +                  </xsl:variable>
  +                  <xsl:if test="required='true'">
  +                    [Required]
  +                  </xsl:if>
  +                  <xsl:if test="rtexprvalue='true'">
  +                    [RT Expr]
  +                  </xsl:if>
  +                </td>
  +              </tr>
  +            </xsl:for-each>
  +          </table>
  +        </blockquote>
  +      </td></tr>
       </table>
     </xsl:template>
   
  
  
  

[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic