Author: mmcallis Date: 2008-02-21 00:08:12 -0500 (Thu, 21 Feb 2008) New Revision: 10057 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.1.1. The JBoss Portlet DTD minor revisions, spelling corrections, removing doubled-up content. Mess almost fixed... 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 04:18:31 UTC (rev 10056) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-21 05:08:12 UTC (rev 10057) @@ -98,10 +98,10 @@ Additional configuration for the portlet. The <computeroutput>&lt;portlet-name&gt;</computeroutput> element defines the portlet name. It must match a portlet defined in the <filename>WEB-INF/portlet.xml</filename> file for that application. </para> <para> - 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>. + 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>. </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 + 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. 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> @@ -157,7 +157,7 @@ </screen></term> <listitem> <para> - 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>. + 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. </para> <para> The following is an example of the <computeroutput>&lt;session-config&gt;</computeroutput> and <computeroutput>&lt;distributed&gt;</computeroutput> elements: @@ -175,7 +175,7 @@ </screen> </para> <para> - 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>. + Accepted values are <computeroutput>true</computeroutput> and <computeroutput>false</computeroutput>. The default value is <computeroutput>false</computeroutput>. </para> </listitem> </varlistentry> @@ -184,7 +184,7 @@ </screen></term> <listitem> <para> - 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. + Define how the portlet behaves with the transactional 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 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. </para> <para> The following is an example of the <computeroutput>&lt;trans-attribute&gt;</computeroutput> element: @@ -202,7 +202,7 @@ </screen> </para> <para> - 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>. + The default 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> @@ -219,7 +219,7 @@ </screen> </para> <para> - No content is allowed inside an link element. + No content is allowed inside a link element. </para> <para> <screen><![CDATA[ @@ -227,7 +227,7 @@ </screen> </para> <para> - The script header element can contain inline script definitions. + Use the <computeroutput>&lt;script&gt;</computeroutput> element for inline script definitions. </para> <para> <screen><![CDATA[ @@ -235,7 +235,7 @@ </screen> </para> <para> - No content is allowed for meta element. + No content is allowed for the <computeroutput>&lt;meta&gt;</computeroutput> element. </para> </listitem> </varlistentry> @@ -247,7 +247,7 @@ Declare a service that will be injected by the portlet container as an attribute of the portlet context. </para> <para> - For example: + The following is an example of the <computeroutput>&lt;service&gt;</computeroutput> element: </para> <para> <screen><![CDATA[ @@ -258,7 +258,8 @@ </service>]]> </screen> </para> - <para>In the portlet it is then possible to use it by doing a lookup on the service name, for example in the init() lifecycle method : + <para> + To use an injected service in a portlet, perform a lookup of the <computeroutput>&lt;service-name&gt;</computeroutput>, for example, using the <computeroutput>init()</computeroutput> lifecycle method: </para> <para> <screen><![CDATA[ @@ -274,7 +275,7 @@ </screen> </para> <para> - The service name that will be used to bind the service as a portlet context attribute. + The <computeroutput>&lt;service-name&gt;</computeroutput> element defines the name that binds the service as a portlet context attribute. </para> <para> <screen><![CDATA[ @@ -282,7 +283,7 @@ </screen> </para> <para> - The full qualified name of the interface that the service implements. + The <computeroutput>&lt;service-class&gt;</computeroutput> element defines the fully qualified name of the interface that the service implements. </para> <para> <screen><![CDATA[ @@ -290,7 +291,7 @@ </screen> </para> <para> - The reference to the service. In the JMX Microkernel environment it consist of the JMX name of the service MBean. For an MBean reference if the domain is left out, then the current domain of the portal will be used. + The <computeroutput>&lt;service-ref&gt;</computeroutput> defines the reference to the service. In the JMX Microkernel environment, this consist of the JMX name of the service MBean. For an MBean reference, if the domain is left out, then the current domain of the portal is used. </para> </listitem> </varlistentry>