Author: mmcallis Date: 2008-02-15 23:01:16 -0500 (Fri, 15 Feb 2008) New Revision: 9998 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml Log: 5.2.3.3. Application Descriptors revising, replacing itemizedlist with variable trying to make it more consistent with 5.2.1.4. Application Descriptors 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 02:54:58 UTC (rev 9997) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-16 04:01:16 UTC (rev 9998) @@ -1093,12 +1093,15 @@ You must initializes the portlet with a default view page to render, similar to the default JBoss Portal page. </para> </listitem> -</variabelist> +</varlistentry> +</variablelist> </para> - - <listitem> - <para><literal>faces-config.xml</literal> -<programlisting><![CDATA[<?xml version="1.0"?> +<para> + The following is an example <filename>HelloWorldJSFSunRIPortlet/WEB-INF/faces-config.xml</filename> file: +</para> +<para> +<screen><![CDATA[ +<?xml version="1.0"?> <!DOCTYPE faces-config PUBLIC "-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.0//EN" "http://java.sun.com/dtd/web-facesconfig_1_0.dtd"> @@ -1115,16 +1118,18 @@ <to-view-id>/WEB-INF/jsp/result.jsp</to-view-id> </navigation-case> </navigation-rule> -</faces-config>]]></programlisting> - There is nothing special about the <literal>faces-config.xml</literal> file included here. This - application would work just as well outside of a portlet as it would inside a portlet container. - In the above lines, we define a basic <literal>User</literal> Bean and a navigation rule to - handle the submittal of the original form on <literal>index.jsp</literal>. - </para> - </listitem> - <listitem> - <para><literal>web.xml</literal> -<programlisting><![CDATA[<?xml version="1.0"?> +</faces-config>]]> +</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. +</para> +<para> + The following is an example of the <filename>HelloWorldJSFSunRIPortlet/WEB-INF/web.xml</filename> file: +</para> +<para> +<screen><![CDATA[ +<?xml version="1.0"?> <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd"> @@ -1144,18 +1149,20 @@ <url-pattern>*.jsf</url-pattern> </servlet-mapping> -</web-app>]]></programlisting> - For the Sun RI, this definition is mandatory to associate jsf extension with the faces servlet. - </para> - </listitem> - <listitem> - <para><literal>jsf-portlet.jar</literal> This library that can be downloaded here: <ulink url="https://jsfportletbridge.dev.java.net/servlets/ProjectDocumentL... - contains the classes for the JSF-Portlet bridge. Since they are not included with the JSF - implementation (unlike myfaces) neither in JBoss AS, it is required to have this library available - in the package.</para> - </listitem> - </itemizedlist> - </para> +</web-app>]]> +</screen> +</para> +<para> + For the Sun JSF RI, this definition is mandatory to associate <filename>.jsf</filename> extensions with the faces 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. + </para> + </warning> +</para> </sect3> <sect3> <title>Building and deploying your portlet</title>