Author: mmcallis Date: 2008-02-20 20:56:09 -0500 (Wed, 20 Feb 2008) New Revision: 10053 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.1.1. JBoss Portlet DTD revising *** this will break the book until later commits *** 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-02-21 00:36:58 UTC (rev 10052) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-21 01:56:09 UTC (rev 10053) @@ -83,7 +83,7 @@ </screen></term> <listitem> <para> - Use the <computeroutput>remotable</computeroutput> element to configure the default behavior of portlets with respect to WSRP exposure: if no value is given, the value is either the value globally defined at the portlet application level, or <computeroutput>false</computeroutput>. Accepted values are <computeroutput>true</computeroutput> and <computeroutput>false</computeroutput>. + Use the <computeroutput>&lt;remotable&gt;</computeroutput> element to configure the default behavior of portlets with respect to WSRP exposure: if no value is given, the value is either the value globally defined at the portlet application level, or <computeroutput>false</computeroutput>. Accepted values are <computeroutput>true</computeroutput> and <computeroutput>false</computeroutput>. </para> <para> You can configure specific settings for the portlet container for each portlet defined in the <filename>WEB-INF/portlet.xml</filename> file. Use the <computeroutput>&lt;service&gt;</computeroutput> element to inject services into the portlet context of applications. @@ -102,7 +102,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 transactionnal 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. By default, the value is <computeroutput>NotSupported</computeroutput>, which means that the portal transaction will be suspended for the duration of the portlet invocation. + invoked, a transaction may or may not exist before the portlet is invoked. The portal transaction is usually present in the local context. By default, the value is <computeroutput>NotSupported</computeroutput>, which means that the portal transaction will be suspended for the duration of the portlet 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 example uses the <computeroutput>&lt;portlet-name&gt;</computeroutput>, <computeroutput>&lt;remotable&gt;</computeroutput>, and <computeroutput>&lt;trans-attribute&gt;</computeroutput> elements: @@ -159,11 +159,10 @@ </screen></term> <listitem> <para> - The <computeroutput>&lt;session-config&gt;</computeroutput> - This element configure the portlet session of the portlet. The distributed element instructs the container to distribute the session attributes using the portal session replication. It applies only to local portlets are not to remote portlets. The default value is false. + The <computeroutput>&lt;session-config&gt;</computeroutput> configures the portlet session of the portlet. The <computeroutput>&lt;distributed&gt;</computeroutput> element instructs the container to distribute the session attributes using the portal session replication. This only applies to local portlets, not remote portlets. Accepted values are <computeroutput>true</computeroutput> and <computeroutput>false</computeroutput>. The default value is <computeroutput>false</computeroutput>. </para> <para> - For example: + The following is an example of the <computeroutput>&lt;session-config&gt;</computeroutput> and <computeroutput>&lt;distributed&gt;</computeroutput> elements: </para> <para> <screen><![CDATA[ @@ -179,7 +178,7 @@ </screen></term> <listitem> <para> - The authorized values for the distributed element are true or false. + The <computeroutput>&lt;distributed&gt;</computeroutput> element instructs the container to distribute the session attributes using the portal session replication. This only applies to local portlets, not remote portlets. Accepted values are <computeroutput>true</computeroutput> and <computeroutput>false</computeroutput>. The default value is <computeroutput>false</computeroutput>. </para> </listitem> </varlistentry> @@ -188,10 +187,10 @@ </screen></term> <listitem> <para> - Defines how the portlet behaves with the transactionnal context. The default value is Never. + Define how the portlet behaves with the transactionnal context. The <computeroutput>&lt;trans-attribute&gt;</computeroutput> element specifies the behavior of the portlet when it is invoked at runtime, with respect to the transactionnal 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. </para> <para> - For example: + The following is an example of the <computeroutput>&lt;trans-attribute&gt;</computeroutput> element: </para> <para> <screen><![CDATA[ @@ -207,7 +206,7 @@ </screen></term> <listitem> <para> - The trans-attribute value defines the transactionnal behavior. The accepted values are Required, Mandatory, Never, Supports, NotSupported and RequiresNew. + The <computeroutput>&lt;trans-attribute&gt;</computeroutput> value defines the transactionnal behavior. By default, the value is <computeroutput>NotSupported</computeroutput>, which means that the portal transaction will be suspended for the duration of the portlet 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> @@ -216,8 +215,7 @@ </screen></term> <listitem> <para> - Specify content which should be included in the portal aggregated page when the portlet -is present on that page. This setting only applies when the portlet is used in the local mode. + Specify content to be included in the portal aggregated page, when the portlet is present on that page. This setting only applies when the portlet is used in the local mode. </para> </listitem> </varlistentry>