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

Author: mmcallis Date: 2008-02-17 17:34:20 -0500 (Sun, 17 Feb 2008) New Revision: 10005 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/migration.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml Log: spelling corrections * s/war/WAR * s/porlet/portlet Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/migration.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/migration.xml 2008-02-17 22:30:16 UTC (rev 10004) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/migration.xml 2008-02-17 22:34:20 UTC (rev 10005) @@ -94,17 +94,17 @@ <orderedlist> <listitem> <para> - Change <emphasis>local.portal.CMSPorlet</emphasis> in the <emphasis>PORTLET_REF</emphasis> column to <emphasis>local./portal-cms.CMSPortlet</emphasis>. + Change <emphasis>local.portal.CMSPortlet</emphasis> in the <emphasis>PORTLET_REF</emphasis> column to <emphasis>local./portal-cms.CMSPortlet</emphasis>. </para> </listitem> <listitem> <para> - Change <emphasis>local.portal.CMSAdminPorlet</emphasis> in the <emphasis>PORTLET_REF</emphasis> column to <emphasis>local./portal-cms.CMSAdminPortlet</emphasis>. + Change <emphasis>local.portal.CMSAdminPortlet</emphasis> in the <emphasis>PORTLET_REF</emphasis> column to <emphasis>local./portal-cms.CMSAdminPortlet</emphasis>. </para> </listitem> <listitem> <para> - Change <emphasis>local.portal.ManagementPorlet</emphasis> in the <emphasis>PORTLET_REF</emphasis> column to <emphasis>local./portal-admin.AdminPortlet</emphasis>. + Change <emphasis>local.portal.ManagementPortlet</emphasis> in the <emphasis>PORTLET_REF</emphasis> column to <emphasis>local./portal-admin.AdminPortlet</emphasis>. </para> </listitem> </orderedlist> 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-17 22:30:16 UTC (rev 10004) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-17 22:34:20 UTC (rev 10005) @@ -532,7 +532,7 @@ </listitem> <listitem> <para> - If required, edit the <filename>HelloWorldPortlet/src/main/org/jboss/portlet/hello/HelloWorldPortlet.java</filename> file, and the XML descriptors in the <filename>HelloWorldPortlet/src/resources/helloworldportlet-war/WEB-INF/</filename> directory. + If required, edit the <filename>HelloWorldPortlet/src/main/org/jboss/portlet/hello/HelloWorldPortlet.java</filename> file, and the application descriptors in the <filename>HelloWorldPortlet/src/resources/helloworldportlet-war/WEB-INF/</filename> directory. </para> </listitem> <listitem> @@ -553,7 +553,7 @@ Note: the directory names will be different for your system. </para> <para> - Expanding the <filename>helloworldportlet.war</filename> file allows you to deploy the portlet as an expanded directory, which makes development easier. As well, it gives you access to the XML descriptors, resource files, JSF, and JSP pages. To expand the <filename>helloworldportlet.war</filename> file: + Expanding the <filename>helloworldportlet.war</filename> file allows you to deploy the portlet as an expanded directory, which makes development easier. As well, it gives you access to the application descriptors, resource files, JSF, and JSP pages. To expand the <filename>helloworldportlet.war</filename> file: </para> <para> <orderedlist> @@ -564,7 +564,7 @@ </listitem> <listitem> <para> - To expand the war file, change into the <filename>HelloWorldPortlet/</filename> directory, and run the <command>ant explode</command> command. On Microsoft Windows, the output will be similar to the following: + To expand the WAR file, change into the <filename>HelloWorldPortlet/</filename> directory, and run the <command>ant explode</command> command. On Microsoft Windows, the output will be similar to the following: </para> <para> <mediaobject> @@ -590,13 +590,13 @@ </mediaobject> </para> <para> - The expanded war file and the XML descriptors are located in the <filename>HelloWorldPortlet/output/lib/exploded/helloworldportlet.war/WEB-INF/</filename> directory. + The expanded WAR file and the application descriptors are located in the <filename>HelloWorldPortlet/output/lib/exploded/helloworldportlet.war/WEB-INF/</filename> directory. </para> </sect3> <sect3> <title>Deploying your Portlet</title> <para> - If you did not expand the <filename>helloworldportlet.war</filename> file, copy the <filename>HelloWorldPortlet/helloworldportlet.war</filename> file into the correct JBoss AS or JBoss EAP <filename>deploy/</filename> directory. If you expanded the <filename>helloworldportlet.war</filename> file, copy the <filename>HelloWorldPortlet/output/lib/exploded/helloworldportlet.war/</filename> directory into the correct JBoss AS or JBoss EAP <filename>deploy/</filename> directory. For example, if you are using JBoss AS, copy the war file or the expanded directory into the <filename>$JBOSS_HOME/server/default/deploy/</filename> directory. + If you did not expand the <filename>helloworldportlet.war</filename> file, copy the <filename>HelloWorldPortlet/helloworldportlet.war</filename> file into the correct JBoss AS or JBoss EAP <filename>deploy/</filename> directory. If you expanded the <filename>helloworldportlet.war</filename> file, copy the <filename>HelloWorldPortlet/output/lib/exploded/helloworldportlet.war/</filename> directory into the correct JBoss AS or JBoss EAP <filename>deploy/</filename> directory. For example, if you are using JBoss AS, copy the WAR file or the expanded directory into the <filename>$JBOSS_HOME/server/default/deploy/</filename> directory. </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: @@ -618,7 +618,7 @@ </mediaobject> </para> <para> - 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/helloworldportlet.war/WEB-INF/web.xml</filename> file. On Linux, run the following command to re-deploy the HelloWorldPortlet: + To re-deploy the portlet, for example, if you have made changes to any of the application descriptors, touch the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldportlet.war/WEB-INF/web.xml</filename> file. On Linux, run the following command to re-deploy the HelloWorldPortlet: </para> <para> <screen> @@ -888,7 +888,7 @@ </listitem> <listitem> <para> - If required, edit the <filename>HelloWorldJSPPortlet/src/main/org/jboss/portlet/hello/HelloWorldJSPPortlet.java</filename> file, and the XML descriptors in the <filename>HelloWorldJSPPortlet/src/resources/helloworldjspportlet-war/WEB-INF/</filename> directory. + If required, edit the <filename>HelloWorldJSPPortlet/src/main/org/jboss/portlet/hello/HelloWorldJSPPortlet.java</filename> file, and the application descriptors in the <filename>HelloWorldJSPPortlet/src/resources/helloworldjspportlet-war/WEB-INF/</filename> directory. </para> </listitem> <listitem> @@ -909,7 +909,7 @@ Note: the directory names will be different for your system. </para> <para> - Expanding the <filename>helloworldjspportlet.war</filename> file allows you to deploy the portlet as an expanded directory, which makes development easier. As well, it gives you access to the XML descriptors, resource files, JSF, and JSP pages. To expand the <filename>helloworldjspportlet.war</filename> file: + Expanding the <filename>helloworldjspportlet.war</filename> file allows you to deploy the portlet as an expanded directory, which makes development easier. As well, it gives you access to the application descriptors, resource files, JSF, and JSP pages. To expand the <filename>helloworldjspportlet.war</filename> file: </para> <para> <orderedlist> @@ -920,7 +920,7 @@ </listitem> <listitem> <para> - To expand the war file, change into the <filename>HelloWorldJSPPortlet/</filename> directory, and run the <command>ant explode</command> command. On Linux, the output will be similar to the following: + To expand the WAR file, change into the <filename>HelloWorldJSPPortlet/</filename> directory, and run the <command>ant explode</command> command. On Linux, the output will be similar to the following: </para> <para> <mediaobject> @@ -946,13 +946,13 @@ </mediaobject> </para> <para> - The expanded war file and the XML descriptors are located in the <filename>HelloWorldJSPPortlet/output/lib/exploded/helloworldjspportlet.war/WEB-INF/</filename> directory. + The expanded WAR file and the application descriptors are located in the <filename>HelloWorldJSPPortlet/output/lib/exploded/helloworldjspportlet.war/WEB-INF/</filename> directory. </para> </sect3> <sect3> <title>Deploying your JSP Portlet</title> <para> - If you did not expand the <filename>helloworldjspportlet.war</filename> file, copy the <filename>HelloWorldJSPPortlet/helloworldjspportlet.war</filename> file into the correct JBoss AS or JBoss EAP <filename>deploy/</filename> directory. If you expanded the <filename>helloworldjspportlet.war</filename> file, copy the <filename>HelloWorldJSPPortlet/output/lib/exploded/helloworldjspportlet.war/</filename> directory into the correct JBoss AS or JBoss EAP <filename>deploy/</filename> directory. For example, if you are using JBoss AS, copy the war file or the expanded directory into the <filename>$JBOSS_HOME/server/default/deploy/</filename> directory. + If you did not expand the <filename>helloworldjspportlet.war</filename> file, copy the <filename>HelloWorldJSPPortlet/helloworldjspportlet.war</filename> file into the correct JBoss AS or JBoss EAP <filename>deploy/</filename> directory. If you expanded the <filename>helloworldjspportlet.war</filename> file, copy the <filename>HelloWorldJSPPortlet/output/lib/exploded/helloworldjspportlet.war/</filename> directory into the correct JBoss AS or JBoss EAP <filename>deploy/</filename> directory. For example, if you are using JBoss AS, copy the WAR file or the expanded directory into the <filename>$JBOSS_HOME/server/default/deploy/</filename> directory. </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: @@ -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 <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: + To re-deploy the portlet, for example, if you have made changes to any of the application 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> @@ -1021,7 +1021,7 @@ <note> <title>Bundled Sun JSF RI</title> <para> - JBoss AS version 4.2.<replaceable>x</replaceable> and JBoss EAP bundle Sun's JSF RI in the + JBoss AS version 4.2.<replaceable>x</replaceable> and JBoss EAP bundle Sun's JSF RI libraries in the <filename>$JBOSS_HOME/server/default/deploy/jboss-web.deployer/jsf-libs/</filename> directory. Therefore, you do not need to package the Sun JSF RI libraries with your portlet application. </para> </note> @@ -1080,7 +1080,7 @@ </screen></term> <listitem> <para> - You must initialize the portlet with a default page to render, similar to what is done with the default JBoss Portal page. + You must initialize the portlet with a default page to render, similar to a welcome page. </para> </listitem> </varlistentry> @@ -1112,7 +1112,7 @@ </screen> </para> <para> - 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. + 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 the submission of the original form in the <filename>HelloWorldJSFSunRIPortlet/WEB-INF/jsp/index.jsp</filename> file. </para> <para> The following is an example of the <computeroutput>Faces Servlet</computeroutput> section from the <filename>HelloWorldJSFSunRIPortlet/WEB-INF/web.xml</filename> file: @@ -1143,7 +1143,17 @@ </screen> </para> <para> - For the Sun JSF RI, this definition is mandatory to associate files with <filename>.jsf</filename> extensions with the Apache MyFaces servlet. + <variablelist> + <varlistentry><term><screen><![CDATA[ +<url-pattern>*.jsf</url-pattern>]]> +</screen></term> +<listitem> + <para> + For the Sun JSF RI, this definition is mandatory to associate files with <filename>.jsf</filename> extensions with the Apache MyFaces servlet. + </para> +</listitem> +</varlistentry> +</variablelist> </para> <para> <warning> @@ -1163,12 +1173,12 @@ <orderedlist> <listitem> <para> - Change into the <filename>HHelloWorldJSFSunRIPortlet</filename> directory, and remove the existing <filename>helloworldjsfsunriportlet.war</filename> file. + Change into the <filename>HelloWorldJSFSunRIPortlet/</filename> directory, and remove the existing <filename>helloworldjsfsunriportlet.war</filename> file. </para> </listitem> <listitem> <para> - If required, edit the <filename>HelloWorldJSFSunRIPortlet/src/main/org/jboss/portlet/hello/bean/User.java</filename> file, and the XML descriptors in the <filename>HelloWorldJSFSunRIPortlet/src/resources/helloworldjsfsunriportlet-war/WEB-INF/</filename> directory. + If required, edit the <filename>HelloWorldJSFSunRIPortlet/src/main/org/jboss/portlet/hello/bean/User.java</filename> file, and the application descriptors in the <filename>HelloWorldJSFSunRIPortlet/src/resources/helloworldjsfsunriportlet-war/WEB-INF/</filename> directory. </para> </listitem> <listitem> @@ -1189,7 +1199,7 @@ Note: the directory names will be different for your system. </para> <para> - Expanding the <filename>helloworldjsfsunriportlet.war</filename> file allows you to deploy the portlet as an expanded directory, which makes development easier. As well, it gives you access to the XML descriptors, resource files, JSF, and JSP pages. To expand the <filename>helloworldjsfsunriportlet.war</filename> file: + Expanding the <filename>helloworldjsfsunriportlet.war</filename> file allows you to deploy the portlet as an expanded directory, which makes development easier. As well, it gives you access to the application descriptors, resource files, JSF, and JSP pages. To expand the <filename>helloworldjsfsunriportlet.war</filename> file: </para> <para> <orderedlist> @@ -1200,7 +1210,7 @@ </listitem> <listitem> <para> - To expand the war file, change into the <filename>HelloWorldJSFSunRIPortlet/</filename> directory, and run the <command>ant explode</command> command. On Linux, the output will be similar to the following: + To expand the WAR file, change into the <filename>HelloWorldJSFSunRIPortlet/</filename> directory, and run the <command>ant explode</command> command. On Linux, the output will be similar to the following: </para> <para> <mediaobject> @@ -1216,7 +1226,7 @@ Note: the directory names will be different for your system. </para> <para> - The expanded war file and the XML descriptors are located in the <filename>HelloWorldJSFSunRIPortlet/output/lib/exploded/helloworldjsfsunriportlet.war</filename> directory. + The expanded WAR file and the application descriptors are located in the <filename>HelloWorldJSFSunRIPortlet/output/lib/exploded/helloworldjsfsunriportlet.war</filename> directory. </para> </sect3> <sect3> @@ -1233,7 +1243,7 @@ </screen> </para> <para> - To see the HelloWorldJSFPortlet, navigate to <ulink url="http://localhost:8080/portal/">http://localhost:8080/portal/</ulink>, or, if the default JBoss Portal page is already open, refresh the page. The HelloWorldJSFPortlet is added to the bottom of the default JBoss Portal page: + To see the HelloWorldJSFSunRIPortlet, navigate to <ulink url="http://localhost:8080/portal/">http://localhost:8080/portal/</ulink>, or, if the default JBoss Portal page is already open, refresh the page. The HelloWorldJSFSunRIPortlet is added to the bottom of the default JBoss Portal page: </para> <para> <mediaobject> @@ -1243,7 +1253,7 @@ </mediaobject> </para> <para> - 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/helloworldjsfsunriportlet.war/WEB-INF/web.xml</filename> file. On Linux, run the following command to re-deploy the HelloWorldPortlet: + To re-deploy the portlet, for example, if you have made changes to any of the application descriptors, touch the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjsfsunriportlet.war/WEB-INF/web.xml</filename> file. On Linux, run the following command to re-deploy the HelloWorldJSFSunRIPortlet: </para> <para> <screen> @@ -1251,7 +1261,7 @@ </screen> </para> <para> - Re-deploying the HelloWorldJSFPortlet will produce output to the JBoss AS or JBoss EAP console, similar to the following: + Re-deploying the HelloWorldJSFSunRIPortlet will produce output to the JBoss AS or JBoss EAP console, similar to the following: </para> <para> <screen><![CDATA[