taylor 2002/07/16 17:03:31 Modified: docs/site catalog.html install.html psml.html webapp/WEB-INF/conf JetspeedSecurity.properties xdocs install.xml psml.xml Log: Documented PSML References and Locators Revision Changes Path 1.9 +0 -3 jakarta-jetspeed/docs/site/catalog.html Index: catalog.html =================================================================== RCS file: /home/cvs/jakarta-jetspeed/docs/site/catalog.html,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- catalog.html 16 Jul 2002 22:05:56 -0000 1.8 +++ catalog.html 17 Jul 2002 00:03:31 -0000 1.9 @@ -138,9 +138,6 @@ <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.20 +203 -17 jakarta-jetspeed/docs/site/install.html Index: install.html =================================================================== RCS file: /home/cvs/jakarta-jetspeed/docs/site/install.html,v retrieving revision 1.19 retrieving revision 1.20 diff -u -r1.19 -r1.20 --- install.html 13 Jul 2002 09:03:59 -0000 1.19 +++ install.html 17 Jul 2002 00:03:31 -0000 1.20 @@ -118,6 +118,9 @@ <blockquote> <ul> <li><a href="#Requirements">Requirements</a></li> + <li><a href="#Downloading A Release Build">Downloading A Release Build</a></li> + <li><a href="#Downloading A Nightly Build">Downloading A Nightly Build</a></li> + <li><a href="#Checkout from CVS">Checkout from CVS</a></li> <li><a href="#Installation">Installation</a></li> <li><a href="#Database Configuration">Database Configuration</a></li> <li><a href="#Servlet Container Notes">Servlet Container Notes</a></li> @@ -154,6 +157,187 @@ <table border="0" cellspacing="0" cellpadding="2" width="100%"> <tr><td bgcolor="#525D76"> <font color="#ffffff" face="arial,helvetica,sanserif"> + <a name="Downloading A Release Build"><strong>Downloading A Release Build</strong></a> + </font> + </td></tr> + <tr><td> + <blockquote> + <p> +When downloading a release build, there are three kinds of builds that you can download: +<ul> +<li><b>Full WAR</b> - Gives you the entire Web Application including all documentation and javadocs. +</li> +<li><b>WAR</b> - Gives you the Web Application minus documentation and javadocs. +</li> +<li><b>Source</b> - Gives you the source code and resources. You will need to build Jetspeed yourself. +</li> +</ul> +The WAR and Full WAR downloads do not require for you to build Jetspeed. The Web Application is ready to deploy to your application server in a Web Archive (WAR) format. +</p> + <table> + <tr> + <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Release 1.4b1 (Latest) + </font> +</td> + <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Download From: + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Jetspeed Release 1.4b1 - Full WAR + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + <a href="http://jakarta.apache.org/builds/jakarta-jetspeed/release/v1.4b1/jetspeed-1.4b1-release-fullwar.zip">jetspeed-1.4b1-release-fullwar.zip</a> + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Jetspeed Release 1.4b1 - Standard WAR + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + <a href="http://jakarta.apache.org/builds/jakarta-jetspeed/release/v1.4b1/jetspeed-1.4b1-release-fullwar.zip">jetspeed-1.4b1-release-war.zip</a> + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Jetspeed Release 1.4b1 - Source Only + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + <a href="http://jakarta.apache.org/builds/jakarta-jetspeed/release/v1.4b1/jetspeed-1.4b1-release-fullwar.zip">jetspeed-1.4b1-release-src.zip</a> + </font> +</td> + </tr> + </table> + <table> + <tr> + <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Release 1.3a2 + </font> +</td> + <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Download From: + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Jetspeed Release 1.3a2 - Full WAR + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + <a href="http://jakarta.apache.org/builds/jakarta-jetspeed/release/v1.3a2/jetspeed-1.3a2-release-fullwar.zip">jetspeed-1.3a2-release-fullwar.zip</a> + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Jetspeed Release 1.3a2 - Standard WAR + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + <a href="http://jakarta.apache.org/builds/jakarta-jetspeed/release/v1.3a2/jetspeed-1.3a2-release-fullwar.zip">jetspeed-1.3a2-release-war.zip</a> + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Jetspeed Release 1.3a2 - Source Only + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + <a href="http://jakarta.apache.org/builds/jakarta-jetspeed/release/v1.3a2/jetspeed-1.3a2-release-fullwar.zip">jetspeed-1.3a2-release-src.zip</a> + </font> +</td> + </tr> + </table> + </blockquote> + </p> + </td></tr> + <tr><td><br/></td></tr> + </table> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica,sanserif"> + <a name="Downloading A Nightly Build"><strong>Downloading A Nightly Build</strong></a> + </font> + </td></tr> + <tr><td> + <blockquote> + <p> +The Jetspeed Nightly Builds are automatically updated from CVS every night on the Jakarta server. +Each zip file is a snapshot of the entire CVS at the end of the given day. +You will need to build Jetspeed from the nightly snapshots. +The last seven builds are available for download in both GZIP and ZIP formats. +The last seven builds are available from here: +<a href="http://jakarta.apache.org/builds/jakarta-jetspeed/nightly/">Nightly Builds</a> +</p> + </blockquote> + </p> + </td></tr> + <tr><td><br/></td></tr> + </table> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica,sanserif"> + <a name="Checkout from CVS"><strong>Checkout from CVS</strong></a> + </font> + </td></tr> + <tr><td> + <blockquote> + <p> +The best way to get the latest Jetspeed source is to checkout directly from CVS. +Follow the Jakarta CVS instructions available <a href="http://jakarta.apache.org/site/cvsindex.html">here</a> +and checkout the <b>jakarta-jetspeed</b> module. +</p> + <p> +<b> +cvs -d :pserver:[EMAIL PROTECTED]:/home/cvspublic login +password: anoncvs +</b> +<br /> +<b> +cvs -d :pserver:[EMAIL PROTECTED]:/home/cvspublic checkout jakarta-jetspeed +</b> +<br /> +<br /> +To check for a particular date, use the -D option: +<br /><br /> +<b> +cvs -d :pserver:[EMAIL PROTECTED]:/home/cvspublic checkout -D 2002-06-04 jakarta-jetspeed +</b> +</p> + </blockquote> + </p> + </td></tr> + <tr><td><br/></td></tr> + </table> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica,sanserif"> <a name="Installation"><strong>Installation</strong></a> </font> </td></tr> @@ -167,13 +351,12 @@ </p> <ul> <li> -1. Checkout the complete Jetspeed source from our CVS server. -Follow the Jakarta CVS instructions available <a href="http://jakarta.apache.org/site/cvsindex.html">here</a> -and checkout the jakarta-jetspeed module -</li> +1. <b>Download or Checkout Jetspeed</b> as described in one of the three sections above. + </li> + <br /><br /> <li> -2. Build Jetspeed - +2. <b>Build Jetspeed</b> +- Skip this step if you downloaded a WAR release version of Jetspeed. <ul> <li>cd <jetspeedRoot>/build</li> <li>[Win32/DOS] .\build war</li> @@ -181,38 +364,40 @@ <li>[unix] ./build.sh war</li> </ul> </li> + <br /> <li> -3. Get a Servlet 2.2 runner (container). We use Tomcat in this installation. - <ul> +3. <b>Download Tomcat</b> or another standard 2.2 or 2.3 compatible Servlet Container. +We use Jakarta Tomcat in the examples here. + <ul> <li> <a href="http://jakarta.apache.org/tomcat/">Tomcat Homepage</a> </li> - </ul> + </ul> </li> + <br /> <li> - -4. Unzip the Tomcat distribution -<p /> +4. <b>Install the Tomcat distribution</b> - Follow the instructions at the Tomcat site. </li> + <br /><br /> <li> -5. Copy the Jetspeed WAR file to the Tomcat webapps directory +5. <b>Copy the Jetspeed WAR file to the Tomcat webapps directory</b> <ul> <li>[Win32] copy <jetspeedRoot>\bin\jetspeed.war <tomcat_home>\webapps\</li> <li>[Unix] cp <jetspeedRoot>/bin/jetspeed.war <tomcat_home>/webapps/</li> </ul> </li> + <br /> <li> -6. Start Tomcat - +6. <b>Start Tomcat</b> <ul> <li>[Win32] <tomcat_home>\bin\startup.bat</li> <li>[Unix] <tomcat_home>/bin/startup.sh</li> </ul> </li> + <br /> <li> -7. Connect to Jetspeed - +7. <b>Connect to Jetspeed</b> <ul> <li> <a href="http://localhost:8080/jetspeed/">http://localhost:8080/jetspeed/</a> @@ -226,6 +411,7 @@ </li> </ul> </li> + <br /> <li> 7a. When signing up a new user in Jetspeed, the registration process includes a step where an email is sent to the new user. In order for this process to work on Windows NT or 2000, you will need to have a local SMTP server running. The Apaches James Mail Enterprise Server is available from: 1.19 +213 -0 jakarta-jetspeed/docs/site/psml.html Index: psml.html =================================================================== RCS file: /home/cvs/jakarta-jetspeed/docs/site/psml.html,v retrieving revision 1.18 retrieving revision 1.19 diff -u -r1.18 -r1.19 --- psml.html 9 Feb 2002 23:58:43 -0000 1.18 +++ psml.html 17 Jul 2002 00:03:31 -0000 1.19 @@ -326,6 +326,12 @@ may provide additionnal functionalities to a portlet and may also add some graphical decorations around the portlet content. </dd> + <dt>PSML Reference</dt> + <dd> + A reference to another PSML resource which is included into this PSML resource + at the specified point in the markup. The reference is specified using a PSML resource + locator in the <b>path</b> attribute of the <b>reference</b> PSML element as described here: <a href="#PSML Locator">PSML Locator</a> + </dd> </dl> </p> <p> @@ -384,6 +390,9 @@ <entry type="ref" parent="http://www.apacheweek.com/issues/apacheweek-headlines"> <parameter name="showTitle" value="false"/> </entry> + + <reference id="P-ed09142736-10018" path="group/apache/page/news"/> + </portlets> </portlets> @@ -401,6 +410,210 @@ </td></tr> <tr><td><br/></td></tr> </table> + </blockquote> + </p> + </td></tr> + <tr><td><br/></td></tr> + </table> + <table border="0" cellspacing="0" cellpadding="2" width="100%"> + <tr><td bgcolor="#525D76"> + <font color="#ffffff" face="arial,helvetica,sanserif"> + <a name="PSML Locator"><strong>PSML Locator</strong></a> + </font> + </td></tr> + <tr><td> + <blockquote> + <p> + PSML Locators are used to locate PSML References. + The <b>path</b> attribute of the <b>reference</b> PSML element defines the locator for another PSML resource. + Locators are used to include an entire PSML resource into another PSML resource. + This is useful for defining groups of markup once, and then sharing that markup in one or more PSML resources. + Here is an example of a Portlet Reference. The locator is defined in the <b>path</b> attribute: + </p> + <div align="left"> + <table cellspacing="4" cellpadding="0" border="0"> + <tr> + <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + </tr> + <tr> + <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + <td bgcolor="#ffffff"><pre> + +<portlets user="default" xmlns="http://xml.apache.org/jetspeed/2000/psml"> +... + <portlets> + <controller name="org.apache.jetspeed.portal.controllers.RowColumnPortletController"/> + + <reference id="P-ed09142736-10018" path="group/apache/page/news"/> + + </portlets> +... +</pre></td> + <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + </tr> + <tr> + <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + </tr> + </table> + </div> + <p> +Locators are always defined as pairs of parameters. They can also be used as part of a URL. +In the example above, there are two pairs of keywords and values: +<ul> +<li>group/apache +</li> +<li>page/news +</li> +</ul> +The keywords are "group" and "page", and the values are "apache" and "news". +"apache" is the name of a group in Jetspeed. Groups are one way to arbitrarily classify PSML resources. +"page" is the name of the PSML resource. The extension '.psml' is not needed. +</p> + <p> +The format of a locator is: +</p> + <div align="left"> + <table cellspacing="4" cellpadding="0" border="0"> + <tr> + <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + </tr> + <tr> + <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + <td bgcolor="#ffffff"><pre> + user/<name>/media-type/<mediaType>/language/<language>/country/<country>/<page>/page + +or + + group/<name>/media-type/<mediaType>/language/<language>/country/<country>/<page>/page + +or + + role/<name>/media-type/<mediaType>/language/<language>/country/<country>/<page>/page +</pre></td> + <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + </tr> + <tr> + <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td> + </tr> + </table> + </div> + <p> +Where the keywords "group", "group" and "role" are mutually exclusive, and all other parameters are optional. +If the page parameter is not specified, the "default" PSML page is located as defined in the JetspeedResources.properties. +For all other parameters, if they are not specified, then the media-type, language and country code will be determined from the capabilities of the requesting device (browser). +Although you can specify any resource, such as another user's PSML in a locator, +Jetspeed will make a security check to determine if you have sufficient authorization to +include the PSML resource. +</p> + <table> + <tr> + <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Keyword + </font> +</td> + <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Description + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + user + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Specify that the resource is located under the 'user' subtree for the given user in the value parameter. If neither 'user', 'group' or 'role' are specified, the current user's subtree is defaulted. + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + group + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Specify that the resource is located under the 'group' subtree for the given group in the value parameter. + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + role + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Specify that the resource is located under the 'role' subtree for the given role in the value parameter. + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + media-type + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Specify that the resource is for a specific media type as given in the value parameter. Typical media types are "html", "wml", "xml" + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + language + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Specify that the resource is for a specific language as given in the value parameter. Languages must be specifed as an ISO-639 standard two-character language abbreviation. The language-code is an ISO-639 standard two-character abbreviation. + + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + country + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Specify that the resource is for a specific country as given in the value parameter. Languages must be specifed as an ISO-639 standard two-character language abbreviation. The country-code is an IS0-3166 standard two-character abbreviation. + + </font> +</td> + </tr> + <tr> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + page + </font> +</td> + <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left"> + <font color="#000000" size="-1" face="arial,helvetica,sanserif"> + Specify that the name of the resource in the value parameter. If not specified, uses the default resource. + + </font> +</td> + </tr> + </table> </blockquote> </p> </td></tr> 1.10 +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.9 retrieving revision 1.10 diff -u -r1.9 -r1.10 1.22 +3 -0 jakarta-jetspeed/xdocs/install.xml Index: install.xml =================================================================== RCS file: /home/cvs/jakarta-jetspeed/xdocs/install.xml,v retrieving revision 1.21 retrieving revision 1.22 diff -u -r1.21 -r1.22 --- install.xml 16 Jul 2002 23:09:06 -0000 1.21 +++ install.xml 17 Jul 2002 00:03:31 -0000 1.22 @@ -13,6 +13,9 @@ <section name="Table of Contents"> <ul> <li><a href="#Requirements">Requirements</a></li> + <li><a href="#Downloading A Release Build">Downloading A Release Build</a></li> + <li><a href="#Downloading A Nightly Build">Downloading A Nightly Build</a></li> + <li><a href="#Checkout from CVS">Checkout from CVS</a></li> <li><a href="#Installation">Installation</a></li> <li><a href="#Database Configuration">Database Configuration</a></li> <li><a href="#Servlet Container Notes">Servlet Container Notes</a></li> 1.10 +103 -0 jakarta-jetspeed/xdocs/psml.xml Index: psml.xml =================================================================== RCS file: /home/cvs/jakarta-jetspeed/xdocs/psml.xml,v retrieving revision 1.9 retrieving revision 1.10 diff -u -r1.9 -r1.10 --- psml.xml 10 Dec 2001 05:17:06 -0000 1.9 +++ psml.xml 17 Jul 2002 00:03:31 -0000 1.10 @@ -138,6 +138,12 @@ may provide additionnal functionalities to a portlet and may also add some graphical decorations around the portlet content. </dd> + <dt>PSML Reference</dt> + <dd> + A reference to another PSML resource which is included into this PSML resource + at the specified point in the markup. The reference is specified using a PSML resource + locator in the <b>path</b> attribute of the <b>reference</b> PSML element as described here: <a href="#PSML Locator">PSML Locator</a> + </dd> </dl> </p> <p> @@ -178,12 +184,109 @@ <entry type="ref" parent="http://www.apacheweek.com/issues/apacheweek-headlines"> <parameter name="showTitle" value="false"/> </entry> + + <reference id="P-ed09142736-10018" path="group/apache/page/news"/> + </portlets> </portlets> ]]></source> </subsection> </section> + <section name="PSML Locator"> + <p> + PSML Locators are used to locate PSML References. + The <b>path</b> attribute of the <b>reference</b> PSML element defines the locator for another PSML resource. + Locators are used to include an entire PSML resource into another PSML resource. + This is useful for defining groups of markup once, and then sharing that markup in one or more PSML resources. + Here is an example of a Portlet Reference. The locator is defined in the <b>path</b> attribute: + </p> + <source test=""><![CDATA[ + +<portlets user="default" xmlns="http://xml.apache.org/jetspeed/2000/psml"> +... + <portlets> + <controller name="org.apache.jetspeed.portal.controllers.RowColumnPortletController"/> + + <reference id="P-ed09142736-10018" path="group/apache/page/news"/> + + </portlets> +... +]]></source> +<p> +Locators are always defined as pairs of parameters. They can also be used as part of a URL. +In the example above, there are two pairs of keywords and values: +<ul> +<li>group/apache +</li> +<li>page/news +</li> +</ul> +The keywords are "group" and "page", and the values are "apache" and "news". +"apache" is the name of a group in Jetspeed. Groups are one way to arbitrarily classify PSML resources. +"page" is the name of the PSML resource. The extension '.psml' is not needed. +</p> +<p> +The format of a locator is: +</p> + <source test=""><![CDATA[ + user/<name>/media-type/<mediaType>/language/<language>/country/<country>/<page>/page + +or + + group/<name>/media-type/<mediaType>/language/<language>/country/<country>/<page>/page + +or + + role/<name>/media-type/<mediaType>/language/<language>/country/<country>/<page>/page +]]></source> +<p> +Where the keywords "group", "group" and "role" are mutually exclusive, and all other parameters are optional. +If the page parameter is not specified, the "default" PSML page is located as defined in the JetspeedResources.properties. +For all other parameters, if they are not specified, then the media-type, language and country code will be determined from the capabilities of the requesting device (browser). +Although you can specify any resource, such as another user's PSML in a locator, +Jetspeed will make a security check to determine if you have sufficient authorization to +include the PSML resource. +</p> + <table> + <tr> + <th>Keyword</th> + <th>Description</th> + </tr> + <tr> + <td>user</td> + <td>Specify that the resource is located under the 'user' subtree for the given user in the value parameter. If neither 'user', 'group' or 'role' are specified, the current user's subtree is defaulted.</td> + </tr> + <tr> + <td>group</td> + <td>Specify that the resource is located under the 'group' subtree for the given group in the value parameter. </td> + </tr> + <tr> + <td>role</td> + <td>Specify that the resource is located under the 'role' subtree for the given role in the value parameter. </td> + </tr> + <tr> + <td>media-type</td> + <td>Specify that the resource is for a specific media type as given in the value parameter. Typical media types are "html", "wml", "xml"</td> + </tr> + <tr> + <td>language</td> + <td>Specify that the resource is for a specific language as given in the value parameter. Languages must be specifed as an ISO-639 standard two-character language abbreviation. The language-code is an ISO-639 standard two-character abbreviation. + </td> + </tr> + <tr> + <td>country</td> + <td>Specify that the resource is for a specific country as given in the value parameter. Languages must be specifed as an ISO-639 standard two-character language abbreviation. The country-code is an IS0-3166 standard two-character abbreviation. + </td> + </tr> + <tr> + <td>page</td> + <td>Specify that the name of the resource in the value parameter. If not specified, uses the default resource. + </td> + </tr> + </table> + + </section> <section name="PSML Database" > <p> If you would also like to store your PSML resources in the database, see the instructions <a href="psml_db.html">here</a>.
-- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>