Author: mmcallis Date: 2008-02-16 00:05:05 -0500 (Sat, 16 Feb 2008) New Revision: 9999 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml Log: minor corrections/revisions 5.2.3. An example Sun JSF Reference Implementation (RI) Portlet 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-16 04:01:16 UTC (rev 9998) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-16 05:05:05 UTC (rev 9999) @@ -974,7 +974,7 @@ </mediaobject> </para> <para> - To re-deploy the portlet, for example, if you have made changes to any of the XML descriptors, touch the $JBOSS_HOME/server/configuration/deploy/helloworldjspportlet.war/WEB-INF/web.xml file. On Linux, run the following command to re-deploy the HelloWorldJSPPortlet: + To re-deploy the portlet, for example, if you have made changes to any of the XML descriptors, touch the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjspportlet.war/WEB-INF/web.xml</filename> file. On Linux, run the following command to re-deploy the HelloWorldJSPPortlet: </para> <para> <screen> @@ -999,13 +999,13 @@ <sect3> <title>Introduction</title> <para> - This section describes how to deploy a JSF portlet in JBoss Portal, using the Apache MyFaces JSF implementation on JBoss AS or JBoss EAP. Before proceeding, download the <ulink url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_6/bundles... from <ulink url="http://labs.jboss.com/portletswap/">JBoss PortletSwap</ulink>. + This section describes how to deploy a JSF portlet in JBoss Portal, using the Apache MyFaces JSF implementation in JBoss AS or JBoss EAP. Before proceeding, download the <ulink url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_6/bundles... from <ulink url="http://labs.jboss.com/portletswap/">JBoss PortletSwap</ulink>. </para> </sect3> <sect3> <title>Package Structure</title> <para> - JBoss Portal requires certain descriptors to be included in a portlet WAR file. Some of these descriptors are defined by the JSR-168 Portlet Specification, and others are specific to JBoss Portal. Like a typical JSF application, the HelloWorldJSFSunRIPortlet package contains a <filename>faces-config.xml</filename> file, that defines managed-beans, converters, validators, navigation rules, and so on. The following is an example of the directory structure of the HelloWorldJSFSunRIPortlet portlet: + JBoss Portal requires certain descriptors to be included in a portlet WAR file. Some of these descriptors are defined by the JSR-168 Portlet Specification, and others are specific to JBoss Portal. Like a typical JSF application, the HelloWorldJSFSunRIPortlet package contains a <filename>faces-config.xml</filename> file that defines managed-beans, converters, validators, navigation rules, and so on. The following is an example of the directory structure of the HelloWorldJSFSunRIPortlet portlet: </para> <para> <mediaobject> @@ -1015,7 +1015,7 @@ </mediaobject> </para> <para> - To create the <filename>WEB-INF/</filename> and <filename>META-INF/</filename> directories, extract the helloworldjsfsunriportlet.war file. + To create the <filename>WEB-INF/</filename> and <filename>META-INF/</filename> directories, extract the <filename>helloworldjsfsunriportlet.war</filename> file. </para> <para> <note> @@ -1030,18 +1030,8 @@ <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 defined. For more information on other discriptors, refer to <xref linkend="first_portlet_descriptors"/> and <xref linkend="descriptors_portlet"/>. + 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"/>. </para> - <para> - The following is an example of the directory structure of the HelloWorldJSFSunRIPortlet portlet: - </para> - <para> - <mediaobject> - <imageobject> - <imagedata align="center" fileref="images/tutorials/jsf_portlet/package_sunri.png" valign="middle"/> - </imageobject> - </mediaobject> - </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: </para> @@ -1078,7 +1068,7 @@ </screen></term> <listitem> <para> - This specifies that the <computeroutput>com.sun.faces.portlet.FacesPortlet</computeroutput> handles all requests and responses from users. This class is part of the <filename>HelloWorldJSFSunRIPortlet/WEB-INF/lib/jsf-portlet.jar</filename> file. + This specifies that the <computeroutput>com.sun.faces.portlet.FacesPortlet</computeroutput> handles all requests and responses from the users. This class is part of the <filename>HelloWorldJSFSunRIPortlet/WEB-INF/lib/jsf-portlet.jar</filename> file. </para> </listitem> </varlistentry> @@ -1090,7 +1080,7 @@ </screen></term> <listitem> <para> - You must initializes the portlet with a default view page to render, similar to the default JBoss Portal page. + You must initialize the portlet with a default page to render, similar to what is done with the default JBoss Portal page. </para> </listitem> </varlistentry> @@ -1122,10 +1112,10 @@ </screen> </para> <para> - Without the <filename>faces-config.xml</filename>, the application would work the same outside of the portlet, as it would inside a portlet container. In this exampel, a basic user bean, <computeroutput>&lt;managed-bean-name&gt;user&lt;/managed-bean-name&gt;</computeroutput>, and a navigation <computeroutput>&lt;navigation-rule&gt;</computeroutput> rule are defined, which handle submitting the original form in the <filename>HelloWorldJSFSunRIPortlet/WEB-INF/jsp/index.jsp</filename> file. + Without the <filename>faces-config.xml</filename> file, the application would work the same outside of the portlet, as it would inside a portlet container. In this example, a basic user bean, <computeroutput>&lt;managed-bean-name&gt;user&lt;/managed-bean-name&gt;</computeroutput>, and a navigation rule are defined, which handle submitting the original form in the <filename>HelloWorldJSFSunRIPortlet/WEB-INF/jsp/index.jsp</filename> file. </para> <para> - The following is an example of the <filename>HelloWorldJSFSunRIPortlet/WEB-INF/web.xml</filename> file: + The following is an example of the <computeroutput>Faces Servlet</computeroutput> section from the <filename>HelloWorldJSFSunRIPortlet/WEB-INF/web.xml</filename> file: </para> <para> <screen><![CDATA[ @@ -1153,13 +1143,13 @@ </screen> </para> <para> - For the Sun JSF RI, this definition is mandatory to associate <filename>.jsf</filename> extensions with the faces servlet. + For the Sun JSF RI, this definition is mandatory to associate files with <filename>.jsf</filename> extensions with the Apache MyFaces servlet. </para> <para> <warning> <title>Classes for the JSF-Portlet bridge are not included</title> <para> - The classes for the JSF-Portlet bridge are not included with the JSF implementation (unlike Apache MyFaces), JBoss AS, or JBoss EAP. This library must be available in your application package. Navigate to the <ulink url="https://jsfportletbridge.dev.java.net/servlets/ProjectDocumentL... bridge webpage</ulink> to download the JSF-Portlet bridge library. + Unlike Apache MyFaces, the classes for the JSF-Portlet bridge are not included with the JSF implementation, JBoss AS, or JBoss EAP. This library must be available in your application package. Navigate to the <ulink url="https://jsfportletbridge.dev.java.net/servlets/ProjectDocumentL... bridge webpage</ulink> to download the JSF-Portlet bridge library. </para> </warning> </para>