Author: mmcallis Date: 2008-02-20 02:49:06 -0500 (Wed, 20 Feb 2008) New Revision: 10041 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.1.1. The JBoss Portlet DTD replacing itemizedlist with variablelist *** 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 05:45:06 UTC (rev 10040) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-20 07:49:06 UTC (rev 10041) @@ -72,59 +72,83 @@ The files for the DTDs are located in the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/jboss-portal.sar/dtd/</filename> directory. </para> <sect2> - <title>JBoss Portlet DTD</title> + <title>The JBoss Portlet DTD</title> <para> -<itemizedlist> + The following list refers to elements found in the JBoss Portlet DTD, <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/jboss-portal.sar/dtd/jboss-portlet_<replaceable>version_number</replaceable>.dtd</filename>: + </para> + <para> + <variablelist> + <varlistentry><term><screen><![CDATA[ +<!ELEMENT portlet-app (remotable?,portlet*,service*)>]]> +</screen></term> <listitem> -<para> -Element <![CDATA[<!ELEMENT portlet-app (remotable?,portlet*,service*)>]]> -</para><para><programlisting><![CDATA[The remotable element is used to configure the default behavior of the portlets with -respect to WSRP exposure. - -For each portlet defined in portlet.xml, it is possible to configure specific -settings of the portlet container. - -It is also possible to inject services in the portlet context of the application -using the service elements.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT portlet (portlet-name,remotable?,ajax?,session-config?,transaction?,header-content?)>]]> -</para><para><programlisting><![CDATA[Additional configuration for a portlet. - -The portlet-name defines the name of the portlet. It must match a portlet defined already -in portlet.xml of the same web application. - -The remotable element configures the portlet exposure to WSRP. If no value is present -then the value considered is either the value defined globally at the portlet -application level or false. - -The trans-attribute value specifies the behavior of the portlet when it is invoked at -runtime with respect to the transactionnal context. According to how the portlet is -invoked a transaction may exist or not before the portlet is invoked. Usually in the -local context the portal transaction could be present. By default the value considered is - NotSupported which means that the portal transaction will be suspended for the duration - of the portlet invocation. - -Example: - + <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>. + </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. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<!ELEMENT portlet (portlet-name,remotable?,ajax?,session-config?,transaction?,header-content?)>]]> +</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. + </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>. + </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 +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: + </para> + <para> +<screen><![CDATA[ <portlet> <portlet-name>MyPortlet</portlet-name> <remotable>true</remotable> <trans-attribute>Required</trans-attribute> -</portlet>]]></programlisting></para> -</listitem><listitem> -<para> +</portlet>]]> +</screen> + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ Element <![CDATA[<!ELEMENT portlet-name (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The portlet name.]]></programlisting></para> -</listitem><listitem> -<para> +</screen></term> +<listitem> + <para> + The portlet name. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ Element <![CDATA[<!ELEMENT remotable (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The remotable value is used for WSRP exposure. The accepted values are the -litterals true of false.]]></programlisting></para> -</listitem><listitem> -<para> +</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>. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ Element <![CDATA[<!ELEMENT ajax (partial-refresh)>]]> -</para><para><programlisting><![CDATA[The ajax tag allows to configure the ajax capabilities of the portlet. If +</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. + </para> +</listitem> +</varlistentry> + + + + The ajax tag allows to configure the ajax capabilities of the portlet. If the portlet is tagged as partial-refresh then the portal may use partial page refreshing and render only that portlet. If the portlet partial-refresh value is false, then the portal will perform a full page refresh when the portlet is refreshed.]]></programlisting></para>