[portal-commits] JBoss Portal SVN: r7637 - docs/trunk/userGuide/en/modules.

Author: chris.laprun(a)jboss.com Date: 2007-06-29 02:22:42 -0400 (Fri, 29 Jun 2007) New Revision: 7637 Modified: docs/trunk/userGuide/en/modules/dynamicity.xml Log: - Added some missing content. - Improved existing content. - Added id to section for cross-referencing. - Fixed typos. Modified: docs/trunk/userGuide/en/modules/dynamicity.xml =================================================================== --- docs/trunk/userGuide/en/modules/dynamicity.xml 2007-06-29 05:50:39 UTC (rev 7636) +++ docs/trunk/userGuide/en/modules/dynamicity.xml 2007-06-29 06:22:42 UTC (rev 7637) @@ -36,14 +36,14 @@ user session. In order to see the changes on the affected pages, please log out and log back in. </note> </sect1> - <sect1> + <sect1 id="management_portlet"> <title>Management Portlet</title> <note>For the remainder of this chapter, the term <emphasis role="bold">object</emphasis> will be used to mean Portal, Page, Portlet, or Window indifferently. </note> <para> - The management portlet provides a two-part interface: tabs, corresponding to the different sections that - can be managed, at the top and the main area under it, displaying the current information for the selected + The management portlet provides a two-part interface: tabs, at the top, corresponding to the different sections + that can be managed; and the main area under it, displaying the current information for the selected tab. <mediaobject> <imageobject> @@ -54,20 +54,21 @@ <para> The tabs are: <itemizedlist> - <listitem><emphasis>Portal Objects</emphasis> gathering operations pertaining to managing Portals and their - pages. This is the most complex part of the interface.</listitem> + <listitem><emphasis>Portal Objects</emphasis> gathering operations pertaining to managing portal objects + (portal instances, pages, windows and their respective configuration information). This is the most + complex part of the interface.</listitem> <listitem><emphasis>Portlet Instances</emphasis> giving access to all the Portlet instances that have been configured.</listitem> <listitem><emphasis>Portlet Definitions</emphasis> giving access to the currently available portlet providers as well as the Portlets that each provider publishes.</listitem> - <listitem><emphasis>Dashboards</emphasis> allowing administrators to configure how Dashboards should berrorhandlingaehave. + <listitem><emphasis>Dashboards</emphasis> allowing administrators to configure how Dashboards should behave. </listitem> </itemizedlist> We will look at each of these tabs and their functionality in the following sections. </para> - <sect2> + <sect2 id="admin_portal_objects"> <title>Managing Portal Objects</title> - <sect3> + <sect3 id="portals_operations"> <title>Portals operations</title> <mediaobject> @@ -88,36 +89,42 @@ <para> A link to access server-wide portal properties is located right beneath the breadcrumbs. This allows - the administrator to set server-wide property and configure how errors should be handled. Please refer - to the <ulink url="http://docs.jboss.com/jbportal/v2.6/reference-guide/en/html/err... - handling chapter</ulink> of the Reference Guide for more information on this point. + the administrator to set server-wide property and configure how errors should be handled: <mediaobject> <imageobject> <imagedata fileref="images/management/portals_properties.png" format="png" align="center" valign="middle"/> </imageobject> </mediaobject> + Please refer to the + <ulink url="http://docs.jboss.com/jbportal/v2.6/reference-guide/en/html/err... + handling chapter</ulink> of the Reference Guide for more information on this point. </para> <para> A form allowing administrator to create new portal instances is located beneath the <literal>Properties</literal> link. Enter the name of the new portal (which, of course, should be - different from any of the already existing one) and click on <literal>Add portal</literal> and you'll - see a new line appear in the portal list located under the form. + different from any of the already existing one) and click on <literal>Add portal</literal> and the + portal instances list will be refreshed to display the newly created portal instance. </para> - <para>The last element of the top level of the <literal>Portal Objects</literal> tab is a table listing - all the available portal instances along with possible actions on them. Clicking on the portal name - will display a screen showing the information for this given portal instance, thus drilling down the - hierarchy of available portal objects.</para> + <para> + The last element of the top level of the <literal>Portal Objects</literal> tab is a table listing + all the available portal instances along with possible actions on them. Clicking on the portal name + will display a screen showing the information for this given portal instance, thus drilling down the + hierarchy of available portal objects. + </para> - <para>In the next sections we will drill down this hiearchy to look at the default portal and - one of its pages.</para> + <para> + In the next sections we will demonstrate the functionality of the management portlet by drilling + progressively further down this hiearchy to look at the default portal, one of its pages, show + how to configure content on a page and finally, look at a specific window information. + </para> </sect3> - <sect3> - <title>Looking at the default Portal</title> + <sect3 id="portal_instance_configuration"> + <title>Looking at a portal instance information</title> <para> If you click on the <literal>default</literal> portal in the list of available portal instances on the @@ -136,7 +143,7 @@ <para> Links to more information and operations that affect this portal instance are located beneath the breadcrumbs. We will look at them in turn later. - We won't look at the <literal>Destroy</literal> operation, which has its name implies, allows an + We won't look at the <literal>Destroy</literal> operation, which as its name implies, allows an administrator to destroy the current portal instance (after a confirmation screen, as the operation is <emphasis role="bold">NOT</emphasis> undoable). Note that these links mirror the links that were available in the portal instances list on the top level page. @@ -150,15 +157,15 @@ <para> It is also possible to designate one of the portal page as the default page that users are directed - to when the first access the portal instance. This is done by selecting the page via the page selection - drop-down menu and then click on <literal>Update</literal>. + to when they first access the portal instance. This is done by selecting the page via the page + selection drop-down menu and then click on <literal>Update</literal>. </para> <para> Finally, a table displaying the list of available pages for this portal instance is located at the bottom of this screen. The first column shows the page name, which you can click to drill down the hierachy and display the information specific to that particular page. The second column, on the other - hand, provides a list of links to more information on the associated page or actions on it. These links + hand, provides a list of action links on the associated page. These links will be also appearing on individual page screens, as we shall see, just like portal action links appearing in the portal instances list also appeared on individual portal pages. </para> @@ -166,8 +173,7 @@ <para> Let's now look at the default portal's <literal>Security</literal> information screen. This can be accessed by clicking the <literal>Security</literal> action link on the portal page. Here, an - administrator can configure the default policy for security on objects for this portal instance. Note - the breadcrumbs... + administrator can configure the default policy for security on objects for this portal instance: <mediaobject> <imageobject> <imagedata fileref="images/management/default_portal_security.png" format="png" align="center" @@ -175,14 +181,13 @@ </imageobject> </mediaobject> Please refer to the - <ulink - url="http://docs.jboss.com/jbportal/v2.6/reference-guide/en/html/sec... + <ulink url="http://docs.jboss.com/jbportal/v2.6/reference-guide/en/html/sec... chapter of the Reference Guide for more information about how to secure portal objects. </para> <para> The <literal>Properties</literal> action link displays the currently configured properties for this - portal instance and allows you to modify them, as well as configure the error handling strategy. + portal instance and allows you to modify them, as well as configure the error handling strategy: <mediaobject> <imageobject> <imagedata fileref="images/management/default_portal_properties.png" format="png" align="center" @@ -193,7 +198,7 @@ <para> The <literal>Theme</literal> action link displays a screen where the administrator can configure theme, - layout and render set for this portal instance. + layout and render set for this portal instance: <mediaobject> <imageobject> <imagedata fileref="images/management/default_portal_theme.png" format="png" align="center" @@ -206,13 +211,13 @@ </para> <para> - Now that we have look at portal level information, let's drill down the hierachy again and look at + Now that we have looked at portal level information, let's drill down the hierachy again and look at a page, more precisely the <literal>default</literal> page, by clicking its name in the pages list. </para> </sect3> - <sect3> - <title>Looking at the default Page of the default Portal</title> + <sect3 id="page_configuration"> + <title>Looking at a page configuration</title> <para> <mediaobject> @@ -221,7 +226,7 @@ valign="middle"/> </imageobject> </mediaobject> - The layout of this screen should start to be familiar. The information for a page looks a lot like the + The layout of this screen should start feeling familiar. The information for a page looks a lot like the information for a portal instance. Note the breadcrumbs indicating that you are indeed looking at a page. Again, we find the action links at the top of the page, mirroring the ones that were available for each page in the pages list of the portal instance screen. Once again, you can configure the page's @@ -229,6 +234,19 @@ </para> <para> + Similarly to other screens in the portal objects hierarchy, a page configuration screen also provides + a list of all windows for that page. This list contains two columns: the first one contains the + name of the window, while the second one provides a list of action links for that specific window. + As usual, clicking on a window name will display information about that window. + </para> + + <para> + Just like a portal instance can contain several pages, a page can contain several subpages. As such + a page defines means to create subpages and set which subpage to display when a user is first directed + to the page. These operations work similarly to the same operations at the portal instance level. + </para> + + <para> You can also rename the page if desired: <mediaobject> <imageobject> @@ -239,9 +257,9 @@ </para> <para> - Of specific interest, is the <literal>Page Layout</literal> link. This is where you need to go to - configure which portlet instance will be displayed in which window on which region on the page. Let's - take a look at this screen and how it works: + Of specific interest, though, is the <literal>Page Layout</literal> link. This is where you need to + go to configure which portlet instance will be displayed in which window on which region on the page. + Let's take a look at this screen and how it works: <mediaobject> <imageobject> <imagedata fileref="images/management/default_page_layout.png" format="png" align="center" @@ -285,14 +303,13 @@ </imageobject> </mediaobject> Note that we could move the window up or down in the region by selecting it in the list and using the - button to the right of the list, or even destroy the window. + button to the right of the list, or even destroy it if desired. </para> <para> We can repeat this process to add content of different types. Let's add a window using a Google widget - displaying the IP address of the user to the left region of the page. First, enter give a name to your - window (we'll use "google" here) and select <literal>widget/google</literal> from the content type - drop-down menu: + displaying the IP address of the user. First, give a name to your window (we'll use "google" here) + and select <literal>widget/google</literal> from the content type drop-down menu: <mediaobject> <imageobject> <imagedata fileref="images/management/layout_google1.png" format="png" align="center" @@ -300,14 +317,14 @@ </imageobject> </mediaobject> Note how the instances list is replaced by a list of Google widgets. The widget we want to use is - located in the <literal>Technology</literal> category so select it from the category drop-down menu: + located in the <literal>Technology</literal> category, so select it from the category drop-down menu: <mediaobject> - <imageobject> + <imageobject> <imagedata fileref="images/management/layout_google2.png" format="png" align="center" valign="middle"/> </imageobject> </mediaobject> - Press <literal>Search Gadgets</literal> and the widget list will be refreshed, select + Press <literal>Search Gadgets</literal> and the widget list will be refreshed. The widget we want is <literal>MyIP</literal>: <mediaobject> <imageobject> @@ -367,16 +384,9 @@ Integration</ulink> in the Reference Guide. More details on how to setup content roots in CMS are available in <xref linkend="cmsadmin"/>. </para> - - <para> - Pages information screens display a list of available windows for that page. Similarly to other - screens in the portal objects hierarchy, the list contains two columns: the first one contains the - name of the window, while the second one provides a list of action links for that specific window. - As usual, clicking on a window name will display information about that window. - </para> </sect3> - <sect3> + <sect3 id="window_configuration"> <title>Looking at windows of a given page</title> <para> Window operations are similar to the same operations at other level of the hierachy of portal objects. @@ -394,7 +404,7 @@ </para> </sect3> </sect2> - <sect2> + <sect2 id="admin_portlet_instances"> <title>Managing Portlet Instances</title> <para> The <literal>Portlet Instances</literal> tab brings the administrator to the list of instances created @@ -408,7 +418,7 @@ </mediaobject> </para> </sect2> - <sect2> + <sect2 id="admin_portlet_definitions"> <title>Managing Portlet Definitions</title> <para> The <literal>Portlet Definitions</literal> tab brings the administrator to the list of portlet @@ -427,15 +437,36 @@ </imageobject> </mediaobject> </para> + <para> + Portlet definitions can be made available by different providers. You can select the provider you want to + browse by selecting it in the drop-down menu and clicking <literal>Change</literal>. + By default, two providers are available: + <itemizedlist> + <listitem> + <emphasis>local</emphasis>: this is Portal's portlet container. Any successfully deployed portlet will + appear in the list of available portlet definitions for this provider. + </listitem> + <listitem> + <emphasis>self</emphasis>: this is Portal's default WSRP consumer configured to consume portlets + published by Portal's own WSRP producer. This doesn't have much practical interest apart from allowing + a quick test of the WSRP functionality of Portal. + </listitem> + </itemizedlist> + More providers can be added to this list. In particular, any active, properly configured WSRP consumer will + also appear in the drop-down menu. Please refer to the + <ulink url="http://docs.jboss.com/jbportal/v2.6/reference-guide/en/html/wsr... + remote WSRP portlets in JBoss Portal</ulink> chapter of the Reference Guide for more information on this + topic. + </para> </sect2> - <sect2> + <sect2 id="admin_dashboards"> <title>Managing Dashboards</title> <para> The <literal>Dashboards</literal> tab allows the administrator to configure parameters for all the user dashboards. It also allows her to configure the error pages and theme properties as for the other portal objects. </para> </sect2> - <sect2> + <sect2 id="admin_wizard"> <title>Wizard mode</title> <para> The wizard mode is a fast and easy way to create a new window on a page backed by a portlet instance.