Author: mmcallis Date: 2008-02-24 20:10:13 -0500 (Sun, 24 Feb 2008) New Revision: 10101 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.1.2. The JBoss Portlet Instance DTD remove itemizedlist, replacing with variablelist 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-24 23:30:39 UTC (rev 10100) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-25 01:10:13 UTC (rev 10101) @@ -74,7 +74,7 @@ <sect2> <title>The JBoss Portlet DTD</title> <para> - 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>: + The following items refer 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> @@ -91,7 +91,8 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<!ELEMENT portlet (portlet-name,remotable?,ajax?,session-config?,transaction?,header-content?,portlet-info?)>]]> +<!ELEMENT portlet (portlet-name,remotable?,ajax?,session-config?,transaction?, +header-content?,portlet-info?)>]]> </screen></term> <listitem> <para> @@ -211,7 +212,7 @@ </screen></term> <listitem> <para> - Specify content to be included in the portal aggregated page when the portlet is present on that page. This setting only applies when the portlet is used in the local mode. + Specify the content to be included in the portal aggregated page when the portlet is present on that page. This setting only applies when the portlet is used in the local mode. </para> <para> <screen><![CDATA[ @@ -291,7 +292,7 @@ </screen> </para> <para> - The <computeroutput>&lt;service-ref&gt;</computeroutput> element defines the reference to the service. In the JMX Microkernel environment, this consist of the JMX name of the service MBean. For an MBean reference, if the domain is left out, then the current domain of the portal is used. + The <computeroutput>&lt;service-ref&gt;</computeroutput> element defines the reference to the service. In the JMX Microkernel environment, this consist of the JMX name of the service MBean. For an MBean reference, if the domain is left out, the current domain of the portal is used. </para> </listitem> </varlistentry> @@ -299,38 +300,50 @@ </para> </sect2> <sect2> - <title>Portlet Instance DTD</title> - <para> -<itemizedlist> + <title>The JBoss Portlet Instance DTD</title> + <para> + The following items refer to elements found in the JBoss Portlet Instance DTD, <filename>$JBOSS_HOME/server/configuration/deploy/jboss-portal.sar/dtd/portlet-instances_<replaceable>version_number</replaceable>.dtd</filename>: + </para> + <para> + <variablelist> + <varlistentry><term><screen><![CDATA[ +<!ELEMENT deployments (deployment*)>]]> +</screen></term> <listitem> -<para> -Element <![CDATA[<!ELEMENT deployments (deployment*)>]]> -</para><para><programlisting><![CDATA[ -The deployements element is a container for deployment elements.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT deployment (if-exists?,instance)> - -]]> -</para><para><programlisting><![CDATA[The deployment is a container for an instance element.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT if-exists (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The if-exists element is used to define action to take if instance with such name is -already present. Possible values are overwrite or keep . Overwrite will destroy the -existing object in the database and create a new one, based on the content of the -deployment. Keep will maintain the existing object deployment or create a new one if -it does not yet exist.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT instance (instance-id,portlet-ref,preferences?,security-constraint?)>]]> -</para><para><programlisting><![CDATA[The instance element is used to create an instance of a portlet from the portlet -application of the same war file containing the portlet-instances.xml file. The portlet -will be created and configured only if the portlet is present and an instance with -such a name does not already exist. - -Example : - + <para> + The deployements element is a container for deployment elements. + </para> + <para> +<screen><![CDATA[ +<![CDATA[<!ELEMENT deployment (if-exists?,instance)>]]> +</screen> + </para> + <para> + The deployment is a container for an instance element. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<![CDATA[<!ELEMENT if-exists (#PCDATA)>]]> +</screen></term> +<listitem> + <para> + The if-exists element is used to define action to take if instance with such name is already present. Possible values are overwrite or keep . Overwrite will destroy the existing object in the database and create a new one, based on the content of the deployment. Keep will maintain the existing object deployment or create a new one if it does not yet exist. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<![CDATA[<!ELEMENT instance (instance-id,portlet-ref,preferences?,security-constraint?)>]]> +</screen></term> +<listitem> + <para> + The instance element is used to create an instance of a portlet from the portlet application of the same war file containing the portlet-instances.xml file. The portlet will be created and configured only if the portlet is present and an instance with such a name does not already exist. + </para> + <para> + Example: + </para> + <para> +<screen><![CDATA[ <instance> <instance-id>MyPortletInstance</instance-id> <portlet-ref>MyPortlet</portlet-ref> @@ -346,38 +359,72 @@ <action-name>view</action-name> </policy-permission> </security-constraint> -</instance>]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT instance-id (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The identifier of the instance.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT portlet-ref (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The reference to the portlet which is its portlet name.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT preferences (preference)>]]> -</para><para><programlisting><![CDATA[The preferences element configures the instance with a specific set of preferences.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT preference (name,value)>]]> -</para><para><programlisting><![CDATA[The preference configure one preference of a set of preferences.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT name (#PCDATA)>]]> -</para><para><programlisting><![CDATA[A name.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT value (#PCDATA)>]]> -</para><para><programlisting><![CDATA[A string value.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT security-constraint (policy-permission*)>]]> -</para><para><programlisting><![CDATA[The security-constraint element is a container for policy-permission elements - -Examples: - +</instance>]]> +</screen> + </para> + <para> +<screen><![CDATA[ +<![CDATA[<!ELEMENT instance-id (#PCDATA)>]]> +</screen> + </para> + <para> + The identifier of the instance. + </para> + <para> +<screen><![CDATA[ +<![CDATA[<!ELEMENT portlet-ref (#PCDATA)>]]> +</screen> + </para> + <para> + The reference to the portlet which is its portlet name. + </para> + <para> +<screen><![CDATA[ +<![CDATA[<!ELEMENT preferences (preference)>]]> +</screen> + </para> + <para> + The preferences element configures the instance with a specific set of preferences. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<![CDATA[<!ELEMENT preference (name,value)>]]> +</screen></term> +<listitem> + <para> + The preference configure one preference of a set of preferences. + </para> + <para> +<screen><![CDATA[ +<![CDATA[<!ELEMENT name (#PCDATA)>]]> +</screen> + </para> + <para> + A name. + </para> + <para> +<screen><![CDATA[ +<!ELEMENT value (#PCDATA)>]]> +</screen> + </para> + <para> + A string value. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<!ELEMENT security-constraint (policy-permission*)>]]> +</screen></term> +<listitem> + <para> + The security-constraint element is a container for policy-permission elements. See the elements after the example for an explanation of each. + </para> + <para> + Example: + </para> + <para> +<screen><![CDATA[ <security-constraint> <policy-permission> <role-name>User</role-name> @@ -390,34 +437,75 @@ <unchecked/> <action-name>view</action-name> </policy-permission> -</security-constraint>]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT policy-permission (action-name*,unchecked?,role-name*)>]]> -</para><para><programlisting><![CDATA[The policy-permission element is used to secure a specific portlet instance based on a user's role.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT action-name (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The action-name element is used to define the access rights given to the role defined. -Possible values are: - - * view - Users can view the page. - * viewrecursive - Users can view the page and child pages. - * personalize - Users are able personalize the page's theme. - * personalizerecursive - Users are able personalize the page AND its children's themes. - pages.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT unchecked EMPTY>]]> -</para><para><programlisting><![CDATA[The unchecked element is used to define (if present) that anyone can view this instance]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT role-name (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The role-name element is used to define a role that this security constraint will apply to - - * <role-name>SOMEROLE</role-name> Access to this instance is limited to the defined role.]]></programlisting></para> -</listitem></itemizedlist> - </para> +</security-constraint>]]> +</screen> + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<!ELEMENT policy-permission (action-name*,unchecked?,role-name*)>]]> +</screen></term> +<listitem> + <para> + The policy-permission element is used to secure a specific portlet instance based on a user's role. + </para> + <para> +<screen><![CDATA[ +<![CDATA[<!ELEMENT action-name (#PCDATA)>]]> +</screen> + </para> + <para> + The action-name element is used to define the access rights given to the role defined. Possible values are: + </para> + <para> + <itemizedlist> + <listitem> + <para> + view - Users can view the page. + </para> + </listitem> + <listitem> + <para> + viewrecursive - Users can view the page and child pages. + </para> + </listitem> + <listitem> + <para> + personalize - Users are able personalize the page's theme. + </para> + </listitem> + <listitem> + <para> + personalizerecursive - Users are able personalize the page AND its children's themes. pages. + </para> + </listitem> + </itemizedlist> + </para> + <para> +<screen><![CDATA[ +<![CDATA[<!ELEMENT unchecked EMPTY>]]> +</screen> + </para> + <para> + The unchecked element is used to define (if present) that anyone can view this instance. + </para> + <para> +<screen><![CDATA[ +<![CDATA[<!ELEMENT role-name (#PCDATA)>]]> +</screen> + </para> + <para> + The role-name element is used to define a role that this security constraint will apply to: + </para> + <para> +<screen><![CDATA[ +<role-name>SOMEROLE</role-name> Access to this instance is limited to the defined role.]]> +</screen> + </para> +</listitem> +</varlistentry> +</variablelist> +</para> </sect2> <sect2> <title>Portal Object DTD</title>