Author: mmcallis Date: 2008-04-20 19:40:07 -0400 (Sun, 20 Apr 2008) New Revision: 10662 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.4.1. Defining a new Portal Page - changing zip to ZIP - adding more detailed steps for helloworldportalpage 6.4.1. Defining a new Portal Page Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml 2008-04-20 23:27:36 UTC (rev 10661) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml 2008-04-20 23:40:07 UTC (rev 10662) @@ -92,7 +92,7 @@ <orderedlist> <listitem> <para> - Change into the directory where the <filename>JBoss Portal Source Code</filename> zip file was extracted to, or where the source from SVN was checked out to. Copy the <filename>build/etc/local.properties-example</filename> file and save it as <filename>build/local.properties</filename>. + Change into the directory where the <filename>JBoss Portal Source Code</filename> ZIP file was extracted to, or where the source from SVN was checked out to. Copy the <filename>build/etc/local.properties-example</filename> file and save it as <filename>build/local.properties</filename>. </para> </listitem> <listitem> Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-04-20 23:27:36 UTC (rev 10661) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2008-04-20 23:40:07 UTC (rev 10662) @@ -20,7 +20,7 @@ </listitem> <listitem> <para> - <emphasis role="bold">Extract the bundle:</emphasis> extract the zip archive. It does not matter which directory is used. On Microsoft Windows, the recommended directory is <filename>C:\jboss-<replaceable>version-number</replaceable></filename>. + <emphasis role="bold">Extract the bundle:</emphasis> extract the ZIP archive. It does not matter which directory is used. On Microsoft Windows, the recommended directory is <filename>C:\jboss-<replaceable>version-number</replaceable></filename>. </para> </listitem> <listitem> @@ -62,7 +62,7 @@ <sect3 id="install_binarydownload"> <title>Getting the Binary</title> <para> - The binary download is available from the <ulink url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu... Portal Downloads</ulink> page. Look for the <computeroutput>JBoss Portal Binary</computeroutput> package. Once the binary zip file has been downloaded and extracted, the folder hierarchy will look similar to the following: + The binary download is available from the <ulink url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu... Portal Downloads</ulink> page. Look for the <computeroutput>JBoss Portal Binary</computeroutput> package. Once the binary ZIP file has been downloaded and extracted, the folder hierarchy will look similar to the following: </para> <para> <mediaobject> @@ -72,7 +72,7 @@ </mediaobject> </para> <para> - Files contained in this download are used in later sections. Download and extract the JBoss Portal binary zip file before proceeding. + Files contained in this download are used in later sections. Download and extract the JBoss Portal binary ZIP file before proceeding. </para> </sect3> <sect3> @@ -80,9 +80,9 @@ <para>Before deploying JBoss Portal, make sure you have JBoss EAP or JBoss AS installed. Customers who have access to the <ulink url="https://support.redhat.com/portal/login.html">JBoss Customer Support Portal (CSP)</ulink> are advised to download and install JBoss EAP 4.2. Customers who do not have access to the JBoss CSP are advised to use <ulink url="http://labs.jboss.com/jbossas/downloads/">JBoss AS</ulink>. For JBoss AS installation instructions, please refer to the <ulink url="http://labs.jboss.com/jbossas/docs/index.html">JBoss AS Installation Guide</ulink>. </para> <warning> - <title>Use the JBoss EAP and JBoss AS zip file</title> + <title>Use the JBoss EAP and JBoss AS ZIP file</title> <para> - Only use the JBoss EAP and JBoss AS zip file versions. <emphasis role="bold">DO NOT ATTEMPT to deploy JBoss Portal on the installer version of JBoss EAP or JBoss AS.</emphasis> + Only use the JBoss EAP and JBoss AS ZIP file versions. <emphasis role="bold">DO NOT ATTEMPT to deploy JBoss Portal on the installer version of JBoss EAP or JBoss AS.</emphasis> </para> </warning> </sect3> @@ -237,7 +237,7 @@ </itemizedlist> </para> <para> - After checking out the source from SVN, or after extracting the <filename>JBoss Portal Source Code</filename> zip file, a directory structure similar to the following will be created: + After checking out the source from SVN, or after extracting the <filename>JBoss Portal Source Code</filename> ZIP file, a directory structure similar to the following will be created: </para> <mediaobject> <imageobject> @@ -255,9 +255,9 @@ <para>Before deploying JBoss Portal, make sure you have JBoss EAP or JBoss AS installed. Customers who have access to the <ulink url="https://support.redhat.com/portal/login.html">JBoss Customer Support Portal (CSP)</ulink> are advised to download and install JBoss EAP 4.2. Customers who do not have access to the JBoss CSP are advised to use <ulink url="http://labs.jboss.com/jbossas/downloads/">JBoss AS</ulink>. For JBoss AS installation instructions, please refer to the <ulink url="http://labs.jboss.com/jbossas/docs/index.html">JBoss AS Installation Guide</ulink>. </para> <warning> - <title>Use the JBoss EAP and JBoss AS zip file</title> + <title>Use the JBoss EAP and JBoss AS ZIP file</title> <para> - Only use the JBoss EAP and JBoss AS zip file versions. <emphasis role="bold">DO NOT ATTEMPT to deploy JBoss Portal on the installer version of JBoss EAP or JBoss AS.</emphasis> We are currently working on aligning the Application installer with JBoss Portal. + Only use the JBoss EAP and JBoss AS ZIP file versions. <emphasis role="bold">DO NOT ATTEMPT to deploy JBoss Portal on the installer version of JBoss EAP or JBoss AS.</emphasis> We are currently working on aligning the Application installer with JBoss Portal. </para> </warning> </sect3> 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:27:36 UTC (rev 10661) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-20 23:40:07 UTC (rev 10662) @@ -1687,22 +1687,40 @@ <sect1 id="desc_examples"> <title>Descriptor Examples</title> <sect2 id="desc_example_page"> - <title>Defining a new portal page</title> - <para>This sample application and descriptor will create a new page, named - <emphasis>MyPage</emphasis> - in your portal. To illustrate our example, we have made available a portlet with a page descriptor that you - can download - here: - <ulink - url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_4/bundles... - >HelloWorld Page</ulink> - . - </para> - <note> - To use this example, simply extract the zip, and deploy the - <emphasis>helloworldportalpage.war</emphasis> - where your portal is running (hot-deployment supported). - </note> + <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. + </para> + <para> + To use the helloworldportalpage portlet: + </para> + <para> + <orderedlist> + <listitem> + <para> + Download the <ulink url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_4/bundles... portlet. + </para> + </listitem> + <listitem> + <para> + Unzip the <filename>HelloWorldPortalPage.zip</filename> ZIP file. + </para> + </listitem> + <listitem> + <para> + To expand the WAR file, which will give you access to the XML descriptors, change into the <filename>HelloWorldPortalPage/</filename> directory, and run the <command>ant explode</command> command. + </para> + </listitem> + <listitem> + <para> + If you did not expand the <filename>helloworldportalpage.war</filename> file, copy the <filename>helloworldportalpage.war</filename> file into the <filename>$JBOSS_HOME/server/default/deploy/</filename> directory. If you expanded the <filename>helloworldportalpage.war</filename> file, copy the <filename>HelloWorldPortalPage/output/lib/exploded/helloworldportalpage.war/</filename> directory into the <filename>$JBOSS_HOME/server/default/deploy/</filename> directory. + </para> + </listitem> + </orderedlist> + </para> + <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