taylor 2002/07/16 15:05:58
Modified: docs/site catalog.html
webapp/WEB-INF/conf JetspeedSecurity.properties admin.xreg
webapp/WEB-INF/psml/user/turbine/html default.psml
webapp/rss admin.rss
xdocs catalog.xml
Added: xdocs portlet_config_DBBrowser.xml
portlet_config_PSMLBrowser.xml
Log:
Documentation 1.4b1 release. more to come....
Revision Changes Path
1.8 +6 -0 jakarta-jetspeed/docs/site/catalog.html
Index: catalog.html
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/docs/site/catalog.html,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- catalog.html 9 Feb 2002 23:58:43 -0000 1.7
+++ catalog.html 16 Jul 2002 22:05:56 -0000 1.8
@@ -135,6 +135,12 @@
<li>
<a href="portlet_config_XSL.html">XSL Portlet</a>
</li>
+ <li>
+ <a href="portlet_config_DBBrowser.html">Database Browser Portlet</a>
+ </li>
+ <li>
+ <a href="portlet_config_PSMLBrowser.html">PSML Browser Portlet</a>
+ </li>
</ul>
<a
href="portlet_config_common.html">Configuration common to many standard portlets</a>
</blockquote>
1.9 +0 -0 jakarta-jetspeed/webapp/WEB-INF/conf/JetspeedSecurity.properties
Index: JetspeedSecurity.properties
===================================================================
RCS file:
/home/cvs/jakarta-jetspeed/webapp/WEB-INF/conf/JetspeedSecurity.properties,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
1.23 +2 -1 jakarta-jetspeed/webapp/WEB-INF/conf/admin.xreg
Index: admin.xreg
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/webapp/WEB-INF/conf/admin.xreg,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- admin.xreg 16 Jul 2002 19:10:40 -0000 1.22
+++ admin.xreg 16 Jul 2002 22:05:57 -0000 1.23
@@ -366,7 +366,8 @@
<parameter name="page-size" value="25"/>
<parameter name="action" value="portlets.PsmlBrowseAction"/>
<meta-info>
- <title>Psml browser</title>
+ <title>PSML Browser</title>
+ <description>Hierarchical tree browser of all PSML resources in the
system.</description>
</meta-info>
<media-type ref="html"/>
<category>admin</category>
1.17 +4 -0
jakarta-jetspeed/webapp/WEB-INF/psml/user/turbine/html/default.psml
Index: default.psml
===================================================================
RCS file:
/home/cvs/jakarta-jetspeed/webapp/WEB-INF/psml/user/turbine/html/default.psml,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- default.psml 30 Jun 2002 04:37:42 -0000 1.16
+++ default.psml 16 Jul 2002 22:05:57 -0000 1.17
@@ -55,6 +55,10 @@
<property name="row" value="3"/>
</layout>
</entry>
+ <entry id="P-ef1547a162-10018" parent="DatabaseBrowserTest">
+ <parameter name="sql" value="select * from coffees"/>
+ <parameter name="windowSize" value="10"/>
+ </entry>
<!--
<reference id="P-ed09142736-10018" path="group/apache/page/news">
<layout position="-1" size="-1">
1.8 +0 -8 jakarta-jetspeed/webapp/rss/admin.rss
Index: admin.rss
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/webapp/rss/admin.rss,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- admin.rss 16 Jul 2002 19:10:41 -0000 1.7
+++ admin.rss 16 Jul 2002 22:05:57 -0000 1.8
@@ -9,14 +9,6 @@
from the admin user home page by chosing the "Admin" and "Security" tabs.
Here are some the most common administrative portlets from both tabs:
</description>
-
- <item>
- <title>PSML Browser</title>
- <description>
- This portlet allows the administrator to edit the PSML for all users and
resources in the portal.
- </description>
- <link>./portal?action=controls.Maximize&js_peid=344</link>
- </item>
<item>
<title>Global</title>
<description>
1.3 +3 -0 jakarta-jetspeed/xdocs/catalog.xml
Index: catalog.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/catalog.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- catalog.xml 28 Aug 2001 03:33:03 -0000 1.2
+++ catalog.xml 16 Jul 2002 22:05:58 -0000 1.3
@@ -29,6 +29,9 @@
<li>
<a href="portlet_config_XSL.html">XSL Portlet</a>
</li>
+ <li>
+ <a href="portlet_config_DBBrowser.html">Database Browser Portlet</a>
+ </li>
</ul>
<a href="portlet_config_common.html">Configuration common to many standard
portlets</a>
</section>
1.1 jakarta-jetspeed/xdocs/portlet_config_DBBrowser.xml
Index: portlet_config_DBBrowser.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Portlet Configuration How To</title>
<subtitle>Database Browser Portlet</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name=''>
<p>
<font face="arial,helvetica,sanserif" size="+3">
<center><strong>Database Browser Portlet</strong></center>
</font>
<br/>
<font face="arial,helvetica,sanserif">
<center>
<strong>Class Name :
org.apache.jetspeed.portal.portlets.browser.DatabaseBrowserPortlet</strong>
<strong>Class Name :
org.apache.jetspeed.modules.actions.portlets.browser.DatabaseBrowserAction</strong>
</center>
</font>
<br/>
</p>
</section>
<section name='Description'>
<p>
Presents the result set of a database query in a grid with columns
representing selected columns,
and rows representing each selected row of data. The SQL query string is
configurable in portlet
configuration mode.
</p>
<subsection name="Supported Media Types">
<p>
<a href="portlet_config_common.html#Supported Media Types">Description
of Media Types.</a>
<ul>
<li>html</li>
</ul>
</p>
</subsection>
</section>
<section name='Element: parameter'>
<p>
Parameter that control the how the web page is converted into a portlet.
</p>
<p>
This element is optional.
</p>
<p>
<a href="portlet_config_common.html#Element: parameter">Parameters
common to many portlets.</a>
</p>
<table>
<tr>
<th>Parameter Name</th>
<th>Description</th>
</tr>
<tr>
<td>sql</td>
<td>The SQL String. Can be any valid SQL Query for your configured
database.
However it is required that the query returns at least one
column. All selected
columns of are represented as columns in the grid.
</td>
</tr>
<tr>
<td>windowSize</td>
<td>The number of rows presented in the grid at one time.
</td>
</tr>
<tr>
<td>template</td>
<td>The Velocity template to layout the database grid HTML in view mode.
For many cases the default template is sufficient.
</td>
</tr>
<tr>
<td>customizeTemplate</td>
<td>The Velocity templated to layout the database grid HTML in customize
mode.
For many cases the default template is sufficient.
</td>
</tr>
<tr>
<td>poolName</td>
<td>To use a different Torque database connection pool than the default
Torque pool.
See the Jakarta Torque project documentation for more
information on database connection pools.
</td>
</tr>
</table>
</section>
<section name='Example of Registry Entry'>
<source test=""><![CDATA[
<portlet-entry name="DatabaseBrowserTest" hidden="false" type="ref"
parent="DatabaseBrowserPortlet" application="false">
<meta-info>
<title>DatabaseBrowserTest</title>
<description>Simple Test Database Browser Portlet Example</description>
</meta-info>
<parameter name="template" value="database-browser-portlet" hidden="false"/>
<parameter name="customizeTemplate" value="database-browser-customize"
hidden="false"/>
<parameter name="action" value="portlets.browser.DatabaseBrowserAction"
hidden="false"/>
<parameter name="sql" value="select * from coffees" hidden="false"/>
<!-- to use an alternate torque pool, set this parameter -->
<!-- parameter name="poolname" value="otherpool" hidden="false"/-->
<parameter name="windowSize" value="5" hidden="false"/>
<media-type ref="html"/>
</portlet-entry>
]]></source>
</section>
<section name='Example of use in Portal'>
<source test=""><![CDATA[
<entry id="P-ef1547a162-10018" parent="DatabaseBrowserTest">
<parameter name="sql" value="select * from coffees"/>
<parameter name="windowSize" value="10"/>
</entry>
]]></source>
</section>
<section name='Issues'>
<p>
<ul>
Warning: this version of the portlet only supports vector-based
result sets.
This means that all rows from the result set are loaded into memory.
Future releases will support a 'virtual' database browser, which
will not load the entire
result set into memory.
</ul>
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed/xdocs/portlet_config_PSMLBrowser.xml
Index: portlet_config_PSMLBrowser.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Portlet Configuration How To</title>
<subtitle>PSML Browser Portlet</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name=''>
<p>
<font face="arial,helvetica,sanserif" size="+3">
<center><strong>PSML Browser Portlet</strong></center>
</font>
<br/>
<font face="arial,helvetica,sanserif">
<center>
<strong>Class Name :
org.apache.jetspeed.modules.actions.portlets.PsmlBrowseAction</strong>
</center>
</font>
<br/>
</p>
</section>
<section name='Description'>
<p>
Presents a hierarchical tree browser of all PSML resources in the
system.
The browser supports the following actions:
<ul>
<li>Edit - Customize the selected PSML resource by clicking on the
PSML resource name.
</li>
<li>Delete - Delete the selected PSML resource by clicking on the
'Delete' hyperlink.
</li>
<li>Clone - Copy the selected PSML resource to another location by
clicking on the 'Clone' hyperlink.
</li>
<li>Add - (left off
</li>
</ul>
</p>
<subsection name="Supported Media Types">
<p>
<a href="portlet_config_common.html#Supported Media Types">Description
of Media Types.</a>
<ul>
<li>html</li>
</ul>
</p>
</subsection>
</section>
<section name='Element: parameter'>
<p>
Parameter that control the how the web page is converted into a portlet.
</p>
<p>
This element is optional.
</p>
<p>
<a href="portlet_config_common.html#Element: parameter">Parameters
common to many portlets.</a>
</p>
<table>
<tr>
<th>Parameter Name</th>
<th>Description</th>
</tr>
<tr>
<td>sql</td>
<td>The SQL String. Can be any valid SQL Query for your configured
database.
However it is required that the query returns at least one
column. All selected
columns of are represented as columns in the grid.
</td>
</tr>
<tr>
<td>windowSize</td>
<td>The number of rows presented in the grid at one time.
</td>
</tr>
<tr>
<td>template</td>
<td>The Velocity template to layout the database grid HTML in view mode.
For many cases the default template is sufficient.
</td>
</tr>
<tr>
<td>customizeTemplate</td>
<td>The Velocity templated to layout the database grid HTML in customize
mode.
For many cases the default template is sufficient.
</td>
</tr>
<tr>
<td>poolName</td>
<td>To use a different Torque database connection pool than the default
Torque pool.
See the Jakarta Torque project documentation for more
information on database connection pools.
</td>
</tr>
</table>
</section>
<section name='Example of Registry Entry'>
<source test=""><![CDATA[
<portlet-entry name="DatabaseBrowserTest" hidden="false" type="ref"
parent="DatabaseBrowserPortlet" application="false">
<meta-info>
<title>DatabaseBrowserTest</title>
<description>Simple Test Database Browser Portlet Example</description>
</meta-info>
<parameter name="template" value="database-browser-portlet" hidden="false"/>
<parameter name="customizeTemplate" value="database-browser-customize"
hidden="false"/>
<parameter name="action" value="portlets.browser.DatabaseBrowserAction"
hidden="false"/>
<parameter name="sql" value="select * from coffees" hidden="false"/>
<!-- to use an alternate torque pool, set this parameter -->
<!-- parameter name="poolname" value="otherpool" hidden="false"/-->
<parameter name="windowSize" value="5" hidden="false"/>
<media-type ref="html"/>
</portlet-entry>
]]></source>
</section>
<section name='Example of use in Portal'>
<source test=""><![CDATA[
<entry id="P-ef1547a162-10018" parent="DatabaseBrowserTest">
<parameter name="sql" value="select * from coffees"/>
<parameter name="windowSize" value="10"/>
</entry>
]]></source>
</section>
<section name='Issues'>
<p>
<ul>
Warning: this version of the portlet only supports vector-based
result sets.
This means that all rows from the result set are loaded into memory.
Future releases will support a 'virtual' database browser, which
will not load the entire
result set into memory.
</ul>
</p>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
