Author: mmcallis Date: 2008-04-20 20:27:09 -0400 (Sun, 20 Apr 2008) New Revision: 10663 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.4.1. Defining a new Portal Page revising list *** this will breakt he book *** 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-20 23:40:07 UTC (rev 10662) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-21 00:27:09 UTC (rev 10663) @@ -327,7 +327,7 @@ </screen> </para> <para> - The <computeroutput>&lt;if-exists&gt;</computeroutput> element is used to define the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option maintains the existing object deployment, or creates a new one if it does not exist. + The <computeroutput>&lt;if-exists&gt;</computeroutput> element is defines the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option maintains the existing object deployment, or creates a new one if it does not exist. </para> </listitem> </varlistentry> @@ -525,7 +525,7 @@ </screen></term> <listitem> <para> - The <computeroutput>&lt;deployment&gt;</computeroutput> element is a generic container for portal object elements. The <computeroutput>&lt;parent-ref&gt;</computeroutput> child element gives the name of the parent object that the current object will use as parent. The optional <computeroutput>&lt;if-exists&gt;</computeroutput> element is used to define the action to take if an instance with the same name already exists. The default behavior of the <computeroutput>&lt;if-exists&gt;</computeroutput> element is to keep the existing object, and not to create a new object. + The <computeroutput>&lt;deployment&gt;</computeroutput> element is a generic container for portal object elements. The <computeroutput>&lt;parent-ref&gt;</computeroutput> child element gives the name of the parent object that the current object will use as parent. The optional <computeroutput>&lt;if-exists&gt;</computeroutput> element defines the action to take if an instance with the same name already exists. The default behavior of the <computeroutput>&lt;if-exists&gt;</computeroutput> element is to keep the existing object, and not to create a new object. </para> <para> The following is an example of the <computeroutput>&lt;deployment&gt;</computeroutput> and <computeroutput>&lt;parent-ref&gt;</computeroutput> elements: @@ -600,7 +600,7 @@ </screen> </para> <para> - The <computeroutput>&lt;if-exists&gt;</computeroutput> element is used to define the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option matains the existing object deployment, or creates a new one if it does not exist. + The <computeroutput>&lt;if-exists&gt;</computeroutput> element is defines the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option matains the existing object deployment, or creates a new one if it does not exist. </para> </listitem> </varlistentry> @@ -814,7 +814,7 @@ </screen></term> <listitem> <para> - A set of generic properties for the portal object. + A set of generic properties for the portal object. Property definitions specific to a page. This is commonly used to define the specific theme and layout to use. If not defined, the default portal theme and layout will be used. </para> <para> <screen><![CDATA[ @@ -1689,12 +1689,9 @@ <sect2 id="desc_example_page"> <title>Defining a new Portal Page</title> <para> - The sample application descriptor in this section creates a new page, <computeroutput>MyPage</computeroutput>, in your portal. To illustrate this example, download the <ulink url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_4/bundles... Page</ulink> portlet. + The sample application descriptor in this section creates a new page, <computeroutput>MyPage</computeroutput>, in your portal. To illustrate this example, download the <ulink url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_4/bundles... Page</ulink> portlet. To use the helloworldportalpage portlet: </para> <para> - To use the helloworldportalpage portlet: - </para> - <para> <orderedlist> <listitem> <para> @@ -1721,78 +1718,76 @@ <para> The helloworldportalpage portlet is hot-deployable, so the JBoss EAP or JBoss AS server do not have to be restarted. The following is an example of the <filename>helloworldportalpage.war/WEB-INF/helloworld-object.xml</filename> descriptor: </para> - <para>Our sample includes a descriptor to define this new portal page, - <emphasis>helloworld-object.xml</emphasis> - , located under - <emphasis>helloworldportalpage.war/WEB-INF/</emphasis> - , and it looks like this: - <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> + <para> +<screen><![CDATA[ +<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD Portal Object 2.6//EN" "http://www.jboss.org/portal/dtd/portal-object_2_6.dtd"> <deployments> <deployment> - <parent-ref>default</parent-ref> <if-exists>overwrite</if-exists> + <parent-ref>default</parent-ref> <properties/> <page> <page-name>MyPage</page-name> - <security-constraint> - <policy-permission> - <action-name>viewrecursive</action-name> - <unchecked/> - </policy-permission> - </security-constraint> <window> <window-name>HelloWorldPortletPageWindow</window-name> <instance-ref>HelloWorldPortletPageInstance</instance-ref> <region>center</region> <height>0</height> </window> + <security-constraint> + <policy-permission> + <unchecked/> + <action-name>viewrecursive</action-name> + </policy-permission> + </security-constraint> </page> </deployment> </deployments>]]> - </programlisting> +</screen> </para> - <para>A deployment file can be composed of a set of &lt;deployments&gt;. In our - example file, above, we are defining a page, placing the portlet as a window - on that page, and creating an instance of that portlet. You can then use the Management - Portlet (bundled with JBoss Portal) to modify the instances of this portlet, reposition - it, and so on...</para> <para> - <itemizedlist> + A depoloyment is composed of a single or multiple <computeroutput>&lt;deployments&gt;</computeroutput> elements, which are a container for the <computeroutput>&lt;deployment&gt;</computeroutput> element. In the previous example, a page is defined, the portlet is placed as a window on a page, and an instance of the portlet is created. The Mangement Portlet (bundled with JBoss Portal) can modify portal instances, page position, and so on. + </para> + <para> + The following list describes the elements in the <filename>helloworldportalpage.war/WEB-INF/helloworld-object.xml</filename> file: + <para> + <itemizedlist> + <listitem> +<screen> +&lt;if-exists&gt; +</screen> + <para> + The <computeroutput>&lt;if-exists&gt;</computeroutput> element is defines the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option matains the existing object deployment, or creates a new one if it does not exist. + </para> + </listitem> + <listitem> +<screen> +&lt;parent-ref&gt; +<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> + </listitem> + <listitem> +<screen> +&lt;properties&gt; +</screen> + <para> + A set of generic properties for the portal object. Property definitions specific to a page. This is commonly used to define the specific theme and layout to use. If not defined, the default portal theme and layout will be used. + </para> + </listitem> <listitem> - <emphasis role="bold">&lt;if-exists&gt;</emphasis> - Possible values are - <emphasis>overwrite</emphasis> - or - <emphasis>keep</emphasis> - . - <emphasis>Overwrite</emphasis> - Fwill destroy the existing object and create a - new one based on the content of the deployment. - <emphasis>Keep</emphasis> - will - maintain the existing objct deployment or create a new one if it does not yet - exist. +<screen> +&lt;page&gt; +</screen> + <para> + The start of a page definition. Among others, the <computeroutput>&lt;page&gt;</computeroutput> element is a container for the <computeroutput>&lt;page-name&gt;</computeroutput>, <computeroutput>&lt;window&gt;</computeroutput>, and <computeroutput>&lt;security-contraint&gt;</computeroutput> elements. + </para> </listitem> <listitem> - <emphasis role="bold">&lt;parent-ref&gt;</emphasis> - Indicates whether the - object should be hooked in to the portal tree. - </listitem> - <listitem> - <emphasis role="bold">&lt;properties&gt;</emphasis> - Properties definition - specific to this page, commonly used to define the specific theme and layout to - use. If not defined, the default portal layouts/theme combination will be used. - </listitem> - <listitem> - <emphasis role="bold">&lt;page&gt;</emphasis> - The start of a page - definition. - </listitem> - <listitem> <emphasis role="bold">&lt;page-name&gt;</emphasis> The name of the page. </listitem>