Author: mmcallis Date: 2008-07-10 00:40:22 -0400 (Thu, 10 Jul 2008) New Revision: 11398 Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml Log: Chapter 6. XML Descriptors - code highlighting - moving from <screen> to <programlisting> for consistency with other chapters Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-07-10 03:52:14 UTC (rev 11397) +++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-07-10 04:40:22 UTC (rev 11398) @@ -2199,7 +2199,6 @@ <param-value>true</param-value> </context-param>]]> </programlisting> - </para> <para> These extra parameters let the application server know that the portlet embeds its own libraries. This avoids collision with the Sun JSF RI Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml 2008-07-10 03:52:14 UTC (rev 11397) +++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml 2008-07-10 04:40:22 UTC (rev 11398) @@ -1,4 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="xmldescriptors"> <chapterinfo> <author> @@ -14,32 +16,26 @@ <para> To use the DTD, add the following declaration to the start of the desired descriptors: </para> - <para> -<screen><![CDATA[ +<programlisting role="XML"><![CDATA[ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD Portal Object 2.6//EN" "http://www.jboss.org/portal/dtd/portal-object_2_6.dtd">]]> -</screen> - </para> +</programlisting> <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 is rejected if you are: </para> - <para> -<screen><![CDATA[ + <programlisting role="XML"><![CDATA[ <if-exists>overwrite</if-exists> <parent-ref>default.default</parent-ref>]]> -</screen> - </para> +</programlisting> <para> The correct element order, and one which is valid against the DTD, is as follows: </para> - <para> -<screen><![CDATA[ +<programlisting role="XML"><![CDATA[ <parent-ref>default.default</parent-ref> <if-exists>overwrite</if-exists>]]> -</screen> - </para> +</programlisting> <para> The following DTDs are available: </para> @@ -77,9 +73,9 @@ </para> <para> <variablelist> - <varlistentry><term><screen><![CDATA[ + <varlistentry><term><programlisting><![CDATA[ <!ELEMENT portlet-app (remotable?,portlet*,service*)>]]> -</screen></term> +</programlisting></term> <listitem> <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>. @@ -89,10 +85,10 @@ </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT portlet (portlet-name,remotable?,ajax?,session-config?,transaction?, header-content?,portlet-info?)>]]> -</screen></term> +</programlisting></term> <listitem> <para> Additional configuration of 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. @@ -107,54 +103,44 @@ <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: </para> - <para> -<screen><![CDATA[ + <programlisting><![CDATA[ <portlet> <portlet-name>MyPortlet</portlet-name> <remotable>true</remotable> <trans-attribute>Required</trans-attribute> </portlet>]]> -</screen> - </para> - <para> -<screen><![CDATA[ +</programlisting> +<programlisting><![CDATA[ <!ELEMENT portlet-name (#PCDATA)>]]> -</screen> - </para> - - <para> +</programlisting><para> The portlet name. </para> - <para> -<screen><![CDATA[ + <programlisting><![CDATA[ <!ELEMENT remotable (#PCDATA)>]]> -</screen> - </para> +</programlisting> <para> Accepted values are <computeroutput>true</computeroutput> and <computeroutput>false</computeroutput>. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT ajax (partial-refresh)>]]> -</screen></term> +</programlisting></term> <listitem> <para> Use the <computeroutput>ajax</computeroutput> element to configure the Asynchronous JavaScript and XML (AJAX) capabilities of the portlet. </para> - <para> -<screen><![CDATA[ + <programlisting><![CDATA[ <!ELEMENT partial-refresh (#PCDATA)>]]> -</screen> - </para> +</programlisting> <para> 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[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT session-config (distributed)>]]> -</screen></term> +</programlisting></term> <listitem> <para> The <computeroutput>&lt;session-config&gt;</computeroutput> element configures the portlet session for the portlet. The <computeroutput>&lt;distributed&gt;</computeroutput> element instructs the container to distribute the session attributes using portal session replication. This only applies to local portlets, not remote portlets. @@ -162,18 +148,14 @@ <para> The following is an example of the <computeroutput>&lt;session-config&gt;</computeroutput> and <computeroutput>&lt;distributed&gt;</computeroutput> elements: </para> - <para> -<screen><![CDATA[ + <programlisting><![CDATA[ <session-config> <distributed>true</distributed> </session-config>]]> -</screen> - </para> - <para> -<screen><![CDATA[ +</programlisting> + <programlisting><![CDATA[ <!ELEMENT distributed (#PCDATA)>]]> -</screen> - </para> +</programlisting> <para> Accepted values are <computeroutput>true</computeroutput> and <computeroutput>false</computeroutput>. The default value is <computeroutput>false</computeroutput>. </para>