portals-jetspeed-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pau...@apache.org
Subject cvs commit: jakarta-jetspeed/xdocs portlet_config_Velocity.xml catalog.xml
Date Tue, 28 Aug 2001 03:33:03 GMT
paulsp      01/08/27 20:33:03

  Modified:    xdocs    catalog.xml
  Added:       xdocs    portlet_config_Velocity.xml
  Log:
  Add Velocity to portlet catalog documentation
  
  Revision  Changes    Path
  1.2       +8 -3      jakarta-jetspeed/xdocs/catalog.xml
  
  Index: catalog.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-jetspeed/xdocs/catalog.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- catalog.xml	2001/07/23 04:41:02	1.1
  +++ catalog.xml	2001/08/28 03:33:03	1.2
  @@ -5,6 +5,7 @@
       <subtitle>Jetspeed Portlet Catalog</subtitle>
       <authors>
         <person name="David Sean Taylor" email="taylor@apache.org"/>
  +      <person name="Paul Spencer" email="paulsp@apache.org"/>
       </authors>
     </properties>
     <body>
  @@ -14,18 +15,22 @@
             <a href="portlet_config_HTML.html">HTML Portlet</a> 
   	</li>
           <li>
  -          <a href="portlet_config_RSS.html">RSS Portlet</a> 
  +          <a href="portlet_config_JSP.html">JSP Portlet</a> 
   	</li>
           <li>
  -          <a href="portlet_config_XSL.html">XSL Portlet</a> 
  +          <a href="portlet_config_RSS.html">RSS Portlet</a> 
   	</li>
           <li>
  -          <a href="portlet_config_JSP.html">JSP Portlet</a> 
  +          <a href="portlet_config_Velocity.html">Velocity Portlet</a> 
   	</li>
           <li>
             <a href="portlet_config_WebPagePortlet.html">Web Page Portlet</a>

   	</li>	
  +        <li>
  +          <a href="portlet_config_XSL.html">XSL Portlet</a> 
  +	</li>
           </ul>
  +     <a href="portlet_config_common.html">Configuration common to many standard portlets</a>
       </section>
     </body>
   </document>
  
  
  
  1.1                  jakarta-jetspeed/xdocs/portlet_config_Velocity.xml
  
  Index: portlet_config_Velocity.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
    <properties>
      <title>Portlet Configuration How To</title>
      <subtitle>Velocity</subtitle>
      <authors>
         <person name="Paul Spencer" email="paulsp@apache.org"/>
      </authors>
    </properties>
    <body>
      <section name=''>
        <p>
          <font face="arial,helvetica,sanserif" size="+3">
            <center><strong>Velocity</strong></center>
          </font>
          <br/>
          <font face="arial,helvetica,sanserif">      
            <center>
              <strong>Class Name : org.apache.jetspeed.portal.portlets.VelocityPortlet</strong>
            </center>
          </font>
          <br/>
        </p>
      </section>
  
      <section name='Description'>
        <p>
          Present content rendered via a Velocity template in a portlet. 
        </p>
        <p>
          Additional information about Velocity is available at <a href="http://jakarta.apache.org/velocity">
          http://jakarta.apache.org/velocity</a>
        </p>
    
      </section>
  
      <section name='Element: parameter'>
        <p>
          Only the template parameter is required.  If the "action" parameter is defined,
the referenced
          class may require additional parameters.
        </p>
        <p>    
          <a href="portlet_config_common.html&#35;Element: parameter">Parameters
common to many portlets.</a>
        </p>
        <table>
          <tr>
            <th>Parameter Name</th>
            <th>Description</th>
           </tr>
          <tr>
            <td>action</td>
            <td>
              Name of action class, relative to <tt>org.apache.jetspeed.modules.actions</tt>.
              The class file is expected in &lt;jetspeed_home&gt;WEB-INF/classes/org/apache/jetspeed/modules/actions.
              <br/>
               This parameter is optional.
            </td>
          </tr>
          <tr>
            <td>template</td>
            <td>
              Name of VM file.
              The file is expected in &lt;jetspeed_home&gt;WEB-INF/templates/vm/<em>media_type</em>.
            </td>
          </tr>
        </table>
      </section>
  
      <section name='Example of Registry Entry'>
        <source test=""><![CDATA[
  <portlet-entry name="PortletCustomizer"
                 hidden="true"
                 type="instance" application="false">
    <security role="user"/>
    <meta-info>
      <title>Customize portlet</title>
    </meta-info>
    <classname>org.apache.jetspeed.portal.portlets.VelocityPortlet</classname>
    <parameter name="template" value="customizer-portlet" hidden="false"/>
    <parameter name="action" value="portlets.CustomizeAction" hidden="false"/>
  </portlet-entry>
  ]]></source>
      </section>
  
  <!--
      <section name='Example of use in Portal'>
        <p/>
      </section>
  -->    
      <section name='Context or Variables available to a Velocity Template'>
      <p>
        Below is a list variables that can be used in the Velocity template file.  Their
        values are defined by Jetspeed.  For a list of properties and methods available, refer
        to the <em>Classname</em> documentation.
      </p>
        <table>
          <tr><th>Context</th><th>Classname</th><th>Description</th></tr>
          <tr><td>action</td><td>String</td><td>Class
name to process form</td></tr>
          <tr><td>clink</td><td>JetspeeedContentLink</td><td></td></tr>
          <tr><td>conf</td><td>PortletConfig</td><td></td></tr>
          <tr><td>config</td><td>JetspeeedResources</td><td></td></tr>
          <tr><td>data</td><td>RunData</td><td></td></tr>
          <tr><td>jetspeed</td><td>JetspeedTool</td><td></td></tr>
          <tr><td>jlink</td><td>JetspeedTemplateLink</td><td></td></tr>
          <tr><td>portlet</td><td>VelocityPortlet</td><td></td></tr>
          <tr><td>skin</td><td>PortletSkin</td><td></td></tr>
          <tr><td>template</td><td>String</td><td>Name
of Velocity template</td></tr>
        </table>
      </section>
  
  <!--
      <section name='Know problems (version 1.3a1)'>
        <p>
          <ul>
          </ul>
        </p>
      </section>
  -->
  <!--
      <section name='Questions (version 1.3a1)'>
        <p>
          <ul>
          </ul>
        </p>
      </section>
  -->
    </body>
  </document>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org


Mime
View raw message