Author: mmcallis Date: 2008-02-25 00:13:33 -0500 (Mon, 25 Feb 2008) New Revision: 10103 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.1.1. The JBoss Portlet DTD minor corrections, adding descriptions from tutorials.xml to xmldescriptors.xml to make sections consistent Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-25 02:01:37 UTC (rev 10102) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-25 05:13:33 UTC (rev 10103) @@ -338,7 +338,7 @@ <computeroutput>&lt;portlet-ref&gt;</computeroutput> value must match the <computeroutput>&lt;portlet-name&gt;</computeroutput> value given in the <filename>HelloWorldPortlet/WEB-INF/portlet.xml</filename> file. 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> files, which in this example, would be the <filename>HelloWorldPortlet/WEB-INF/helloworld-object.xml</filename> file. + in the <filename>*-object.xml</filename> file, which in this example, would be the <filename>HelloWorldPortlet/WEB-INF/helloworld-object.xml</filename> file. </para> <para> The following is an example of the <filename>HelloWorldPortlet/WEB-INF/portlet-instances.xml</filename> file: @@ -360,7 +360,7 @@ </screen> </para> <para> - The <filename>*-object.xml</filename> files are JBoss Portal specific descriptors that allow users to + The <filename>*-object.xml</filename> file is a JBoss Portal specific descriptor that allow users to define the structure of their portal instances, and create and configure their windows and pages. In the following example: </para> @@ -427,7 +427,7 @@ </screen></term> <listitem> <para> - Instructs the portal to overwrite or keep this object if it already exists. Possible values are <literal>overwrite</literal> or <literal>keep</literal>. The <literal>overwrite</literal> value will destroy the existing object and create a new one based on the content of the deployment. The <literal>keep</literal> option will maintain the existing object deployment or create a new one if it does not exist. + Instructs the portal to overwrite or keep this object if it already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> value will destroy the existing object and create a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option will maintain the existing object deployment, or create a new one if it does not exist. </para> </listitem> </varlistentry> 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 02:01:37 UTC (rev 10102) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-25 05:13:33 UTC (rev 10103) @@ -311,7 +311,7 @@ </screen></term> <listitem> <para> - The <computeroutput>&lt;deployements&gt;</computeroutput> element is a container for <computeroutput>&lt;deployment&gt;</computeroutput> elements. + The <computeroutput>&lt;deployments&gt;</computeroutput> element is a container for the <computeroutput>&lt;deployment&gt;</computeroutput> element. </para> <para> <screen><![CDATA[ @@ -319,7 +319,7 @@ </screen> </para> <para> - The <computeroutput>&lt;deployment&gt;</computeroutput> is a container for the <computeroutput>&lt;instance&gt;</computeroutput> element. + The <computeroutput>&lt;deployment&gt;</computeroutput> element is a container for the <computeroutput>&lt;instance&gt;</computeroutput> element. </para> <para> <screen><![CDATA[ @@ -327,7 +327,7 @@ </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. + The <computeroutput>&lt;if-exists&gt;</computeroutput> element is used to define 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> value will destroy the existing object and create a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option will maintain the existing object deployment, or create a new one if it does not exist. </para> </listitem> </varlistentry> @@ -336,10 +336,10 @@ </screen></term> <listitem> <para> - 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. + The <computeroutput>&lt;instance&gt;</computeroutput> element is used in the <filename>WEB-INF/portlet-instances.xml</filename> file, which is used to create instances of portlets. The portlet will only be created and configured if the portlet is present, and an instance with the same name does not already exist. </para> <para> - Example: + 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> <screen><![CDATA[ @@ -367,7 +367,7 @@ </screen> </para> <para> - The identifier of the instance. + 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> <screen><![CDATA[ @@ -375,7 +375,7 @@ </screen> </para> <para> - The reference to the portlet which is its portlet name. + The reference to the portlet, which is the portlet name. The <computeroutput>&lt;portlet-ref&gt;</computeroutput> value must match the <computeroutput>&lt;portlet-name&gt;</computeroutput> give in the <filename>WEB-INF/portlet.xml</filename> file. </para> <para> <screen><![CDATA[ @@ -383,7 +383,7 @@ </screen> </para> <para> - The preferences element configures the instance with a specific set of preferences. + The <computeroutput>&lt;preferences&gt;</computeroutput> element configures the instance with a specific set of preferences. </para> </listitem> </varlistentry> @@ -392,7 +392,7 @@ </screen></term> <listitem> <para> - The preference configure one preference of a set of preferences. + The <computeroutput>&lt;preference&gt;</computeroutput> element configures one preference which is part of a set of preferences, which is defined using the <computeroutput>&lt;preferences&gt;</computeroutput> element. </para> <para> <screen><![CDATA[ @@ -417,7 +417,7 @@ </screen></term> <listitem> <para> - The <computeroutput>&lt;security-constraint&gt;</computeroutput> element is a container for policy-permission elements. + The <computeroutput>&lt;security-constraint&gt;</computeroutput> element is a container for <computeroutput>&lt;policy-permission&gt;</computeroutput> elements. </para> <para> The following is an example of the <computeroutput>&lt;security-constraint&gt;</computeroutput> element: @@ -454,28 +454,28 @@ </screen> </para> <para> - The <computeroutput>&lt;action-name&gt;</computeroutput> 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. Accepted values are: </para> <para> <itemizedlist> <listitem> <para> - view - Users can view the page. + <computeroutput>view</computeroutput>: users can view the page. </para> </listitem> <listitem> <para> - viewrecursive - Users can view the page and child pages. + <computeroutput>viewrecursive</computeroutput>: users can view the page and child pages. </para> </listitem> <listitem> <para> - personalize - Users are able personalize the page's theme. + <computeroutput>personalize</computeroutput>: 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. + <computeroutput>personalizerecursive</computeroutput>: users are able personalize the page and child pages themes. </para> </listitem> </itemizedlist> @@ -486,7 +486,7 @@ </screen> </para> <para> - The <computeroutput>&lt;unchecked&gt;</computeroutput> element is used to define (if present) that anyone can view this instance. + If present. the <computeroutput>&lt;unchecked&gt;</computeroutput> element is used to define that anyone can view the instance. </para> <para> <screen><![CDATA[ @@ -494,11 +494,11 @@ </screen> </para> <para> - The <computeroutput>&lt;role-name&gt;</computeroutput> 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. The following example only allows users that are part of the <computeroutput>EXAMPLEROLE</computeroutput> role, to access the instance: </para> <para> <screen><![CDATA[ -<role-name>SOMEROLE</role-name> Access to this instance is limited to the defined role.]]> +<role-name>EXAMPLEROLE</role-name>]]> </screen> </para> </listitem>