Author: mmcallis Date: 2008-02-27 01:45:24 -0500 (Wed, 27 Feb 2008) New Revision: 10133 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.1.3. The JBoss Portal Object DTD minor revisions... 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-27 05:51:19 UTC (rev 10132) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-27 06:45:24 UTC (rev 10133) @@ -86,7 +86,7 @@ Use the <computeroutput>&lt;remotable&gt;</computeroutput> element to configure the default behavior of portlets with respect to WSRP exposure: if no value is given, the value is either the value globally defined at the portlet application level, or <computeroutput>false</computeroutput>. Accepted values are <computeroutput>true</computeroutput> and <computeroutput>false</computeroutput>. </para> <para> - You can configure specific settings for the portlet container for each portlet defined in the <filename>WEB-INF/portlet.xml</filename> file. Use the <computeroutput>&lt;service&gt;</computeroutput> element to inject services into the portlet context of applications. + You can configure specific settings of the portlet container for each portlet defined in the <filename>WEB-INF/portlet.xml</filename> file. Use the <computeroutput>&lt;service&gt;</computeroutput> element to inject services into the portlet context of applications. </para> </listitem> </varlistentry> @@ -96,7 +96,7 @@ </screen></term> <listitem> <para> - Additional configuration for the portlet. The <computeroutput>&lt;portlet-name&gt;</computeroutput> element defines the portlet name. It must match a portlet defined in the <filename>WEB-INF/portlet.xml</filename> file for that application. + Additional configuration of the portlet. The <computeroutput>&lt;portlet-name&gt;</computeroutput> element defines the portlet name. It must match a portlet defined in the <filename>WEB-INF/portlet.xml</filename> file for that application. </para> <para> Use the <computeroutput>&lt;remotable&gt;</computeroutput> element to configure the default behavior of portlets with respect to WSRP exposure: if no value is given, the value is either the value globally defined at the portlet application level, or <computeroutput>false</computeroutput>. @@ -613,7 +613,7 @@ </screen></term> <listitem> <para> - The context type of the portal object. A context type represent a node in a tree, which does not have a visual representation, and only exists under root. A context can only have children with the <emphasis>portal</emphasis> type. + The context type of the portal object. A context type represent a node in a tree, which does not have a visual representation, and only exists under the root. A context can only have children that use the <emphasis>portal</emphasis> type. </para> <para> <screen><![CDATA[ @@ -621,7 +621,7 @@ </screen> </para> <para> - The context name value. + The context name. </para> </listitem> </varlistentry> @@ -631,7 +631,7 @@ </screen></term> <listitem> <para> - A portal object with the type <emphasis>portal</emphasis>. A portal type represents a virtual portal, and can only have children that use the type <emphasis>page</emphasis>. In addition to the common portal object elements, it also supports the declaration of the modes and the window states that it supports. If there are no declarations of modes or window states, the default value will be <computeroutput>view</computeroutput>, <computeroutput>edit</computeroutput>, <computeroutput>help</computeroutput>, and <computeroutput>normal</computeroutput>, <computeroutput>minimized</computeroutput>, <computeroutput>maximized</computeroutput> respectively. + A portal object that uses the <emphasis>portal</emphasis> type. A portal type represents a virtual portal, and can only have children that use the <emphasis>page</emphasis> type. In addition to the common portal object elements, it also allows you to declare modes and window states that are supported. </para> <para> <screen><![CDATA[ @@ -647,10 +647,10 @@ </screen> </para> <para> - The supported modes of the portal. Accepted values are <computeroutput>view</computeroutput>, <computeroutput>edit</computeroutput>, and <computeroutput>help</computeroutput>. + The <computeroutput>&lt;supported-modes&gt;</computeroutput> elements defines the supported modes of the portal. Accepted values are <computeroutput>view</computeroutput>, <computeroutput>edit</computeroutput>, and <computeroutput>help</computeroutput>. </para> <para> - The following is an example of the <computeroutput>&lt;supported-mode&gt;</computeroutput> element: + The following is an example of the <computeroutput>&lt;supported-mode&gt;</computeroutput> and <computeroutput>&lt;mode&gt;</computeroutput> elements: </para> <para> <screen><![CDATA[ @@ -668,7 +668,7 @@ </screen></term> <listitem> <para> - The portlet mode value. + The portlet mode value. If there are no declarations of modes or window states, the default values will be <computeroutput>view</computeroutput>, <computeroutput>edit</computeroutput>, <computeroutput>help</computeroutput>, and <computeroutput>normal</computeroutput>, <computeroutput>minimized</computeroutput>, <computeroutput>maximized</computeroutput> respectively. </para> </listitem> </varlistentry> @@ -677,7 +677,7 @@ </screen></term> <listitem> <para> - Use the <computeroutput>&lt;supported-window-states&gt;</computeroutput> element to define the supported window states for the portal. Accepted values are <computeroutput>normal</computeroutput>, <computeroutput>minimized</computeroutput>, and <computeroutput>maximized</computeroutput>. The following is an example of the <computeroutput>&lt;supported-window-states&gt;</computeroutput> and <computeroutput>&lt;window-state&gt;</computeroutput> elements: + Use the <computeroutput>&lt;supported-window-states&gt;</computeroutput> element to define the supported window states of the portal. The following is an example of the <computeroutput>&lt;supported-window-states&gt;</computeroutput> and <computeroutput>&lt;window-state&gt;</computeroutput> elements: </para> <para> <screen><![CDATA[ @@ -694,7 +694,7 @@ </screen> </para> <para> - Use the <computeroutput>&lt;window-state&gt;</computeroutput> element to define a window state. + Use the <computeroutput>&lt;window-state&gt;</computeroutput> element to define a window states. Accepted values are <computeroutput>normal</computeroutput>, <computeroutput>minimized</computeroutput>, and <computeroutput>maximized</computeroutput>. </para> </listitem> </varlistentry> @@ -704,7 +704,7 @@ </screen></term> <listitem> <para> - A portal object with the type <emphasis>page</emphasis>. A page type represents a page, and can only have children that use the type <emphasis>page</emphasis> and <emphasis>window</emphasis>. The children windows are the windows of the page, and the children pages are the subpages of this page. + A portal object with the type <emphasis>page</emphasis>. A page type represents a page, and can only have children that use the types <emphasis>page</emphasis> and <emphasis>window</emphasis>. The children windows are the windows of the page, and the children pages are the subpages of this page. </para> <para> <screen><![CDATA[ @@ -712,7 +712,7 @@ </screen> </para> <para> - The page name value. + The page name. </para> </listitem> </varlistentry> @@ -722,15 +722,12 @@ </screen></term> <listitem> <para> - A portal object with the type <emphasis>window</emphasis>. A window type represents a window. Beside the common properties, a window has content and belongs to a region on the page. + A portal object with the type <emphasis>window</emphasis>. A window type represents a window. Besides the common properties, a window has content and belongs to a region on the page. </para> <para> - The <computeroutput>&lt;instance-ref&gt;</computeroutput> and <computeroutput>&lt;content&gt;</computeroutput> elements are used to define the content of the window. The <computeroutput>&lt;content&gt;</computeroutput> element is generic, and is used to describe any kind of content. The <computeroutput>&lt;instance-ref&gt;</computeroutput> element is a shortcut to define the content-type of portlet which points to a portlet instance. + The <computeroutput>&lt;instance-ref&gt;</computeroutput> and <computeroutput>&lt;content&gt;</computeroutput> elements are used to define the content of the window. The <computeroutput>&lt;content&gt;</computeroutput> element is generic, and is used to describe any kind of content. The <computeroutput>&lt;instance-ref&gt;</computeroutput> element is a shortcut to define the content-type of the portlet, which points to a portlet instance. The <computeroutput>&lt;instance-ref&gt;</computeroutput> value must much an <computeroutput>&lt;instance-id&gt;</computeroutput> value in the <filename>WEB-INF/portlet-instances.xml</filename> file. </para> <para> - The region and height defines how the window is placed in the page. - </para> - <para> <screen><![CDATA[ <!ELEMENT window-name (#PCDATA)>]]> </screen>