Author: mmcallis Date: 2008-02-24 21:01:37 -0500 (Sun, 24 Feb 2008) New Revision: 10102 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.1.2. The JBoss Portlet Instance DTD - starting to makeup (computeroutput) elements, - minor corrections 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-25 01:10:13 UTC (rev 10101) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-25 02:01:37 UTC (rev 10102) @@ -311,33 +311,32 @@ </screen></term> <listitem> <para> - The deployements element is a container for deployment elements. + The <computeroutput>&lt;deployements&gt;</computeroutput> element is a container for <computeroutput>&lt;deployment&gt;</computeroutput> elements. </para> <para> <screen><![CDATA[ -<![CDATA[<!ELEMENT deployment (if-exists?,instance)>]]> +<!ELEMENT deployment (if-exists?,instance)>]]> </screen> </para> <para> - The deployment is a container for an instance element. + The <computeroutput>&lt;deployment&gt;</computeroutput> is a container for the <computeroutput>&lt;instance&gt;</computeroutput> 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. +<screen><![CDATA[ +<!ELEMENT if-exists (#PCDATA)>]]> +</screen> +</para> + <para> + The <computeroutput>&lt;if-exists&gt;</computeroutput> element is used to define action to take if instance with such name is already present. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> value will destroy the existing object in the database and create a new one, based on the content of the deployment. The <computeroutput>keep</computeroutput> value 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?)>]]> +<!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. + The <computeroutput>&lt;instance&gt;</computeroutput> element is used to create an instance of a portlet from the portlet application of the same war file containing the <filename>WEB-INF/portlet-instances.xml</filename> 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: @@ -364,7 +363,7 @@ </para> <para> <screen><![CDATA[ -<![CDATA[<!ELEMENT instance-id (#PCDATA)>]]> +<!ELEMENT instance-id (#PCDATA)>]]> </screen> </para> <para> @@ -372,7 +371,7 @@ </para> <para> <screen><![CDATA[ -<![CDATA[<!ELEMENT portlet-ref (#PCDATA)>]]> +<!ELEMENT portlet-ref (#PCDATA)>]]> </screen> </para> <para> @@ -380,7 +379,7 @@ </para> <para> <screen><![CDATA[ -<![CDATA[<!ELEMENT preferences (preference)>]]> +<!ELEMENT preferences (preference)>]]> </screen> </para> <para> @@ -389,7 +388,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<![CDATA[<!ELEMENT preference (name,value)>]]> +<!ELEMENT preference (name,value)>]]> </screen></term> <listitem> <para> @@ -397,7 +396,7 @@ </para> <para> <screen><![CDATA[ -<![CDATA[<!ELEMENT name (#PCDATA)>]]> +<!ELEMENT name (#PCDATA)>]]> </screen> </para> <para> @@ -418,10 +417,10 @@ </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. + The <computeroutput>&lt;security-constraint&gt;</computeroutput> element is a container for policy-permission elements. </para> <para> - Example: + The following is an example of the <computeroutput>&lt;security-constraint&gt;</computeroutput> element: </para> <para> <screen><![CDATA[ @@ -447,15 +446,15 @@ </screen></term> <listitem> <para> - The policy-permission element is used to secure a specific portlet instance based on a user's role. + The <computeroutput>&lt;policy-permission&gt;</computeroutput> element is used to secure a specific portlet instance based on a user's role. </para> <para> <screen><![CDATA[ -<![CDATA[<!ELEMENT action-name (#PCDATA)>]]> +<!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: + The <computeroutput>&lt;action-name&gt;</computeroutput> element is used to define the access rights given to the role defined. Possible values are: </para> <para> <itemizedlist> @@ -483,19 +482,19 @@ </para> <para> <screen><![CDATA[ -<![CDATA[<!ELEMENT unchecked EMPTY>]]> +<!ELEMENT unchecked EMPTY>]]> </screen> </para> <para> - The unchecked element is used to define (if present) that anyone can view this instance. + The <computeroutput>&lt;unchecked&gt;</computeroutput> element is used to define (if present) that anyone can view this instance. </para> <para> <screen><![CDATA[ -<![CDATA[<!ELEMENT role-name (#PCDATA)>]]> +<!ELEMENT role-name (#PCDATA)>]]> </screen> </para> <para> - The role-name element is used to define a role that this security constraint will apply to: + The <computeroutput>&lt;role-name&gt;</computeroutput> element is used to define a role that this security constraint will apply to: </para> <para> <screen><![CDATA[