Author: mmcallis Date: 2008-07-13 21:33:56 -0400 (Sun, 13 Jul 2008) New Revision: 11430 Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml Log: 6.1.2. The JBoss Portlet Instance DTD moving content out of variablelist: make docbook valid and enable code highlighting. 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-14 01:20:40 UTC (rev 11429) +++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml 2008-07-14 01:33:56 UTC (rev 11430) @@ -240,46 +240,35 @@ <para> The following items refer to elements found in the JBoss Portlet Instance DTD, <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/jboss-portal.sar/dtd/portlet-instances_<replaceable>version_number</replaceable>.dtd</filename>: </para> - <para> - <variablelist> - <varlistentry><term><programlisting><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT deployments (deployment*)>]]> -</programlisting></term> -<listitem> +</programlisting> <para> The <computeroutput>&lt;deployments&gt;</computeroutput> element is a container for <computeroutput>&lt;deployment&gt;</computeroutput> elements. </para> - <para> <programlisting><![CDATA[ <!ELEMENT deployment (if-exists?,instance)>]]> </programlisting> - </para> <para> The <computeroutput>&lt;deployment&gt;</computeroutput> element is a container for the <computeroutput>&lt;instance&gt;</computeroutput> element. </para> - <para> <programlisting><![CDATA[ <!ELEMENT if-exists (#PCDATA)>]]> </programlisting> -</para> <para> The <computeroutput>&lt;if-exists&gt;</computeroutput> element defines the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option maintains the existing object deployment, or creates a new one if it does not exist. </para> -</listitem> -</varlistentry> -<varlistentry><term><programlisting><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT instance (instance-id,portlet-ref,display-name*,preferences?, security-constraint?, (display-name* | (resource-bundle, supported-locale+)))>]]> -</programlisting></term> -<listitem> +</programlisting> <para> The <computeroutput>&lt;instance&gt;</computeroutput> element is used in the <filename>WEB-INF/portlet-instances.xml</filename> file, which creates instances of portlets. The portlet will only be created and configured if the portlet is present, and if an instance with the same name does not already exist. </para> <para> The following is an example of the <computeroutput>&lt;instance&gt;</computeroutput> element, which also contains the <computeroutput>&lt;security-constraint&gt;</computeroutput> element. Descriptions of each element follow afterwards: </para> - <para> -<programlisting><![CDATA[ +<programlisting role="XML"><![CDATA[ <instance> <instance-id>MyPortletInstance</instance-id> <portlet-ref>MyPortlet</portlet-ref> @@ -297,67 +286,49 @@ </security-constraint> </instance>]]> </programlisting> - </para> - <para> <programlisting><![CDATA[ <!ELEMENT instance-id (#PCDATA)>]]> </programlisting> - </para> <para> The instance identifier. The <computeroutput>&lt;instance-id&gt;</computeroutput> value can be named anything, but it must match the <computeroutput>&lt;instance-ref&gt;</computeroutput>value given in the <filename>*-object.xml</filename> file. </para> - <para> <programlisting><![CDATA[ <!ELEMENT portlet-ref (#PCDATA)>]]> </programlisting> - </para> <para> The <computeroutput>&lt;portlet-ref&gt;</computeroutput> element defines the portlet that an instance represents. The <computeroutput>&lt;portlet-ref&gt;</computeroutput> value must match the <computeroutput>&lt;portlet-name&gt;</computeroutput> given in the <filename>WEB-INF/portlet.xml</filename> file. </para> - <para> <programlisting><![CDATA[ <!ELEMENT preferences (preference+)>]]> </programlisting> - </para> <para> The <computeroutput>&lt;preferences&gt;</computeroutput> element configures an instance with a set of preferences. </para> -</listitem> -</varlistentry> -<varlistentry><term><programlisting><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT preference (name,value)>]]> -</programlisting></term> -<listitem> +</programlisting> <para> The <computeroutput>&lt;preference&gt;</computeroutput> element configures one preference, which is part of a set of preferences. Use the <computeroutput>&lt;preferences&gt;</computeroutput> element to define a set of preferences. </para> - <para> <programlisting><![CDATA[ <!ELEMENT name (#PCDATA)>]]> </programlisting> - </para> <para> A name. </para> - <para> <programlisting><![CDATA[ <!ELEMENT value (#PCDATA)>]]> </programlisting> - </para> <para> A string value. </para> -</listitem> -</varlistentry> -<varlistentry><term><programlisting><![CDATA[ + <programlisting><![CDATA[ <!ELEMENT security-constraint (policy-permission*)>]]> -</programlisting></term> -<listitem> +</programlisting> <para> The <computeroutput>&lt;security-constraint&gt;</computeroutput> element is a container for <computeroutput>&lt;policy-permission&gt;</computeroutput> elements. The following is an example of the <computeroutput>&lt;security-constraint&gt;</computeroutput> and <computeroutput>&lt;policy-permission&gt;</computeroutput> elements: </para> - <para> -<programlisting><![CDATA[ +<programlisting role="XML"><![CDATA[ <security-constraint> <policy-permission> <role-name>User</role-name> @@ -372,21 +343,15 @@ </policy-permission> </security-constraint>]]> </programlisting> - </para> -</listitem> -</varlistentry> -<varlistentry><term><programlisting><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT policy-permission (action-name*,unchecked?,role-name*)>]]> -</programlisting></term> -<listitem> +</programlisting> <para> The <computeroutput>&lt;policy-permission&gt;</computeroutput> element secures a specific portlet instance based on a user's role. </para> - <para> <programlisting><![CDATA[ <!ELEMENT action-name (#PCDATA)>]]> </programlisting> - </para> <para> The <computeroutput>&lt;action-name&gt;</computeroutput> element defines the access rights given to the role defined. Accepted values are: </para> @@ -414,31 +379,21 @@ </listitem> </itemizedlist> </para> - <para> <programlisting><![CDATA[ <!ELEMENT unchecked EMPTY>]]> </programlisting> - </para> <para> If present, the <computeroutput>&lt;unchecked&gt;</computeroutput> element defines anyone can view the instance. </para> - <para> <programlisting><![CDATA[ <!ELEMENT role-name (#PCDATA)>]]> </programlisting> - </para> <para> The <computeroutput>&lt;role-name&gt;</computeroutput> element defines a role that the security constraint will apply to. The following example only allows users that are part of the <computeroutput>EXAMPLEROLE</computeroutput> role to access the instance: </para> - <para> -<programlisting><![CDATA[ +<programlisting role="XML"><![CDATA[ <role-name>EXAMPLEROLE</role-name>]]> </programlisting> - </para> -</listitem> -</varlistentry> -</variablelist> -</para> </sect2> <sect2> <title>The JBoss Portal Object DTD</title>