You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by ta...@apache.org on 2001/07/30 05:57:57 UTC
cvs commit: jakarta-jetspeed/xdocs portlet_config_RSS.xml portlet_config_common.xml
taylor 01/07/29 20:57:57
Modified: xdocs portlet_config_RSS.xml portlet_config_common.xml
Log:
- updated docs, from Paul Spencer
Revision Changes Path
1.2 +66 -31 jakarta-jetspeed/xdocs/portlet_config_RSS.xml
Index: portlet_config_RSS.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/portlet_config_RSS.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- portlet_config_RSS.xml 2001/07/23 04:41:02 1.1
+++ portlet_config_RSS.xml 2001/07/30 03:57:57 1.2
@@ -30,13 +30,22 @@
<p>
Rich Site Summary (RSS) is an XML-based format developed by Netscape to drive
channels for Netscape Netcenter. The goal of RSS is to propagate change on a
- site, inlcuding your Jetspeed site, to increase traffic. Using an RSS file, all
+ site, including your Jetspeed site, to increase traffic. Using an RSS file, all
you need to do is change one file, and all the external sites your channels are
- registered with with will automatically reflect those changes.
+ registered with will automatically reflect those changes.
</p>
<p>
+ The formatting of the RSS into a portlet is controlled by the stylesheet. If formatting
+ changes are desired, create a new stylesheet and do not edit the one distributed
+ with Jetspeed. This will insure your changes are preserved across updates.
+ </p>
+ <p>
General information on RSS can be found in the
- <a href="http://www.dmoz.org/Reference/Libraries/Library_and_Information_Science/Technical_Services/Cataloguing/Metadata/Resource_Description_Framework_-_RDF/Applications/RSS/">Open Directory</a> .
+ <a href="http://www.dmoz.org/Reference/Libraries/Library_and_Information_Science/Technical_Services/Cataloguing/Metadata/Resource_Description_Framework_-_RDF/Applications/RSS/">Open Directory</a>.
+ </p>
+ <p>
+ RSS format information can be found in the
+ <a href="http://my.netscape.com/publish/formats/rss-spec-0.91.html">http://my.netscape.com/publish/formats/rss-spec-0.91.html</a>.
</p>
<subsection name='Supported Media Types'>
<p>
@@ -50,15 +59,26 @@
</p>
</subsection>
</section>
-
+ <section name='Element: meta-info'>
+ <p>
+ Portlet title and description. By default the title is the name of the portlet and their is no description.
+ </p>
+ <p>
+ This element is optional, but it's use is suggested.
+ </p>
+ <p>
+ <a href="portlet_config_common.html#Element: meta-info">General information about of meta-info.</a>
+ </p>
+ </section>
+
<section name='Element: parameter'>
<!-- when name include < > name does not appear on screen -->
<p>
Parameter that control the how the web page is converted into a portlet.
</p>
<p>
- This element is optional.
+ These elements are optional.
</p>
<p>
<a href="portlet_config_common.html#Element: parameter">Parameters common to many portlets.</a>
@@ -71,21 +91,20 @@
</tr>
<tr>
- <td>itemDisplayed</td>
- <td>The number of items from the RSS file to display on screen. </td>
- </tr>
- <tr>
- <td></td>
- <td>If not present, Default 15 for HTML, 5 for WML</td>
+ <td>itemdisplayed</td>
+ <td>
+ The number of items from the RSS file to display on screen.
+ <br/>
+ If not present, Default 15 for HTML, 5 for WML
+ </td>
</tr>
<tr>
- <td>showDescription</td>
- <td>Should the portlet show the item descriptions.</td>
- </tr>
- <tr>
- <td></td>
- <td>If not present, Default: true for HTML, false for WML
+ <td>showdescription</td>
+ <td>
+ Should the portlet show the item descriptions and icons.
+ <br/>
+ If not present, Default: true for HTML, false for WML
<table>
<tr><th>Value</th><th>Description</th></tr>
<tr><td>true</td><td>Item Description is displayed</td></tr>
@@ -95,12 +114,11 @@
</tr>
<tr>
- <td>showTitle</td>
- <td>Should the portlet show the channel description.</td>
- </tr>
- <tr>
- <td></td>
- <td>If not present, Default: true for HTML, false for WML
+ <td>showtitle</td>
+ <td>
+ Should the portlet show the channel description and icon.
+ <br/>
+ If not present, Default: true for HTML, false for WML
<table>
<tr><th>Value</th><th>Description</th></tr>
<tr><td>true</td><td>Channel Description is displayed</td></tr>
@@ -108,21 +126,36 @@
</table>
</td>
</tr>
+
<tr>
- <td>stylesheet[.<mime>]</td>
- <td>The stylesheet URL. If a mime-type is specified, the stylesheet
- is only used for this mime-type
+ <td>showtextinput</td>
+ <td>
+ Should the portlet show the text input.
+ <br/>
+ If not present, Default: true for HTML, false for WML
+ <br/>
+ <table>
+ <tr><th>Value</th><th>Description</th></tr>
+ <tr><td>true</td><td>Text Input is displayed, when present.</td></tr>
+ <tr><td>false</td><td>Text Input is NOT displayed</td></tr>
+ </table>
</td>
</tr>
+
<tr>
- <td></td>
- <td>Valid URL required</td>
+ <td>stylesheet[.<mime type>]</td>
+ <td>
+ The stylesheet URL. If a mime-type is specified, the stylesheet
+ is only used for this mime-type
+ <br/>
+ File name, including path relative to <jetspeed_home>
+ </td>
</tr>
</table>
</section>
<section name='Element: url'>
<p>
- Contains the URL of the RSS news feed. The returned page should be a RSS formated XML file.
+ Contains the URL of the RSS news feed. The returned page should be a RSS formatted XML file.
</p>
<p>
This element is <strong>required</strong>.
@@ -144,7 +177,7 @@
<dt><tt><url>http://search.yahoo.com/search?p=jetspeed&n=100</url></tt></dt><dd>Contains & instead of &amp;.</dd>
</dl>
</section>
- <section name='Example of Registery Entry'>
+ <section name='Example of Registry Entry'>
<source test=""><![CDATA[
<portlet-entry name="Apacheweek" hidden="false" type="ref"
parent="RSS" application="false">
@@ -161,15 +194,17 @@
<section name='Know problems (version 1.3a1)'>
<p>
<ul>
- <li><textinput> not correctly implemented.</li>
+ <li><textinput> not correctly implemented. Fixed in 1.3a2</li>
</ul>
</p>
</section>
+<!--
<section name='Questions (version 1.3a1)'>
<p>
<ul>
</ul>
</p>
</section>
+-->
</body>
</document>
1.2 +189 -13 jakarta-jetspeed/xdocs/portlet_config_common.xml
Index: portlet_config_common.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/portlet_config_common.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- portlet_config_common.xml 2001/07/23 04:41:02 1.1
+++ portlet_config_common.xml 2001/07/30 03:57:57 1.2
@@ -6,7 +6,7 @@
<title>Portlet Configuration How To</title>
<subtitle>Configuration common to most portlets</subtitle>
<authors>
- <person name="Paul Spencer" email="paulspencer@mindspring.com"/>
+ <person name="Paul Spencer" email="paulspencer@mindspring.com"/>
</authors>
</properties>
@@ -36,26 +36,126 @@
</section>
+<section name='Element: portlet-entry'>
+ <p>
+ Definition of a portlet.
+ </p>
+ <table>
+ <tr>
+ <th>Attribute Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>Name of portlet. This name MUST be unique</td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>
+ Type of portlet-entry
+ <br/>
+ <table>
+ <tr>
+ <th>Allowable values</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>abstract</td>
+ <td>
+ Portlet is one which cannot be created directly. It acts as a portlet template, useful for
+ defining common properties for a group of related portlets.
+ </td>
+ </tr>
+ <tr>
+ <td>instance</td>
+ <td>
+ Portlet is the basic entry. It should provide all the necessary information to create the
+ portlet, at least the classname.
+ </td>
+ </tr>
+ <tr>
+ <td>ref</td>
+ <td>
+ Portlet is based on an existing <portlet-entry> which can be of any type,
+ including other ref entries. The engine will follow all refs until it finds either an
+ abstract or instance entry, override all parameters found in the these definitions by those
+ in the ref definition's, and then create the portlet using the combined definitions
+ </td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+ <tr>
+ <td>hidden</td>
+ <td>
+ <br/>
+ <table>
+ <tr>
+ <th>Allowable values</th>
+ </tr>
+ <tr>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>true</td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+ <tr>
+ <td>application</td>
+ <td>
+ <br/>
+ <table>
+ <tr>
+ <th>Allowable values</th>
+ </tr>
+ <tr>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>true</td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+ </table>
+</section>
<section name='Element: meta-info'>
<p>
- Tyically optional information that describe the item (portlet, parameter, ...)
+ Typically optional information that describe the item (portlet, parameter, ...). Meta-info is used
+ by the Jetspeed customizer. The information is also available to some portlet types.
</p>
<subsection name='Element: title'>
<p>
Title of item (portlet, parameter, ...)
</p>
+ <table>
+ <tr>
+ <th>Parent Element</th>
+ <th>Default</th>
+ </tr>
+ <tr>
+ <td>portlet-entry</td>
+ <td>Value of portlet-entry's name attribute</td>
+ </tr>
+ <tr>
+ <td>parameter</td>
+ <td>Value of parameters's name attribute</td>
+ </tr>
+ </table>
</subsection>
<subsection name='Element: description'>
<p>
- Description of item (portlet, parameter, ...)
+ Description of item (portlet, parameter, ...). Their is no default description.
</p>
</subsection>
<subsection name='Element: icon'>
<p>
- Path and file name of icon relative to <jetspeed_home%>
+ Path and file name of icon relative to <jetspeed_home>
</p>
</subsection>
@@ -79,9 +179,52 @@
<table>
<tr>
- <th>Atribute Name</th>
+ <th>Attribute Name</th>
<th>Description</th>
- </tr>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>Name of portlet, parameter,...</td>
+ </tr>
+ <tr>
+ <td>value</td>
+ <td>Default/initial value</td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>
+ Data type of value. When this attribute is not present any charater string is accepted
+ <br/>
+ <table>
+ <tr>
+ <th>Allowable values</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>boolean</td>
+ <td>Only <tt>true</tt> or <tt>false</tt> are allowed as a value for this parameter</td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+ <tr>
+ <td>hidden</td>
+ <td>
+ <br/>
+ <table>
+ <tr>
+ <th>Allowable values</th>
+ </tr>
+ <tr>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>true</td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+
</table>
<table>
<tr>
@@ -91,11 +234,11 @@
<tr>
<td>showDescription</td>
- <td>Should the portlet show the item descriptions.</td>
- </tr>
- <tr>
- <td></td>
- <td>If not present, Default: true for HTML, false for WML
+ <td>
+ Should the portlet show the item descriptions.
+ <br/>
+ If not present, Default: <tt>true</tt> for HTML, <tt>false</tt> for WML
+ <br/>
<table>
<tr><th>Value</th><th>Description</th></tr>
<tr><td>true</td><td>Item Description is displayed</td></tr>
@@ -130,6 +273,21 @@
</tr>
</table>
+ <table>
+ <tr>
+ <th>Allowable Protocols</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>http://</td>
+ <td>Standard HTTP protocol is used to retreive file or data</td>
+ </tr>
+ <tr>
+ <td><![CDATA[ ]]></td>
+ <td>File is local and path is relative to <jetspeed_home></td>
+ </tr>
+ </table>
+
<p><strong>Good URLs:</strong></p>
<dl>
<dt><tt><url>http://jakata.apache.org/jetspeed</url></tt></dt><dd>Basic URL</dd>
@@ -145,23 +303,37 @@
<section name='Element: security'>
<p>
+ Used by customizer to limit access to this item (portlet, parameter,...)
</p>
<table>
<tr>
- <th>Atribute Name</th>
+ <th>Attribute Name</th>
<th>Description</th>
</tr>
<tr>
<td>role</td>
- <td>Role required by user to select item</td>
+ <td>Role required by user to select this item</td>
</tr>
</table>
</section>
<section name='Element: media-type'>
<p>
+ Media types that can display and configure portal.
+ </p>
+ <p>
Media types are define in <jetspeed_home>/WEB-INF/conf/media.xreg
</p>
+ <table>
+ <tr>
+ <th>Attribute Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>ref</td>
+ <td>Media type.</td>
+ </tr>
+ </table>
</section>
<section name='Example of Registery Entry'>
@@ -216,6 +388,10 @@
<li>Add descriptions and review.</li>
<li>Add common parameters, i.e. bgcolor and display.screen.</li>
<li>Complete examples</li>
+ <li>How is the application attribute of <portlet-entry> used?</li>
+ <li>How is the hidden attribute of <portlet-entry> used?</li>
+ <li>How is the hidden attribute of <paramter> used?</li>
+ <li>Verify definition/implementation of <portlet-entry>.</li>
</ul>
</p>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org