Author: mmcallis Date: 2008-04-20 21:19:51 -0400 (Sun, 20 Apr 2008) New Revision: 10666 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.4.1. Defining a new Portal Page finished adding content 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-04-21 01:02:11 UTC (rev 10665) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-21 01:19:51 UTC (rev 10666) @@ -1751,6 +1751,7 @@ </para> <para> The following list describes the elements in the <filename>helloworldportalpage.war/WEB-INF/helloworld-object.xml</filename> file: + </para> <para> <itemizedlist> <listitem> @@ -1764,7 +1765,7 @@ <listitem> <screen> &lt;parent-ref&gt; -<screen> +</screen> <para> The <computeroutput>&lt;parent-ref&gt;</computeroutput> element contains a reference to the parent object. The naming convention for naming objects is to concatenate the names of the path to the object, and separate the names using a period. If the path is empty, the empty string must be used. The <computeroutput>&lt;parent-ref&gt;</computeroutput> element tells the portal where the portlet appears. The syntax for the <computeroutput>&lt;parent-ref&gt;</computeroutput> element is <computeroutput><replaceable>portal-instance</replaceable>.<replaceable>portal-page</replaceable></computeroutput>. </para> @@ -1905,87 +1906,26 @@ </itemizedlist> </para> <para> - <screen><![CDATA[ - <!ELEMENT unchecked EMPTY>]]> - </screen> +<screen> +&lt;unchecked/&gt; +</screen> </para> <para> If present, the <computeroutput>&lt;unchecked&gt;</computeroutput> element defines that anyone can view the instance. </para> <para> - <screen><![CDATA[ - <!ELEMENT role-name (#PCDATA)>]]> - </screen> - </para> +<screen> +&lt;role-name&gt; +</screen> + </para> + <para> + The <computeroutput>&lt;role-name&gt;</computeroutput> element defines 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 the instance: + </para> <para> - The <computeroutput>&lt;role-name&gt;</computeroutput> element defines 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 the instance: - </para> - <para> - <screen><![CDATA[ - <role-name>EXAMPLEROLE</role-name>]]> - </screen> - </para> - - - - - - - - - - Takes the name of - the application followed by the name of the portlet, as defined in the - <emphasis>portlet.xml</emphasis> - </listitem> - <listitem> - <para> - <programlisting><![CDATA[<security-constraint> - <policy-permission> - <action-name>viewrecursive</action-name> - <unchecked/> - </policy-permission> -</security-constraint>]]></programlisting> - The security contraint portion is worth taking a look at, in an isolated fashion. It allows you to - secure a specific page/portal based on a user's role. - </para> - <para> - <emphasis role="bold">Role definition:</emphasis> - You must define a role that this security constraint will apply to. Possible values are: - <itemizedlist> - <listitem> - <emphasis role="bold">&lt;unchecked/&gt;</emphasis> - Anyone can view this page. - </listitem> - <listitem> - <emphasis role="bold">&lt;role-name&gt;SOMEROLE&lt;/role-name&gt;</emphasis> - Access to this page is limited to the defined role. - </listitem> - </itemizedlist> - <emphasis role="bold">Access Rights:</emphasis> - You must define the access rights given to the role defined. Possible values are: - <itemizedlist> - <listitem> - <emphasis role="bold">view</emphasis> - Users can view the page. - </listitem> - <listitem> - <emphasis role="bold">viewrecursive</emphasis> - Users can view the page and child pages. - </listitem> - <listitem> - <emphasis role="bold">personalize</emphasis> - Users are able to personalize the page's theme. - </listitem> - <listitem> - <emphasis role="bold">personalizerecursive</emphasis> - Users are able to personalize the page AND its children's themes. - </listitem> - </itemizedlist> - </para> - </listitem> - </itemizedlist> - </para> +<screen> +&lt;role-name&gt;EXAMPLEROLE&lt;/role-name&gt; +</screen> + </para> </sect2> <sect2 id="desc_example_portal"> <title>Defining a new portal instance</title>