Author: smeehan
Date: 2008-12-03 00:07:04 -0500 (Wed, 03 Dec 2008)
New Revision: 12332
Modified:
docs/enterprise/trunk/UserGuide/en-US/Administration_CMS_Portlet.xml
docs/enterprise/trunk/UserGuide/en-US/Author_Group.xml
docs/enterprise/trunk/UserGuide/en-US/Book_Info.xml
docs/enterprise/trunk/UserGuide/en-US/Dynamicity.xml
docs/enterprise/trunk/UserGuide/en-US/JBoss_Portal_Basics.xml
docs/enterprise/trunk/UserGuide/en-US/Portal_User_Guide.ent
docs/enterprise/trunk/UserGuide/en-US/Portal_User_Guide.xml
docs/enterprise/trunk/UserGuide/en-US/Revision_History.xml
docs/enterprise/trunk/UserGuide/en-US/User_Role.xml
Log:
revisions JBPORTAL-2198
Modified: docs/enterprise/trunk/UserGuide/en-US/Administration_CMS_Portlet.xml
===================================================================
--- docs/enterprise/trunk/UserGuide/en-US/Administration_CMS_Portlet.xml 2008-12-03
05:04:12 UTC (rev 12331)
+++ docs/enterprise/trunk/UserGuide/en-US/Administration_CMS_Portlet.xml 2008-12-03
05:07:04 UTC (rev 12332)
@@ -3,14 +3,9 @@
]>
<chapter id="Portal_User_Guide-Test-Administration_CMS_Portlet">
- <title>Administration CMS Portlet</title>
+ <title>Administration Content Management System (CMS) Portlet</title>
-<section
id="Portal_User_Guide-Administration_CMS_Portlet-Administration_-_Content_Management_System">
- <title>Administration - Content Management System</title>
- <para>
- Test of a section
- </para>
-</section>
+
<section
id="Portal_User_Guide-Administration_-_Content_Management_System-Introduction">
<title>Introduction</title>
@@ -21,11 +16,11 @@
</para>
<para>
- Viewing the CMSAdmin Portlet is accomplished by logging in as an admin
(admin/admin) and navigating to the admin portal and then the CMS Page tab.
+ Viewing the CMSAdmin Portlet is accomplished by logging in as admin (admin/admin)
and navigating to the admin portal and then the CMS Page tab.
</para>
<para>
- You should then be presented with a page that is similar to this:
+ You will then be presented with a page that is similar to this:
</para>
<mediaobject>
@@ -90,7 +85,7 @@
</para>
<para>
- Version and Locale Information are also contained on this screen. Note that any
version labeled with the
+ Version and Locale Information are also contained on this screen. Note that any
version labeled with a
<mediaobject>
<imageobject>
@@ -118,7 +113,7 @@
<para>
The copy resource window allows a user to copy files to any folder on the system,
as well as copy whole directory trees to any directory on the system. A user can select
which
- destination directory to copy the resource to, by using the directory browser.
Clicking the
+ destination directory to copy the resource to by using the directory browser.
Clicking the
<mediaobject>
<imageobject>
@@ -126,7 +121,7 @@
</imageobject>
</mediaobject>
- icon expands the directory tree. Clicking on the name of the directory within the
tree, sets it as the destination directory for the copied resource.
+ icon expands the directory tree. Clicking on the name of the directory within the
tree sets it as the destination directory for the copied resource.
</para>
</section>
@@ -155,7 +150,7 @@
</imageobject>
</mediaobject>
- icon expands the directory tree. Clicking on the name of the directory within the
tree, sets it as the destination directory for the moved resource.
+ icon expands the directory tree. Clicking on the name of the directory within the
tree sets it as the destination directory for the moved resource.
</para>
@@ -176,7 +171,7 @@
</mediaobject>
<para>
- The delete resource confirmation window allows a user to delete a file, or a
directory on the system. Note that deleting a directory, will delete the entire tree, so
all directories under the deleted one, will also be deleted.
+ The delete resource confirmation window allows a user to delete a file or a
directory on the system. Note that deleting a directory will delete the entire tree, so
all directories under the deleted one will also be deleted.
</para>
@@ -250,10 +245,10 @@
icon.
</para>
- <note>
+ <important>
<para>
- It is important to note here that when creating links to images or other
resources within the system, as user must use the relative file path to that resource. ie:
images/hello.gif. Keep in mind at all times that the document base is
http://localhost/portal/ by default!</para>
- </note>
+ It is important to note here that when creating links to images or other
resources within the system, a user must use the relative file path to that resource. ie:
images/hello.gif. Keep in mind at all times that the document base is
http://localhost/portal/ by default!</para>
+ </important>
<para>
Additionally, a user can set a title for the file that will be used in the
portlet title bar, and a language for the file, used in serving localized content.
@@ -316,8 +311,8 @@
</section>
- <section id="Portal_User_Guide-Actions-Exportig_Folders">
- <title>Exporting folders</title>
+ <section id="Portal_User_Guide-Actions-Exporting_Folders">
+ <title>Exporting Folders</title>
<para>
@@ -343,11 +338,11 @@
icon expands the directory tree. Clicking on the name of the directory within the
tree, sets it as the source directory for the export resource. Additionally, a user can
set a language for the files to be exported.
</para>
- <note>
+ <important>
<para>
Version information is not exported. Only versions labeled "Live" are
exported!
</para>
- </note>
+ </important>
</section>
@@ -415,7 +410,7 @@
</mediaobject>
</para>
<para>
- You should then be presented with a screen that allows you to assign read, write,
and manage priviledges on the selected node for selected Roles or specific Users.
+ You should then be presented with a screen that allows you to assign read, write,
and manage privileges on the selected node for selected Roles or specific Users.
<mediaobject>
<imageobject>
@@ -440,7 +435,7 @@
</listitem>
</itemizedlist>
- Adminsitrating and assigning permissions on a selected node is as simple as
selecting which Roles and/or Users you want to allow to have a specific permission.
+ Administrating and assigning permissions on a selected node is as simple as
selecting which Roles and/or Users you want to allow to have a specific permission.
</para>
</section>
Modified: docs/enterprise/trunk/UserGuide/en-US/Author_Group.xml
===================================================================
--- docs/enterprise/trunk/UserGuide/en-US/Author_Group.xml 2008-12-03 05:04:12 UTC (rev
12331)
+++ docs/enterprise/trunk/UserGuide/en-US/Author_Group.xml 2008-12-03 05:07:04 UTC (rev
12332)
@@ -4,33 +4,25 @@
<authorgroup>
<author>
- <firstname>Roy</firstname>
- <surname>Russo</surname>
- <affiliation>
- <orgname>JBoss</orgname>
- <orgdiv>Best Div in the place</orgdiv>
- </affiliation>
- <email>roy(a)jboss.org</email>
- </author>
-
- <author>
<firstname>Chris</firstname>
<surname>Laprun</surname>
- <affiliation>
- <orgname>JBoss</orgname>
- <orgdiv>Best Div in the place</orgdiv>
- </affiliation>
<email>chris.laprun(a)jboss.com</email>
</author>
+
<author>
<firstname>Emanuel</firstname>
- <surname>Muckenhuber</surname>
- <affiliation>
- <orgname>JBoss</orgname>
- <orgdiv>Best Div in the place</orgdiv>
- </affiliation>
+ <surname>Muckenhuber</surname>
<email>emuckenh(a)redhat.com</email>
</author>
+
+ <author>
+ <firstname>Roy</firstname>
+ <surname>Russo</surname>
+ <email>roy(a)jboss.org</email>
+ </author>
+
+
+
Modified: docs/enterprise/trunk/UserGuide/en-US/Book_Info.xml
===================================================================
--- docs/enterprise/trunk/UserGuide/en-US/Book_Info.xml 2008-12-03 05:04:12 UTC (rev
12331)
+++ docs/enterprise/trunk/UserGuide/en-US/Book_Info.xml 2008-12-03 05:07:04 UTC (rev
12332)
@@ -4,10 +4,10 @@
<bookinfo id="Portal_User_Guide-Documentation">
<title>Portal User Guide</title>
- <subtitle>short descriptor</subtitle>
+
<productname>JBoss</productname>
<productnumber>0.1</productnumber>
- <edition>0</edition>
+ <edition>1</edition>
<pubsnumber>0</pubsnumber>
<abstract>
<para>This document is intended for those using JBoss Portal as End-Users. This
is a "Where do I Click?" Guide.</para>
Modified: docs/enterprise/trunk/UserGuide/en-US/Dynamicity.xml
===================================================================
--- docs/enterprise/trunk/UserGuide/en-US/Dynamicity.xml 2008-12-03 05:04:12 UTC (rev
12331)
+++ docs/enterprise/trunk/UserGuide/en-US/Dynamicity.xml 2008-12-03 05:07:04 UTC (rev
12332)
@@ -3,38 +3,41 @@
]>
<chapter id="Portal_User_Guide-Dynamicity">
- <title>Administration - Portal Object Management (Dynamcity)</title>
+ <title>Administration - Portal Object Management (Dynamicity)</title>
<section id="Portal_User_Guide-Dynamacity-Introduction">
<title>Introduction</title>
- <note>
- <para>
- Viewing the Management Portlet is accomplished by logging in as an admin
(admin/admin) and navigating to the Admin portal (see linkcommentedout <!-- <xref
linkend="adminportal"/> -->).</para>
- </note>
+
- <para>
+ <para>
- 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:
+ 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>
- <listitem>
- <para>Portal Instances: Multiple Portal instances can be launched at any
time, secured, and skinned.</para></listitem>
- <listitem><para>Pages: Multiple pages, composed of windows, can
coexist inside a portal instance, secured and each
- could have its own theme applied, if desired.</para></listitem>
- <listitem><para>Portlets: Can be hot-deployed and will instantly
register with the portal, appearing in the
- management portlet.</para></listitem>
- <listitem><para>Portlet Instances: Instances can be
created/destroyed. Their preference variables can be modified
- at runtime, instances assigned to windows and
secured.</para></listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Portal Instances: Multiple Portal instances can be launched at any
time, secured, and skinned.</para></listitem>
+ <listitem><para>Pages: Multiple pages, composed of windows, can
securely coexist inside a portal instance. Each
+ could have its own theme applied, if desired.</para></listitem>
+ <listitem><para>Portlets: Can be hot-deployed and will instantly
register with the portal, appearing in the
+ management portlet.</para></listitem>
+ <listitem><para>Portlet Instances: Instances can be
created/destroyed. Instance preference variables can be modified
+ at runtime, assigned to windows and secured.</para></listitem>
<listitem><para>Windows: Windows can be secured,
created/destroyed, and assigned to specific pages.</para></listitem>
- <listitem><para>Themes/Layouts: Can be hot-deployed and will
register with the portal, appearing the management
+ <listitem><para>Themes/Layouts: Can be hot-deployed and will
register with the portal. They appear in the management
portlet, allowing for dynamic customization of any of the above
components.</para>
</listitem>
</itemizedlist>
</para>
- <!--
+ <note>
+ <para>
+ Viewing the Management Portlet is accomplished by logging in as an admin
(admin/admin) and navigating to the Admin portal (see <xref
linkend="Portal_User_Guide-JBoss_Portal_Basics-Admin_Portal"/>).
+ </para>
+ </note>
+
+ <!--
<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.
@@ -47,16 +50,18 @@
<title>Management Portlet</title>
- <note>
+
<para>
+ The management portlet provides a two-part interface: tabs at the top which
correspond to the different sections
+ that can be managed; and the main area under it, which displays the current
information for the selected tab.
+ </para>
+ <note>
+ <para>
For the remainder of this chapter, the term <emphasis
role="bold">object</emphasis> will be used to mean
Portal, Page, Portlet, or Window indifferently.
</para>
- </note>
- <para>
- 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.
-
+ </note>
+ <para>
<mediaobject>
<imageobject>
<imagedata fileref="images/intro/adminportal.png"
format="PNG" scalefit="1"/>
@@ -68,18 +73,18 @@
<itemizedlist>
<listitem>
- <para><emphasis>Portal Objects</emphasis> gathering
operations pertaining to managing portal objects
+ <para><emphasis role="bold">Portal
Objects</emphasis> gather operations pertaining to managing portal objects
(portal instances, pages, windows and their respective configuration
information). This is the most
complex part of the interface.</para>
</listitem>
- <listitem><para><emphasis>Portlet Instances</emphasis>
giving access to all the Portlet instances that have been
+ <listitem><para><emphasis role="bold">Portlet
Instances</emphasis> give access to all the Portlet instances that have been
configured.</para>
</listitem>
- <listitem><para><emphasis>Portlet
Definitions</emphasis> giving access to the currently available portlet
+ <listitem><para><emphasis role="bold">Portlet
Definitions</emphasis> give access to the currently available portlet
providers as well as the Portlets that each provider publishes.</para>
</listitem>
<listitem>
- <para><emphasis>Dashboards</emphasis> allowing
administrators to configure how Dashboards should behave.</para>
+ <para><emphasis role="bold">Dashboards</emphasis>
allow administrators to configure how Dashboards should behave.</para>
</listitem>
</itemizedlist>
@@ -90,7 +95,7 @@
<section
id="Portal_User_Guide-Management_Portlet-Managing_Portal_Objects">
- <title>Magaging Portal Objects</title>
+ <title>Managing Portal Objects</title>
@@ -106,12 +111,12 @@
</mediaobject>
<para>
- The <literal>Portal Objects</literal> brings the administrator to a
page showing the list of the
+ <emphasis role="bold">Portal Objects</emphasis> brings the
administrator to a page displaying a list of the
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!
- When you first click on the <literal>Portal Objects</literal> tab,
the context is the list of portals
+ where in the hierarchy of portal objects the current screen is located. Some of
the screens can be
+ found at several levels of the hierarchy. If you are lost, refer to the
breadcrumbs for context.
+ When you first click on the <emphasis role="bold">Portal
Objects</emphasis> tab, the context is the list of portals
as shown in the picture above.
</para>
@@ -146,9 +151,9 @@
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
+ available in this listing as it is more of an action across portals than to a
specific 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
+ is displayed when the 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.
@@ -157,7 +162,7 @@
<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 specific window
information.
</para>
</section>
@@ -166,7 +171,7 @@
<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
+ top-level <literal>Portal Objects</literal> page, you will be taken
to a page showing the information
for the portal instance named "default", as shown below:
<mediaobject>
@@ -175,7 +180,7 @@
</imageobject>
</mediaobject>
- Note the breadcrumbs at the top of the screen indicating where in the hierachy
you currently are.
+ Note the breadcrumbs at the top of the screen indicating where in the hierarchy
you currently are.
In this case, we are looking at the <literal>default</literal>
portal.
</para>
@@ -197,7 +202,7 @@
<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
+ hierarchy 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.
Once again, the
@@ -270,7 +275,7 @@
</para>
<para>
- Now that we have looked 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
hierarchy again and look at
a page, more precisely the <literal>default</literal> page, by
clicking its name in the pages list.
</para>
</section>
@@ -300,7 +305,7 @@
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.
+ Clicking on a window name will display information about that window.
</para>
<para>
@@ -360,7 +365,7 @@
</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>
+ Finally, we can add our window to the center region of the page by clicking on
the <literal>Add</literal>
button located left to the windows list for the region:
<mediaobject>
@@ -459,7 +464,7 @@
Integration
</ulink>
- in the Reference Guide. More details on how to setup content roots in CMS are
available in linkcommentedout <!-- <xref linkend="cmsadmin"/> -->.
+ in the Reference Guide. More details on how to setup content roots in CMS are
available in <xref
linkend="Portal_User_Guide-Administration_-_Content_Management_System-Introduction"/>.
</para>
</section>
@@ -469,7 +474,7 @@
<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.
+ Window operations are similar to the same operations at other level of the
hierarchy 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
@@ -481,7 +486,7 @@
</imageobject>
</mediaobject>
- Note, once again, the breadcrumbs... :)
+
</para>
</section>
</section>
@@ -509,8 +514,8 @@
<para>
The <literal>Portlet Definitions</literal> tab brings the
administrator to the list of portlet
- 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
+ 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>
@@ -521,11 +526,11 @@
<itemizedlist>
<listitem>
- <para><emphasis>local</emphasis>: this is Portal's
portlet container. Any successfully deployed portlet will
+ <para><emphasis role="bold">local</emphasis>:
this is Portal's portlet container. Any successfully deployed portlet will
appear in the list of available portlet definitions for this
provider.</para>
</listitem>
<listitem>
- <para><emphasis>self</emphasis>: this is Portal's
default WSRP consumer configured to consume portlets
+ <para><emphasis role="bold">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.</para>
</listitem>
@@ -567,7 +572,7 @@
<para>
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.
+ It also allows the user to configure the error pages and theme properties as for
the other portal objects.
</para>
</section>
@@ -577,8 +582,8 @@
<para>
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 user just needs to define which portlet definition to use and where the
instance should be located
+ (portal / page / location on the page. 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.
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:04:12 UTC
(rev 12331)
+++ docs/enterprise/trunk/UserGuide/en-US/JBoss_Portal_Basics.xml 2008-12-03 05:07:04 UTC
(rev 12332)
@@ -4,15 +4,13 @@
<chapter id="Portal_User_Guide-JBoss_Portal_Basics">
<title>JBoss Portal Basics</title>
- <para>
- This is a test paragraph
- </para>
+
<section id="Portal_User_Guide-JBoss_Portal_Basics-Portal_Concepts">
<title>Portal Concepts - Illustrated</title>
<para>
- This section will introduce the reader to some basic portal concepts and terms,
used within JBoss Portal and this document.
+ This section will introduce the reader to some basic portal terms and concepts
used within JBoss Portal and thoughout this document.
</para>
@@ -21,7 +19,7 @@
<title>Portal Instances</title>
<para>
- JBoss Portal supports multiple portal instances running within one container. A
portal instance can be viewed as a 'bucket', containing portal objects such as,
Portal Pages, Themes, Layouts, and Portlet Windows. It also manages the relationship
between the user and the portal itself. The hierarchy of portal objects is depicted as
follows:
+ JBoss Portal supports multiple portal instances running within one container. A
portal instance can be viewed as a 'bucket', containing portal objects such as
Portal Pages, Themes, Layouts, and Portlet Windows. It also manages the relationship
between the user and the portal itself. The hierarchy of portal objects is depicted in the
following diagram:
<mediaobject>
<imageobject>
@@ -34,43 +32,38 @@
<para>
A portal instance is
reachable by the url format
- <emphasis>http://[domain]/[context]/portal/[portal_name]</emphasis>.
In a default/local install, the
+ <emphasis>http://<replaceable>[domain]</replaceable>/<replaceable>[context]</replaceable>/portal/<replaceable>[portal_name]</replaceable></emphasis>.
In a default/local install, the
<emphasis>default</emphasis>
portal instance can be reached at
- <ulink
url="http://localhost:8080/portal/portal/default">http://localhost:8080/portal/portal/default</ulink>
+
http://localhost:8080/portal/portal/default.Consult your portal administrator for
information on the available portal instances - some of which may have restricted logins.
.
</para>
- <note>
- <para> Consult your portal administrator for information on the available
portal instances - some of which may have restricted logins, not found in others.
- </para>
- </note>
-
</section>
- <section id="Portal_User_Guide-Portal_Concepts-Portal_Images">
+ <section id="Portal_User_Guide-Portal_Concepts-Portal_Pages">
<title>Pages</title>
<para>
- A Portal Page is an aggregator of Portlet Windows. It is generated by the portal,
during the reponse phase. During this phase, the portal aggregates all of the HTML markup
created the individual portlets, decorates them with window controls, and presents them to
the user as a consolidated page.
+ A Portal Page is an aggregator of Portlet Windows. It is generated by the portal,
during the response phase. During this phase, the portal aggregates all of the HTML markup
created by the individual portlets, decorates them with window controls, and presents them
to the user as a consolidated page.
</para>
<para>
A portal page is reachable by the url format
- <emphasis>http://[domain]/[context]/portal/[portal_name]/[page_name]</emphasis>.
In a default/local install, the
+ <emphasis>http://<replaceable>[domain]</replaceable>/<replaceable>[context]</replaceable>/portal/<replaceable>[portal_name]</replaceable>/<replaceable>[page_name]</replaceable></emphasis>.
In a default/local install, the
<emphasis>default</emphasis>
page can be reached at
- <ulink url="http://localhost:8080/portal/portal/default">
+
http://localhost:8080/portal/portal/default/default
- </ulink>
+
. Likewise, the News Page in a default install can be reached at
- <ulink url="http://localhost:8080/portal/portal/default/News">
+
http://localhost:8080/portal/portal/default/News
- </ulink>
+
</para>
<para>
More, on navigating the portal pages and what they contain can be found in,
- linkcommentedout <!-- <xref linkend="contents_pages"/> -->
+ <xref
linkend="Portal_User_Guide-JBoss_Portal_Basics-Contents_Pages"/>
</para>
</section>
@@ -86,10 +79,10 @@
</imageobject>
</mediaobject>
- The diagram above, shows the default JBoss Portal page with certain
window-related items highlighted (in red).
+ The diagram above shows the default JBoss Portal page with certain
window-related items highlighted (in red).
Lets look at these items:
-
+ </para>
<itemizedlist>
<listitem>
<para>
@@ -112,56 +105,106 @@
will take on the page and how much markup will be shown.
<emphasis role="bold">Portlet Mode</emphasis> icons,
on the other hand, control the mode in which
the portlet operates, thus impacting the type of generated markup. Note that
not all portlets
- support all defined window states and/or portlet modes.
- <itemizedlist>
- <listitem>
- <para>
- <emphasis role="bold">Window State icons and their
meaning:</emphasis>
- <itemizedlist>
- <listitem>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/intro/ico_16_normal.gif"
format="GIF"/>
- </imageobject>
- </mediaobject>
- <emphasis role="bold">(Normal)</emphasis>
- - 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.
- </para>
- </listitem>
- <listitem>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/intro/ico_16_minimize.gif"
format="GIF"/>
- </imageobject>
- </mediaobject>
- <emphasis role="bold">(Minimized)</emphasis>
- - The portlet is instructed to render minimal-to-no markup.
- </para>
- </listitem>
- <listitem>
- <para>
+ support all defined window states and/or portlet modes. The table below
explains the different Window State icons and their meaning.
+ </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>
+
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ Normal
+ </entry>
+ <entry>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/ico_16_normal.gif"
format="GIF"/>
+ </imageobject>
+ </mediaobject>
+ </entry>
+
+
+ <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.
+ </entry>
+
+
+
+ </row>
+ <row>
+ <entry>
+ Minimized
+ </entry>
+ <entry>
<mediaobject>
<imageobject>
+ <imagedata fileref="images/intro/ico_16_minimize.gif"
format="GIF"/>
+ </imageobject>
+ </mediaobject>
+ </entry>
+
+ <entry>
+ The portlet is instructed to render minimal-to-no markup.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ Maximized
+ </entry>
+ <entry>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="images/intro/ico_16_maximize.gif"
format="GIF"/>
</imageobject>
</mediaobject>
- <emphasis role="bold">(Maximized)</emphasis>
- - The portlet window can occupy as much space of real estate on the page.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- <listitem>
+ </entry>
+
+ <entry>
+ The portlet window can occupy as much space of real estate on the page.
+ </entry>
+ </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>
<itemizedlist>
<listitem>
<para>
@@ -185,8 +228,8 @@
<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 yhe user will leave the
- "Edit Mode" and reverting back to "View Mode". Portlets are
by default in View
+ 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
mode.
</para>
</listitem>
@@ -197,19 +240,12 @@
<imagedata fileref="images/intro/ico_16_help.gif"
format="GIF"/>
</imageobject>
</mediaobject>
- <emphasis role="bold">(Help)</emphasis>
- - Allows a user to access helpful information about the portlet, if it provides
- it (which is recommended).
+ <emphasis role="bold">Help</emphasis>
+ - Allows a user to access useful information about the portlet.
</para>
</listitem>
</itemizedlist>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-</listitem>
-</itemizedlist>
-</para>
+
</section>
</section>
@@ -218,7 +254,7 @@
<title>Default Portal installation</title>
<para>
- This section will take a quick look at the default Portal installation and the
pages and portlets that come
+ This section covers the default Portal installation and the pages and portlets
that come
with it.
</para>
@@ -227,7 +263,7 @@
<para>
Three pages are available in the default Portal: Home, News and Weather. You can
access pages either by
- entering the page URL in your browser location bar, as shown in linkcommentedout
<!-- <xref linkend="intro_portal_pages"/> -->, or
+ entering the page URL in your browser location bar, as shown in <xref
linkend="Portal_User_Guide-Portal_Concepts-Portal_Pages"/>, or
by clicking the tab associated to the page in the Navigation Tabs at the top of
the page.
<mediaobject>
@@ -238,9 +274,9 @@
</para>
- <note>
+
<para>
- Navigation tabs support sub-page navigation as well. By hovering over a tab with
child Pages, it will display a flyout menu for those subpages:
+ Although there are no pages with subpages in the default Portal installation,
you can configure the navigation tabs to support sub-page navigation. By hovering over a
tab with child Pages, it will display a menu for those subpages:
<mediaobject>
<imageobject>
@@ -248,12 +284,12 @@
</imageobject>
</mediaobject>
- There are no pages with subpages in the default Portal
installation.</para>
- </note>
+ , .</para>
+
<para>
While you can use a Portal anonymously, it is much more interesting to do so
while logged in, as you get the
opportunity to customize the content you want to see or even create your own
personal Dashboard, as
- explained in linkcommentedout <!-- <xref
linkend="dashboard"/> -->.
+ explained in <xref
linkend="Portal_User_Guide-JBoss_Portal_Basics-Dashboard"/> .
</para>
</section>
@@ -262,7 +298,7 @@
<para>
Logging in to the portal is accomplished by clicking the
- <emphasis>Login</emphasis> link at the top-right of the portal page.
Portal will present you with a logging
+ <emphasis>Login</emphasis> link at the top-right of the portal page.
The portal will present you with a login
screen where you can enter your credentials:
<mediaobject>
@@ -312,7 +348,7 @@
</imageobject>
</mediaobject>
- Displays hard-coded links to downloading JBoss Portal, downloading portlets from
<ulink url="http://www.portletswap.com">PortletSwap</ulink>, and the
live online JBoss Portal demo. It also contains default authentication information on
loging in, as well as a link to the official Portal documentation.
+ The Greetings Portlet displays hard-coded links to downloading JBoss Portal,
downloading portlets from <ulink
url="http://www.portletswap.com">PortletSwap</ulink>, and the live
online JBoss Portal demo. It also contains default authentication information on logging
in, as well as a link to the official Portal documentation.
</para>
</section>
@@ -321,7 +357,7 @@
<note>
<para>
- Administrators should view linkcommentedout <!-- <xref
linkend="useradmin"/> --> for managing the portal user base. Only user
+ 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>
</note>
<para>
@@ -333,7 +369,7 @@
</mediaobject>
</para>
<para>
- Once successfully logged in, the user will have additional functionality at his
disposal, that
+ Once successfully logged in to the Identity User Portlet, the user will have
additional functionality at their disposal, that
is covered in the following sections.
<mediaobject>
@@ -350,8 +386,8 @@
<emphasis role="bold">Create a new account</emphasis>
</para>
<para>
- Create a new account by clicking on the
<emphasis>"Register"</emphasis>
- link in the navigation of the portlet, when not logged. A User can then fill in the
necessary
+ Create a new account by clicking on the <emphasis>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>
<imageobject>
@@ -366,8 +402,8 @@
<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
- in the navigation of the portlet. Therfore the user needs to fill in his user name
to receive an e-mail with his new
+ Already registered users can request a new password by clicking on the
<emphasis>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>
<para>
@@ -384,15 +420,15 @@
<emphasis role="bold">View profile</emphasis>
</para>
<para>
- The default page after login is the view profile, which shows a summary of the most
important properties of a user.
+ The default page after login is the view profile page. This page displays a summary
of the most important properties of a user.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Edit personal information</emphasis>
</para>
- <para>A user has the ability to edit his personal information, change his
password and e-mail address at any time by clicking on the
- <emphasis>"Edit profile"</emphasis> link, when logged in.
+ <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.
</para>
</listitem>
</itemizedlist>
@@ -411,29 +447,29 @@
</imageobject>
</mediaobject>
- Portal includes a basic Content Management System (CMS). Portal provides a CMS
portlet which allows users
+ Portal includes a basic Content Management System (CMS) portlet which allows
users
to navigate the CMS content (static html, images, binary files, etc.).
</para>
<para>
- Displaying content is done by the portal using a path mapper. For example, if we
wanted to display a zip
- file, located in <emphasis>/default/foo/bar.zip</emphasis>, we would
type in the URL
+ Content is displayed through the portal using a path mapper. For example, if you
wanted to display a zip
+ file, located in <emphasis>/default/foo/bar.zip</emphasis>, you
would type in the URL
<emphasis>http://localhost:8080/content/default/foo/bar.zip</emphasis>.
- <emphasis
- role="bold">Notice how the path to the content, is prefixed with
the '/content' term.</emphasis>
- Although in this example we are describing binary content retrieval, the same is
to be said for text/html
+ Notice how the path to the content, is prefixed with the <emphasis
+ role="bold">/content</emphasis> term.
+ Although in this example we are describing binary content retrieval, the same
can be said for text/html
files. Keep in mind, however, that binary files are displayed outside of the
portal pages, but text/html
are displayed inside the CMSPortlet Window.
</para>
<para>
<emphasis role="bold">Serving Logic:</emphasis>
- The CMS Portlet now serves content based on the user's locale setting. For
example: if a user's locale is
- set to Spanish in his browser, and he requests URL: default/index.html , the
CMSPortlet will first try
+ The CMS Portlet now serves content based on the user's locale setting. For
example, if a user's locale is
+ set to Spanish in their browser, and they request URL: default/index.html, the
CMSPortlet will first try
and retrieve the Spanish version of that file. If a Spanish version is not
found, it will then try and
retrieve the default language version set for the CMSPortlet (set to English, by
default).
</para>
<note>
<para>
- Administrators should read linkcommentedout <!-- <xref
linkend="admincmsPortlet"/> --> for managing the data in the CMS.
+ Administrators should read <xref
linkend="Portal_User_Guide-Test-Administration_CMS_Portlet"/> for managing
the data in the CMS.
</para>
</note>
</section>
@@ -443,37 +479,40 @@
<title>News Page</title>
<para>
- <mediaobject>
+ The News Page contains 2 portlets displaying news from common internet feeds. An
open internet
+ connection on the server-side is therefore required for them to operate.
<mediaobject>
+
<imageobject>
<imagedata fileref="images/intro/newspage.png"
format="PNG" scalefit="1"/>
</imageobject>
</mediaobject>
- The News Page contains 2 portlets displaying news from common internet feeds. An
open internet
- connection on the server-side is therefore required for them to operate. ;-)
+
</para>
<section id="Portal_User_Guide-News_Page-News_Portlet">
<title>News Portlet</title>
<para>
+ The News Portlet retrieves an RSS news feed from a URL and displays it as HTML
to the user.
+
<mediaobject>
<imageobject>
<imagedata fileref="images/intro/newsportlet.png"
format="PNG" scalefit="1"/>
</imageobject>
</mediaobject>
- The News Portlet retrieves an RSS news feed from a URL and displays it as HTML
to the user.
+
</para>
<para>
- Additionally, a logged-in user is able to modify her preference in RSS feed
source by using the
- Portlet's Edit Mode (click
+ Additionally, a logged-in user is able to modify their preference in RSS feed
source by using the
+ Portlet's Edit Mode by clicking
<mediaobject>
<imageobject>
<imagedata fileref="images/intro/ico_edit.gif"
format="GIF"/>
</imageobject>
</mediaobject>
- ). Once the form is submitted, this property will be saved
- in the user's preference, so she will always see the same news source, when
logged in.
+ Once the form is submitted, this property will be saved
+ in the user's preference, so the user will always see the same news source
when logged in.
<mediaobject>
<imageobject>
<imagedata fileref="images/intro/newsportlet_edit.png"
format="PNG"/>
@@ -493,24 +532,26 @@
<title>Weather Page</title>
<para>
- This page contains a portlet displaying the weather forecast for a specific
location.
+ This page contains a portlet that displays the weather forecast for a specific
location.
</para>
<section id="Portal_User_Guide-Weather_Page-Weather_Portlet">
<title>Weather Portlet</title>
<para>
+ The Weather Portlet retrieves an RSS weather feed, based on a key (commonly a US
Postal Code), and
+ displays it as HTML to the user.
+
<mediaobject>
<imageobject>
<imagedata fileref="images/intro/weatherportlet.gif"
format="GIF"/>
</imageobject>
</mediaobject>
- The Weather Portlet retrieves an RSS weather feed, based on a key (commonly a US
Postal Code), and
- displays it as HTML to the user.
+
</para>
<para>
- Additionally, a logged-in user is able to modify her preference in location by
using the Portlet's Edit Mode (click
+ Additionally, a logged-in user is able to modify their location preference by
using the Portlet's <emphasis role="bold">Edit Mode</emphasis>
by clicking
<mediaobject>
<imageobject>
@@ -518,8 +559,8 @@
</imageobject>
</mediaobject>
- ). Any valid US Postal Code can be input here. Once the form is submitted, this
property will be saved
- in the user's preference, so she will always see the same weather data for
her location, when logged in.
+ Any valid US Postal Code can be input here. Once the form is submitted, this
property will be saved
+ in the user's preference, so the user will always see the same weather data
for their location when logged in.
<mediaobject>
<imageobject>
@@ -530,8 +571,7 @@
</para>
<para>
- <emphasis role="bold">Not in the United
States?</emphasis>
- Follow these steps to configure the Weather portlet to display information for
your area.
+ If you are not located in the United States you will need to configure the
Weather portlet to display the information for your area.
<orderedlist>
<listitem>
<para>Go to
@@ -540,7 +580,7 @@
</listitem>
<listitem>
<para>
- Enter your city name in the location field, found on the page:
+ Enter your city name in the location field:
<mediaobject>
<imageobject>
<imagedata fileref="images/intro/weather_config1.png"
format="PNG" align="center"
@@ -551,7 +591,7 @@
</listitem>
<listitem>
<para>
- Find your location on the list under the form and click on it
(<emphasis>Marseille, France</emphasis>, in this case):
+ Find your location on the list under the <emphasis
role="bold">Search Results</emphasis> and click on it
(<emphasis>Marseille, France</emphasis>, in this case):
<mediaobject>
<imageobject>
@@ -577,7 +617,7 @@
</listitem>
<listitem>
<para>
- Paste these numbers in to the weather portlet edit form
(<emphasis>FRXX0059</emphasis> in this case):
+ Paste these numbers into the weather portlet edit form
(<emphasis>FRXX0059</emphasis> in this case):
<mediaobject>
<imageobject>
@@ -586,7 +626,7 @@
</imageobject>
</mediaobject>
- Hit <emphasis>submit</emphasis>...
+ Click on <emphasis>submit</emphasis>
<mediaobject>
<imageobject>
@@ -606,8 +646,8 @@
<title>Personal Dashboard</title>
<para>
- Once logged in, all users/administrations of the portal can access a personal
dashboard by clicking the
- <emphasis>Dashboard</emphasis> link at the top-right of the portal
page. Note how the links changed.
+ Once logged in, all users/administrators of the portal can access a personal
dashboard by clicking the
+ <emphasis role="bold">Dashboard</emphasis> link at the
top-right of the portal page. Note how the links changed.
<mediaobject>
<imageobject>
@@ -615,15 +655,14 @@
</imageobject>
</mediaobject>
- The personal dashboard allows users to customize their portal pages however they
like, and all changes will be
- persisted... so the next time the user logs in to his dashboard, he will see the
previous changes he made.
+ The personal dashboard allows users to customize their portal pages however they
like. All changes will be
+ persisted so the next time the user logs in to their dashboard, the user will
see the previous changes they made.
While navigating any of the dashboard pages, a user will be able to drag and
drop portlet windows to any
location, if the administrator allows this functionality. Changes made in this
fashion will also be persisted.
</para>
<para>
- It is also possible to copy the content of a shared page to your dashboard so
you can customize it to your
- liking. Just click the <emphasis>'Copy to my
dashboard'</emphasis> link at the top right of the page.
+ It is also possible to copy the content of a shared page to your dashboard so
you can customize it to your liking. Just click the <emphasis
role="bold">Copy to my dashboard</emphasis> link at the top right of
the page.
This will clone the page and add it to your personal dashboard as a page with
the same name.
<mediaobject>
@@ -638,7 +677,7 @@
<title>Configuring your personal dashboard</title>
<para>
- You can configure your dashboard by using the top-right menu item labeled
<emphasis>'Configure dashboard'</emphasis>:
+ You can configure your dashboard by using the top-right menu item labeled
<emphasis role="bold">'Configure dashboard'</emphasis>:
<mediaobject>
<imageobject>
@@ -677,8 +716,8 @@
</para>
<para>
You may delete dashboard pages at any time, by first selecting the page you want
to delete using the
- popup menu at the top of the screen and then clicking the <emphasis>Delete
this page</emphasis> button
- at the bottom of the screen. We will note that users are not able to delete the
default dashboard page.
+ popup menu at the top of the screen and then clicking the <emphasis
role="bold">Delete this page</emphasis> button
+ at the bottom of the screen. Users are not able to delete the default dashboard
page.
<mediaobject>
<imageobject>
<imagedata fileref="images/intro/dashboard_deletepage.png"
format="PNG" scalefit="1"/>
@@ -697,10 +736,10 @@
<title>Managing Portlets on a page</title>
<para>
- You can add, remove and reorder portlets on a dashboard page to adapt your
environment to your liking.
- To do so, just select the page you want to modify using the page popup selector
and use the portlet
+ You can add, remove and reorder portlets on a dashboard page to suit your
specific requirements.
+ Select the page you want to modify by using the page popup selector and then the
portlet
management form. We will not explain how to use it here as it is similar to the
page layout functionality
- of the Admin portal, which we will look at in linkcommentedout <!-- <xref
linkend="page_configuration"/> -->
+ of the Admin portal, which we will look at in <xref
linkend="Portal_User_Guide-Managing_Portal_Objects-Page_configuration"/>
<mediaobject>
<imageobject>
@@ -716,28 +755,31 @@
<para>
- <note> <para>
- You <emphasis role="bold">must be</emphasis> logged in as
an administrator, or have proper privileges
- to see this portal.</para>
- </note>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/intro/adminportal.png"
format="PNG" scalefit="1"/>
- </imageobject>
- </mediaobject>
- The Admin Portal's purpose is to allow an administrator to manage all
aspects of the portal. Follow the links for in-depth reviews of these functions:
- <itemizedlist>
+
+ 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:
+
+ <itemizedlist>
<listitem>
<para>
- Users/Roles (See: linkcommentedout <!-- <xref
linkend="useradmin"/> -->, linkcommentedout <!-- <xref
linkend="roleadmin"/> -->)</para></listitem>
- <listitem><para>Content Management System (See: linkcommentedout <!--
<xref linkend="admincmsPortlet"/> -->)</para></listitem>
+ Users/Roles (See: <xref
linkend="Portal_User_Guide-User_Role-Managing_Users"/>
+
+ <xref
linkend="Portal_User_Guide-User_Role-Managing_Roles"/></para></listitem>
+ <listitem><para>Content Management System (See: <xref
linkend="Portal_User_Guide-Test-Administration_CMS_Portlet"/>
</para></listitem>
<listitem><para>Portal Objects (themes, layouts, portal instances, pages,
windows, security, and deployed
- portlets) (See: linkcommentedout <!-- <xref
linkend="dynamicity"/> -->)</para></listitem>
+ portlets) (See: <xref linkend="Portal_User_Guide-Dynamicity"/>
</para></listitem>
<listitem><para>WSRP (See the
<ulink
url="http://docs.jboss.com/jbportal/v2.6/reference-guide/en/html/wsr...
chapter</ulink>
in the Reference Guide for more information)</para>
</listitem>
</itemizedlist>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/adminportal.png"
format="PNG" scalefit="1"/>
+ </imageobject>
+ </mediaobject>
+
+
</para>
Modified: docs/enterprise/trunk/UserGuide/en-US/Portal_User_Guide.ent
===================================================================
--- docs/enterprise/trunk/UserGuide/en-US/Portal_User_Guide.ent 2008-12-03 05:04:12 UTC
(rev 12331)
+++ docs/enterprise/trunk/UserGuide/en-US/Portal_User_Guide.ent 2008-12-03 05:07:04 UTC
(rev 12332)
@@ -1,5 +1,5 @@
<!ENTITY PRODUCT "Documentation">
<!ENTITY BOOKID "Portal_User_Guide">
<!ENTITY YEAR "2008">
-<!ENTITY HOLDER "YOUR NAME GOES HERE 'Portal_User_Guide.ent'">
+<!ENTITY HOLDER "Red Hat">
Modified: docs/enterprise/trunk/UserGuide/en-US/Portal_User_Guide.xml
===================================================================
--- docs/enterprise/trunk/UserGuide/en-US/Portal_User_Guide.xml 2008-12-03 05:04:12 UTC
(rev 12331)
+++ docs/enterprise/trunk/UserGuide/en-US/Portal_User_Guide.xml 2008-12-03 05:07:04 UTC
(rev 12332)
@@ -10,6 +10,6 @@
<xi:include href="Administration_CMS_Portlet.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="User_Role.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <index />
+
</book>
Modified: docs/enterprise/trunk/UserGuide/en-US/Revision_History.xml
===================================================================
--- docs/enterprise/trunk/UserGuide/en-US/Revision_History.xml 2008-12-03 05:04:12 UTC
(rev 12331)
+++ docs/enterprise/trunk/UserGuide/en-US/Revision_History.xml 2008-12-03 05:07:04 UTC
(rev 12332)
@@ -10,9 +10,9 @@
<revnumber>1.0</revnumber>
<date></date>
<author>
- <firstname></firstname>
- <surname></surname>
- <email></email>
+ <firstname>Sarah</firstname>
+ <surname>Meehan</surname>
+ <email>smeehan(a)redhat.com</email>
</author>
<revdescription>
<simplelist>
Modified: docs/enterprise/trunk/UserGuide/en-US/User_Role.xml
===================================================================
--- docs/enterprise/trunk/UserGuide/en-US/User_Role.xml 2008-12-03 05:04:12 UTC (rev
12331)
+++ docs/enterprise/trunk/UserGuide/en-US/User_Role.xml 2008-12-03 05:07:04 UTC (rev
12332)
@@ -7,8 +7,8 @@
<para>
This chapter covers the administrator functions made available by the User
management portlet. For end-user operation, see:
- linkcommentedout <!-- <xref linkend="intro_user_portlet"/>
-->. Administrative functions are available once you are logged in with the proper
- credentials (admin/admin), then going to the linkcommentedout <!-- <xref
linkend="adminportal"/> --> and then the Members Page tab. You can change
between
+ <xref
linkend="Portal_User_Guide-Home_Page-Intro_user_portlet"/>. Administrative
functions are available once you are logged in with the proper
+ credentials (admin/admin), then going to the <xref
linkend="Portal_User_Guide-JBoss_Portal_Basics-Admin_Portal"/> and then the
Members Page tab. You can change between
user and role management by clicking on the corresponding links in the top of
the portlet.
</para>
@@ -19,7 +19,7 @@
<para>
This section covers the user management of the IdentityUserManagementPortlet
which is displayed by default.
- For role management please see linkcommentedout <!-- <xref
linkend="roleadmin"/> -->.
+ For role management please see <xref
linkend="Portal_User_Guide-User_Role-Managing_Roles"/>.
<mediaobject>
<imageobject>
@@ -27,7 +27,7 @@
</imageobject>
<caption>
<para>
- The Members page in the linkcommentedout <!-- <xref
linkend="adminportal"/> -->.
+ The Members page in the <xref
linkend="Portal_User_Guide-JBoss_Portal_Basics-Admin_Portal"/>.
</para>
</caption>
</mediaobject>
@@ -56,7 +56,7 @@
<section id="Portal_User_Guide-Actions-Searching_for_Users">
<title>Searching for Users</title>
<para>
- For searching users click on the link <emphasis>Search
users</emphasis> and then type a partial username in the form text field, to search
for usernames matching that
+ To search for a user click on the link <emphasis
role="bold">Search users</emphasis> and then type a partial username in
the form text field. This will search for usernames that match that
criteria.
<mediaobject>
@@ -204,7 +204,7 @@
</section>
<section id="Portal_User_Guide-Managing_Roles-Actions">
- <title>Introduction</title>
+ <title>Actions</title>
<para>
The User management portlet also provides several actions related to role
management, which are described in the following sections.
@@ -239,12 +239,33 @@
security rules.
</para>
</section>
+
+
+<section id="Portal_User_Guide-Actions-Edit_Role">
+ <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.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/role/edit_role.png" format="PNG"
scalefit="1"/>
+ </imageobject>
+ <caption>
+ <para>
+ Edit an existing role.
+ </para>
+ </caption>
+ </mediaobject>
+ While editing a role, you just need to pick an existing role then change the display
name.
+ </para>
+</section>
+
+
<section id="Portal_User_Guide-Actions-Editing_Role_Members">
<title>Editing Role Members</title>
<para>
- Editing role members, is accomplished by first clicking the
+ Editing role members is accomplished by first clicking the
<emphasis>Members</emphasis>
link at the role management page for the role you would like to modify.