Author: smeehan Date: 2008-12-03 01:35:00 -0500 (Wed, 03 Dec 2008) New Revision: 12333 Modified: docs/enterprise/trunk/UserGuide/en-US/Book_Info.xml docs/enterprise/trunk/UserGuide/en-US/JBoss_Portal_Basics.xml docs/enterprise/trunk/UserGuide/en-US/User_Role.xml Log: Revisions JBPORTAL-2198 Modified: docs/enterprise/trunk/UserGuide/en-US/Book_Info.xml =================================================================== --- docs/enterprise/trunk/UserGuide/en-US/Book_Info.xml 2008-12-03 05:07:04 UTC (rev 12332) +++ docs/enterprise/trunk/UserGuide/en-US/Book_Info.xml 2008-12-03 06:35:00 UTC (rev 12333) @@ -12,7 +12,7 @@ <abstract> <para>This document is intended for those using JBoss Portal as End-Users. This is a "Where do I Click?" Guide.</para> <para> - For Portlet developers, Portal administrators, and those wishing to implement/extend the JBoss + For Portlet developers, Portal administrators, and those wishing to extend and/or implement the JBoss Portal framework, there is a Reference Guide available from our <ulink url="http://labs.jboss.com/portal/jbossportal/docs/index.html"&... page</ulink> . Modified: docs/enterprise/trunk/UserGuide/en-US/JBoss_Portal_Basics.xml =================================================================== --- docs/enterprise/trunk/UserGuide/en-US/JBoss_Portal_Basics.xml 2008-12-03 05:07:04 UTC (rev 12332) +++ docs/enterprise/trunk/UserGuide/en-US/JBoss_Portal_Basics.xml 2008-12-03 06:35:00 UTC (rev 12333) @@ -10,7 +10,7 @@ <title>Portal Concepts - Illustrated</title> <para> - This section will introduce the reader to some basic portal terms and concepts used within JBoss Portal and thoughout this document. + This section will introduce the reader to some basic portal terms and concepts used within JBoss Portal and throughout this document. </para> @@ -109,34 +109,34 @@ </para> </listitem> </itemizedlist> - <table id="Table_1"> - <title>Window state icons and their meaning</title> - <tgroup cols="3"> - <colspec colname="c1" colnum="1" colwidth="1*"/> - <colspec colname="c2" colnum="2" colwidth="4*"/> - <colspec colname="c3" colnum="3" colwidth="4*"/> - <thead> - <row> - <entry> - Window State - </entry> - <entry> - Icon - </entry> - <entry> - Meaning - </entry> + <table id="Table_1"> + <title>Window state icons and their meaning</title> + <tgroup cols="3"> + <colspec colname="c1" colnum="1" colwidth="1*"/> + <colspec colname="c2" colnum="2" colwidth="4*"/> + <colspec colname="c3" colnum="3" colwidth="4*"/> + <thead> + <row> + <entry> + Window State + </entry> + <entry> + Icon + </entry> + <entry> + Meaning + </entry> - </row> - </thead> - <tbody> - <row> - <entry> - Normal - </entry> - <entry> - <mediaobject> - <imageobject> + </row> + </thead> + <tbody> + <row> + <entry> + Normal + </entry> + <entry> + <mediaobject> + <imageobject> <imagedata fileref="images/intro/ico_16_normal.gif" format="GIF"/> </imageobject> </mediaobject> @@ -144,9 +144,7 @@ <entry> - Normal window state, is the most common state for portlets (portlets in the - above image are in the normal window state). The portlet window will occupy only - enough space to show the portlet content on the page. + Normal window state, is the most common state for portlets (portlets in the above image are in the normal window state). The portlet window will occupy only enough space to show the portlet content on the page. </entry> @@ -183,28 +181,19 @@ <entry> The portlet window can occupy as much space of real estate on the page. </entry> - </row> - - + </row> </tbody> </tgroup> </table> - - - - - - - - + - <para> - <emphasis role="bold">Portlet Modes and their meaning:</emphasis> - Portlet modes are not always available (it depends on the portlet support for a given mode). - Moreover, the Edit mode is only available to logged-in users, as in this mode, the portlet - preferences can be modified to be individually suited to a particular user's needs. - </para> + <para> + <emphasis role="bold">Portlet Modes and their meaning:</emphasis> + Portlet modes are not always available (it depends on the portlet support for a given mode). + Moreover, the Edit mode is only available to logged-in users, as in this mode, the portlet + preferences can be modified to be individually suited to a particular user's needs. + </para> <itemizedlist> <listitem> <para> @@ -213,8 +202,8 @@ <imagedata fileref="images/intro/ico_edit.gif" format="GIF"/> </imageobject> </mediaobject> - <emphasis role="bold">(Edit)</emphasis> - - Only visible to logged-in users. Allows a logged-in user to customize the + <emphasis role="bold">Edit</emphasis> + : Only visible to logged-in users. Allows a logged-in user to customize the portlet's preferences. </para> </listitem> @@ -225,8 +214,8 @@ <imagedata fileref="images/intro/ico_cancel.gif" format="GIF"/> </imageobject> </mediaobject> - <emphasis role="bold">(Return to View mode)</emphasis> - - The button labeled 'Cancel' is only visible when a user is logged in and the + <emphasis role="bold">Return to View mode</emphasis> + : The button labeled 'Cancel' is only visible when a user is logged in and the portlet associated to the current window is in the Edit mode. This replaces the Edit button so the user understands that by clicking it the user will leave the "Edit mode" and revert back to "View mode". Portlets are by default in View @@ -241,7 +230,7 @@ </imageobject> </mediaobject> <emphasis role="bold">Help</emphasis> - - Allows a user to access useful information about the portlet. + : Allows a user to access useful information about the portlet. </para> </listitem> </itemizedlist> @@ -326,7 +315,7 @@ </para> <note> <para> - If you login as an administrator, you will also be presented with a link to the <emphasis>Admin</emphasis> portal. + If you login as an administrator, you will also be presented with a link to the <emphasis role="bold">Admin</emphasis> portal. </para> </note> @@ -358,7 +347,7 @@ <note> <para> Administrators should view <xref linkend="Portal_User_Guide-User_Role-Managing_Users"/> for managing the portal user base. Only user - operations are covered in this section...</para> + operations are covered in this section.</para> </note> <para> <mediaobject> @@ -386,7 +375,7 @@ <emphasis role="bold">Create a new account</emphasis> </para> <para> - Create a new account by clicking on the <emphasis>Register</emphasis> + Create a new account by clicking on the <emphasis role="bold">Register</emphasis> link in the navigation of the portlet. A user can then fill in the necessary information to create an account on the system: <mediaobject> @@ -402,7 +391,7 @@ <emphasis role="bold">Lost password</emphasis> </para> <para> - Already registered users can request a new password by clicking on the <emphasis>Lost password</emphasis> link + Already registered users can request a new password by clicking on the <emphasis role="bold">Lost password</emphasis> link in the navigation of the portlet. After entering your user name you will receive an e-mail with your new login credentials. </para> @@ -428,7 +417,7 @@ <emphasis role="bold">Edit personal information</emphasis> </para> <para>A user has the ability to edit their personal information, change their password and e-mail address at any time by clicking on the - <emphasis>Edit profile</emphasis> link, when logged in. + <emphasis role="bold">Edit profile</emphasis> link, when logged in. </para> </listitem> </itemizedlist> @@ -626,7 +615,7 @@ </imageobject> </mediaobject> - Click on <emphasis>submit</emphasis> + Click on <emphasis role="bold">submit</emphasis> <mediaobject> <imageobject> @@ -692,11 +681,11 @@ <para> You can select a theme and layout for your dashboard by selecting from the available ones and then - clicking on select in the <emphasis>Theme and Layout</emphasis> form. + clicking on select in the <emphasis role="bold">Theme and Layout</emphasis> form. </para> <para> You can also create new pages that will be added to your dashboard by simply entering the name of the new - page in the <emphasis>Create New Page</emphasis> form at the top left of the screen. + page in the <emphasis role="bold">Create New Page</emphasis> form at the top left of the screen. <note> <itemizedlist> <listitem> @@ -757,7 +746,7 @@ <para> The Admin Portal's purpose is to allow an administrator to manage all aspects of the portal. You <emphasis role="bold">must be</emphasis> logged in as an administrator, or have proper privileges - to see this portal.Follow the links for in-depth reviews of these functions: + to see this portal. Follow the links for in-depth reviews of these functions: <itemizedlist> <listitem> Modified: docs/enterprise/trunk/UserGuide/en-US/User_Role.xml =================================================================== --- docs/enterprise/trunk/UserGuide/en-US/User_Role.xml 2008-12-03 05:07:04 UTC (rev 12332) +++ docs/enterprise/trunk/UserGuide/en-US/User_Role.xml 2008-12-03 06:35:00 UTC (rev 12333) @@ -18,7 +18,7 @@ <title>Managing Users</title> <para> - This section covers the user management of the IdentityUserManagementPortlet which is displayed by default. + This section covers the user management of the <classname>IdentityUserManagementPortlet</classname> which is displayed by default. For role management please see <xref linkend="Portal_User_Guide-User_Role-Managing_Roles"/>. <mediaobject> @@ -77,7 +77,7 @@ <title>Updating User Profiles</title> <para> Clicking on the - <emphasis>Edit user</emphasis> + <emphasis role="bold">Edit user</emphasis> link on the search page will allow you to edit a user's profile data, and even reset his password. <mediaobject> @@ -100,7 +100,7 @@ <para> Clicking on the - <emphasis>Roles</emphasis> + <emphasis role="bold">Roles</emphasis> link in the search page allows you to modify the roles a specific user belongs to. <mediaobject> @@ -121,7 +121,7 @@ <title>Creating Users</title> <para> Clicking on the - <emphasis>Create User Account</emphasis> + <emphasis role="bold">Create User Account</emphasis> link on the main UserPortlet view, allows administrators to instantly create new users. <mediaobject> @@ -144,7 +144,7 @@ <para> - Click on the <emphasis>Show pending registrations</emphasis> link to show all registrations with validated e-mail addresses. + Click on the <emphasis role="bold">Show pending registrations</emphasis> link to show all registrations with validated e-mail addresses. You can approve or reject each user by clicking on the corresponding action or click on <emphasis>select all</emphasis> to approve or reject all selected users. </para> @@ -166,7 +166,7 @@ <note> <para> By default the subscription modes are set to <emphasis>automatic</emphasis> and users will be created automatically. Furthermore the - link to <emphasis>Show pending registrations</emphasis> will only be displayed if a user needs to be approved by the administrator. + link to <emphasis role="bold">Show pending registrations</emphasis> will only be displayed if a user needs to be approved by the administrator. </para> </note> </section> @@ -179,7 +179,7 @@ <title>Managing Roles</title> <para> - The User management portlet is also responsible to create and edit roles and it is accessible once logged in - as described in previously - when clicking on the <emphasis>role management</emphasis> + The User management portlet is also responsible to create and edit roles and it is accessible once logged in - as described in previously - when clicking on the <emphasis role="bold">role management</emphasis> link in the User management portlet. </para> @@ -217,7 +217,7 @@ <para> Creating new roles, is accomplished by first clicking on the - <emphasis>Create new role</emphasis> + <emphasis role="bold">Create new role</emphasis> link in the portlet. <mediaobject> <imageobject> @@ -245,7 +245,7 @@ <title>Edit a role</title> <para> - Editing roles is accomplished by clicking on <emphasis>Edit role</emphasis> in the row of the role you want to edit. + Editing roles is accomplished by clicking on <emphasis role="bold">Edit role</emphasis> in the row of the role you want to edit. <mediaobject> <imageobject> <imagedata fileref="images/role/edit_role.png" format="PNG" scalefit="1"/> @@ -266,7 +266,7 @@ <para> Editing role members is accomplished by first clicking the - <emphasis>Members</emphasis> + <emphasis role="bold">Members</emphasis> link at the role management page for the role you would like to modify. <mediaobject> @@ -290,7 +290,7 @@ <para> Deleting roles is accomplished by clicking the - <emphasis>Delete</emphasis> + <emphasis role="bold">Delete</emphasis> link for the role you would like to remove. </para>