Author: smumford
Date: 2010-02-10 02:25:18 -0500 (Wed, 10 Feb 2010)
New Revision: 1605
Modified:
portal/trunk/docs/user-guide/en/modules/Introduction.xml
portal/trunk/docs/user-guide/en/modules/account/Account_and_Password_Retrieval.xml
portal/trunk/docs/user-guide/en/modules/account/Register_New_Accounts.xml
portal/trunk/docs/user-guide/en/modules/account/Remember_User_Account.xml
portal/trunk/docs/user-guide/en/modules/account/Sign_in_and_Sign_out.xml
portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Gadgets_in_User_Workspace.xml
portal/trunk/docs/user-guide/en/modules/language/Internationalization_Portlet.xml
portal/trunk/docs/user-guide/en/modules/portal/Change_Portal_Skins.xml
portal/trunk/docs/user-guide/en/modules/portal/Manage_Navigation_Nodes.xml
portal/trunk/docs/user-guide/en/modules/portal/User_Management.xml
portal/trunk/docs/user-guide/en/modules/portletsUser/Dashboard_Portlet.xml
portal/trunk/docs/user-guide/en/modules/portletsUser/Functional_Portlets.xml
Log:
Incorporate RH QE feedback
Modified: portal/trunk/docs/user-guide/en/modules/Introduction.xml
===================================================================
--- portal/trunk/docs/user-guide/en/modules/Introduction.xml 2010-02-10 07:24:32 UTC (rev
1604)
+++ portal/trunk/docs/user-guide/en/modules/Introduction.xml 2010-02-10 07:25:18 UTC (rev
1605)
@@ -6,23 +6,43 @@
<chapter id="chap-User_Guide-Introduction">
<title>Introduction</title>
<para>
- GateIn is a merge of two mature projects; JBoss Portal and eXo Portal. It takes the
best of both offerings and incorporates them into a single new project. The aim is to
provide an intuitive portal for as-is use and a framework to build upon depending on your
needs.
+ &PRODUCT; is a merge of two mature projects; JBoss Portal and eXo Portal. It takes
the best of both offerings and incorporates them into a single new project. The aim is to
provide an intuitive portal for as-is use and a framework to build upon depending on your
needs.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="images/Frontpage.png" format="PNG"
scalefit="1" width="444" />
</imageobject>
</mediaobject>
+ <section>
+ <title>Getting Started</title>
+ <para>
+ For instructions on how to install and run &PRODUCT;, refer to the Installation
guide available at <ulink type="http"
url="www.redhat.com/docs"></ulink>
+ </para>
+ </section>
<section id="sect-User_Guide-Introduction-Links">
<title>Links</title>
+ <important>
+ <title>&PRODUCT; Download</title>
+ <para>
+ <emphasis role="bold">This link is a placeholder for the final
download location:</emphasis>
+ </para>
+ <para>
+ <ulink type="http"
url="http://download.devel.redhat.com/devel/candidates/JBEPP/5.0.0_E...
+ </para>
+ </important>
<itemizedlist>
<listitem>
<para>
- GateIn project homepage. GateIn 3.0 is the community project that Enterprise Portal
Platform 5.0 is based on. <ulink
url="http://www.gatein.org"></ulink>
+ GateIn project homepage. GateIn 3.0 is the community project that &PRODUCT; is
based on. <ulink url="http://www.gatein.org"></ulink>
</para>
</listitem>
<listitem>
<para>
+ GateIn downloads: <ulink
url="http://www.jboss.org/gatein/downloads.html">www.jboss.o...
+ </para>
+ </listitem>
+ <listitem>
+ <para>
Further documentation about the Red Hat &PRODUCT; and other Red Hat products can
be found at <ulink type="http"
url="www.redhat.com/docs"></ulink>
</para>
</listitem>
@@ -36,12 +56,7 @@
<para>
GateIn documentation: <ulink
url="http://www.jboss.org/gatein/documentation.html">www.jbo...
</para>
- </listitem>
- <listitem>
- <para>
- GateIn downloads: <ulink
url="http://www.jboss.org/gatein/downloads.html">www.jboss.o...
- </para>
- </listitem> -->
+ </listitem> -->
</itemizedlist>
</section>
Modified:
portal/trunk/docs/user-guide/en/modules/account/Account_and_Password_Retrieval.xml
===================================================================
---
portal/trunk/docs/user-guide/en/modules/account/Account_and_Password_Retrieval.xml 2010-02-10
07:24:32 UTC (rev 1604)
+++
portal/trunk/docs/user-guide/en/modules/account/Account_and_Password_Retrieval.xml 2010-02-10
07:25:18 UTC (rev 1605)
@@ -45,12 +45,12 @@
<itemizedlist>
<listitem>
<para>
- <emphasis role="bold">Forgot my password</emphasis> : If you
forget your password, you need to select this option.
+ <emphasis role="bold">Forgot my password</emphasis>. If you
forget your password, you need to select this option.
</para>
</listitem>
<listitem>
<para>
- <emphasis role="bold">Forgot my username</emphasis> : If you
forget your username, you need to select this option.
+ <emphasis role="bold">Forgot my username</emphasis>. If you
forget your username, you need to select this option.
</para>
</listitem>
</itemizedlist>
Modified: portal/trunk/docs/user-guide/en/modules/account/Register_New_Accounts.xml
===================================================================
--- portal/trunk/docs/user-guide/en/modules/account/Register_New_Accounts.xml 2010-02-10
07:24:32 UTC (rev 1604)
+++ portal/trunk/docs/user-guide/en/modules/account/Register_New_Accounts.xml 2010-02-10
07:25:18 UTC (rev 1605)
@@ -28,7 +28,7 @@
Users who visit the Portal and who are not registered are limited in the content they
can see. Users who need access to deeper content or who need to undertake actions within
the prtal should register themselves and then contact the portal administrator to have
appropriate permissions added to their account.
</para>
<para>
- Users can quickly and easily register a new account by themselves. Just by completing
the steps below, you will have a new account that helps you access more pages and take
more actions in &PRODUCT;:
+ Users can quickly and easily register a new account for themselves. Complete the steps
below:
</para>
<procedure>
<step>
@@ -58,7 +58,7 @@
<term>User Name</term>
<listitem>
<para>
- The name that the user uses to login.
+ The name used to login.
</para>
</listitem>
</varlistentry>
@@ -82,7 +82,7 @@
<term>First Name</term>
<listitem>
<para>
- The first name of the user.
+ The user's first name.
</para>
</listitem>
</varlistentry>
@@ -90,7 +90,7 @@
<term>Last Name</term>
<listitem>
<para>
- The last name of the user.
+ The user's last name.
</para>
</listitem>
</varlistentry>
@@ -98,7 +98,7 @@
<term>Email Address</term>
<listitem>
<para>
- The email address of the user. It must be in the appropriate format, example:
username(a)abc.com.
+ The user's email address. This must be in the appropriate format. For
example: username(a)abc.com.
</para>
</listitem>
</varlistentry>
@@ -111,10 +111,10 @@
</step>
<step>
<para>
- Click the magnifying glass icon to search and check if the chosen username is
available.
+ Click the 'find' icon beside the user name field to check if the chosen
username is available.
</para>
</step>
- <step>
+<!-- <step>
<para>
Input values in the <emphasis role="bold">User
Profile</emphasis> tab, include: Profile information, Home information, Business
information. These fields are not required.
</para>
@@ -126,10 +126,10 @@
<imagedata fileref="images/UserProfile.png" format="PNG"
width="444" />
</imageobject>
</mediaobject>
- </step>
+ </step> -->
<step>
<para>
- Click <emphasis role="bold">Save</emphasis> to register a new
account or <emphasis role="bold">Reset</emphasis> to refresh all
entered values. You cannot add a new account if one of these cases occurs:
+ Click <emphasis role="bold">Subscribe</emphasis> to register a
new account or <emphasis role="bold">Reset</emphasis> to refresh all
entered values. You cannot add a new account if one of these cases occurs:
</para>
<itemizedlist>
<listitem>
@@ -149,7 +149,7 @@
</listitem>
<listitem>
<para>
- The <emphasis role="bold">Email Address</emphasis> format is
not valid
+ The <emphasis role="bold">Email Address</emphasis> format is
not valid.
</para>
</listitem>
<listitem>
@@ -165,7 +165,7 @@
<note>
<title>Note</title>
<para>
- Be sure you enter your email address carefully. If you should forget your user name
or password, you can recover it by using this email address.
+ Be sure you enter your email address carefully. If you should forget your user name
or password, you can recover it with this email address.
</para>
</note>
</para>
Modified: portal/trunk/docs/user-guide/en/modules/account/Remember_User_Account.xml
===================================================================
--- portal/trunk/docs/user-guide/en/modules/account/Remember_User_Account.xml 2010-02-10
07:24:32 UTC (rev 1604)
+++ portal/trunk/docs/user-guide/en/modules/account/Remember_User_Account.xml 2010-02-10
07:25:18 UTC (rev 1605)
@@ -25,7 +25,7 @@
--><title>Remember User Account</title>
<para>
- This feature allows users to return to the &PRODUCT; and be automatically
authenticated based on the value of a cookie provided by the browser. Thus users do not
have to perform an explicit authentication again.
+ Users can return to the &PRODUCT; and be automatically authenticated with a cookie
provided by their browser. Thus users do not have to perform an explicit authentication
each time they access the portal.
</para>
<mediaobject>
<imageobject>
@@ -35,7 +35,7 @@
<procedure>
<step>
<para>
- Input your registered <emphasis role="bold">User
name</emphasis> and <emphasis role="bold">Password</emphasis>
.
+ Input your registered user name and password.
</para>
</step>
<step>
@@ -50,8 +50,9 @@
</step>
</procedure>
<para>
- You must remember to close your browser without signing out (as signing out will delete
the cookie). The next time, you can automatically sign in the portal without signing in
again with your first/last name welcome.
+ You must remember to close your browser without signing out (as signing out will delete
the cookie). This will allow you to re-enter the portal without having to sign in again.
</para>
+
</section>
Modified: portal/trunk/docs/user-guide/en/modules/account/Sign_in_and_Sign_out.xml
===================================================================
--- portal/trunk/docs/user-guide/en/modules/account/Sign_in_and_Sign_out.xml 2010-02-10
07:24:32 UTC (rev 1604)
+++ portal/trunk/docs/user-guide/en/modules/account/Sign_in_and_Sign_out.xml 2010-02-10
07:25:18 UTC (rev 1605)
@@ -26,141 +26,135 @@
--><title>Sign In and Sign Out</title>
<para>
- After registering your account, you can sign in to &PRODUCT; to go into your
private mode.
+ After registering your account, you can sign in to &PRODUCT; to go into private
mode.
</para>
- <procedure>
- <title>Sign In</title>
- <step>
- <para>
- Go to a Portal in the public mode by inputting URL in the address bar (e.g:
http://localhost:8080/portal)
- </para>
- </step>
- <step>
- <para>
- Click the <emphasis role="bold">Sign in</emphasis> link at the
top right of the page if you are current in the Classic portal. The <emphasis
role="bold">Sign in</emphasis> form appears:
+ <para>
+ To sign in to a portal, users must complete the <emphasis
role="bold">Sign in</emphasis> form. This form contains the following
elements:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ User name
+ </term>
+ <listitem>
+ <para>
+ The registered user name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Password
+ </term>
+ <listitem>
+ <para>
+ The registered password.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Remember My Login
+ </term>
+ <listitem>
+ <para>
+ This option allows users to return to &PRODUCT; and be automatically
authenticated based on the value of a cookie provided by the
<literal>bvarlistentryser</literal>. Thus users do not have to perform an
explicit authentication again.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Forgot your User Name/Password?
+ </term>
+ <listitem>
+ <para>
+ To follow some steps to get the forgotten user name or password. Please refer
[Portal:Account and Password Retrieval] for more details.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Sign in
+ </term>
+ <listitem>
+ <para>
+ To sign into &PRODUCT; with user name and password.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ Discard
+ </term>
+ <listitem>
+ <para>
+ Close the Sign In form without logging in.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <procedure>
+ <title>Sign In</title>
+ <step>
+ <para>
+ Go to your Portal by entering the URL into the address bar of your browser (For
example
http://localhost:8080/portal).
+ </para>
+ </step>
+ <step>
+ <para>
+ Click the <emphasis role="bold">Sign in</emphasis> link at
the top right of the page if you are current in the Classic portal. The <emphasis
role="bold">Sign in</emphasis> form appears:
+ </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/SignIn2.6.png" format="PNG"
width="444" />
+ </imageobject>
+ </mediaobject>
+ </step>
+ <step>
+ <para>
+ Input your registered <emphasis role="bold">User
name</emphasis> and <emphasis role="bold">Password</emphasis>
.
+ </para>
+ </step>
+ <step>
+ <para>
+ Select the <emphasis role="bold">Remember My
Login</emphasis> check box when you sign in &PRODUCT; at the first time if you
want to automatically return to &PRODUCT; without signing in again. You can see
<xref linkend="sect-User_Guide-Remember_User_Account" /> for more
details.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click the <emphasis role="bold">Sign in</emphasis> button to
submit the form or <emphasis role="bold">Discard</emphasis> to
escape.
+ </para>
+ </step>
+ </procedure>
+ <para>
+ If the user name does not exist or the user name and/or password is invalid an alert
message will appear. To attempt the login again; click the <emphasis
role="bold">OK</emphasis> button on the alert message to be returned to
the Sign In form. Enter the user name and password again.
</para>
+ <para>
+ After signing in, you will be redirected to the homepage and welcomed with your full
name in the top right corner of the page.
+ </para>
<mediaobject>
<imageobject>
- <imagedata fileref="images/SignIn2.6.png" format="PNG"
width="444" />
+ <imagedata fileref="images/PortalHome.png" format="PNG"
width="444" />
</imageobject>
</mediaobject>
- </step>
- <step>
- <para>
- Input your registered <emphasis role="bold">User
name</emphasis> and <emphasis role="bold">Password</emphasis>
.
- </para>
- </step>
- <step>
- <para>
- Select the <emphasis role="bold">Remember My Login</emphasis>
check box when you sign in &PRODUCT; at the first time if you want to automatically
return to &PRODUCT; without signing in again. You can see <xref
linkend="sect-User_Guide-Remember_User_Account" /> for more details.
- </para>
- </step>
- <step>
- <para>
- Click the <emphasis role="bold">Sign in</emphasis> button to
submit the form or <emphasis role="bold">Discard</emphasis> to
escape.
- </para>
- </step>
- <step>
- <para>
- Details:
- </para>
- <variablelist>
- <varlistentry>
- <term>
- User name
- </term>
- <listitem>
- <para>
- The registered user name.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Password
- </term>
- <listitem>
- <para>
- The registered password.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Remember My Login
- </term>
- <listitem>
- <para>
- This option allows users to return to &PRODUCT; and be automatically
authenticated based on the value of a cookie provided by the bvarlistentryser. Thus users
do not have to perform an explicit authentication again.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Forgot your User Name/Password?
- </term>
- <listitem>
- <para>
- To follow some steps to get the forgotten user name or password. Please refer
[Portal:Account and Password Retrieval] for more details.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Sign in
- </term>
- <listitem>
- <para>
- To sign into &PRODUCT; with user name and password.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- Discard
- </term>
- <listitem>
- <para>
- To close the *Sign In* form.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>
- If <emphasis role="bold">User Name</emphasis> does not exist
or the User name/Password is invalid an alert message will appear. This alert requires you
to input a recognised value. To attempt the login again; click the <emphasis
role="bold">OK</emphasis> button on the alert message to be returned to
the Sign In form. Enter <emphasis role="bold">User Name</emphasis>
and <emphasis role="bold">Password</emphasis> again.
- </para>
- <para>
- After signing in, you will be redirected to the authenticated homepage:
- </para>
- <para>
- After signing in, you will be redirected to the authenticated homepage and welcomed
with your full First Name and Last Name:
- </para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/PortalHome.png" format="PNG"
width="444" />
- </imageobject>
- </mediaobject>
- </step>
- </procedure>
-
- <procedure>
- <title>Sign Out</title>
- <step>
- <para>
- This function lets you get back to the anonymous portal. It ends your current portal
session.
- </para>
- </step>
- <step>
- <para>
- In the upper left corner of the screen, click <emphasis
role="bold">Sign out</emphasis> :
- </para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/SignOut.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </step>
- </procedure>
+ <procedure>
+ <title>Sign Out</title>
+ <step>
+ <para>
+ This function lets you get back to the anonymous portal. It ends your current
portal session.
+ </para>
+ </step>
+ <step>
+ <para>
+ In the upper left corner of the screen, click <emphasis
role="bold">Sign out</emphasis> :
+ </para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/SignOut.png" format="PNG"
/>
+ </imageobject>
+ </mediaobject>
+ </step>
+ </procedure>
</section>
Modified:
portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Gadgets_in_User_Workspace.xml
===================================================================
---
portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Gadgets_in_User_Workspace.xml 2010-02-10
07:24:32 UTC (rev 1604)
+++
portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Gadgets_in_User_Workspace.xml 2010-02-10
07:25:18 UTC (rev 1605)
@@ -3,7 +3,7 @@
<!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent">
%BOOK_ENTITIES;
]>
-<section id="sect-User_Guide-Manage_Gadgets_in_User_Workspace">
+<section id="sect-User_Guide-Manage_Gadgets">
<title>Manage Gadgets</title>
<para>
Gadgets are a small convenient applications that help portal users perform private
actions. &PRODUCT; provides you with some gadgets by default (see <xref
linkend="sect-User_Guide-Dashboard_Portlet-Using_the_Dashboard_Workspace"/>.
Modified:
portal/trunk/docs/user-guide/en/modules/language/Internationalization_Portlet.xml
===================================================================
---
portal/trunk/docs/user-guide/en/modules/language/Internationalization_Portlet.xml 2010-02-10
07:24:32 UTC (rev 1604)
+++
portal/trunk/docs/user-guide/en/modules/language/Internationalization_Portlet.xml 2010-02-10
07:25:18 UTC (rev 1605)
@@ -91,7 +91,7 @@
<section
id="sect-User_Guide-Internationalization_Portlet-View_and_Edit_a_Resource">
<title>View and Edit a Resource</title>
<para>
- Click the magnifying glass icon corresponding to the resource which you want to view.
On the view form, you also can edit information by clicking the <emphasis
role="bold">Edit</emphasis> button. You can only edit the <emphasis
role="bold">Resource</emphasis> field.
+ Click the 'find' icon corresponding to the resource which you want to view. On
the view form, you also can edit information by clicking the <emphasis
role="bold">Edit</emphasis> button. You can only edit the <emphasis
role="bold">Resource</emphasis> field.
</para>
<para>
Click the <emphasis role="bold">Save</emphasis> button to submit
your changes or click the <emphasis role="bold">Cancel</emphasis>
button to quit without saving any changes.
Modified: portal/trunk/docs/user-guide/en/modules/portal/Change_Portal_Skins.xml
===================================================================
--- portal/trunk/docs/user-guide/en/modules/portal/Change_Portal_Skins.xml 2010-02-10
07:24:32 UTC (rev 1604)
+++ portal/trunk/docs/user-guide/en/modules/portal/Change_Portal_Skins.xml 2010-02-10
07:25:18 UTC (rev 1605)
@@ -77,6 +77,9 @@
</listitem>
</varlistentry>
</variablelist>
+ <para>
+ More information about adding skins to a portal see the &PRODUCT; Reference Guide
at <ulink type="http"
url="www.redhat.com/docs"></ulink>
+ </para>
</section>
Modified: portal/trunk/docs/user-guide/en/modules/portal/Manage_Navigation_Nodes.xml
===================================================================
--- portal/trunk/docs/user-guide/en/modules/portal/Manage_Navigation_Nodes.xml 2010-02-10
07:24:32 UTC (rev 1604)
+++ portal/trunk/docs/user-guide/en/modules/portal/Manage_Navigation_Nodes.xml 2010-02-10
07:25:18 UTC (rev 1605)
@@ -175,7 +175,7 @@
</step>
<step>
<para>
- Click the magnifying glass icon to perform the search. All pages matching with
search term will be listed.
+ Click the 'find' icon to perform the search. All pages matching with
search term will be listed.
</para>
</step>
<step>
Modified: portal/trunk/docs/user-guide/en/modules/portal/User_Management.xml
===================================================================
--- portal/trunk/docs/user-guide/en/modules/portal/User_Management.xml 2010-02-10 07:24:32
UTC (rev 1604)
+++ portal/trunk/docs/user-guide/en/modules/portal/User_Management.xml 2010-02-10 07:25:18
UTC (rev 1605)
@@ -50,7 +50,7 @@
</step>
<step>
<para>
- Click the magnifying glass icon to begin the search.
+ Click the 'find' icon to begin the search.
</para>
</step>
</procedure>
Modified: portal/trunk/docs/user-guide/en/modules/portletsUser/Dashboard_Portlet.xml
===================================================================
--- portal/trunk/docs/user-guide/en/modules/portletsUser/Dashboard_Portlet.xml 2010-02-10
07:24:32 UTC (rev 1604)
+++ portal/trunk/docs/user-guide/en/modules/portletsUser/Dashboard_Portlet.xml 2010-02-10
07:25:18 UTC (rev 1605)
@@ -6,7 +6,7 @@
<section id="sect-User_Guide-Dashboard_Portlet">
<title>Dashboard Portlet</title>
<para>
- The Dashboard portlet is used for hosting mini applications known as gadgets. The
Dashboard uses a variety of graphical effects for displaying, opening and using gadgets.
Gadgets can be moved around, rearranged, deleted and created. More than one instance of
the same gadget can be opened at the same time and each instance of the same gadget can
have different settings. The gadgets instances are as independent as different portlets
instances.
+ The Dashboard portlet is used for hosting mini applications known as gadgets. The
Dashboard uses a variety of graphical effects for displaying, opening and using gadgets.
Gadgets can be moved, rearranged, created and deleted. More than one instance of the same
gadget can be opened at the same time and each instance of the same gadget can have
different settings. The gadgets instances are as independent as different portlets
instances.
</para>
<mediaobject>
<imageobject>
@@ -17,11 +17,30 @@
<section
id="sect-User_Guide-Dashboard_Portlet-Using_the_Dashboard_Workspace">
<title>Using the Dashboard Workspace</title>
+ <procedure>
+ <step>
+ <para>
+ Click on <emphasis role="bold">Dashboard</emphasis> in the
toolbar to access the Dashboard portlet.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click on <emphasis role="bold">Add Gadgets</emphasis> to open
the Dashboard Workspace.
+ </para>
+ </step>
+
+ </procedure>
<para>
- Click on <emphasis role="bold">Add Gadgets</emphasis> to open
the Dashboard Workspace.
+ The active Dashboard can be individually named by clicking on the default name
("<emphasis>Click and Type Page Name</emphasis>") where it appears
below the current user name (see image below) and entering a new name.
</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/Dashname.png" format="PNG"
width="444" />
+ </imageobject>
+ </mediaobject>
+
<para>
- A popup window listing all available gadgets appears. There are four gadgets built
into &PRODUCT; by default however you can add many more.
+ The Dashboard Workspace lists all available gadgets. There are four gadgets built into
&PRODUCT; by default, however you can add many more.
</para>
<mediaobject>
<imageobject>
@@ -96,21 +115,38 @@
<section id="sect-User_Guide-Dashboard_Portlet-Add_Gadgets">
<title>Add Gadgets</title>
<para>
- To add more gadgets, do the following:
+ To add more gadgets from external sources:
</para>
- <para>
- Open the popup to add gadgets
- </para>
<procedure>
<step>
<para>
- While in the Dashboard portlet, click the <emphasis role="bold">Add
Gadgets</emphasis> link
+ Obtain the URL (.xml or .rss) of the gadget you wish to add from the gadget source.
+ </para>
+ <para>
+ For example; the gadgets available at <ulink type="http"
url="http://www.google.com/ig/directory?synd=open">Google
Gadget</ulink> provide a link to <emphasis role="bold">View
source</emphasis>. Clicking on this will open a page showing the gadget's XML
source. Use the URL of this page in the Dashboard Workspace. The URL should end in
<literal>.xml</literal>
+ </para>
+ <note>
+ <title>URL Types</title>
+ <para>
+ Remote gadgets can be only created using an .xml link or RSS URL. However, if you
use a link that generates an RSS feed (for example:
http://feeds.feedburner.com/gatein), a
new RSS reader gadget will be created automatically.
+ </para>
+ </note>
+ </step>
+ <step>
+ <para>
+ Return to your portal and click the Dashboard link in the toolbar.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click on <emphasis role="bold">Add Gadgets</emphasis> in the
Dashboard to open the Dashboard Workspace.
+ </para>
<mediaobject>
<imageobject>
<imagedata fileref="images/Dashboard1.png" format="PNG"
width="444" />
</imageobject>
</mediaobject>
- </para>
+
</step>
<step>
<para>
@@ -124,21 +160,12 @@
</step>
<step>
<para>
- Enter a link (.xml or .rss) in the text box above the gadgets list.
+ Paste the URL obtained in step 1 into the text box above the gadget list.
</para>
- <note>
- <title>Note</title>
- <para>
- If you enter an .rss file or a link that generate an RSS feed (for example:
http://feeds.feedburner.com/gatein), a new RSS gadget reader will be created in the
dashboard.
- </para>
- </note>
- <para>
- Remote gadgets can be only created using the .xml file format (which is the standard
gadget format).
- </para>
</step>
<step>
<para>
- Click on the + icon to add a new gadget to the gadget list.
+ Click on the <emphasis role="bold">plus</emphasis> icon to add
the new gadget to the page.
</para>
</step>
</procedure>
Modified: portal/trunk/docs/user-guide/en/modules/portletsUser/Functional_Portlets.xml
===================================================================
---
portal/trunk/docs/user-guide/en/modules/portletsUser/Functional_Portlets.xml 2010-02-10
07:24:32 UTC (rev 1604)
+++
portal/trunk/docs/user-guide/en/modules/portletsUser/Functional_Portlets.xml 2010-02-10
07:25:18 UTC (rev 1605)
@@ -6,8 +6,11 @@
<section id="sect-User_Guide-Functional_Portlets">
<title>Functional Portlets</title>
<para>
- Portlets are pluggable user interface components that are managed and displayed within
a portal. Functional Portlets support all functions of a Portal. &PRODUCT; provides
the following portlets by default:
+ Portlets are pluggable user interface components that are managed and displayed within
a portal. Functional Portlets support all functions of a Portal. They are built into the
portal and are accessed via toolbar links as required when actioning portal tasks.
</para>
+ <para>
+ &PRODUCT; provides the following portlets by default.
+ </para>
<variablelist>
<varlistentry>