Author: chris.laprun(a)jboss.com Date: 2007-06-29 01:16:03 -0400 (Fri, 29 Jun 2007) New Revision: 7635 Added: docs/trunk/userGuide/en/images/management/default_page_after.png docs/trunk/userGuide/en/images/management/google_window.png docs/trunk/userGuide/en/images/management/layout_cms1.png docs/trunk/userGuide/en/images/management/layout_cms2.png docs/trunk/userGuide/en/images/management/layout_content.png docs/trunk/userGuide/en/images/management/layout_final.png docs/trunk/userGuide/en/images/management/layout_google1.png docs/trunk/userGuide/en/images/management/layout_google2.png docs/trunk/userGuide/en/images/management/layout_google3.png docs/trunk/userGuide/en/images/management/layout_instance.png docs/trunk/userGuide/en/images/management/layout_region.png Modified: docs/trunk/userGuide/en/modules/dynamicity.xml Log: - Finished updating dynamicity chapter... That was a tough one and to think it's going to be redone again soon... :( Added: docs/trunk/userGuide/en/images/management/default_page_after.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/default_page_after.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/google_window.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/google_window.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/layout_cms1.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/layout_cms1.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/layout_cms2.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/layout_cms2.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/layout_content.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/layout_content.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/layout_final.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/layout_final.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/layout_google1.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/layout_google1.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/layout_google2.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/layout_google2.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/layout_google3.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/layout_google3.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/layout_instance.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/layout_instance.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/management/layout_region.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/layout_region.png ___________________________________________________________________ Name: svn:mime-type + image/png Modified: docs/trunk/userGuide/en/modules/dynamicity.xml =================================================================== --- docs/trunk/userGuide/en/modules/dynamicity.xml 2007-06-29 03:43:05 UTC (rev 7634) +++ docs/trunk/userGuide/en/modules/dynamicity.xml 2007-06-29 05:16:03 UTC (rev 7635) @@ -60,65 +60,155 @@ 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 behave. + <listitem><emphasis>Dashboards</emphasis> allowing administrators to configure how Dashboards should berrorhandlingaehave. </listitem> </itemizedlist> We will look at each of these tabs and their functionality in the following sections. </para> <sect2> <title>Managing Portal Objects</title> - <para> - TODO <sect3> <title>Portals operations</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/management/portals.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + <para> - <mediaobject> - <imageobject> - <imagedata fileref="images/management/portals.png" format="png" align="center" valign="middle"/> - </imageobject> - </mediaobject> + The <literal>Portal Objects</literal> brings the administrator to a page showing the list of the + available portal instances defined for this Portal server. Several points are of note. First, a + navigation indicator or "breadcrumbs" is located right beneath the tabs. This provides context as to + where in the hierarchy of portal objects the current screen is located as some of the screens can be + found at several levels of the hierarchy. If you are lost, take a look at the breadcrumbs for context! + When you first click on the <literal>Portal Objects</literal> tab, the context is the list of portals + as shown in the picture above. + </para> + <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. <mediaobject> <imageobject> <imagedata fileref="images/management/portals_properties.png" format="png" align="center" - valign="middle"/> + valign="middle"/> </imageobject> </mediaobject> - </para> + </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. + </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> </sect3> <sect3> <title>Looking at the default Portal</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/management/default_portal.png" format="png" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <para> + If you click on the <literal>default</literal> portal in the list of available portal instances on the + top-level <literal>Portal Objects</literal> page, you'll be taken to a page showing the information + for the portal instance named "default", as shown below: + <mediaobject> + <imageobject> + <imagedata fileref="images/management/default_portal.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + Note the breadcrumbs at the top of the screen indicating where in the hierachy you currently are. + In this case, we are looking at the default portal. + </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/management/default_portal_security.png" format="png" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <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 + 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. + </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/management/default_portal_properties.png" format="png" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <para> + It is possible to create new pages using the page creation form located under the portal-wide + operation links. Enter the new page name and click on <literal>Add</literal> and the new page will + appear in the pages list, ready to be configured. + </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/management/default_portal_theme.png" format="png" align="center" - valign="middle"/> - </imageobject> - </mediaobject> + <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>. + </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 + 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> + + <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... + <mediaobject> + <imageobject> + <imagedata fileref="images/management/default_portal_security.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/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. + <mediaobject> + <imageobject> + <imagedata fileref="images/management/default_portal_properties.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + </para> + + <para> + The <literal>Theme</literal> action link displays a screen where the administrator can configure theme, + layout and render set for this portal instance. + <mediaobject> + <imageobject> + <imagedata fileref="images/management/default_portal_theme.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/the... + and Themes</ulink> chapter of the Reference Guide for more information about themes and layouts. + </para> + + <para> + Now that we have look 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> @@ -127,25 +217,182 @@ <para> <mediaobject> <imageobject> - <imagedata fileref="images/management/default_page.png" format="png" align="center" valign="middle"/> + <imagedata fileref="images/management/default_page.png" format="png" align="center" + valign="middle"/> </imageobject> </mediaobject> + The layout of this screen should start to be 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 + security, theme and properties. You can also destroy it if so desired. + </para> + <para> + You can also rename the page if desired: <mediaobject> <imageobject> - <imagedata fileref="images/management/default_page_layout.png" format="png" align="center" valign="middle"/> + <imagedata fileref="images/management/default_page_rename.png" format="png" align="center" + valign="middle"/> </imageobject> </mediaobject> + </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: <mediaobject> <imageobject> - <imagedata fileref="images/management/default_page_rename.png" format="png" align="center" valign="middle"/> + <imagedata fileref="images/management/default_page_layout.png" format="png" align="center" + valign="middle"/> </imageobject> </mediaobject> + + This screen is structured in two parts, flowing from left to right, following the natural process + involved in displaying content on a page. First, you need to identify which content you want to + display: this is what the <literal>Content Definition</literal> section is for. Then, you need to + figure out where on the page should this content be displayed, hence the <literal>Page Layout</literal> + section. </para> + <para> + Let's add a window named <literal>test</literal> displaying the content of the portlet instance + named <literal>NewsPortletInstance</literal> to the center region, beneath the already existing + <literal>CMSWindow</literal>. + First, we need to enter our new window name in the <literal>Window name</literal> field and select + the <literal>portlet</literal> content type from the drop down menu: + <mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_content.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + Once this is done, we can select the portlet instance by clicking its name in the instances list: + <mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_instance.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + Note that this displays some information about the portlet instance. + Finally, we can add our window to the center region of the page by clicking on <literal>Add</literal> + button located left to the windows list for the region: + <mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_region.png" format="png" align="center" + valign="middle"/> + </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. + </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: + <mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_google1.png" format="png" align="center" + valign="middle"/> + </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: + <mediaobject> + <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 + <literal>MyIP</literal>: + <mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_google3.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + You can now add the new window to the desired region. + </para> + + <para> + Let's repeat this process again, this time with content from CMS. Enter a new window name (we'll + use "cms" here) and select <literal>cms</literal> from the content type drop-down menu: + <mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_cms1.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + Once again, the instances list was replaced by a directory listing showing the available content roots. + Click on <literal>default</literal> and select <literal>project.html</literal>: + <mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_cms2.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + You can now add the window to the desired region. + </para> + + <para> + We've added three new windows to the default page using different content types. We added a window + displaying the content of a portlet (displaying the content of an RSS feed in this case). Another one + displaying a Google widget and yet another one some CMS-issued content. We decided to remove the + existing <literal>CMSWindow</literal>, add the <literal>cms</literal> window below the + <literal>test</literal> one in the center region, while the window showing the Google widget was added + to the left region, below the existing content: + <mediaobject> + <imageobject> + <imagedata fileref="images/management/layout_final.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + If all went well, logging out of the Admin portal, you should see (IP address blurred to protect + the guilty ^_^): + <mediaobject> + <imageobject> + <imagedata fileref="images/management/default_page_after.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + </para> + + <para> + You can read more about + <ulink url="http://docs.jboss.com/jbportal/v2.6/reference-guide/en/html/con... + 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> - </para> + + <sect3> + <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. + The only information displayed when a window name is clicked in the windows list of a portal page + information screen is information about the content, similar to the one that is displayed in the + page layout screen. Thus, for the <literal>google</literal> window that we created in the previous + section: + <mediaobject> + <imageobject> + <imagedata fileref="images/management/google_window.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + Note, once again, the breadcrumbs... :) + </para> + </sect3> </sect2> <sect2> <title>Managing Portlet Instances</title> @@ -184,16 +431,17 @@ <sect2> <title>Managing Dashboards</title> <para> - The <literal>Dashboard</literal> tab allows the administrator to configure parameters for all the user dashboards. + 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> <title>Wizard mode</title> <para> - The wizard mode is a fast and easy way to create a new window on a page filled by a portlet instance. - The user just needs to define which portlet definition he wants, where does he want it and the wizard - will automatically create a new instance of portlet put it in a window and add that window to the region + The wizard mode is a fast and easy way to create a new window on a page backed by a portlet instance. + The user just needs to define which portlet definition to use, where should the instance be located + (portal / page / location on the page) and the wizard will automatically create a new instance of + the portlet, create a window for it and add that window to the specified region on the page defined by the user. <mediaobject> <imageobject>