[portal-commits] JBoss Portal SVN: r10022 - docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules.

Author: mmcallis Date: 2008-02-18 23:30:47 -0500 (Mon, 18 Feb 2008) New Revision: 10022 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml Log: 5.2.4. An example Apache MyFaces JSF Portlet minor spelling corrections 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-02-19 00:32:26 UTC (rev 10021) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-19 04:30:47 UTC (rev 10022) @@ -316,8 +316,8 @@ </supports>]]></screen></term> <listitem> <para> - The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all the markup types your 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 VIEW portlet mode, so this does not have to be declared. Use <computeroutput>&lt;mime-type&gt;</computeroutput> to define which markup type your portlet supports, which in this example, is <computeroutput>text/html</computeroutput>. This section tells the portal that it will only output text and HTML, and that it only supports the <computeroutput>VIEW</computeroutput> mode. + The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all of the markup types your 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 VIEW 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 will only output text and HTML, and that it only supports the <computeroutput>VIEW</computeroutput> mode. </para> </listitem> </varlistentry> @@ -1030,7 +1030,7 @@ <sect3> <title>Application Descriptors</title> <para> - For brevity, only the <filename>portlet.xml</filename>, <filename>faces-config.xml</filename>, and <filename>web.xml</filename> descriptors are described here. For more information about application descriptors, refer to <xref linkend="first_portlet_descriptors"/> and <xref linkend="descriptors_portlet"/>. + Only the <filename>portlet.xml</filename>, <filename>faces-config.xml</filename>, and <filename>web.xml</filename> descriptors are described here. For more information about application descriptors, refer to <xref linkend="first_portlet_descriptors"/> and <xref linkend="descriptors_portlet"/>. </para> <para> The following is an example of the <filename>HelloWorldJSFSunRIPortlet/WEB-INF/portlet.xml</filename> file. This file must adhere to its definition in the JSR-168 Portlet Specification. You may define more than one portlet application in this file: @@ -1091,8 +1091,8 @@ </supports>]]></screen></term> <listitem> <para> - The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all the markup types your 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 VIEW portlet mode, so this does not have to be declared. Use <computeroutput>&lt;mime-type&gt;</computeroutput> to define which markup type your portlet supports, which in this example, is <computeroutput>text/html</computeroutput>. This section tells the portal that it will only output text and HTML, and that it only supports the <computeroutput>VIEW</computeroutput> mode. + The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all of the markup types your 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 VIEW 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 will only output text and HTML, and that it only supports the <computeroutput>VIEW</computeroutput> mode. </para> </listitem> </varlistentry> @@ -1114,6 +1114,7 @@ <managed-bean-class>org.jboss.portlet.hello.bean.User</managed-bean-class> <managed-bean-scope>session</managed-bean-scope> </managed-bean> + <navigation-rule> <navigation-case> <from-outcome>done</from-outcome> @@ -1361,7 +1362,7 @@ <sect3> <title>Application Descriptors</title> <para> - For brevity, only the <filename>portlet.xml</filename>, <filename>faces-config.xml</filename>, and <filename>web.xml</filename> descriptors are described here. For more information about application descriptors, refer to <xref linkend="first_portlet_descriptors"/> and <xref linkend="descriptors_portlet"/>. + Only the <filename>portlet.xml</filename>, <filename>faces-config.xml</filename>, and <filename>web.xml</filename> descriptors are described here. For more information about application descriptors, refer to <xref linkend="first_portlet_descriptors"/> and <xref linkend="descriptors_portlet"/>. </para> <para> The following is an example of the <filename>HelloWorldJSFMyFaces42Portlet/WEB-INF/portlet.xml</filename> file. This file must adhere to its definition in the JSR-168 Portlet Specification. You may define more than one portlet application in this file: @@ -1422,8 +1423,8 @@ </supports>]]></screen></term> <listitem> <para> - The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all the markup types your 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 VIEW portlet mode, so this does not have to be declared. Use <computeroutput>&lt;mime-type&gt;</computeroutput> to define which markup type your portlet supports, which in this example, is <computeroutput>text/html</computeroutput>. This section tells the portal that it will only output text and HTML, and that it only supports the <computeroutput>VIEW</computeroutput> mode. + The <computeroutput>&lt;supports&gt;</computeroutput> element allows you to declare all of the markup types your 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 VIEW 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 will only output text and HTML, and that it only supports the <computeroutput>VIEW</computeroutput> mode. </para> </listitem> </varlistentry> @@ -1453,6 +1454,7 @@ <managed-bean-class>org.jboss.portlet.hello.bean.User</managed-bean-class> <managed-bean-scope>session</managed-bean-scope> </managed-bean> + <navigation-rule> <navigation-case> <from-outcome>done</from-outcome> @@ -1477,7 +1479,7 @@ </screen> </para> <para> - These extra parameters let the application server know that the portlet embeds its own libraries. This avoids collision with the Sun JSF RI libraries bundled with JBoss AS And JBoss EAP. For more information, refer to the <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossFaces">Ap... MyFaces page on the JBoss Wiki</ulink>. + These extra parameters let the application server know that the portlet embeds its own libraries. This avoids collision with the Sun JSF RI libraries bundled with JBoss AS and JBoss EAP. For more information, refer to the <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossFaces">Ap... MyFaces page on the JBoss Wiki</ulink>. </para> </sect3> <sect3> @@ -1552,8 +1554,7 @@ </para> <para> Performing this step on a running instance of JBoss AS or JBoss EAP, and JBoss Portal, will trigger a hot-deploy of the portlet. - </para> - <para> + </para><para> To see the HelloWorldJSFMyFaces42Portlet, navigate to <ulink url="http://localhost:8080/portal/"></ulink>, or, if the default JBoss Portal page is already open, refresh the page. HelloWorldJSFMyFaces42Portlet is added to the bottom of the default JBoss Portal page: </para> <para>