[portal-commits] JBoss Portal SVN: r6161 - trunk/core/src/resources/portal-core-sar/dtd.

Author: julien(a)jboss.com Date: 2007-02-05 12:12:13 -0500 (Mon, 05 Feb 2007) New Revision: 6161 Modified: trunk/core/src/resources/portal-core-sar/dtd/portal-object_2_6.dtd Log: commenting more the portal object dtd Modified: trunk/core/src/resources/portal-core-sar/dtd/portal-object_2_6.dtd =================================================================== --- trunk/core/src/resources/portal-core-sar/dtd/portal-object_2_6.dtd 2007-02-05 17:02:04 UTC (rev 6160) +++ trunk/core/src/resources/portal-core-sar/dtd/portal-object_2_6.dtd 2007-02-05 17:12:13 UTC (rev 6161) @@ -159,55 +159,93 @@ <!ELEMENT page-name (#PCDATA)> <!-- -A portal object of type window. A window type represents a window. +A portal object of type window. A window type represents a window. Beside the common properties a window has +a content and belong to a region on the page. + +The instance-ref or content tags are used to define the content of the window. The usage of the content tag +is generic and can be used to describe any kind of content. The instance-ref is a shortcut to define a content +type of portlet which points to a portlet instance. + +The region and height defines how the window is placed in the page. --> <!ELEMENT window (window-name,(instance-ref|content),region,height,properties?,listener?)> <!-- +The window name value. --> <!ELEMENT window-name (#PCDATA)> <!-- +Define the content of the window as a reference to a portlet instance. The value is the id of the instance. + +Example: + +<instance-ref>MyPortletInstance</instance-ref> + --> <!ELEMENT instance-ref (#PCDATA)> <!-- +Define the content of the window in a generic manner. The content is define by the type of the content +and an URI which acts as an identificator for the content. + +Example: + +<content> + <content-type>portlet</content-type> + <content-uri>MyPortletInstance</content-uri> +</content> + +<content> + <content-type>cms</content-type> + <content-uri>/default/index.html</content-uri> +</content> + --> <!ELEMENT content (content-type,content-uri)> <!-- +The content type of the window. --> <!ELEMENT content-type (#PCDATA)> <!-- +The content URI of the window. --> <!ELEMENT content-uri (#PCDATA)> <!-- +The region the window belongs to. --> <!ELEMENT region (#PCDATA)> <!-- +The height of the window in the particular region. --> <!ELEMENT height (#PCDATA)> <!-- +Define a listener for a portal object. The value is the id of the listener. --> <!ELEMENT listener (#PCDATA)> <!-- +A set of generic properties for the portal object. --> <!ELEMENT properties (property*)> <!-- +A generic string property. --> <!ELEMENT property (name,value)> <!-- +A name value. --> <!ELEMENT name (#PCDATA)> <!-- +A value. --> <!ELEMENT value (#PCDATA)>