Author: julien(a)jboss.com Date: 2007-02-05 11:25:36 -0500 (Mon, 05 Feb 2007) New Revision: 6155 Modified: trunk/core/src/resources/portal-core-sar/dtd/portal-object_2_6.dtd Log: updates to 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 16:00:59 UTC (rev 6154) +++ trunk/core/src/resources/portal-core-sar/dtd/portal-object_2_6.dtd 2007-02-05 16:25:36 UTC (rev 6155) @@ -30,68 +30,136 @@ --> <!-- -The deployements element is a container for deployment elements. +The deployements element is a generic container for deployment elements. --> <!ELEMENT deployments (deployment*)> <!-- -The deployment is a container for an instance element. +The deployment is a generic container for portal object elements. The parent-ref +child gives the name of the parent object that the current object will use as parent. +The optional if-exists element define the behavior when a portal object which an identical +name is already child of the parent element. The default behavior of the if-exist tag is to +keep the existing object and not create a new object. The last element is the portal object +itself. + +Example: + +<deployment> + <parent-ref>default</parent-ref> + <page> + ... + </page> +</deployment> + +All portal objects have a common configuration which can be : + +1/ a listener : specifies the id of a listener is the listener registry. A listener object is able to +listen portal events which apply to the portal node hierarchy. + +2/ properties : a set of generic properties owned by the portal object. Some properties can drive the behavior +of the object. + +3/ security-constraint : defines security configuration of the portal object. + --> -<!ELEMENT deployment (parent-ref,if-exists?,(context|portal|page|window)*)> +<!ELEMENT deployment (parent-ref,if-exists?,context|portal|page|window)> <!-- +Contains a reference to the parent object. The naming convention for naming object +is to concatenate the names of the path to the object and separate the names by a dot. +If the path is empty then the empty string must be used. + +Example: + +<parent-ref/> the root having an empty path +<parent-ref>default</parent-ref> the object with the name default under the root having the path (default) +<parent-ref>default.default</parent-ref> the object with the path (default,default) + --> <!ELEMENT parent-ref (#PCDATA)> <!-- +The authorized values are overwrite and keep. Overwrite means that the existing object will be destroyed +and the current declaration will be used. Keep means that the existing object will not be destroyed and +no creation hence will be done. --> <!ELEMENT if-exists (#PCDATA)> <!-- +A portal object of type context. A context type represent a node in the tree which does not have +a visual representation. It can exist only under the root. A context can only have children with the portal type. --> <!ELEMENT context (context-name,properties?,portal*,listener?,security-constraint?)> <!-- +The context name value. --> <!ELEMENT context-name (#PCDATA)> <!-- +A portal object of type portal. A portal type represents a virtual portal and can have children of type page. +In addition of the common portal object elements it support also the declaration of the modes and the window +states it supports. If no declaration of modes or window states is done then the default value will be +respectively (view,edit,help) and (normal,minimized,maximized). --> -<!ELEMENT portal (portal-name,properties?,supported-modes?,supported-window-states?,(page|window)*,listener?,security-constraint?)> +<!ELEMENT portal (portal-name,properties?,supported-window-states?,page*,listener?,security-constraint?)> <!-- +The portal name value. --> +<!ELEMENT portal-name (#PCDATA)> + + +<!-- +The supported modes of a portal. + +Example: + +<supported-mode> + <mode>view</mode> + <mode>edit</mode> + <mode>help</mode> +</supported-mode> +--> <!ELEMENT supported-modes (mode*)> <!-- +A portlet mode value. --> <!ELEMENT mode (#PCDATA)> <!-- +The supported window states of a portal. + +Example: + +<supported-window-states> + <window-state>normal</window-state> + <window-state>minimized</window-state> + <window-state>maximized</window-state> +</supported-window-states> + --> <!ELEMENT supported-window-states (window-state*)> <!-- +A window state value. --> <!ELEMENT window-state (#PCDATA)> <!-- +A portal object of type page. A page type represents a page which can have children of type page and window. +The children windows are the windows of the page and the children pages are the subpages of this page. --> -<!ELEMENT portal-name (#PCDATA)> - -<!-- ---> <!ELEMENT page (page-name,properties?,(page|window)*,listener?,security-constraint?)> <!-- +The page name value. --> -<!ELEMENT listener (#PCDATA)> - -<!-- ---> <!ELEMENT page-name (#PCDATA)> <!-- +A portal object of type window. A window type represents a window. --> <!ELEMENT window (window-name,(instance-ref|content),properties?,region,height,listener?)> @@ -125,6 +193,10 @@ <!-- --> +<!ELEMENT listener (#PCDATA)> + +<!-- +--> <!ELEMENT properties (property*)> <!--