Author: mmcallis Date: 2008-02-26 21:01:47 -0500 (Tue, 26 Feb 2008) New Revision: 10130 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.1.3. The JBoss Portal Object DTD revising elements names to make them consistent with portal-object_2_6.dtd 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 01:49:30 UTC (rev 10129) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-27 02:01:47 UTC (rev 10130) @@ -524,7 +524,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<!ELEMENT deployment (parent-ref,if-exists?,(context | portal | page | window))>]]> +<!ELEMENT deployment (parent-ref?,if-exists?,(context|portal|page|window))>]]> </screen></term> <listitem> <para> @@ -606,7 +606,8 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<!ELEMENT context (context-name,properties?,listener?,security-constraint?,portal*)>]]> +<!ELEMENT context (context-name,properties?,listener?,security-constraint?,portal*, +(display-name* | (resource-bundle, supported-locale+)))>]]> </screen></term> <listitem> <para> @@ -620,13 +621,14 @@ <para> The context name value. </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<!ELEMENT portal (portal-name,supported-modes,supported-window-states?,properties?,listener?, +security-constraint?,page*, (display-name* | (resource-bundle, supported-locale+)))>]]> +</screen></term> +<listitem> <para> -<screen><![CDATA[ -<!ELEMENT portal (portal-name,supported-modes,supported-window-states?,properties?, -listener?,security-constraint?,page*)>]]> -</screen> - </para> - <para> 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). </para> <para> @@ -695,7 +697,8 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<!ELEMENT page (page-name,properties?,listener?,security-constraint?,(page | window)*)>]]> +<!ELEMENT page (page-name,properties?,listener?,security-constraint?,(page | window)*, +(display-name* | (resource-bundle, supported-locale+)))>]]> </screen></term> <listitem> <para> @@ -712,7 +715,8 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<!ELEMENT window (window-name,(instance-ref | content),region,height,properties?,listener?)>]]> +<!ELEMENT window (window-name,(instance-ref|content),region,height,initial-window-state?, +initial-mode?,properties?,listener?, (display-name* | (resource-bundle, supported-locale+)))>]]> </screen></term> <listitem> <para> @@ -884,40 +888,37 @@ </screen></term> <listitem> <para> - The <computeroutput>&lt;policy-permission&gt;</computeroutput> element is used to secure a specific portal page based on a user's role. + The <computeroutput>&lt;policy-permission&gt;</computeroutput> element is used to secure a specific portlet instance based on a user's role. </para> <para> <screen><![CDATA[ <!ELEMENT action-name (#PCDATA)>]]> </screen> - </para> - <para> - The <computeroutput>&lt;role-name&gt;</computeroutput> element is used to define a role that this security constraint will apply to. - </para> - <para> - Example>:Access to this portal page is limited to the defined role. - </para> - <para> -<screen> -&lt;role-name&gt;SOMEROLE&lt;/role-name&gt; -</screen> - </para> - <para> + </para> + <para> + The <computeroutput>&lt;action-name&gt;</computeroutput> element is used to define the access rights given to the role defined. The accepted value is <computeroutput>view</computeroutput>, which allows users to view the page. + </para> + <para> <screen><![CDATA[ <!ELEMENT unchecked EMPTY>]]> </screen> - </para> - <para> - The unchecked element is used to define (if present) that anyone can view this portal page. - </para> - <para> + </para> + <para> + If present, the <computeroutput>&lt;unchecked&gt;</computeroutput> element is used to define that anyone can view this instance. + </para> + <para> <screen><![CDATA[ <!ELEMENT role-name (#PCDATA)>]]> </screen> - </para> - <para> - The action-name element is used to define the access rights given to the role defined. Possible value is: view - Users can view the page. - </para> + </para> + <para> + The <computeroutput>&lt;role-name&gt;</computeroutput> element is used to define a role that the security constraint will apply to. The following example only allows users that are part of the <computeroutput>EXAMPLEROLE</computeroutput> role to access this instance: + </para> + <para> +<screen><![CDATA[ +<role-name>EXAMPLEROLE</role-name>]]> +</screen> + </para> </listitem> </varlistentry> </variablelist>