Author: mmcallis Date: 2008-03-30 22:58:46 -0400 (Sun, 30 Mar 2008) New Revision: 10420 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/migration.xml 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: trying to remove the use of "will" Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml 2008-03-31 00:55:17 UTC (rev 10419) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml 2008-03-31 02:58:46 UTC (rev 10420) @@ -28,7 +28,7 @@ </screen> </para> <para> - This example changes the default port to port 8088. The JBoss EAP or JBoss AS server must be restarted before the new port settings will take affect. + This example changes the default port to port 8088. The JBoss EAP or JBoss AS server must be restarted before the new port settings take affect. </para> <para> The default SSL port is 8843. To enable HTTPS support, refer to the <ulink url="http://docs.jboss.org/jbossas/jboss4guide/r4/html/ch9.chapt.htm... AS Guide</ulink>. For further information, refer to <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/ssl-howto.html">... SSL configuration how-to</ulink>. @@ -143,7 +143,7 @@ <sect1 id="configuration-hibdialect"> <title>Forcing the Database Dialect</title> <para> - This sections describes how to override the Database (DB) dialect settings. Under most circumstances, the auto-detect feature will work. If the Hibernate dialect is not working correctly, override the default behavior by following the instructions in this section. + This sections describes how to override the Database (DB) dialect settings. Under most circumstances, the auto-detect feature works. If the Hibernate dialect is not working correctly, override the default behavior by following the instructions in this section. </para> <sect2> <title>Database Dialect Settings for JBoss Portal</title> @@ -160,7 +160,7 @@ ]]></screen> </para> <para> - Note: this example is for a PostgreSQL database. If you use another database, you will need to modify <computeroutput>org.hibernate.dialect.PostgreSQLDialect</computeroutput> to reflect the correct database. For a list of supported dialects, refer to the <ulink url="http://www.hibernate.org/hib_docs/v3/reference/en/html/session-... list on the Hibernate website</ulink>. + Note: this example is for a PostgreSQL database. If you use another database, you need to modify <computeroutput>org.hibernate.dialect.PostgreSQLDialect</computeroutput> to reflect the correct database. For a list of supported dialects, refer to the <ulink url="http://www.hibernate.org/hib_docs/v3/reference/en/html/session-... list on the Hibernate website</ulink>. </para> </sect2> <sect2> @@ -189,7 +189,7 @@ </orderedlist> </para> <para> - Note: this example is for a PostgreSQL database. If you use another database, you will need to modify <computeroutput>org.hibernate.dialect.PostgreSQLDialect</computeroutput> to reflect the correct database. For a list of supported dialects, refer to the <ulink url="http://www.hibernate.org/hib_docs/v3/reference/en/html/session-... list on the Hibernate website</ulink>. + Note: this example is for a PostgreSQL database. If you use another database, you need to modify <computeroutput>org.hibernate.dialect.PostgreSQLDialect</computeroutput> to reflect the correct database. For a list of supported dialects, refer to the <ulink url="http://www.hibernate.org/hib_docs/v3/reference/en/html/session-... list on the Hibernate website</ulink>. </para> </sect2> </sect1> @@ -252,12 +252,12 @@ </sect1> <sect1> <title>Configuring proxy settings</title> - <para>There are a couple of scenarios where you will need your proxy to be correctly defined at the JVM + <para>There are a couple of scenarios where you need your proxy to be correctly defined at the JVM level so that you can access documents from Internet. It could be to get the thirdparty libraries if you decided to build JBoss Portal from the sources, to access RSS feeds or weather information in the samples portlet we provide or for your own needs.</para> - <para>To set up the proxy settings you will need to know the proxy host and the port to use then - add them when starting java.</para> + <para>To configure the proxy settings, you need to know the proxy host and the port to use. Then, + add them when starting Java.</para> <para>Usually setting up JAVA_OPTS environment variable to <literal>-Dhttp.proxyHost=YOUR_PROXY_HOST -Dhttp.proxyPort=YOUR_PROXY_PORT</literal> is enough.</para> </sect1> Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-03-31 00:55:17 UTC (rev 10419) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-03-31 02:58:46 UTC (rev 10420) @@ -72,7 +72,7 @@ </mediaobject> </para> <para> - Files contained in this download will be used in later sections. Download and extract the JBoss Portal binary zip file before proceeding. + Files contained in this download are used in later sections. Download and extract the JBoss Portal binary zip file before proceeding. </para> </sect3> <sect3> @@ -98,7 +98,7 @@ <orderedlist> <listitem> <para> - <emphasis role="bold">Create a new database:</emphasis> this guide assumes that the new database will be called <emphasis>jbossportal</emphasis>. + <emphasis role="bold">Create a new database:</emphasis> this guide assumes that the new database is called <emphasis>jbossportal</emphasis>. </para> </listitem> <listitem> @@ -259,7 +259,7 @@ </imageobject> </mediaobject> <para> - If the source files were obtained from SVN, change into the <filename>trunk/src/</filename> directory to see the directories from the above image. As well, there will be an empty <filename>thirdparty</filename> directory. This directory will contain files after building the JBoss Portal source code (refer to <xref linkend="building_deploying_from_source" />). For more information about the JBoss Portal SVN repository, and accessing different versions of the JBoss Portal codebase, please visit the <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=PortalSVNRepo">... Portal SVN Repo</ulink> page on the JBoss Wiki. + If the source files were obtained from SVN, change into the <filename>trunk/src/</filename> directory to see the directories from the above image. As well, there is an empty <filename>thirdparty</filename> directory. This directory contains files after building the JBoss Portal source code (refer to <xref linkend="building_deploying_from_source" />). For more information about the JBoss Portal SVN repository, and accessing different versions of the JBoss Portal codebase, please visit the <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=PortalSVNRepo">... Portal SVN Repo</ulink> page on the JBoss Wiki. </para> </sect2> <sect2> @@ -298,7 +298,7 @@ <orderedlist> <listitem> <para> - Add the following line to the <filename>~/.bashrc</filename> file. Note: this must be configured while logged in as the user who will run JBoss EAP or JBoss AS: + Add the following line to the <filename>~/.bashrc</filename> file. Note: this must be configured while logged in as the user who runs JBoss EAP or JBoss AS: </para> <para> <screen> @@ -329,7 +329,7 @@ <sect2 id="building_deploying_from_source"> <title>Building and Deploying from the Sources</title> <para> - During the first build, third-party libraries will be obtained from an online + During the first build, third-party libraries are obtained from an online repository, so you must be connected to the Internet, and if you are behind a proxy server, you need to define your proxy server address and proxy server port number. If you are running Linux, add the following line to the <filename>$JBOSS_HOME/bin/run.sh</filename> file: </para> <para> @@ -414,7 +414,7 @@ <orderedlist> <listitem> <para> - <emphasis role="bold">Create a new database:</emphasis> this guide assumes that the new database will be called <emphasis>jbossportal</emphasis>. + <emphasis role="bold">Create a new database:</emphasis> this guide assumes that the new database is called <emphasis>jbossportal</emphasis>. </para> </listitem> <listitem> 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-03-31 00:55:17 UTC (rev 10419) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/migration.xml 2008-03-31 02:58:46 UTC (rev 10420) @@ -63,7 +63,7 @@ </mediaobject> </para> <para> - If you use a default theme that exists in JBoss Portal 2.6, such as renaissance, no configuration should be necessary. Using old themes from JBoss Portal 2.4 may make JBoss Portal 2.6 unusable, for example, not being able to log in. To update custom themes, please refer to those bundled with JBoss Portal as an example. + If you use a default theme that exists in JBoss Portal 2.6, such as renaissance, no configuration shouldf be necessary. Using old themes from JBoss Portal 2.4 may make JBoss Portal 2.6 unusable, for example, not being able to log in. To update custom themes, please refer to those bundled with JBoss Portal as an example. </para> </sect2> <sect2 id="upgrade_portal_database"> @@ -75,7 +75,7 @@ Database schema has not changed between the JBoss Portal 2.4 and 2.6 releases, but certain content that is kept in the databases has changed. Data can be updated manually by using the correct tools for your RDBMS. For example, if you are using a MySQL database, you can use the <ulink url="http://www.mysql.com/products/tools/query-browser/">MySQL Query Browser</ulink>. </para> <para> - The following instructions refer to a standard JBoss Portal 2.4 deployment. If you named core portlets, portlet instances, or portlet windows differently, you will need to make the appropriate modifications. The following is an example of using the MySQL Query Browser: + The following instructions refer to a standard JBoss Portal 2.4 deployment. If you named core portlets, portlet instances, or portlet windows differently, you need to make the appropriate modifications. The following is an example of using the MySQL Query Browser: </para> <para> <mediaobject> 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-03-31 00:55:17 UTC (rev 10419) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-03-31 02:58:46 UTC (rev 10420) @@ -22,7 +22,7 @@ <para>The JSR-168 Portlet Specification aims at defining portlets that can be used by any JSR-168 portlet container, also known as a portal. There are different portals with commercial and non-commercial licenses. This chapter gives a brief overview of the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink>. Portlet developers are strongly encouraged to read the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink>. </para> <para> - JBoss Portal is fully JSR-168 compliant, which means any JSR-168 portlet will behave as it should inside the portal. + JBoss Portal is fully JSR-168 compliant, which means any JSR-168 portlet behaves as it should inside the portal. </para> <sect2> <title>Portal Pages</title> @@ -66,7 +66,7 @@ <sect2> <title>Window States</title> <para> - Window states are an indicator of how much page real-estate a portlet will consume on any given page. + Window states are an indicator of how much page real-estate a portlet consumes on any given page. The three states defined by the JSR-168 specification are: </para> <para> @@ -317,7 +317,7 @@ <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 - <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 will only output text and HTML, and that it only supports the <computeroutput>view</computeroutput> mode. + <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> </varlistentry> @@ -327,7 +327,7 @@ </portlet-info>]]></screen></term> <listitem> <para> - When rendered, the portlet's title will be displayed as the header in the portlet window, unless it is overridden programmatically. In this example, the title would be <computeroutput>HelloWorld Portlet</computeroutput>. + When rendered, the portlet's title is displayed as the header in the portlet window, unless it is overridden programmatically. In this example, the title would be <computeroutput>HelloWorld Portlet</computeroutput>. </para> </listitem> </varlistentry> @@ -373,7 +373,7 @@ </listitem> <listitem> <para> - specifies that the window will display the markup generated by the <computeroutput>HelloWorldPortletInstance</computeroutput> portlet instance. + specifies that the window displays the markup generated by the <computeroutput>HelloWorldPortletInstance</computeroutput> portlet instance. </para> </listitem> <listitem> @@ -383,7 +383,7 @@ </listitem> <listitem> <para> - the <computeroutput>&lt;region&gt;</computeroutput> element specifies where the window will appear on the page. + the <computeroutput>&lt;region&gt;</computeroutput> element specifies where the window appears on the page. </para> </listitem> </itemizedlist> @@ -418,7 +418,7 @@ </screen></term> <listitem> <para> - Tells the portal where this portlet will appear. In this case, <computeroutput>default.default</computeroutput> specifies that the portlet will appear in the portal instance named <computeroutput>default</computeroutput>, and on the page named <computeroutput>default</computeroutput>. + Tells the portal where this portlet appears. In this case, <computeroutput>default.default</computeroutput> specifies that the portlet appears in the portal instance named <computeroutput>default</computeroutput>, and on the page named <computeroutput>default</computeroutput>. </para> </listitem> </varlistentry> @@ -427,7 +427,7 @@ </screen></term> <listitem> <para> - Instructs the portal to overwrite or keep this object if it already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option will destroy the existing object and create a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option will maintain the existing object deployment, or create a new one if it does not exist. + Instructs the portal to overwrite or keep this object if it already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option maintains the existing object deployment, or creates a new one if it does not exist. </para> </listitem> </varlistentry> @@ -456,7 +456,7 @@ </screen></term> <listitem> <para> - Specifies where the window will appear within the page layout. + Specifies where the window appears within the page layout. </para> </listitem> </varlistentry> @@ -476,7 +476,7 @@ <para> JBoss Portal 2.6 introduces the notion of <emphasis>content-type</emphasis>, which is a generic mechanism to - specify what content will be displayed by a given portlet window. The <computeroutput>window</computeroutput> section + specify what content displayed by a given portlet window. The <computeroutput>window</computeroutput> section of the previous example, <filename>HelloWorldPortlet/WEB-INF/helloworld-object.xml</filename>, can be re-written to take advantage of the new content framework. The following is an example deployment descriptor that uses the new content framework: </para> <para> @@ -599,7 +599,7 @@ 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: + Performing this step on a running instance of JBoss AS or JBoss EAP, and JBoss Portal, triggers a hot-deploy of the portlet: </para> <para> <screen><![CDATA[ @@ -618,7 +618,7 @@ </mediaobject> </para> <para> - 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. This will only work if you copied the <filename>HelloWorldPortlet/output/lib/exploded/helloworldportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. 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. This only works if you copied the <filename>HelloWorldPortlet/output/lib/exploded/helloworldportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. On Linux, run the following command to re-deploy the HelloWorldPortlet: </para> <para> <screen> @@ -626,7 +626,7 @@ </screen> </para> <para> - Re-deploying the HelloWorldPortlet will produce output to the JBoss AS or JBoss EAP console, similar to the following: + Re-deploying the HelloWorldPortlet produces output to the JBoss AS or JBoss EAP console, similar to the following: </para> <para> <screen><![CDATA[ @@ -749,7 +749,7 @@ </screen></term> <listitem> <para> - Support for these modes must be declared in the <filename>HelloWorldJSPPortlet/WEB-INF/portlet.xml</filename> file. They will be triggered when a user clicks on the respective icons in the portlet window titlebar, or through generated links within the portlet. + Support for these modes must be declared in the <filename>HelloWorldJSPPortlet/WEB-INF/portlet.xml</filename> file. They are triggered when a user clicks on the respective icons in the portlet window titlebar, or through generated links within the portlet. </para> </listitem> </varlistentry> @@ -775,7 +775,7 @@ </screen></term> <listitem> <para> - As in the servlet world, you must declare what content-type the portlet will be responding in. Do this before starting to write content, or the portlet will throw an exception. + As in the servlet world, you must declare what content-type the portlet will be responding in. Do this before starting to write content, or the portlet throws an exception. </para> </listitem> </varlistentry> @@ -955,7 +955,7 @@ 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: + Performing this step on a running instance of JBoss AS or JBoss EAP, and JBoss Portal, triggers a hot-deploy of the portlet: </para> <para> <screen><![CDATA[ @@ -974,7 +974,7 @@ </mediaobject> </para> <para> - 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. This will only work if you copied the <filename>HelloWorldJSPPortlet/output/lib/exploded/helloworldjspportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. 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. This only works if you copied the <filename>HelloWorldJSPPortlet/output/lib/exploded/helloworldjspportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. On Linux, run the following command to re-deploy the HelloWorldJSPPortlet: </para> <para> <screen> @@ -982,7 +982,7 @@ </screen> </para> <para> - Re-deploying the HelloWorldJSPPortlet will produce output to the JBoss AS or JBoss EAP console, similar to the following: + Re-deploying the HelloWorldJSPPortlet produces output to the JBoss AS or JBoss EAP console, similar to the following: </para> <para> <screen><![CDATA[ @@ -1092,7 +1092,7 @@ <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 - <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 will only output text and HTML, and that it only supports the <computeroutput>view</computeroutput> mode. + <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> </varlistentry> @@ -1238,7 +1238,7 @@ If you did not expand the <filename>helloworldjsfsunriportlet.war</filename> file, copy the <filename>HelloWorldJSFSunRIPortlet/helloworldjsfsunriportlet.war</filename> file into the correct JBoss AS or JBoss EAP <filename>deploy/</filename> directory. If you expanded the <filename>helloworldjsfsunriportlet.war</filename> file, copy the <filename>HelloWorldJSFSunRIPortlet/output/lib/exploded/helloworldjsfsunriportlet.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: + Performing this step on a running instance of JBoss AS or JBoss EAP, and JBoss Portal, triggers a hot-deploy of the portlet: </para> <para> <screen><![CDATA[ @@ -1257,7 +1257,7 @@ </mediaobject> </para> <para> - 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. This will only work if you copied the <filename>HelloWorldJSFSunRIPortlet/output/lib/exploded/helloworldjsfsunriportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. On Linux, run the following command to re-deploy the HelloWorldJSFSunRIPortlet: + 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. This only works if you copied the <filename>HelloWorldJSFSunRIPortlet/output/lib/exploded/helloworldjsfsunriportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. On Linux, run the following command to re-deploy the HelloWorldJSFSunRIPortlet: </para> <para> <screen> @@ -1265,7 +1265,7 @@ </screen> </para> <para> - Re-deploying the HelloWorldJSFSunRIPortlet will produce output to the JBoss AS or JBoss EAP console, similar to the following: + Re-deploying the HelloWorldJSFSunRIPortlet produces output to the JBoss AS or JBoss EAP console, similar to the following: </para> <para> <screen><![CDATA[ @@ -1330,7 +1330,7 @@ This section describes how to deploy a JSF portlet in JBoss Portal, using the Apache MyFaces JSF implementation in JBoss AS and 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> <para> - Apache MyFaces can be used globally for the entire server, replacing the Sun JSF RI libraries, but the HelloWorldJSFMyFaces42Portlet uses its own libraries, and will not affect the application server. + Apache MyFaces can be used globally for the entire server, replacing the Sun JSF RI libraries, but the HelloWorldJSFMyFaces42Portlet uses its own libraries, but does not affect the application server. </para> </sect3> <sect3> @@ -1414,7 +1414,7 @@ <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 - <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 will only output text and HTML, and that it only supports the <computeroutput>view</computeroutput> mode. + <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> </varlistentry> @@ -1543,7 +1543,7 @@ If you did not expand the <filename>helloworldjsfmyfacesportlet.war</filename> file, copy the <filename>HelloWorldJSFMyFaces42Portlet/helloworldjsfmyfacesportlet.war</filename> file into the correct JBoss AS or JBoss EAP <filename>deploy/</filename> directory. If you expanded the <filename>helloworldjsfmyfacesportlet.war</filename> file, copy the <filename>HelloWorldJSFMyFaces42Portlet/output/lib/exploded/helloworldjsfmyfacesportlet.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. + Performing this step on a running instance of JBoss AS or JBoss EAP, and JBoss Portal, triggers a hot-deploy of the portlet. </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. The HelloWorldJSFMyFaces42Portlet is added to the bottom of the default JBoss Portal page: </para> @@ -1555,7 +1555,7 @@ </mediaobject> </para> <para> - 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/helloworldjsfmyfacesportlet.war/WEB-INF/web.xml</filename> file. This will only work if you copied the <filename>HelloWorldJSFMyFaces42Portlet/output/lib/exploded/helloworldjsfmyfacesportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. On Linux, run the following command to re-deploy the HelloWorldJSFMyFaces42Portlet: + 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/helloworldjsfmyfacesportlet.war/WEB-INF/web.xml</filename> file. This only works if you copied the <filename>HelloWorldJSFMyFaces42Portlet/output/lib/exploded/helloworldjsfmyfacesportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. On Linux, run the following command to re-deploy the HelloWorldJSFMyFaces42Portlet: </para> <para> <screen> 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-03-31 00:55:17 UTC (rev 10419) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-03-31 02:58:46 UTC (rev 10420) @@ -24,7 +24,7 @@ </screen> </para> <para> - If you do not use the DTD declaration, the previous mechanism for XML validation is used. The DTD is more strict, specifically with the order of XML elements. The following is an example from a <filename>*-object.xml</filename> descriptor, which is valid if you are not using the DTD, but will be rejected if you are: + If you do not use the DTD declaration, the previous mechanism for XML validation is used. The DTD is more strict, specifically with the order of XML elements. The following is an example from a <filename>*-object.xml</filename> descriptor, which is valid if you are not using the DTD, but is rejected if you are: </para> <para> <screen><![CDATA[ @@ -103,7 +103,7 @@ </para> <para> The <computeroutput>&lt;trans-attribute&gt;</computeroutput> element specifies the behavior of the portlet when it is invoked at runtime with respect to the transactional context. Depending on how the portlet is - invoked, a transaction may or may not exist before the portlet is invoked. The portal transaction is usually present in the local context. The default value is <computeroutput>NotSupported</computeroutput>, which means that the portal transaction will be suspended for the duration of the portlet's invocation. Accepted values are <computeroutput>Required</computeroutput>, <computeroutput>Mandatory</computeroutput>, <computeroutput>Never</computeroutput>, <computeroutput>Supports</computeroutput>, <computeroutput>NotSupported</computeroutput>, and <computeroutput>RequiresNew</computeroutput>. + invoked, a transaction may or may not exist before the portlet is invoked. The portal transaction is usually present in the local context. The default value is <computeroutput>NotSupported</computeroutput>, which means that the portal transaction is suspended for the duration of the portlet's invocation. Accepted values are <computeroutput>Required</computeroutput>, <computeroutput>Mandatory</computeroutput>, <computeroutput>Never</computeroutput>, <computeroutput>Supports</computeroutput>, <computeroutput>NotSupported</computeroutput>, and <computeroutput>RequiresNew</computeroutput>. </para> <para> The following is an example section from a <filename>WEB-INF/portlet.xml</filename> file, which uses the <computeroutput>&lt;portlet-name&gt;</computeroutput>, <computeroutput>&lt;remotable&gt;</computeroutput>, and <computeroutput>&lt;trans-attribute&gt;</computeroutput> elements: @@ -203,7 +203,7 @@ </screen> </para> <para> - The default value is <computeroutput>NotSupported</computeroutput>, which means that the portal transaction will be suspended for the duration of the portlet's invocation. Accepted values are <computeroutput>Required</computeroutput>, <computeroutput>Mandatory</computeroutput>, <computeroutput>Never</computeroutput>, <computeroutput>Supports</computeroutput>, <computeroutput>NotSupported</computeroutput>, and <computeroutput>RequiresNew</computeroutput>. + The default value is <computeroutput>NotSupported</computeroutput>, which means that the portal transaction is suspended for the duration of the portlet's invocation. Accepted values are <computeroutput>Required</computeroutput>, <computeroutput>Mandatory</computeroutput>, <computeroutput>Never</computeroutput>, <computeroutput>Supports</computeroutput>, <computeroutput>NotSupported</computeroutput>, and <computeroutput>RequiresNew</computeroutput>. </para> </listitem> </varlistentry> @@ -327,7 +327,7 @@ </screen> </para> <para> - The <computeroutput>&lt;if-exists&gt;</computeroutput> element is used to define the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option will destroy the existing object and create a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option will maintain the existing object deployment, or create a new one if it does not exist. + The <computeroutput>&lt;if-exists&gt;</computeroutput> element is used to define the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object and create a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option maintains the existing object deployment, or creates a new one if it does not exist. </para> </listitem> </varlistentry> @@ -568,7 +568,7 @@ </screen> </para> <para> - The <computeroutput>&lt;parent-ref&gt;</computeroutput> element contains a reference to the parent object. The naming convention for naming objects is to concatenate the names of the path to the object, and separate the names using a period. If the path is empty, the empty string must be used. The <computeroutput>&lt;parent-ref&gt;</computeroutput> element tells the portal where the portlet will appear. The syntax for the <computeroutput>&lt;parent-ref&gt;</computeroutput> element is <computeroutput><replaceable>portal-instance</replaceable>.<replaceable>portal-page</replaceable></computeroutput>. + The <computeroutput>&lt;parent-ref&gt;</computeroutput> element contains a reference to the parent object. The naming convention for naming objects is to concatenate the names of the path to the object, and separate the names using a period. If the path is empty, the empty string must be used. The <computeroutput>&lt;parent-ref&gt;</computeroutput> element tells the portal where the portlet appears. The syntax for the <computeroutput>&lt;parent-ref&gt;</computeroutput> element is <computeroutput><replaceable>portal-instance</replaceable>.<replaceable>portal-page</replaceable></computeroutput>. </para> <para> The following is an example of the root having an empty path: @@ -579,7 +579,7 @@ </screen> </para> <para> - The following specifies that the portlet will appear in the portal instance named <computeroutput>default</computeroutput>: + The following specifies that the portlet appears in the portal instance named <computeroutput>default</computeroutput>: </para> <para> <screen> @@ -587,7 +587,7 @@ </screen> </para> <para> - The following specifies that the portlet will appear in the portal instance named <computeroutput>default</computeroutput>, and on the page named <computeroutput>default</computeroutput>: + The following specifies that the portlet appear in the portal instance named <computeroutput>default</computeroutput>, and on the page named <computeroutput>default</computeroutput>: </para> <para> <screen> @@ -600,7 +600,7 @@ </screen> </para> <para> - The <computeroutput>&lt;if-exists&gt;</computeroutput> element is used to define the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option will destroy the existing object and create a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option will maintain the existing object deployment, or create a new one if it does not exist. + The <computeroutput>&lt;if-exists&gt;</computeroutput> element is used to define the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option matains the existing object deployment, or creates a new one if it does not exist. </para> </listitem> </varlistentry> @@ -665,7 +665,7 @@ </screen></term> <listitem> <para> - The portlet mode value. If there are no declarations of modes or window states, the default values will be <computeroutput>view</computeroutput>, <computeroutput>edit</computeroutput>, <computeroutput>help</computeroutput>, and <computeroutput>normal</computeroutput>, <computeroutput>minimized</computeroutput>, <computeroutput>maximized</computeroutput>, respectively. + The portlet mode value. If there are no declarations of modes or window states, the default values are <computeroutput>view</computeroutput>, <computeroutput>edit</computeroutput>, <computeroutput>help</computeroutput>, and <computeroutput>normal</computeroutput>, <computeroutput>minimized</computeroutput>, <computeroutput>maximized</computeroutput>, respectively. </para> </listitem> </varlistentry> @@ -751,7 +751,7 @@ </screen> </para> <para> - The region the window belongs to. The <computeroutput>&lt;region&gt;</computeroutput> element specifies where the window will appear on the page. + The region the window belongs to. The <computeroutput>&lt;region&gt;</computeroutput> element specifies where the window appears on the page. </para> <para> <screen><![CDATA[ @@ -923,7 +923,7 @@ </screen> </para> <para> - The <computeroutput>&lt;role-name&gt;</computeroutput> element is used to define a role that the security constraint will apply to. The following example only allows users that are part of the <computeroutput>EXAMPLEROLE</computeroutput> role to access the instance: + The <computeroutput>&lt;role-name&gt;</computeroutput> element defines a role that the security constraint applies to. The following example only allows users that are part of the <computeroutput>EXAMPLEROLE</computeroutput> role to access the instance: </para> <para> <screen><![CDATA[ @@ -1003,7 +1003,7 @@ <listitem> <para> <programlisting><![CDATA[<deployments>...</deployments>]]></programlisting> - The <computeroutput>&lt;deployments&gt;</computeroutput> element encapsulates the entire document, and is a container for the <computeroutput>&lt;deployment&gt;</computeroutput> element. Multiple deployments can be specified within the <computeroutput>&lt;deployments&gt;</computeroutput> tag. + The <computeroutput>&lt;deployments&gt;</computeroutput> element encapsulates the entire document, and is a container for <computeroutput>&lt;deployment&gt;</computeroutput> elements. Multiple deployments can be specified within the <computeroutput>&lt;deployments&gt;</computeroutput> element. </para> </listitem> <listitem> @@ -1011,7 +1011,7 @@ <programlisting><![CDATA[<deployment>...</deployment>]]></programlisting> </para> <para> - The <computeroutput>&lt;deployment&gt;</computeroutput> element is used to specify object deployments, such as portals, pages, windows, and so on. + The <computeroutput>&lt;deployment&gt;</computeroutput> element specifies object deployments, such as portals, pages, windows, and so on. </para> </listitem> <listitem> @@ -1019,7 +1019,7 @@ <programlisting><![CDATA[<if-exists>...</if-exists>]]></programlisting> </para> <para> - The <computeroutput>&lt;if-exists&gt;</computeroutput> element is used to define the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option will destroy the existing object and create a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option will maintain the existing object deployment, or create a new one if it does not exist. + The <computeroutput>&lt;if-exists&gt;</computeroutput> element defines the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option maintains the existing object deployment, or creates a new one if it does not exist. </para> </listitem> <listitem> @@ -1027,10 +1027,10 @@ <programlisting><![CDATA[<parent-ref>...</parent-ref>]]></programlisting> </para> <para> - The <computeroutput>&lt;parent-ref&gt;</computeroutput> element contains a reference to the parent object. The naming convention for naming objects is to concatenate the names of the path to the object, and separate the names using a period. If the path is empty, the empty string must be used. The <computeroutput>&lt;parent-ref&gt;</computeroutput> element tells the portal where the portlet will appear. The syntax for the <computeroutput>&lt;parent-ref&gt;</computeroutput> element is <computeroutput><replaceable>portal-instance</replaceable>.<replaceable>portal-page</replaceable></computeroutput>. + The <computeroutput>&lt;parent-ref&gt;</computeroutput> element contains a reference to the parent object. The naming convention for naming objects is to concatenate the names of the path to the object, and separate the names using a period. If the path is empty, the empty string must be used. The <computeroutput>&lt;parent-ref&gt;</computeroutput> element tells the portal where the portlet appears. The syntax for the <computeroutput>&lt;parent-ref&gt;</computeroutput> element is <computeroutput><replaceable>portal-instance</replaceable>.<replaceable>portal-page</replaceable></computeroutput>. </para> <para> - In the example above, a window is defined, and assigned to <computeroutput>default.default</computeroutput>. This means the window will appear on the <computeroutput>default</computeroutput> page, in the <computeroutput>default</computeroutput> portal. + In the example above, a window is defined, and assigned to <computeroutput>default.default</computeroutput>. This means the window appears on the <computeroutput>default</computeroutput> page, in the <computeroutput>default</computeroutput> portal. </para> </listitem> <listitem> @@ -1038,7 +1038,7 @@ <programlisting><![CDATA[<window>...</window>]]></programlisting> </para> <para> - The <computeroutput>&lt;window&gt;</computeroutput> element defines a portlet window. The <computeroutput>&lt;window&gt;</computeroutput> element requires an <computeroutput>&lt;instance-ref&gt;</computeroutput> element, which is used to assign a portal instance to a window. As well, use the <computeroutput>&lt;region&gt;</computeroutput> and <computeroutput>&lt;height&gt;</computeroutput> elements to define where the window will appear within the portlet. + The <computeroutput>&lt;window&gt;</computeroutput> element defines a portlet window. The <computeroutput>&lt;window&gt;</computeroutput> element requires an <computeroutput>&lt;instance-ref&gt;</computeroutput> element, which is used to assign a portal instance to a window. As well, use the <computeroutput>&lt;region&gt;</computeroutput> and <computeroutput>&lt;height&gt;</computeroutput> elements to define where the window appears within the portlet. </para> </listitem> <listitem>