Author: mmcallis Date: 2008-03-27 03:08:25 -0400 (Thu, 27 Mar 2008) New Revision: 10389 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.2.1. *-object.xml Descriptors - revising content, and copying a little content from 6.1.2. The JBoss Portlet Instance DTD 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-03-27 03:48:14 UTC (rev 10388) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-03-27 07:08:25 UTC (rev 10389) @@ -977,9 +977,9 @@ The following sections describe the descriptors used to define portal objects, such as portals, pages, portlet instances, windows, and portlets. Refer to <xref linkend="tutorials_tutorials"/> and <xref linkend="desc_examples"/> for examples on using these descriptors within a portlet application. </para> <sect2 id="desc_objectxml"> - <title><filename>*-object.xml</filename> Files</title> + <title><filename>*-object.xml</filename> Descriptors</title> <para> - The <filename>*-object.xml</filename> files are used to define portal instances, pages, windows, and the window layout. As well, themes and layouts for specific portal instances, pages, and windows, can be defined. The following example defines a portlet window being added to the default page, in the default portal. For advanced functionality using this descriptor, refer to <xref linkend="desc_examples"/>: + The <filename>*-object.xml</filename> descriptors are used to define portal instances, pages, windows, and the window layout. As well, themes and layouts for specific portal instances, pages, and windows, can be defined. The following example defines a portlet window being added to the <computeroutput>default</computeroutput> page, in the <computeroutput>default</computeroutput> portal. For advanced functionality using these descriptors, refer to <xref linkend="desc_examples"/>: </para> <para> <programlisting><![CDATA[ @@ -1003,45 +1003,34 @@ <listitem> <para> <programlisting><![CDATA[<deployments>...</deployments>]]></programlisting> - The - <emphasis>deployments</emphasis> - tag, encapsulates the entire document. You may specify more than one deployment within this tag. + The <computeroutput>&lt;deployments&gt;</computeroutput> element encapsulates the entire document. Multiple deployments can be specified within the <computeroutput>&lt;deployments&gt;</computeroutput> tag. </para> </listitem> <listitem> <para> <programlisting><![CDATA[<deployment>...</deployment>]]></programlisting> - The - <emphasis>deployment</emphasis> - tag is used to specify object deployments: portals, pages, windows, etc... + </para> + <para> + The <computeroutput>&lt;deployment&gt;</computeroutput> element is used to specify object deployments, such as portals, pages, windows, and so on. </para> </listitem> <listitem> <para> <programlisting><![CDATA[<if-exists>...</if-exists>]]></programlisting> - Possible values are - <emphasis>overwrite</emphasis> - or - <emphasis>keep</emphasis> - . - <emphasis>Overwrite</emphasis> - will destroy the existing object in the database and create a new one, based on the - content of the deployment. - <emphasis>Keep</emphasis> - will maintain the existing object deployment or create a new one if - it does not yet exist. - </para> + </para> + <para> + 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> option 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> <listitem> <para> <programlisting><![CDATA[<parent-ref>...</parent-ref>]]></programlisting> - The - <emphasis>parent-ref</emphasis> - tag specifies where a particulare object will exist within the portal object tree. In our example, - above, we are defining a window and assigning it to - <emphasis>default.default</emphasis> - , interpreted, this means the window will appear in the default portal and the default page within - it. + </para> + <para> + The <computeroutput>&lt;parent-ref&gt;</computeroutput> element contains a reference to the parent object. The naming convention for naming objects is to concatenate the names of the path to the object, and separate the names by a period. If the path is empty, then the empty string must be used. The <computeroutput>&lt;parent-ref&gt;</computeroutput> element tells the portal where the portlet should appear. The syntax for the <computeroutput>&lt;parent-ref&gt;</computeroutput> element is <computeroutput><replaceable>portal-instance</replaceable>.<replaceable>portal-page</replaceable></computeroutput>. + </para> + <para> + In the example above, a window is defined, and assigned to <computeroutput>default.default</computeroutput>. This means the window will appear in the <computeroutput>default</computeroutput> page, in the <computeroutput>default</computeroutput> portal. </para> </listitem> <listitem>