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

Author: mmcallis Date: 2008-04-20 20:38:37 -0400 (Sun, 20 Apr 2008) New Revision: 10664 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.4.1. Defining a new Portal Page - periodic backup - revising descriptions with text from 6.2. Portlet Descriptors 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-04-21 00:27:09 UTC (rev 10663) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-21 00:38:37 UTC (rev 10664) @@ -1783,36 +1783,53 @@ <screen> &lt;page&gt; </screen> - <para> - The start of a page definition. Among others, the <computeroutput>&lt;page&gt;</computeroutput> element is a container for the <computeroutput>&lt;page-name&gt;</computeroutput>, <computeroutput>&lt;window&gt;</computeroutput>, and <computeroutput>&lt;security-contraint&gt;</computeroutput> elements. - </para> - </listitem> + <para> + The start of a page definition. Among others, the <computeroutput>&lt;page&gt;</computeroutput> element is a container for the <computeroutput>&lt;page-name&gt;</computeroutput>, <computeroutput>&lt;window&gt;</computeroutput>, and <computeroutput>&lt;security-contraint&gt;</computeroutput> elements. + </para> + </listitem> <listitem> - <emphasis role="bold">&lt;page-name&gt;</emphasis> - The name of the page. - </listitem> +<screen> +&lt;page-name&gt; +</screen> + <para> + The page name. + </para> + </listitem> + <listitem> +<screen> +&lt;window&gt; +</screen> + <para> + The <computeroutput>&lt;window&gt;</computeroutput> element defines a portlet window. The <computeroutput>&lt;window&gt;</computeroutput> element requires an <computeroutput>&lt;instance-ref&gt;</computeroutput> element, which is used to assign a portal instance to a window. + </para> + </listitem> + <listitem> +<screen> +&lt;window-name&gt; +</screen> + <para> + 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> +<screen> +&lt;instance-ref&gt; +</screen> + <para> + The <computeroutput>&lt;instance-ref&gt;</computeroutput> elements define 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> - <emphasis role="bold">&lt;window&gt;</emphasis> - The start of a window - definition. +<screen> +&lt;region&gt;...&lt;/region&gt; +&lt;height&gt;...&lt;/height&gt; +</screen> + <para> + 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> </listitem> <listitem> - <emphasis role="bold">&lt;window-name&gt;</emphasis> - The name of the - window. - </listitem> - <listitem> - <emphasis role="bold">&lt;instance-ref&gt;</emphasis> - The instance - reference used by this window. Should correspond with the - &lt;instance-name&gt; variable. - </listitem> - <listitem> - <emphasis role="bold">&lt;height&gt;</emphasis> - The vertical position of - this window within the region defined in the layout. - </listitem> - <listitem> <emphasis role="bold">&lt;instance&gt;</emphasis> The start of an instance definition. page.