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 pa...@apache.org on 2001/08/28 05:30:06 UTC
cvs commit: jakarta-jetspeed/xdocs portlet_config_common.xml portlet_config_HTML.xml portlet_config_JSP.xml
paulsp 01/08/27 20:30:06
Modified: xdocs portlet_config_common.xml portlet_config_HTML.xml
portlet_config_JSP.xml
Log:
General spelling and cleanup
Revision Changes Path
1.3 +42 -26 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.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- portlet_config_common.xml 2001/07/30 03:57:57 1.2
+++ portlet_config_common.xml 2001/08/28 03:30:06 1.3
@@ -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="paulsp@apache.org"/>
</authors>
</properties>
@@ -20,19 +20,21 @@
<br/>
</p>
</section>
+
<section name='Description'>
<p>
+ Common elements
+ <ul>
+ <li><a href="#Element: portlet-entry">portlet-entry</a></li>
+ <li><a href="#Element: meta-info">meta-info</a></li>
+ <li><a href="#Element: classname">classname</a></li>
+ <li><a href="#Element: parameter">parameter</a></li>
+ <li><a href="#Element: url">url</a></li>
+ <li><a href="#Element: security">security</a></li>
+ <li><a href="#Element: media-type">media-type</a></li>
+ </ul>
+ <a href="#Example of Registry Entry">Registery Entry examples</a>
</p>
-
-
- <subsection name='Supported Media Types'>
- <p>
- <ul>
- <li>html</li>
- <li>wml</li>
- </ul>
- </p>
- </subsection>
</section>
@@ -105,6 +107,7 @@
<tr>
<td>application</td>
<td>
+ Portlet will be displayed in a full screen, i.e. the only portlet displayed.
<br/>
<table>
<tr>
@@ -121,6 +124,7 @@
</tr>
</table>
</section>
+
<section name='Element: meta-info'>
<p>
Typically optional information that describe the item (portlet, parameter, ...). Meta-info is used
@@ -142,7 +146,7 @@
</tr>
<tr>
<td>parameter</td>
- <td>Value of parameters's name attribute</td>
+ <td>Value of parameter's name attribute</td>
</tr>
</table>
</subsection>
@@ -163,15 +167,14 @@
<section name='Element: classname'>
<p>
- Java class name of portlet
+ Java class uses to generate content.
</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.
+ The hidden attribute controls whether the customizer will display the parameter.
</p>
<p>
This element is optional.
@@ -193,7 +196,7 @@
<tr>
<td>type</td>
<td>
- Data type of value. When this attribute is not present any charater string is accepted
+ Data type of value. When this attribute is not present any character string is accepted
<br/>
<table>
<tr>
@@ -247,17 +250,32 @@
</td>
</tr>
+ <tr>
+ <td>_display</td>
+ <td>
+ Initial display state of portlet.
+ <br/>
+ If not present, Default: <tt>normal</tt>
+ <br/>
+ <table>
+ <tr><th>Value</th><th>Description</th></tr>
+ <tr><td>closed</td><td>Portlet is closed and not visible</td></tr>
+ <tr><td>minimized</td><td>Portlet is minimized. Only title is displayed</td></tr>
+ <tr><td>normal</td><td>Portal and content is 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.
+ Since the configuration file is an XML file, some character must be represented using XML entities.
</p>
<table>
<tr>
<th>Character</th>
- <th>XML Entitiy</th>
+ <th>XML Entity</th>
</tr>
<tr>
<td>&</td>
@@ -280,7 +298,7 @@
</tr>
<tr>
<td>http://</td>
- <td>Standard HTTP protocol is used to retreive file or data</td>
+ <td>Standard HTTP protocol is used to retrieve file or data</td>
</tr>
<tr>
<td><![CDATA[ ]]></td>
@@ -296,7 +314,7 @@
</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>index.html</url></tt></dt><dd>No protocol, 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>
@@ -336,7 +354,7 @@
</table>
</section>
-<section name='Example of Registery Entry'>
+<section name='Example of Registry Entry'>
<p>
<center>Abstract Portal Entry</center>
</p>
@@ -359,7 +377,7 @@
</portlet-entry>
]]></source>
<p>
- <center>Referance Portal Entry</center>
+ <center>Reference Portal Entry</center>
</p>
<source><![CDATA[
<portlet-entry name="RSS" hidden="false" type="ref" application="false">
@@ -390,12 +408,10 @@
<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>How is the hidden attribute of <parameter> used?</li>
<li>Verify definition/implementation of <portlet-entry>.</li>
</ul>
</p>
</section>
</body>
-</document>
-
-
+</document>
\ No newline at end of file
1.4 +1 -1 jakarta-jetspeed/xdocs/portlet_config_HTML.xml
Index: portlet_config_HTML.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/portlet_config_HTML.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- portlet_config_HTML.xml 2001/08/24 19:12:45 1.3
+++ portlet_config_HTML.xml 2001/08/28 03:30:06 1.4
@@ -33,7 +33,7 @@
<ul>
<li>HTML is a static</li>
<li>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>HTML file does not have to be visible to the Web Server</li>
<li>Specific task can not be achieved with WebPagePortlet</li>
<li>Desired portlet is just an image, like JPEG or SVG</li>
</ul>
1.2 +9 -9 jakarta-jetspeed/xdocs/portlet_config_JSP.xml
Index: portlet_config_JSP.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/portlet_config_JSP.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- portlet_config_JSP.xml 2001/07/23 04:41:02 1.1
+++ portlet_config_JSP.xml 2001/08/28 03:30:06 1.2
@@ -4,7 +4,7 @@
<title>Portlet Configuration How To</title>
<subtitle>JSP</subtitle>
<authors>
- <person name="Paul Spencer" email="paulspencer@mindspring.com"/>
+ <person name="Paul Spencer" email="paulsp@apache.org"/>
</authors>
</properties>
<body>
@@ -28,7 +28,7 @@
<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>JSP does not have to be visible to the Web Server</li>
<li>Specific task can not be achieved with WebPagePortlet</li>
</ul>
</p>
@@ -37,8 +37,6 @@
<a href="portlet_config_common.html#Supported Media Types">
Description of Media Types.
</a>
- <ul>
- </ul>
</p>
</subsection>
</section>
@@ -60,7 +58,7 @@
<table>
<tr>
- <th>Paramater Name</th>
+ <th>Parameter Name</th>
<th>Description</th>
</tr>
<tr>
@@ -69,7 +67,7 @@
</tr>
</table>
</section>
-<section name='Example of Registery Entry'>
+<section name='Example of Registry Entry'>
<source test=""><![CDATA[
<portlet-entry name="HelloJSP" hidden="false" type="ref"
parent="JSP" application="false">
@@ -82,20 +80,22 @@
</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>
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org