taylor 01/07/22 21:41:02
Modified: xdocs usejetspeed.xml
xdocs/stylesheets project.xml
Added: xdocs catalog.xml portlet_config_HTML.xml
portlet_config_JSP.xml portlet_config_RSS.xml
portlet_config_WebPagePortlet.xml
portlet_config_XSL.xml portlet_config_common.xml
Log:
-- Portlet Catalog documentation, contributed by Paul Spencer.
-- updated links to bluesunrise, moved documentation to
www.bluesunrise.com/jetspeed-docs
-- added new website from Tom Adams
Revision Changes Path
1.6 +11 -5 jakarta-jetspeed/xdocs/usejetspeed.xml
Index: usejetspeed.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/usejetspeed.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- usejetspeed.xml 2001/04/01 16:46:44 1.5
+++ usejetspeed.xml 2001/07/23 04:41:02 1.6
@@ -23,14 +23,20 @@
<p>
<ul>
<li>
- <a
href="http://www.bluesunrise.com:8080/nile";>http://www.bluesunrise.com:8080/nile/</a>
+ <a
href="http://www.bluesunrise.com/jetspeed/";>http://www.bluesunrise.com/jetspeed/</a>
+ <br/>This site lets you see the state of the latest development on
Jetspeed. It is refreshed from the CVS Head every week or so.
+ <P/>
</li>
<li>
- <a
href="http://216.216.26.182/servlet/qmetrics";>http://216.216.26.182/servlet/qmetrics/</a>
+ <a
href="http://fw.intranet.hisitech.com/jetspeed/";>http://fw.intranet.hisitech.com/jetspeed/</a>
+ <BR/>A development version, about current CVS + my patches, not always up.
+ <P/>
</li>
<li>
- <a
href="http://fw.intranet.hisitech.com/jetspeed/";>http://fw.intranet.hisitech.com/jetspeed/</a>
(A development version, about current CVS + my patches, not always up)
- </li>
+ <a href="http://qld.ieaust.org.au/";>http://qld.ieaust.org.au/</a>
+ <BR/>
+ <P/>
+ </li>
<li>
<a href="http://www.DiverseBooks.com/";>http://www.DiverseBooks.com/</a>
</li>
@@ -38,7 +44,7 @@
</p>
<p>
-An version 1.2b2 is running at:
+A version 1.2b2 is running at:
<ul>
<li>
<a href="http://XMLmodeling.com";>http://XMLmodeling.com/</a>
1.1 jakarta-jetspeed/xdocs/catalog.xml
Index: catalog.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Jetspeed Portlet Catalog</title>
<subtitle>Jetspeed Portlet Catalog</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="Standard Portlets">
<ul>
<li>
<a href="portlet_config_HTML.html">HTML Portlet</a>
</li>
<li>
<a href="portlet_config_RSS.html">RSS Portlet</a>
</li>
<li>
<a href="portlet_config_XSL.html">XSL Portlet</a>
</li>
<li>
<a href="portlet_config_JSP.html">JSP Portlet</a>
</li>
<li>
<a href="portlet_config_WebPagePortlet.html">Web Page Portlet</a>
</li>
</ul>
</section>
</body>
</document>
1.1 jakarta-jetspeed/xdocs/portlet_config_HTML.xml
Index: portlet_config_HTML.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Portlet Configuration How To</title>
<subtitle>HTML</subtitle>
<authors>
<person name="Paul Spencer" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name=''>
<p>
<font face="arial,helvetica,sanserif" size="+3">
<center><strong>HTML</strong></center>
</font>
<br/>
<font face="arial,helvetica,sanserif">
<center>
<strong>Class Name :
org.apache.jetspeed.portal.portlets.FileServerPortlet</strong>
</center>
</font>
<br/>
</p>
</section>
<section name='Description'>
<p>
Present HTML in a portlet.
</p>
<p>
Why use a HTML portlet instead of a WebPagePortlet?
<ul>
<li>HTML is a static</li>
<li>Not all HTML file it not a complete HTML document, i.e. <HEAD>
is not in file</li>
<li>HTML file does not have to be visable to the Web Server</li>
<li>Specific task can not be achieved with WebPagePortlet</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>
</section>
<section name='Element: url'>
<p>
Name of HTML file. This must include the path relative to
<jetspeed_home>
</p>
<p>
This element is <strong>required</strong>.
</p>
</section>
<section name='Example of Registery Entry'>
<source test=""><![CDATA[
<portlet-entry name="Welcome" hidden="false" type="ref"
parent="HTML" application="false">
<meta-info>
<title>Welcome</title>
</meta-info>
<url>/welcome.html</url>
</portlet-entry>]]></source>
</section>
<section name='Example of use in Portal'>
<p/>
</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>
1.1 jakarta-jetspeed/xdocs/portlet_config_JSP.xml
Index: portlet_config_JSP.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Portlet Configuration How To</title>
<subtitle>JSP</subtitle>
<authors>
<person name="Paul Spencer" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name=''>
<p>
<font face="arial,helvetica,sanserif" size="+3">
<center><strong>JSP</strong></center>
</font>
<br/>
<font face="arial,helvetica,sanserif">
<center><strong>Class Name :
org.apache.jetspeed.portal.portlets.JspPortlet</strong></center>
</font>
<br/>
</p>
</section>
<section name='Description'>
<p>
Present the output of a JSP in a portlet.
</p>
<p>
Why use a JSP portlet instead of a WebPagePortlet?
<ul>
<li>JSP does not have to be visable to the Web Server</li>
<li>Specific task can not be achieved with WebPagePortlet</li>
</ul>
</p>
<subsection name='Supported Media Types'>
<p>
<a href="portlet_config_common.html#Supported Media Types">
Description of Media Types.
</a>
<ul>
</ul>
</p>
</subsection>
</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 template parameter is <strong>required</strong>.
</p>
<p>
<a href="portlet_config_common.html#Element: parameter">
Parameters common to many portlets.
</a>
</p>
<table>
<tr>
<th>Paramater Name</th>
<th>Description</th>
</tr>
<tr>
<td>template</td>
<td>Name of JSP file. This must include the path relative to
<jetspeed_home></td>
</tr>
</table>
</section>
<section name='Example of Registery Entry'>
<source test=""><![CDATA[
<portlet-entry name="HelloJSP" hidden="false" type="ref"
parent="JSP" application="false">
<meta-info>
<title>HelloJSP</title>
<description>Simple JSP Portlet Example</description>
</meta-info>
<parameter name="template"
value="/WEB-INF/templates/jsp/portlets/html/hello.jsp" hidden="false"/>
</portlet-entry>
]]></source>
</section>
<section name='Example of use in Portal'>
</section>
<section name='Know problems (version 1.3a1)'>
<p>
<ul>
<li>JSP output appear before any other portlets, including it's title.</li>
</ul>
</p>
</section>
<section name='Questions (version 1.3a1)'>
<p>
<ul>
<li>Supported media types?</li>
<li>Does the JSP have access to Parameters, i.e. Can I add parameters that
only the JSP will use?</li>
<li>What is available to the JSP from Jetspeed, like username...?</li>
<li>What JSP stuff should NOT be done?</li>
</ul>
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed/xdocs/portlet_config_RSS.xml
Index: portlet_config_RSS.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Portlet Configuration How To</title>
<subtitle>RSS</subtitle>
<authors>
<person name="Paul Spencer" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name=''>
<p>
<font face="arial,helvetica,sanserif" size="+3">
<center><strong>RSS</strong></center>
</font>
<br/>
<font face="arial,helvetica,sanserif">
<center><strong>Class Name :
org.apache.jetspeed.portal.portlets.NewRSSPortlet</strong></center>
</font>
<br/>
</p>
</section>
<section name='Description'>
<p>
Present a RSS new feed in a portlet.
</p>
<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
you need to do is change one file, and all the external sites your channels
are
registered with with will automatically reflect those changes.
</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> .
</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>
<li>wml</li>
</ul>
</p>
</subsection>
</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.
</p>
<p>
<a href="portlet_config_common.html#Element: parameter">Parameters
common to many portlets.</a>
</p>
<table>
<tr>
<th>Paramater Name</th>
<th>Description</th>
</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>
</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
<table>
<tr><th>Value</th><th>Description</th></tr>
<tr><td>true</td><td>Item Description is displayed</td></tr>
<tr><td>false</td><td>Item Description is NOT displayed</td></tr>
</table>
</td>
</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
<table>
<tr><th>Value</th><th>Description</th></tr>
<tr><td>true</td><td>Channel Description is displayed</td></tr>
<tr><td>false</td><td>Channel Description is NOT displayed</td></tr>
</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>
</tr>
<tr>
<td></td>
<td>Valid URL required</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.
</p>
<p>
This element is <strong>required</strong>.
</p>
<p>
<a href="portlet_config_common.html#Element: url">General information
about of URL.</a>
</p>
<p>
<strong>Good URLs:</strong>
</p>
<dl>
<dt><tt><url>http://jakata.apache.org/jetspeed</url></tt></dt><dd>Basic
URL</dd>
<dt><tt><url>http://search.yahoo.com/bin/search?p=jetspeed</url></tt></dt><dd>1
Parameter passed</dd>
<dt><tt><url>http://search.yahoo.com/search?p=jetspeed&amp;n=100</url></tt></dt><dd>2
Parameter passed</dd>
</dl>
<p><strong>Bad URLs:</strong></p>
<dl>
<dt><tt><url>index.html</url></tt></dt><dd>No protocal, http://
or hostname</dd>
<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'>
<source test=""><![CDATA[
<portlet-entry name="Apacheweek" hidden="false" type="ref"
parent="RSS" application="false">
<meta-info>
<title>Apacheweek</title>
</meta-info>
<url>http://www.apacheweek.com/issues/apacheweek-headlines.xml</url>
</portlet-entry>]]></source>
</section>
<section name='Example of use in Portal'>
<p/>
</section>
<section name='Know problems (version 1.3a1)'>
<p>
<ul>
<li><textinput> not correctly implemented.</li>
</ul>
</p>
</section>
<section name='Questions (version 1.3a1)'>
<p>
<ul>
</ul>
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed/xdocs/portlet_config_WebPagePortlet.xml
Index: portlet_config_WebPagePortlet.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Portlet Configuration How To</title>
<subtitle>WebPagePortlet</subtitle>
<authors>
<person name="Paul Spencer" email="[EMAIL PROTECTED]"></person>
</authors>
</properties>
<body>
<section name="">
<p>
<font face="arial,helvetica,sanserif" size="+3">
<center><strong>WebPagePortlet</strong></center>
</font>
<br/>
<font face="arial,helvetica,sanserif">
<center>
<strong>Class Name :
org.apache.jetspeed.portal.portlets.WebPagePortlet</strong>
</center>
</font>
<br/>
</p>
</section>
<section name="Description">
<p>
Present a web page in a portlet.
</p>
<p>
The web page will be loaded by the Jetspeed server, not the user's web
browser, and maintained by the cache
subsystem. Since Jetspeed is loading the page, no information from the
user's browser, like cookies, will
be provided to the web server.
</p>
<p>
The WebPagePortlet will convert, or delete, some of the HTML tags so the
resulting page can be presented in a portlet.
</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">
<!-- when name include &lt; &gt; 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.
</p>
<p>
<a href="portlet_config_common.html#Element: parameter">Parameters
common to many portlets.</a>
</p>
<table>
<tr>
<th>Paramater Name</th>
<th>Description</th>
</tr>
<tr>
<td>dont_remove_applet</td>
<td>
<APPLET> tag. Used to include a Java Applet.
The space allocate on the web page for the applet will be available for
other HTML tags, thus the
apparance of the resulting page will be different.
</td>
</tr>
<tr>
<td></td>
<td>If not present, "no" is the default value
<table>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>yes</td>
<td>Include the Java applets in the protlet</td>
</tr>
<tr>
<td>no</td>
<td>Remove Java applets</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>dont_remove_head</td>
<td><HEAD> tag.</td>
</tr>
<tr>
<td></td>
<td>If not present, "no" is the default value
<table>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>yes</td>
<td>The <HEAD> tags are retained</td>
</tr>
<tr>
<td>no</td>
<td>The <HEAD> tags is removed</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>dont_remove_meta</td>
<td><META> tag.</td>
</tr>
<tr>
<td></td>
<td>If not present, "no" is the default value
<table>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>yes</td>
<td><META> tags are retained</td>
</tr>
<tr>
<td>no</td>
<td><META> tags are removed</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>dont_remove_noscript</td>
<td><NOSCRIPT> tag.</td>
</tr>
<tr>
<td></td>
<td>If not present, "no" is the default value
<table>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>yes</td>
<td><NOSCRIPT>tags are retained</td>
</tr>
<tr>
<td>no</td>
<td><NOSCRIPT> tags are removed</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>dont_remove_onsomething</td>
<td><Retain onBlur, onChange, ... attributes> in tag.</td>
</tr>
<tr>
<td></td>
<td>If not present, "no" is the default value
<table>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>yes</td>
<td>Retain attributes</td>
</tr>
<tr>
<td>no</td>
<td>Remove attributes</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>dont_remove_object</td>
<td><OBJECT> tag.</td>
</tr>
<tr>
<td></td>
<td>If not present, "no" is the default value
<table>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>yes</td>
<td><OBJECT;gt;tags are retained</td>
</tr>
<tr>
<td>no</td>
<td><OBJECT> tags are removed</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>dont_remove_script</td>
<td><SCRIPT> tag.</td>
</tr>
<tr>
<td></td>
<td>If not present, "no" is the default value
<table>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>yes</td>
<td><SCRIPT> tags are retained</td>
</tr>
<tr>
<td>no</td>
<td><SCRIPT> tags are removed</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>dont_remove_style</td>
<td>no</td>
</tr>
<tr>
<td></td>
<td>If not present, "no" is the default value
<table>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>yes</td>
<td><STYLE> tags are retained</td>
</tr>
<tr>
<td>no</td>
<td><STYLE> tags are removed</td>
</tr>
</table>
</td>
</tr>
</table>
</section>
<section name="Element: url">
<p>
Contains the URL of the web page to be displayed.
</p>
<p>
This element is <strong>required</strong>.
</p>
<p>
<a href="portlet_config_common.html#Element: url">General information
about of URL.</a>
</p>
<p>
<strong>Good URLs:</strong>
</p>
<dl>
<dt>
<tt><url>http://jakata.apache.org/jetspeed</url></tt>
</dt>
<dd>Basic URL</dd>
<dt>
<tt><url>http://search.yahoo.com/bin/search?p=jetspeed</url></tt>
</dt>
<dd>1 Parameter passed</dd>
<dt>
<tt><url>http://search.yahoo.com/search?p=jetspeed&amp;n=100</url></tt>
</dt>
<dd>2 Parameter passed</dd>
</dl>
<p>
<strong>Bad URLs:</strong>
</p>
<dl>
<dt>
<tt><url>index.html</url></tt>
</dt>
<dd>No protocal, http:// or hostname</dd>
<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">
<p>
The example will place the results of a Yahoo search on "jetspeed" in a
portlet.
</p>
<p>
From <jetspeed_home>/WEB-INF/conf/local-portlets.xreg
</p>
<source test=""><![CDATA[
<portlet-entry name="JetspeedInYahoo" hidden="false" type="ref"
parent="WebPagePortlet" application="false">
<meta-info>
<title>JetspeedInYahoo</title>
<description>References to Jetspeed in Yahoo</description>
</meta-info>
<parameter name="dont_remove_applet" value="yes" hidden="false"/>
<parameter name="dont_remove_script" value="yes" hidden="false"/>
<url>http://search.yahoo.com/bin/search?p=jetspeed</url>
</portlet-entry>]]></source>
</section>
<section name="Example of use in Portal">
<p></p>
</section>
<section name="Know problems (version 1.3a1)">
<p>
<ul>
<li>Some <META> may cause errors and prevent the portlet from being
displayed</li>
</ul>
</p>
</section>
<section name="Questions and possible problems to be investigated (version
1.3a1)">
<p>
<ul>
<li>Property "dont_remove_head does" not seem to work. Head tag is always
removed</li>
<li>Can values in the HTTP Request be set, i.e. User-Agent...?
This would allow a "Netscape 4" or "IE 5" only site to get browser
specific pages
from the web server
</li>
<li>Cookie support?</li>
<li>"dont_remove_script" does not appear to work</li>
<li>Why use "dont_remove_head"?</li>
<li>Why use "dont_remove_meta", how is it related to
"dont_remove_head"?</li>
<li>Frame support?</li>
</ul>
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed/xdocs/portlet_config_XSL.xml
Index: portlet_config_XSL.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Portlet Configuration How To</title>
<subtitle>XSL</subtitle>
<authors>
<person name="Paul Spencer" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name=''>
<p>
<font face="arial,helvetica,sanserif" size="+3">
<center><strong>XSL</strong></center>
</font>
<br/>
<font face="arial,helvetica,sanserif">
<center>
<strong>Class Name :
org.apache.jetspeed.portal.portlets.XSLPortlet</strong>
</center>
</font>
<br/>
</p>
</section>
<section name='Description'>
<p>
Present a Transformed an XML Document in a portlet.
</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>Paramater Name</th>
<th>Description</th>
</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>
</tr>
<tr>
<td></td>
<td>Valid URL required</td>
</tr>
</table>
</section>
<section name='Example of Registery Entry'>
<source test=""><![CDATA[
]]></source>
</section>
<section name='Example of use in Portal'>
<p/>
</section>
<section name='Know problems (version 1.3a1)'>
<p>
<ul>
</ul>
</p>
</section>
<section name='Questions (version 1.3a1)'>
<p>
<ul>
<li>Where is he inbound XML file defined?</li>
<li>How is this related to Cocoon?</li>
</ul>
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed/xdocs/portlet_config_common.xml
Index: portlet_config_common.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Portlet Configuration How To</title>
<subtitle>Configuration common to most portlets</subtitle>
<authors>
<person name="Paul Spencer" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name=''>
<p>
<font face="arial,helvetica,sanserif" size="+3">
<center><strong>Configuration common to most portlets</strong></center>
</font>
<br/>
</p>
</section>
<section name='Description'>
<p>
</p>
<subsection name='Supported Media Types'>
<p>
<ul>
<li>html</li>
<li>wml</li>
</ul>
</p>
</subsection>
</section>
<section name='Element: meta-info'>
<p>
Tyically optional information that describe the item (portlet, parameter, ...)
</p>
<subsection name='Element: title'>
<p>
Title of item (portlet, parameter, ...)
</p>
</subsection>
<subsection name='Element: description'>
<p>
Description of item (portlet, parameter, ...)
</p>
</subsection>
<subsection name='Element: icon'>
<p>
Path and file name of icon relative to <jetspeed_home%>
</p>
</subsection>
</section>
<section name='Element: classname'>
<p>
Java class name of portlet
</p>
</section>
<section name='Element: parameter'>
<!-- when name include < > name does not appear on screen -->
<p>
The hidden attribute controls wether the customizer will display the parameter.
Parameter that control the how the web page is converted into a portlet.
</p>
<p>
This element is optional.
</p>
<table>
<tr>
<th>Atribute Name</th>
<th>Description</th>
</tr>
</table>
<table>
<tr>
<th>Parameter Name</th>
<th>Description</th>
</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
<table>
<tr><th>Value</th><th>Description</th></tr>
<tr><td>true</td><td>Item Description is displayed</td></tr>
<tr><td>false</td><td>Item Description is NOT displayed</td></tr>
</table>
</td>
</tr>
</table>
</section>
<section name='Element: url'>
<p>
Since the configuration file is an XML file, some character must be repesents
using XML entities.
</p>
<table>
<tr>
<th>Character</th>
<th>XML Entitiy</th>
</tr>
<tr>
<td>&</td>
<td>&amp;</td>
</tr>
<tr>
<td><</td>
<td>&lt;</td>
</tr>
<tr>
<td>></td>
<td>&gt;</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>
<dt><tt><url>http://search.yahoo.com/bin/search?p=jetspeed</url></tt></dt><dd>1
Parameter passed</dd>
<dt><tt><url>http://search.yahoo.com/search?p=jetspeed&amp;n=100</url></tt></dt><dd>2
Parameter passed</dd>
</dl>
<p><strong>Bad URLs:</strong></p>
<dl>
<dt><tt><url>index.html</url></tt></dt><dd>No protocal, http:// or
hostname</dd>
<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='Element: security'>
<p>
</p>
<table>
<tr>
<th>Atribute Name</th>
<th>Description</th>
</tr>
<tr>
<td>role</td>
<td>Role required by user to select item</td>
</tr>
</table>
</section>
<section name='Element: media-type'>
<p>
Media types are define in <jetspeed_home>/WEB-INF/conf/media.xreg
</p>
</section>
<section name='Example of Registery Entry'>
<p>
<center>Abstract Portal Entry</center>
</p>
<source><![CDATA[
<portlet-entry name="RSS" hidden="false" type="abstract" application="false">
<meta-info>
<title></title>
<description></description>
</meta-info>
<classname>org.apache.jetspeed.portal.portlets.NewRSSPortlet</classname>
<parameter name="stylesheet" value="/WEB-INF/xsl/rss.xsl" hidden="false">
<meta-info>
<title></title>
<description></description>
</meta-info>
<security role="admin"/>
</parameter>
<media-type ref="html"/>
<media-type ref="wml"/>
</portlet-entry>
]]></source>
<p>
<center>Referance Portal Entry</center>
</p>
<source><![CDATA[
<portlet-entry name="RSS" hidden="false" type="ref" application="false">
<meta-info>
<title></title>
<description></description>
</meta-info>
<parameter name="" value="" hidden="false">
<meta-info>
<title></title>
<description></description>
</meta-info>
<security role=""/>
</parameter>
</portlet-entry>
]]></source>
</section>
<section name='Example of use in Portal'>
<p/>
</section>
<section name='Questions and possible problems to be investigated (version 1.3a1)'>
<p>
<ul>
<li>Add descriptions and review.</li>
<li>Add common parameters, i.e. bgcolor and display.screen.</li>
<li>Complete examples</li>
</ul>
</p>
</section>
</body>
</document>
1.8 +6 -5 jakarta-jetspeed/xdocs/stylesheets/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/stylesheets/project.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- project.xml 2001/05/19 09:38:19 1.7
+++ project.xml 2001/07/23 04:41:02 1.8
@@ -19,15 +19,16 @@
<menu name="Get Involved">
<item name="Todo" href="/todo.html"/>
<item name="Contributors" href="/contributors.html"/>
- <item name="CVS Repository"
href="http://jakarta.apache.org/site/cvsindex.html"/>
- <item name="Javadoc"
href="http://www.bluesunrise.com/jetspeed/javadocs/"/>
+ <item name="CVS Repository"
href="http://jakarta.apache.org/site/cvsindex.html"/>
<item name="CVS Branches" href="/branches.html"/>
<item name="Coding Spec" href="/code-standards.html"/>
</menu>
- <menu name="Tutorials">
+ <menu name="Documentation">
+ <item name="Javadoc"
href="http://www.bluesunrise.com/jetspeed-docs/javadocs/"/>
<item name="Development" href="/application-development.html"/>
- <item name="Portlet Howto"
href="http://www.bluesunrise.com/jetspeed/PortletHowTo.htm"/>
- <item name="Configuration Howto"
href="http://www.bluesunrise.com/jetspeed/jetspeed.htm"/>
+ <item name="Portlet Howto"
href="http://www.bluesunrise.com/jetspeed-docs/PortletHowTo.htm"/>
+ <item name="Configuration Howto"
href="http://www.bluesunrise.com/jetspeed-docs/jetspeed.htm"/>
+ <item name="Portlet Catalog" href="/catalog.html"/>
</menu>
<menu name="Components">
<item name="Syndication" href="/content-syndication.html"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
