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

Author: mmcallis Date: 2008-02-26 18:13:42 -0500 (Tue, 26 Feb 2008) New Revision: 10123 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.1.3. The JBoss Portal Object DTD revising lists, replacing itemizedlists with variablelists 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-26 20:03:02 UTC (rev 10122) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-26 23:13:42 UTC (rev 10123) @@ -614,7 +614,7 @@ </para> <para> <screen><![CDATA[ -<![CDATA[<!ELEMENT context-name (#PCDATA)>]]> +<!ELEMENT context-name (#PCDATA)>]]> </screen> </para> <para> @@ -622,7 +622,7 @@ </para> <para> <screen><![CDATA[ -<![CDATA[<!ELEMENT portal (portal-name,supported-modes,supported-window-states?,properties?, +<!ELEMENT portal (portal-name,supported-modes,supported-window-states?,properties?, listener?,security-constraint?,page*)>]]> </screen> </para> @@ -660,7 +660,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<![CDATA[<!ELEMENT mode (#PCDATA)>]]> +<!ELEMENT mode (#PCDATA)>]]> </screen></term> <listitem> <para> @@ -669,7 +669,7 @@ </listitem> </varlistentry> <varlistentry><term><screen><![CDATA[ -<![CDATA[<!ELEMENT supported-window-states (window-state*)>]]> +<!ELEMENT supported-window-states (window-state*)>]]> </screen></term> <listitem> <para> @@ -682,60 +682,110 @@ <window-state>minimized</window-state> <window-state>maximized</window-state> </supported-window-states>]]> -</screen></para> +</screen> + </para> + <para> +<screen><![CDATA[ +<!ELEMENT window-state (#PCDATA)>]]> +</screen> + </para> + <para> + A window state value. + </para> </listitem> </varlistentry> -</variablelist> -</para> -</sect2> -<!--<para> -Element <![CDATA[<!ELEMENT window-state (#PCDATA)>]]> -</para><para><programlisting><![CDATA[A window state value.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT page (page-name,properties?,listener?,security-constraint?,(page | window)*)>]]> -</para><para><programlisting><![CDATA[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.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT page-name (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The page name value.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT window (window-name,(instance-ref | content),region,height,properties?,listener?)> - -]]> -</para><para><programlisting><![CDATA[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.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT window-name (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The window name value.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT instance-ref (#PCDATA)>]]> -</para><para><programlisting><![CDATA[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>]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT content (content-type,content-uri)>]]> -</para><para><programlisting><![CDATA[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: - +<varlistentry><term><screen><![CDATA[ +<!ELEMENT page (page-name,properties?,listener?,security-constraint?,(page | window)*)>]]> +</screen></term> +<listitem> + <para> + 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. + </para> + <para> +<screen><![CDATA[ +<!ELEMENT page-name (#PCDATA)>]]> +</screen> + </para> + <para> + The page name value. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<!ELEMENT window (window-name,(instance-ref | content),region,height,properties?,listener?)>]]> +</screen></term> +<listitem> + <para> + 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. + </para> + <para> + 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. + </para> + <para> + The region and height defines how the window is placed in the page. + </para> + <para> +<screen><![CDATA[ +<!ELEMENT window-name (#PCDATA)>]]> +</screen> + </para> + <para> + The window name value. + </para> + <para> +<screen><![CDATA[ +<!ELEMENT instance-ref (#PCDATA)>]]> +</screen> + </para> + <para> + Define the content of the window as a reference to a portlet instance. The value is the id of the instance. + </para> + <para> + The following is an example of the <computeroutput>&lt;instance-ref&gt;</computeroutput> element: + </para> + <para> +<screen> +&lt;instance-ref&gt;MyPortletInstance&lt;/instance-ref&gt; +</screen> + </para> + <para> +<screen><![CDATA[ +<!ELEMENT region (#PCDATA)>]]> +</screen> + </para> + <para> + The region the window belongs to. + </para> + <para> +<screen><![CDATA[ +<!ELEMENT height (#PCDATA)>]]> +</screen> + </para> + <para> + The height of the window in the particular region. + </para> + <para> +<screen><![CDATA[ +<!ELEMENT listener (#PCDATA)>]]> +</screen> + </para> + <para> + Define a listener for a portal object. The value is the id of the listener. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<!ELEMENT content (content-type,content-uri)>]]> +</screen></term> +<listitem> + <para> + 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. + </para> + <para> + The following is an example of the <computeroutput>&lt;content&gt;</computeroutput> element: + </para> + <para> +<screen><![CDATA[ <content> <content-type>portlet</content-type> <content-uri>MyPortletInstance</content-uri> @@ -744,50 +794,74 @@ <content> <content-type>cms</content-type> <content-uri>/default/index.html</content-uri> -</content>]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT content-type (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The content type of the window.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT content-uri (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The content URI of the window.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT region (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The region the window belongs to.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT height (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The height of the window in the particular region.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT listener (#PCDATA)>]]> -</para><para><programlisting><![CDATA[Define a listener for a portal object. The value is the id of the listener.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT properties (property*)>]]> -</para><para><programlisting><![CDATA[A set of generic properties for the portal object.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT property (name,value)>]]> -</para><para><programlisting><![CDATA[A generic string property.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT name (#PCDATA)>]]> -</para><para><programlisting><![CDATA[A name value.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT value (#PCDATA)>]]> -</para><para><programlisting><![CDATA[A value.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT security-constraint (policy-permission*)>]]> -</para><para><programlisting><![CDATA[The security-constraint element is a container for policy-permission elements - -Examples: - +</content>]]> +</screen> + </para> + <para> +<screen><![CDATA[ +<!ELEMENT content-type (#PCDATA)>]]> +</screen> + </para> + <para> + The content type of the window. + </para> + <para> +<screen><![CDATA[ +<!ELEMENT content-uri (#PCDATA)>]]> +</screen> + </para> + <para> + The content URI of the window. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<!ELEMENT properties (property*)>]]> +</screen></term> +<listitem> + <para> + A set of generic properties for the portal object. + </para> + <para> +<screen><![CDATA[ +<!ELEMENT property (name,value)>]]> +</screen> + </para> + <para> + A generic string property. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<!ELEMENT name (#PCDATA)>]]> +</screen></term> +<listitem> + <para> + A name value. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<!ELEMENT value (#PCDATA)>]]> +</screen></term> +<listitem> + <para> + A value. + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<!ELEMENT security-constraint (policy-permission*)>]]> +</screen></term> +<listitem> + <para> + The security-constraint element is a container for policy-permission elements + </para> + <para> + The following is an example of the <computeroutput>&lt;security-constraint&gt;</computeroutput> element: + </para> + <para> +<screen><![CDATA[ <security-constraint> <policy-permission> <role-name>User</role-name> @@ -800,32 +874,55 @@ <unchecked/> <action-name>view</action-name> </policy-permission> -</security-constraint>]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT policy-permission (action-name*,unchecked?,role-name*)>]]> -</para><para><programlisting><![CDATA[The policy-permission element is used to secure a specific portal page based on a user's role.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT action-name (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The role-name element is used to define a role that this security constraint will apply to - - * <role-name>SOMEROLE</role-name> Access to this portal page is limited to the defined role.]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT unchecked EMPTY>]]> -</para><para><programlisting><![CDATA[The unchecked element is used to define (if present) that anyone can view this portal page]]></programlisting></para> -</listitem><listitem> -<para> -Element <![CDATA[<!ELEMENT role-name (#PCDATA)>]]> -</para><para><programlisting><![CDATA[The action-name element is used to define the access rights given to the role defined. -Possible values are: - - * view - Users can view the page.]]></programlisting></para> -</listitem></itemizedlist> - - </para> - </sect2> --> +</security-constraint>]]> +</screen> + </para> +</listitem> +</varlistentry> +<varlistentry><term><screen><![CDATA[ +<!ELEMENT policy-permission (action-name*,unchecked?,role-name*)>]]> +</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. + </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> +<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> +<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> +</listitem> +</varlistentry> +</variablelist> +</para> + </sect2> <sect2> <title>JBoss App DTD</title> <para>