[portal-commits] JBoss Portal SVN: r6254 - docs/trunk/referenceGuide/en/modules.

Author: julien(a)jboss.com Date: 2007-02-13 12:53:30 -0500 (Tue, 13 Feb 2007) New Revision: 6254 Modified: docs/trunk/referenceGuide/en/modules/xmldescriptors.xml Log: added section on DTD changes Modified: docs/trunk/referenceGuide/en/modules/xmldescriptors.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/xmldescriptors.xml 2007-02-13 16:30:08 UTC (rev 6253) +++ docs/trunk/referenceGuide/en/modules/xmldescriptors.xml 2007-02-13 17:53:30 UTC (rev 6254) @@ -8,6 +8,46 @@ </author> </chapterinfo> <title>XML Descriptors</title> + <sect1> + <title>Changes since previous releases</title> + <para>The previous releases of JBoss Portal did not have an external schema to validate the various XML + descriptors although it was internally validated by the portal. Since 2.6 we have worked on providing + Document Type Definition (DTD) for the various descriptors. The DTD validation will be only effective + if you XML descriptors declares it like that:</para> + <programlisting><![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"> +...]]></programlisting> + <para>If you do not perform the declaration then the previous mechanism will be used. The main difference + between using the DTD and not is that the additional DTD validation is more strict specifically on the order + of the XML elements. The following example will be accepted without the DTD declaration and will not with the DTD + declaration:</para> + <programlisting><![CDATA[ +<?xml version="1.0" encoding="UTF-8"?> +<deployment> + <if-exists>overwrite</if-exists> + <parent-ref>default.default</parent-ref> + ... +</deployment>]]></programlisting> + <para>The correct descriptor is rather:</para> + <programlisting><![CDATA[ +<?xml version="1.0" encoding="UTF-8"?> +<deployment> + <parent-ref>default.default</parent-ref> + <if-exists>overwrite</if-exists> + ... +</deployment>]]></programlisting> + <para>The various DTD available are:</para> + <itemizedlist> + <listitem>For -object.xml descriptors: "-//JBoss Portal//DTD Portal Object 2.6//EN"</listitem> + <listitem>For jboss-app.xml descriptors: "-//JBoss Portal//DTD JBoss Web Application 2.6//EN"</listitem> + <listitem>For jboss-portlet.xml descriptors: "-//JBoss Portal//DTD JBoss Portlet 2.6//EN"</listitem> + <listitem>For portlet-instances.xml descriptors: "-//JBoss Portal//DTD Portlet Instances 2.6//EN"</listitem> + </itemizedlist> + <para>Those files are available in the <emphasis>jboss-portal.sar/dtd/</emphasis> folder</para> + </sect1> <sect1 id="descriptors_portlet"> <title>Portlet Descriptors</title> <para>To define your portal objects (portals, pages, portlet instances, windows, and portlets), you will be using