[portal-commits] JBoss Portal SVN: r5906 - in docs/trunk/userGuide/en: images/intro modules
portal-commits at lists.jboss.org
portal-commits at lists.jboss.org
Tue Dec 19 15:27:12 EST 2006
Author: roy.russo at jboss.com
Date: 2006-12-19 15:26:59 -0500 (Tue, 19 Dec 2006)
New Revision: 5906
Added:
docs/trunk/userGuide/en/images/intro/dashboard_assignportlets.gif
docs/trunk/userGuide/en/images/intro/dashboard_assignthemes.gif
docs/trunk/userGuide/en/images/intro/dashboard_configure.gif
docs/trunk/userGuide/en/images/intro/dashboard_createpage.gif
docs/trunk/userGuide/en/images/intro/dashboard_dnd.gif
docs/trunk/userGuide/en/images/intro/dashboard_selectpage.gif
docs/trunk/userGuide/en/images/intro/login_ss.gif
docs/trunk/userGuide/en/images/intro/portlet_assign.gif
docs/trunk/userGuide/en/images/intro/portlet_down.gif
docs/trunk/userGuide/en/images/intro/portlet_remove.gif
docs/trunk/userGuide/en/images/intro/portlet_up.gif
Modified:
docs/trunk/userGuide/en/images/intro/dashboard.jpg
docs/trunk/userGuide/en/modules/intro.xml
Log:
JBPORTAL-1164 - Document dashboards in User Guide
Modified: docs/trunk/userGuide/en/images/intro/dashboard.jpg
===================================================================
(Binary files differ)
Added: docs/trunk/userGuide/en/images/intro/dashboard_assignportlets.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/dashboard_assignportlets.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/dashboard_assignthemes.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/dashboard_assignthemes.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/dashboard_configure.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/dashboard_configure.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/dashboard_createpage.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/dashboard_createpage.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/dashboard_dnd.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/dashboard_dnd.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/dashboard_selectpage.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/dashboard_selectpage.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/login_ss.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/login_ss.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/portlet_assign.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/portlet_assign.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/portlet_down.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/portlet_down.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/portlet_remove.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/portlet_remove.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: docs/trunk/userGuide/en/images/intro/portlet_up.gif
===================================================================
(Binary files differ)
Property changes on: docs/trunk/userGuide/en/images/intro/portlet_up.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: docs/trunk/userGuide/en/modules/intro.xml
===================================================================
--- docs/trunk/userGuide/en/modules/intro.xml 2006-12-19 17:46:38 UTC (rev 5905)
+++ docs/trunk/userGuide/en/modules/intro.xml 2006-12-19 20:26:59 UTC (rev 5906)
@@ -219,6 +219,12 @@
admin/admin
]]>
</programlisting>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/login_ss.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
</para>
<para>
Once logged in, the top-right menu will change so you can then navigate to your personal dashboard and other
@@ -531,14 +537,154 @@
persisted... so the next time the user logs in to his dashboard, he will see the previous changes he made.
<mediaobject>
<imageobject>
- <imagedata fileref="images/intro/dashboard_dnd.jpg" format="jpg" align="center"
+ <imagedata fileref="images/intro/dashboard_dnd.gif" format="gif" align="center"
valign="middle"/>
</imageobject>
</mediaobject>
- <note>At the time of this release, functionality on Adding Pages, and Adding portlet windows, has not been
- added to the dashboarding area for users.
- </note>
+ 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 be persisted.
</para>
+ <sect2 id="dashboard_configure">
+ <title>Configuring your personal dashboard</title>
+ <para>
+ A user is able to configure his personal dashboard, by accessing the Configurator, using the top-right menu
+ item, labeled
+ <emphasis>Edit Content</emphasis>
+ . He should then see the main Configurator screen:
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/dashboard_configure.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ From this screen, a user is able to perform configuration actions on his dashboard, by first selecting the
+ page he would like to edit, using the page selector dropdown:
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/dashboard_selectpage.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ The possible actions on a selected page are as follows:
+ <itemizedlist>
+ <listitem>
+ <xref linkend="dashboard_createpages"/>
+ </listitem>
+ <listitem>
+ <xref linkend="dashboard_assignportlets"/>
+ </listitem>
+ <listitem>
+ <xref linkend="dashboard_assignthemes"/>
+ </listitem>
+ <listitem>
+ <xref linkend="dashboard_deletepage"/>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <sect3 id="dashboard_createpages">
+ <title>Creating Pages</title>
+ <para>
+ A user is able to create new pages in his personal dashboard by simply entering a desired Page name in
+ the
+ <emphasis>Create New Page</emphasis>
+ dialogue.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/dashboard_createpage.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ <note>
+ <itemizedlist>
+ <listitem>Page names must be unique.</listitem>
+ <listitem>Page names cannot be blank.</listitem>
+ </itemizedlist>
+ </note>
+ Upon creating a new page, the Configurator will refresh and allow a user to customize the new page.
+ </para>
+ </sect3>
+ <sect3 id="dashboard_assignportlets">
+ <title>Managing Portlets</title>
+ <para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/dashboard_assignportlets.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ This section of the Configurator allows users to add, remove, and reorder portlets on a selected
+ dashboard
+ page.
+ </para>
+ <para>
+ <emphasis role="bold">Assigning portlets</emphasis>
+ to a page is accomplished by selecting which portlets you would like added to a page
+ from the
+ <emphasis>Available Content</emphasis>
+ list. (You may select multiple portlets by holding CTRL and clicking on the available portlets.) Once you
+ have selected which portlet you would like to assign to a specific column, click the
+ <imageobject>
+ <imagedata fileref="images/intro/portlet_assign.gif" format="gif"/>
+ </imageobject>
+ button next to the target column.
+ </para>
+ <para>
+ <emphasis role="bold">Removing portlets</emphasis>
+ from a page is accomplished by selecting which portlets you would like removed from a
+ specific column. (You may select multiple portlets by holding CTRL and clicking on the available
+ portlets.)
+ Once you
+ have selected which portlet you would like removed, click the
+ <imageobject>
+ <imagedata fileref="images/intro/portlet_remove.gif" format="gif"/>
+ </imageobject>
+ button next to the source column.
+ </para>
+ <para>
+ <emphasis role="bold">Sorting portlets</emphasis>
+ in a column is accomplished by selecting which portlets you would like to sort from a
+ specific column. (You may select multiple portlets by holding CTRL and clicking on the available
+ portlets.)
+ Once you
+ have selected which portlet you would like re-ordered, click the
+ <imageobject>
+ <imagedata fileref="images/intro/portlet_up.gif" format="gif"/>
+ </imageobject>
+ or
+ <imageobject>
+ <imagedata fileref="images/intro/portlet_down.gif" format="gif"/>
+ </imageobject>
+ button next to the source column.
+ </para>
+ </sect3>
+ <sect3 id="dashboard_assignthemes">
+ <title>Managing Theme and Layouts</title>
+ <para>
+ Using the Theme and Layout dropdowns, the configurator allows for theme and/or layout assignment to a
+ specific dashboard page. The user simply selects the desired theme and/or layout and presses
+ <emphasis>Select</emphasis>
+ to assign it to the page.
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/intro/dashboard_assignthemes.gif" format="gif" align="center"
+ valign="middle"/>
+ </imageobject>
+ </mediaobject>
+ </para>
+ </sect3>
+ <sect3 id="dashboard_deletepage">
+ <title>Deleting Pages</title>
+ <para>
+ Users may delete dashboard pages at any time, by scrolling to the bottom of the Configurator screen and
+ clicking the
+ <emphasis>Delete this page</emphasis>
+ button. We will note that users are not able to delete the default dashboard page.
+ <warning>
+ Deleted pages are NOT recoverable. This change is permanent!
+ </warning>
+ </para>
+ </sect3>
+ </sect2>
</sect1>
<sect1 id="adminportal">
<title>Admin Portal</title>
More information about the portal-commits
mailing list