Author: mmcallis Date: 2008-03-31 20:57:20 -0400 (Mon, 31 Mar 2008) New Revision: 10441 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.2.3. The jboss-portlet.xml Descriptor - final revisions 6.2.4. The portlet.xml Descriptor - started revising first paragraph Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-01 00:20:32 UTC (rev 10440) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-01 00:57:20 UTC (rev 10441) @@ -1286,12 +1286,12 @@ <sect2> <title>The <filename>jboss-portlet.xml</filename> Descriptor</title> <para> - The <filename>jboss-portlet.xml</filename> descriptor allows you to use JBoss-specific functionality within your portlet application. This descriptor is covered by the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink>, and would normally be package inside your portlet WAR, alongside the other descriptors in these sections. + The <filename>jboss-portlet.xml</filename> descriptor allows you to use JBoss-specific functionality within your portlet application. This descriptor is covered by the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink>, and is normally packaged inside your portlet WAR file, alongside the other descriptors in these sections. </para> <sect3> <title>Injecting Header Content</title> <para> - The following example injects a specific style sheet, <computeroutput>/images/management/management.css</computeroutput>, allowing the porlet to leverage a specific style: + The following example injects a specific style sheet, <computeroutput>/images/management/management.css</computeroutput>, allowing the portlet to leverage a specific style: </para> <para> <screen><![CDATA[ @@ -1311,7 +1311,7 @@ </screen> </para> <para> - Use the <computeroutput>&lt;header-content&gt;</computeroutput> and <computeroutput>&lt;link&gt;</computeroutput> elements to specify a style sheet to use. + Use the <computeroutput>&lt;header-content&gt;</computeroutput> and <computeroutput>&lt;link&gt;</computeroutput> elements to specify a style sheet. </para> </sect3> <sect3> @@ -1341,15 +1341,14 @@ <screen><![CDATA[ UserModule userModule = (UserModule) getPortletContext().getAttribute("UserModule"); String userId = request.getParameters().getParameter("userid"); -User user = userModule.findUserById(userId); -]]> +User user = userModule.findUserById(userId);]]> </screen> </para> </sect3> <sect3> <title>Defining Extra Portlet Information</title> <para> - As of JBoss Portal 2.6.3, icons can be defined for a portlet, by using the <computeroutput>&lt;icon&gt;</computeroutput>, <computeroutput>&lt;small-icon&gt;</computeroutput>, and <computeroutput>&lt;large-icon&gt;</computeroutput> elements: + As of JBoss Portal 2.6.3, icons can be defined for a portlet by using the <computeroutput>&lt;icon&gt;</computeroutput>, <computeroutput>&lt;small-icon&gt;</computeroutput>, and <computeroutput>&lt;large-icon&gt;</computeroutput> elements: </para> <para> <screen><![CDATA[ @@ -1371,20 +1370,30 @@ </screen> </para> <para> - The reference can be absolute, for example, <emphasis>http://www.example.com/images/smallIcon.png</emphasis>;, or relative to the web application context, by starting with a <computeroutput>/</computeroutput>, as shown above. These icons can be used by different parts of the portlet user interface. + References to icons can be absolute, for example, <emphasis>http://www.example.com/images/smallIcon.png</emphasis>;, or relative to the web application context, for example, <computeroutput>/images/smallIcon.png</computeroutput>. Icons can be used by different parts of the portlet user interface. </para> </sect3> <sect3> <title>Portlet Session Replication in a Clustered Environment</title> </sect3> - <para>See <xref linkend="portlet_session_replication"/>.</para> + <para> + For information about portlet session replication in clustered environments, refer to <xref linkend="portlet_session_replication"/>. + </para> + <para> + <note> + <title>Is the <filename>jboss-portlet.xml</filename> descriptor required?</title> + <para> + Technically, it is not; however, it may be required to access JBoss-specific functionality that is not covered by the Portlet specification. + </para> + </note> + </para> </sect2> <sect2> - <title>portlet.xml</title> - <para>This is the standard portlet descriptor covered by the JSR-168 Specification. It is - advisable that developers read the specification items covering proper use of this descriptor, as it is only - covered here briefly. For example purposes, we use an edited version of our JBoss Portal UserPortlet - definition. Normally, you would package this descriptor in your portlet WAR file. + <title>The <filename>portlet.xml</filename> Descriptor</title> + <para> + The <filename>portlet.xml</filename> descriptor is the standard portlet descriptor covered by the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink>. Developers are strongly encouraged to read the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink> items covering the correct use of this descriptor, as it is oinly covered briefly in this section. Normally, the <filename>portlet.xml</filename> descriptor is packaged inside your portlet WAR file, alongside other the other descriptors in these sections. The following example is a modified version of the JBoss Portal UserPortlet definition: + </para> + <para> <programlisting><![CDATA[ <?xml version="1.0" encoding="UTF-8"?> <portlet-app @@ -1488,14 +1497,6 @@ <note>This is a simple portlet.xml primer, and is not meant as a replacement for what is covered in the actual Portlet specification.</note> </para> - <para> - <note> - <title>Is the <filename>jboss-portlet.xml</filename> descriptor required?</title> - <para> - Technically, it is not; however, it may be required to access JBoss-specific functionality that is not covered by the Portlet specification. - </para> - </note> - </para> </sect2> </sect1> <sect1 id="portaldescriptors">