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

Author: mmcallis Date: 2008-02-20 19:36:58 -0500 (Wed, 20 Feb 2008) New Revision: 10052 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.1.1. The JBoss Portlet DTD revisions, minor corrections. *** 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-20 17:04:09 UTC (rev 10051) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-21 00:36:58 UTC (rev 10052) @@ -69,7 +69,7 @@ </itemizedlist> </para> <para> - The files for the DTDs are located in the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/jboss-portal.sar/dtd/</filename> directory. + The DTDs are located in the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/jboss-portal.sar/dtd/</filename> directory. </para> <sect2> <title>The JBoss Portlet DTD</title> @@ -83,29 +83,29 @@ </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 false. Accepted values are <computeroutput>true</computeroutput> and <computeroutput>false</computeroutput>. + 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>. </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>service</computeroutput> element to inject services into the portlet context of applications. + 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. </para> </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<!ELEMENT portlet (portlet-name,remotable?,ajax?,session-config?,transaction?,header-content?)>]]> + <!ELEMENT portlet (portlet-name,remotable?,ajax?,session-config?,transaction?,header-content?,portlet-info?)>]]> </screen></term> <listitem> <para> - Additional configuration for a portlet. The <computeroutput>portlet-name</computeroutput> element defines the portlet name. It must match a portlet defined in the <filename>WEB-INF/portlet.xml</filename> file for that application. + 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>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 false. 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> - The <computeroutput>trans-attribute</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 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. </para> <para> - The following example uses the <computeroutput>portlet-name</computeroutput>, <computeroutput>remotable</computeroutput>, and <computeroutput>trans-attribute</computeroutput> elements: + The following example uses the <computeroutput>&lt;portlet-name&gt;</computeroutput>, <computeroutput>&lt;remotable&gt;</computeroutput>, and <computeroutput>&lt;trans-attribute&gt;</computeroutput> elements: </para> <para> <screen><![CDATA[ @@ -119,7 +119,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<![CDATA[<!ELEMENT portlet-name (#PCDATA)>]]> +<!ELEMENT portlet-name (#PCDATA)>]]> </screen></term> <listitem> <para> @@ -128,20 +128,20 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<![CDATA[<!ELEMENT remotable (#PCDATA)>]]> +<!ELEMENT remotable (#PCDATA)>]]> </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 false. 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> </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<![CDATA[<!ELEMENT ajax (partial-refresh)>]]> +<!ELEMENT ajax (partial-refresh)>]]> </screen></term> <listitem> <para> - Use the <computeroutput>ajax</computeroutput> element to configure the Asynchronous JavaScript and XML (AJAX) capabilities of the portlet. If a portlet uses the <computeroutput>true</computeroutput> value for the <computeroutput>partial-refresh</computeroutput> element, then the portal uses partial page refreshing, and only renders that portlet. If the <computeroutput>partial-refresh</computeroutput> element uses a <computeroutput>false</computeroutput> value, the portal uses a full-page refresh when the portlet is refreshed. + Use the <computeroutput>ajax</computeroutput> element to configure the Asynchronous JavaScript and XML (AJAX) capabilities of the portlet. If a portlet uses the <computeroutput>true</computeroutput> value for the <computeroutput>&lt;partial-refresh&gt;</computeroutput> element, the portal uses partial page refreshing and only renders that portlet. If the <computeroutput>&lt;partial-refresh&gt;</computeroutput> element uses a <computeroutput>false</computeroutput> value, the portal uses a full-page refresh when the portlet is refreshed. </para> </listitem> </varlistentry> @@ -150,15 +150,16 @@ </screen></term> <listitem> <para> - The authorized values for the partial-refresh element are true or false. + If a portlet uses the <computeroutput>true</computeroutput> value for the <computeroutput>&lt;partial-refresh&gt;</computeroutput> element, the portal uses partial page refreshing and only renders that portlet. If the <computeroutput>&lt;partial-refresh&gt;</computeroutput> element uses a <computeroutput>false</computeroutput> value, the portal uses a full-page refresh when the portlet is refreshed. </para> </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<![CDATA[<!ELEMENT session-config (distributed)>]]> +<!ELEMENT session-config (distributed)>]]> </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. </para> <para> @@ -248,7 +249,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -Element <![CDATA[<!ELEMENT service (service-name,service-class,service-ref)>]]> +<![CDATA[<!ELEMENT service (service-name,service-class,service-ref)>]]> </screen></term> <listitem> <para>