Author: mmcallis Date: 2008-04-01 01:27:23 -0400 (Tue, 01 Apr 2008) New Revision: 10445 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.2.4. The portlet.xml Descriptor - final revisions - minor changes to wording in tutorials.xml Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-04-01 04:31:25 UTC (rev 10444) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-04-01 05:27:23 UTC (rev 10445) @@ -316,7 +316,7 @@ </supports>]]></screen></term> <listitem> <para> - The <computeroutput>&lt;supports&gt;</computeroutput> element declares all of the markup types that your portlet supports in the <literal>render</literal> method. This is accomplished via the + The <computeroutput>&lt;supports&gt;</computeroutput> element declares all of the markup types that a portlet supports in the <literal>render</literal> method. This is accomplished via the <computeroutput>&lt;mime-type&gt;</computeroutput> element, which is required for every portlet. The declared MIME types must match the capability of the portlet. As well, it allows you to pair which modes and window states are supported for each markup type. All portlets must support the <computeroutput>view</computeroutput> portlet mode, so this does not have to be declared. Use the <computeroutput>&lt;mime-type&gt;</computeroutput> element to define which markup type your portlet supports, which in this example, is <computeroutput>text/html</computeroutput>. This section tells the portal that it only outputs text and HTML, and that it only supports the <computeroutput>view</computeroutput> mode. </para> </listitem> @@ -1091,7 +1091,7 @@ </supports>]]></screen></term> <listitem> <para> - The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all of the markup types that your portlet supports in the <literal>render</literal> method. This is accomplished via the + The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all of the markup types that a portlet supports in the <literal>render</literal> method. This is accomplished via the <computeroutput>&lt;mime-type&gt;</computeroutput> element, which is required for every portlet. The declared MIME types must match the capability of the portlet. As well, it allows you to pair which modes and window states are supported for each markup type. All portlets must support the <computeroutput>view</computeroutput> portlet mode, so this does not have to be declared. Use the <computeroutput>&lt;mime-type&gt;</computeroutput> element to define which markup type your portlet supports, which in this example, is <computeroutput>text/html</computeroutput>. This section tells the portal that it only outputs text and HTML, and that it only supports the <computeroutput>view</computeroutput> mode. </para> </listitem> @@ -1413,7 +1413,7 @@ </supports>]]></screen></term> <listitem> <para> - The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all of the markup types that your portlet supports in the <literal>render</literal> method. This is accomplished via the + The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all of the markup types that a portlet supports in the <literal>render</literal> method. This is accomplished via the <computeroutput>&lt;mime-type&gt;</computeroutput> element, which is required for every portlet. The declared MIME types must match the capability of the portlet. As well, it allows you to pair which modes and window states are supported for each markup type. All portlets must support the <computeroutput>view</computeroutput> portlet mode, so this does not have to be declared. Use the <computeroutput>&lt;mime-type&gt;</computeroutput> element to define which markup type your portlet supports, which in this example, is <computeroutput>text/html</computeroutput>. This section tells the portal that it only outputs text and HTML, and that it only supports the <computeroutput>view</computeroutput> mode. </para> </listitem> 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 04:31:25 UTC (rev 10444) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-01 05:27:23 UTC (rev 10445) @@ -1397,7 +1397,7 @@ <sect2> <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 only covered briefly in these sections. Normally, the <filename>portlet.xml</filename> descriptor is packaged inside your portlet WAR file, alongside the other descriptors in these sections. The following example is a modified version of the JBoss Portal UserPortlet definition: + 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 only covered briefly in these sections. Normally the <filename>portlet.xml</filename> descriptor is packaged inside your portlet WAR file, alongside the other descriptors in these sections. The following example is a modified version of the JBoss Portal UserPortlet definition: </para> <para> <screen><![CDATA[ @@ -1414,7 +1414,7 @@ <display-name>User Portlet</display-name> <portlet-class>org.jboss.portal.core.portlet.user.UserPortlet</portlet-class> <init-param> - <description>Whether we should use ssl on login and throughout the Portal. + <description>Whether we should use SSL for log ins, and throughout the Portal. 1=yes;0=no</description> <name>useSSL</name> <value>0</value> @@ -1493,7 +1493,7 @@ <programlisting><![CDATA[<supports>...</supports>]]></programlisting> </para> <para> - The <computeroutput>&lt;supports&gt;</computeroutput> element declares all of the markup types that your portlet supports. Use the <computeroutput>&lt;mime-type&gt;</computeroutput> element to declare supported capabilities, for example, if the only outputs are text and HTML, use <computeroutput>&lt;mime-type&gt;text/html&lt;/mime-type&gt;</computeroutput>. Use the <computeroutput>&lt;portlet-mode&gt;</computeroutput> element to define the supported portlet modes for the portlet. For example, all portlets must support <computeroutput>view</computeroutput> portlet mode, which is defined using <computeroutput>&lt;portlet-mode&gt;view&lt;/portlet-mode&gt;</computeroutput>. + The <computeroutput>&lt;supports&gt;</computeroutput> element declares all of the markup types that a portlet supports. Use the <computeroutput>&lt;mime-type&gt;</computeroutput> element to declare supported capabilities, for example, if the only outputs are text and HTML, use <computeroutput>&lt;mime-type&gt;text/html&lt;/mime-type&gt;</computeroutput>. Use the <computeroutput>&lt;portlet-mode&gt;</computeroutput> element to define the supported portlet modes for the portlet. For example, all portlets must support <computeroutput>view</computeroutput> portlet mode, which is defined using <computeroutput>&lt;portlet-mode&gt;view&lt;/portlet-mode&gt;</computeroutput>. </para> </listitem> <listitem> @@ -1509,7 +1509,7 @@ <programlisting><![CDATA[<resource-bundle>...</resource-bundle>]]></programlisting> </para> <para> - The <computeroutput>&lt;resource-bundle&gt;</computeroutput> element contains the localized information for the specified locales. + The <computeroutput>&lt;resource-bundle&gt;</computeroutput> element specifies the resource bundle that contains the localized information for the specified locales. </para> </listitem> <listitem>