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

Author: mmcallis Date: 2008-05-09 20:06:15 -0400 (Fri, 09 May 2008) New Revision: 10765 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml Log: 6.4.2. Defining a new Portal Instance - revising - making consistent with 6.4.1. Defining a new Portal Page 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-05-09 13:37:49 UTC (rev 10764) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-05-10 00:06:15 UTC (rev 10765) @@ -1670,7 +1670,7 @@ <sect2> <title>Log in to Dashboard</title> <para> - By default, when a user logs in, they are forwarded to the default page of the default portal. In order to + By default, when a user logs in they are forwarded to the default page of the default portal. In order to forward a user to their Dashboard, set the <computeroutput>core.login.namespace</computeroutput> value to <computeroutput>dashboard</computeroutput> in the <filename>jboss-portal.sar/conf/config.xml</filename> file: </para> <para> @@ -1714,7 +1714,7 @@ </orderedlist> </para> <para> - The HelloWorldPortalPage portlet is hot-deployable, so the JBoss EAP or JBoss AS server does not have to be restarted after deploying the HelloWorldPortalPage portlet. The following is an example of the <filename>helloworldportalpage.war/WEB-INF/helloworld-object.xml</filename> descriptor: + The HelloWorldPortalPage portlet is hot-deployable, so the JBoss EAP or JBoss AS server does not have to be restarted after deploying the HelloWorldPortalPage portlet. The following is an example of the <filename>HelloWorldPortalPage/WEB-INF/helloworld-object.xml</filename> descriptor: </para> <para> <screen><![CDATA[ @@ -1929,20 +1929,38 @@ </sect2> <sect2 id="desc_example_portal"> <title>Defining a new Portal Instance</title> - <para>To illustrate our example, we have made available a portlet that you can download - here: - <ulink - url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_4/bundles... - >HelloPortal</ulink> - . - </para> - <para>For our example we make available - <emphasis>helloworld-object.xml</emphasis> - located - under - <emphasis>helloworldportal.war/WEB-INF/</emphasis> - , and it looks like this: - <programlisting><![CDATA[ + <para> + The sample application descriptor in this section creates a new portal instance, <computeroutput>HelloPortal</computeroutput>, that contains two pages. To illustrate this example, download the <ulink url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_4/bundles... portlet. To use the HelloWorldPortal 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>HelloWorldPortal</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>HelloWorldPortal/</filename> directory, and run the <command>ant explode</command> command. + </para> + </listitem> + <listitem> + <para> + If you did not expand the <filename>helloworldportal.war</filename> file, copy the <filename>helloworldportal.war</filename> file into the correct JBoss AS or JBoss EAP <filename>deploy/</filename> directory. If you expanded the <filename>helloworldportal.war</filename> file, copy the <filename>HelloWorldPortal/output/lib/exploded/helloworldportal.war</filename> directory into the correct JBoss AS or JBoss EAP <filename>deploy/</filename> directory. For example, if you are using the <computeroutput>default</computeroutput> JBoss AS profile, copy the WAR file or the expanded directory into the <filename>$JBOSS_HOME/server/default/deploy/</filename> directory. + </para> + </listitem> + </orderedlist> + </para> + <para> + The HelloWorldPortal portlet is hot-deployable, so the JBoss EAP or JBoss AS server does not have to be restarted after deploying the HelloWorldPortal portlet. The following is an example of the HelloWorldPortal/WEB-INF/helloworld-object.xml descriptor: + </para> + <para> +<screen><![CDATA[ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD Portal Object 2.6//EN" @@ -2026,25 +2044,19 @@ </page> </deployment> </deployments>]]> - </programlisting> +</screen> </para> - <para>This example, when deployed, will register a new portal instance named - <literal>HelloPortal</literal> - with two pages in it. The portal instance can be - accessed by navigating to: - <ulink url="http://localhost:8080/portal/portal/HelloPortal" - >http://localhost:8080/portal/portal/HelloPortal</ulink> - for the default page, and - <ulink url="http://localhost:8080/portal/portal/HelloPortal/foobar" - >http://localhost:8080/portal/portal/HelloPortal/foobar</ulink> - , for the second page - created. - </para> - <note>You must define a page named - <literal>default</literal> - for any new portal instance - to be accessible via a web browser. - </note> + <para> + When deployed, this example registers a new portal instance, <computeroutput>HelloPortal</computeroutput>, that contains two pages. To view the default page in the <computeroutput>HelloPortal</computeroutput> instance, navigate to <ulink url="http://localhost:8080/portal/portal/HelloPortal" />, and to <ulink url="http://localhost:8080/portal/portal/HelloPortal/foobar" /> for the second page. + </para> + <para> + <note> + <title>Portal Instance <computerouput>default</computerouput> Page</title> + <para> + To be accessible via a Web browser, you must define a page named <computerouput>default</computerouput> for any portal instance. + </para> + </note> + </para> </sect2> </sect1> </chapter>