[portal-commits] JBoss Portal SVN: r8597 - in docs: branches/JBoss_Portal_Branch_2_6/userGuide/en/modules and 2 other directories.

Author: chris.laprun(a)jboss.com Date: 2007-10-11 01:44:45 -0400 (Thu, 11 Oct 2007) New Revision: 8597 Added: docs/branches/JBoss_Portal_Branch_2_6/userGuide/en/images/management/portlet_details.png docs/trunk/userGuide/en/images/management/portlet_details.png Modified: docs/branches/JBoss_Portal_Branch_2_6/userGuide/en/modules/dynamicity.xml docs/trunk/userGuide/en/modules/dynamicity.xml Log: - Content update (text was not in synch with usability updates). - Added portlet details screenshot. - Fixed typos and grammar. Added: docs/branches/JBoss_Portal_Branch_2_6/userGuide/en/images/management/portlet_details.png =================================================================== (Binary files differ) Property changes on: docs/branches/JBoss_Portal_Branch_2_6/userGuide/en/images/management/portlet_details.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: docs/branches/JBoss_Portal_Branch_2_6/userGuide/en/modules/dynamicity.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/userGuide/en/modules/dynamicity.xml 2007-10-10 22:50:59 UTC (rev 8596) +++ docs/branches/JBoss_Portal_Branch_2_6/userGuide/en/modules/dynamicity.xml 2007-10-11 05:44:45 UTC (rev 8597) @@ -11,10 +11,10 @@ <sect1> <title>Introduction</title> <note>Viewing the Management Portlet is accomplished by logging in as an admin (admin/admin) and navigating to the - <xref linkend="adminportal"/>. + Admin portal (see <xref linkend="adminportal"/>). </note> <para> - The concept of dynamicity is that all portal objects are able to dynamically be modified at runtime, + The concept of dynamicity refers to the fact all portal objects can be dynamically modified at runtime, eliminating the need to struggle with large xml files, or restarting the application server for changes to take effect. In the scope of dynamicity, Portal objects are defined and can be altered as follows: <itemizedlist> @@ -31,7 +31,7 @@ portlet, allowing for dynamic customization of any of the above components.</listitem> </itemizedlist> </para> - <!-- + <!-- <note> Many of the operations that can be done via the Management portlet are done in the context of the current user session. In order to see the changes on the affected pages, please log out and log back in. @@ -81,7 +81,7 @@ <para> 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 + available portal instances defined for this Portal server. Several points are of particular interest. 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! @@ -106,21 +106,29 @@ <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 the + different from any of the already existing one) and click on <literal>Create 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 + The last element at this level 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. + hierarchy of available portal objects. Clicking on an action name will execute the specified action + on the associated portal instance. These actions are available on each individual portal screen as we + shall see. The notable exception is the <literal>Make Default/Default</literal> action which is only + available in this listing as it is more of an action across portals than specific to a portal thus + benefiting from being seen at this level. This action allows users to specify which portal instance + is displayed when Portal is first being accessed. Clicking on <literal>Make Default</literal> will + specify that the associated portal will be displayed to users by default. The portal list will be + refreshed and the selected portal status will be refreshed, its action now showing its + <literal>Default</literal> status. </para> <para> In the next sections we will demonstrate the functionality of the management portlet by drilling progressively further down this hierarchy 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. + how to configure content on a page and, finally, look at a specific window information. </para> </sect3> @@ -139,28 +147,22 @@ </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. + In this case, we are looking at the <literal>default</literal> portal. </para> <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 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. + affect this portal instance are located beneath the breadcrumbs. We will look at them in turn later, + excluding the <literal>Destroy</literal> operation, which as its name implies, allows an + administrator to destroy the current portal instance. Note that these links mirror the links that were + available in the portal instances list on the top level page, <literal>Make Default/Default</literal> + excepted. </para> <para> - It is also possible to designate one of the portal page as the default page that users are directed - to when they first access the portal instance. This is done by clicking on the <literal>Make Default</literal> - action. - </para> - - <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. + operation links. Enter the new page name and click on <literal>Create page</literal> and the new page + will appear in the pages list, ready to be configured. </para> <para> @@ -169,7 +171,10 @@ hierachy and display the information specific to that particular page. The second column, on the other 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. + appearing in the portal instances list also appeared on individual portal pages. Once again, the + <literal>Make Default/Default</literal> action, which behaves as its portal counterpart, only appears + in this list: this is where you specify which page should be the default one when users first access + the portal instance. </para> <para> @@ -183,7 +188,8 @@ </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> @@ -214,7 +220,7 @@ <para> 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. + a page, more precisely the <literal>default</literal> page, by clicking its name in the pages list. </para> </sect3> @@ -310,7 +316,7 @@ <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. First, give a name to your window (we'll use "google" here) + game. 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> @@ -321,7 +327,7 @@ Note how the instances list is replaced by a list of Google widgets. The widget we want to use is located in the <literal>Fun &amp; Games</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> @@ -410,7 +416,7 @@ <para> The <literal>Portlet Instances</literal> tab brings the administrator to the list of instances created in the running portal. On this page, the user can either modify the security constraints for the portlet - (to grant access only to certain roles), destoy an instance or override the portlet definition preferences + (to grant access only to certain roles), destroy an instance or override the portlet definition preferences for a specific instance if there is any overridable preference. <mediaobject> <imageobject> @@ -423,24 +429,14 @@ <title>Managing Portlet Definitions</title> <para> The <literal>Portlet Definitions</literal> tab brings the administrator to the list of portlet - definitions. The id represent the portlet definition identifier as used in the XML descriptor. - A more human readable name is following in the next column. For each portlet accessed through WSRP, - the <literal>remote</literal> checkbox is selected. A <literal>remotable</literal> checkbox is used to show which - portlet are exposed through WSRP to other consumers. + definitions, formatted as a table displaying name, description, whether the portlet is remote (i.e. accessed + via WSRP from a remote producer) or if it is remotable (i.e. if it is exposed to WSRP consumers by Portal's + producer). </para> + <para> - The <literal>Info</literal> action, will display the portlet definition title, description, supported languages - and keywords. The <literal>Preferences</literal> action is used to edit preferences at the portlet definition level - as explained in the JSR-168 specification. - <mediaobject> - <imageobject> - <imagedata fileref="images/management/portlets.png" format="png" align="center" valign="middle"/> - </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>. + browse by selecting it in the drop-down menu and clicking <literal>View portlets</literal>. By default, two providers are available: <itemizedlist> <listitem> @@ -458,12 +454,33 @@ <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. + <mediaobject> + <imageobject> + <imagedata fileref="images/management/portlets.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> </para> + + <para> + Clicking on a portlet name in the list will display the portlet definition title, description, supported + languages and keywords. + + <mediaobject> + <imageobject> + <imagedata fileref="images/management/portlet_details.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + + The <literal>Preferences</literal> action (when available) is used to edit preferences at the portlet + definition level as explained in the JSR-168 specification. + </para> + </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. + The <literal>Dashboards</literal> tab allows the administrator to configure parameters for all user dashboards. It also allows her to configure the error pages and theme properties as for the other portal objects. </para> </sect2> Added: docs/trunk/userGuide/en/images/management/portlet_details.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/management/portlet_details.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: docs/trunk/userGuide/en/modules/dynamicity.xml =================================================================== --- docs/trunk/userGuide/en/modules/dynamicity.xml 2007-10-10 22:50:59 UTC (rev 8596) +++ docs/trunk/userGuide/en/modules/dynamicity.xml 2007-10-11 05:44:45 UTC (rev 8597) @@ -11,10 +11,10 @@ <sect1> <title>Introduction</title> <note>Viewing the Management Portlet is accomplished by logging in as an admin (admin/admin) and navigating to the - <xref linkend="adminportal"/>. + Admin portal (see <xref linkend="adminportal"/>). </note> <para> - The concept of dynamicity is that all portal objects are able to dynamically be modified at runtime, + The concept of dynamicity refers to the fact all portal objects can be dynamically modified at runtime, eliminating the need to struggle with large xml files, or restarting the application server for changes to take effect. In the scope of dynamicity, Portal objects are defined and can be altered as follows: <itemizedlist> @@ -81,7 +81,7 @@ <para> 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 + available portal instances defined for this Portal server. Several points are of particular interest. 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! @@ -106,21 +106,29 @@ <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 the + different from any of the already existing one) and click on <literal>Create 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 + The last element at this level 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. + hierarchy of available portal objects. Clicking on an action name will execute the specified action + on the associated portal instance. These actions are available on each individual portal screen as we + shall see. The notable exception is the <literal>Make Default/Default</literal> action which is only + available in this listing as it is more of an action across portals than specific to a portal thus + benefiting from being seen at this level. This action allows users to specify which portal instance + is displayed when Portal is first being accessed. Clicking on <literal>Make Default</literal> will + specify that the associated portal will be displayed to users by default. The portal list will be + refreshed and the selected portal status will be refreshed, its action now showing its + <literal>Default</literal> status. </para> <para> In the next sections we will demonstrate the functionality of the management portlet by drilling progressively further down this hierarchy 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. + how to configure content on a page and, finally, look at a specific window information. </para> </sect3> @@ -139,28 +147,22 @@ </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. + In this case, we are looking at the <literal>default</literal> portal. </para> <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 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. + affect this portal instance are located beneath the breadcrumbs. We will look at them in turn later, + excluding the <literal>Destroy</literal> operation, which as its name implies, allows an + administrator to destroy the current portal instance. Note that these links mirror the links that were + available in the portal instances list on the top level page, <literal>Make Default/Default</literal> + excepted. </para> <para> - It is also possible to designate one of the portal page as the default page that users are directed - to when they first access the portal instance. This is done by clicking on the <literal>Make Default</literal> - action. - </para> - - <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. + operation links. Enter the new page name and click on <literal>Create page</literal> and the new page + will appear in the pages list, ready to be configured. </para> <para> @@ -169,7 +171,10 @@ hierachy and display the information specific to that particular page. The second column, on the other 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. + appearing in the portal instances list also appeared on individual portal pages. Once again, the + <literal>Make Default/Default</literal> action, which behaves as its portal counterpart, only appears + in this list: this is where you specify which page should be the default one when users first access + the portal instance. </para> <para> @@ -183,7 +188,8 @@ </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> @@ -310,7 +316,7 @@ <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. First, give a name to your window (we'll use "google" here) + game. 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> @@ -410,7 +416,7 @@ <para> The <literal>Portlet Instances</literal> tab brings the administrator to the list of instances created in the running portal. On this page, the user can either modify the security constraints for the portlet - (to grant access only to certain roles), destoy an instance or override the portlet definition preferences + (to grant access only to certain roles), destroy an instance or override the portlet definition preferences for a specific instance if there is any overridable preference. <mediaobject> <imageobject> @@ -423,24 +429,14 @@ <title>Managing Portlet Definitions</title> <para> The <literal>Portlet Definitions</literal> tab brings the administrator to the list of portlet - definitions. The id represent the portlet definition identifier as used in the XML descriptor. - A more human readable name is following in the next column. For each portlet accessed through WSRP, - the <literal>remote</literal> checkbox is selected. A <literal>remotable</literal> checkbox is used to show which - portlet are exposed through WSRP to other consumers. + definitions, formatted as a table displaying name, description, whether the portlet is remote (i.e. accessed + via WSRP from a remote producer) or if it is remotable (i.e. if it is exposed to WSRP consumers by Portal's + producer). </para> + <para> - The <literal>Info</literal> action, will display the portlet definition title, description, supported languages - and keywords. The <literal>Preferences</literal> action is used to edit preferences at the portlet definition level - as explained in the JSR-168 specification. - <mediaobject> - <imageobject> - <imagedata fileref="images/management/portlets.png" format="png" align="center" valign="middle"/> - </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>. + browse by selecting it in the drop-down menu and clicking <literal>View portlets</literal>. By default, two providers are available: <itemizedlist> <listitem> @@ -458,12 +454,33 @@ <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. + <mediaobject> + <imageobject> + <imagedata fileref="images/management/portlets.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> </para> + + <para> + Clicking on a portlet name in the list will display the portlet definition title, description, supported + languages and keywords. + + <mediaobject> + <imageobject> + <imagedata fileref="images/management/portlet_details.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + + The <literal>Preferences</literal> action (when available) is used to edit preferences at the portlet + definition level as explained in the JSR-168 specification. + </para> + </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. + The <literal>Dashboards</literal> tab allows the administrator to configure parameters for all user dashboards. It also allows her to configure the error pages and theme properties as for the other portal objects. </para> </sect2>