[portal-commits] JBoss Portal SVN: r10419 - docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules.

Author: mmcallis Date: 2008-03-30 20:55:17 -0400 (Sun, 30 Mar 2008) New Revision: 10419 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.2.1. *-object.xml Descriptors revising, adding content... 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-29 12:13:39 UTC (rev 10418) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-03-31 00:55:17 UTC (rev 10419) @@ -1046,7 +1046,7 @@ <programlisting><![CDATA[<window-name>...</window-name>]]></programlisting> </para> <para> - A <emphasis role="bold">unique name</emphasis> given to the portlet window. This can be named anything. + The <computeroutput>&lt;window-name&gt;</computeroutput> element defines the <emphasis role="bold">unique name</emphasis> given to a portlet window. This can be named anything. </para> </listitem> <listitem> @@ -1054,7 +1054,7 @@ <programlisting><![CDATA[<instance-ref>...</instance-ref>]]></programlisting> </para> <para> - The portlet instance that the window will represent. This value is the ID of a portlet instance, and must match the value of one of the <computeroutput>&lt;instance-id&gt;</computeroutput> elements in the <filename>WEB-INF/portlet-instances.xml</filename> file. + The <computeroutput>&lt;instance-ref&gt;</computeroutput> elements defines the portlet instances that windows represent. This value is the ID of a portlet instance, and must match the value of one of the <computeroutput>&lt;instance-id&gt;</computeroutput> elements in the <filename>WEB-INF/portlet-instances.xml</filename> file. </para> </listitem> <listitem> @@ -1064,13 +1064,14 @@ <height>...</height>]]></programlisting> </para> <para> - Specifies where the window will appear within the page layout. The <computeroutput>&lt;region&gt;</computeroutput> element specifies where the window will appear on the page. The <computeroutput>&lt;region&gt;</computeroutput> element often depends on other regions defined in the portal layout. The <computeroutput>&lt;height&gt;</computeroutput> element can be assigned a value between one and <replaceable>X</replaceable>. + The <computeroutput>&lt;region&gt;</computeroutput> and <computeroutput>&lt;height&gt;</computeroutput> elements define where the window appears within the page layout. The <computeroutput>&lt;region&gt;</computeroutput> element specifies where the window appears on the page. The <computeroutput>&lt;region&gt;</computeroutput> element often depends on other regions defined in the portal layout. The <computeroutput>&lt;height&gt;</computeroutput> element can be assigned a value between one and <replaceable>X</replaceable>. </para> </listitem> </itemizedlist> </para> - <para>The example *-object.xml, above, makes reference to items found in other descriptor files. To - help with this topic, we have included a sample image that depicts the relationship: + <para>The previous <filename>*-object.xml</filename> example makes reference to items found in other descriptor files. The following diagram illustrates the relationship between the <filename>portlet.xml</filename>, <filename>portlet-instances.xml</filename>, and <filename>helloworld-object.xml</filename> descriptors: + </para> + <para> <mediaobject> <imageobject> <imagedata align="center" fileref="images/tutorials/first_portlet/desc_relationship.gif" @@ -1078,7 +1079,6 @@ </imageobject> </mediaobject> </para> - <para> <note> <title>Are <filename>*-object.xml</filename> descriptors necessary?</title>