[portal-commits] JBoss Portal SVN: r7613 - in docs/trunk/userGuide/en: modules and 1 other directory.

Author: chris.laprun(a)jboss.com Date: 2007-06-28 18:49:46 -0400 (Thu, 28 Jun 2007) New Revision: 7613 Added: docs/trunk/userGuide/en/images/intro/adminportal.png docs/trunk/userGuide/en/images/intro/dashboard.png docs/trunk/userGuide/en/images/intro/dashboard_assignportlets.png docs/trunk/userGuide/en/images/intro/dashboard_configure.png docs/trunk/userGuide/en/images/intro/dashboard_copy_to.png docs/trunk/userGuide/en/images/intro/dashboard_deletepage.png docs/trunk/userGuide/en/images/intro/newspage.png docs/trunk/userGuide/en/images/intro/newsportlet.png docs/trunk/userGuide/en/images/intro/newsportlet_edit.png docs/trunk/userGuide/en/images/intro/weather_config1.png Removed: docs/trunk/userGuide/en/images/intro/adminpage.gif docs/trunk/userGuide/en/images/intro/dashboard.jpg docs/trunk/userGuide/en/images/intro/dashboard_add.gif 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_dnd.jpg docs/trunk/userGuide/en/images/intro/dashboard_selectpage.gif docs/trunk/userGuide/en/images/intro/newspage.gif docs/trunk/userGuide/en/images/intro/newsportlet.gif docs/trunk/userGuide/en/images/intro/newsportlet_edit.gif docs/trunk/userGuide/en/images/intro/weather_config1.gif Modified: docs/trunk/userGuide/en/modules/intro.xml Log: - Fixed intro module with updated content and new screenshots. Deleted: docs/trunk/userGuide/en/images/intro/adminpage.gif =================================================================== (Binary files differ) Added: docs/trunk/userGuide/en/images/intro/adminportal.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/intro/adminportal.png ___________________________________________________________________ Name: svn:mime-type + image/png Deleted: docs/trunk/userGuide/en/images/intro/dashboard.jpg =================================================================== (Binary files differ) Added: docs/trunk/userGuide/en/images/intro/dashboard.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/intro/dashboard.png ___________________________________________________________________ Name: svn:mime-type + image/png Deleted: docs/trunk/userGuide/en/images/intro/dashboard_add.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/intro/dashboard_assignportlets.gif =================================================================== (Binary files differ) Added: docs/trunk/userGuide/en/images/intro/dashboard_assignportlets.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/intro/dashboard_assignportlets.png ___________________________________________________________________ Name: svn:mime-type + image/png Deleted: docs/trunk/userGuide/en/images/intro/dashboard_assignthemes.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/intro/dashboard_configure.gif =================================================================== (Binary files differ) Added: docs/trunk/userGuide/en/images/intro/dashboard_configure.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/intro/dashboard_configure.png ___________________________________________________________________ Name: svn:mime-type + image/png Added: docs/trunk/userGuide/en/images/intro/dashboard_copy_to.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/intro/dashboard_copy_to.png ___________________________________________________________________ Name: svn:mime-type + image/png Deleted: docs/trunk/userGuide/en/images/intro/dashboard_createpage.gif =================================================================== (Binary files differ) Added: docs/trunk/userGuide/en/images/intro/dashboard_deletepage.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/intro/dashboard_deletepage.png ___________________________________________________________________ Name: svn:mime-type + image/png Deleted: docs/trunk/userGuide/en/images/intro/dashboard_dnd.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/intro/dashboard_dnd.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/intro/dashboard_selectpage.gif =================================================================== (Binary files differ) Deleted: docs/trunk/userGuide/en/images/intro/newspage.gif =================================================================== (Binary files differ) Added: docs/trunk/userGuide/en/images/intro/newspage.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/intro/newspage.png ___________________________________________________________________ Name: svn:mime-type + image/png Deleted: docs/trunk/userGuide/en/images/intro/newsportlet.gif =================================================================== (Binary files differ) Added: docs/trunk/userGuide/en/images/intro/newsportlet.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/intro/newsportlet.png ___________________________________________________________________ Name: svn:mime-type + image/png Deleted: docs/trunk/userGuide/en/images/intro/newsportlet_edit.gif =================================================================== (Binary files differ) Added: docs/trunk/userGuide/en/images/intro/newsportlet_edit.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/intro/newsportlet_edit.png ___________________________________________________________________ Name: svn:mime-type + image/png Deleted: docs/trunk/userGuide/en/images/intro/weather_config1.gif =================================================================== (Binary files differ) Added: docs/trunk/userGuide/en/images/intro/weather_config1.png =================================================================== (Binary files differ) Property changes on: docs/trunk/userGuide/en/images/intro/weather_config1.png ___________________________________________________________________ Name: svn:mime-type + image/png Modified: docs/trunk/userGuide/en/modules/intro.xml =================================================================== --- docs/trunk/userGuide/en/modules/intro.xml 2007-06-28 22:46:12 UTC (rev 7612) +++ docs/trunk/userGuide/en/modules/intro.xml 2007-06-28 22:49:46 UTC (rev 7613) @@ -6,6 +6,11 @@ <surname>Russo</surname> <email&gt;roy(a)jboss.org&lt;/email&gt; </author> + <author> + <firstname>Chris</firstname> + <surname>Laprun</surname> + <email&gt;chris.laprun(a)jboss.com&lt;/email&gt; + </author> </chapterinfo> <title>JBoss Portal Basics</title> <sect1> @@ -315,29 +320,20 @@ </sect3> <sect3 id="intro_cms_portlet"> <title>CMS Portlet</title> - - TODO TODO TODO Update TODO TODO TODO - <para> <mediaobject> <imageobject> - <imagedata fileref="images/intro/cms_portlet.gif" format="gif" align="center" - valign="middle"/> + <imagedata fileref="images/intro/cms_portlet.gif" format="gif" align="center" valign="middle"/> </imageobject> </mediaobject> - Renders data from the Content Management System embedded with the Portal. Users are able to - navigate the content, view images, binary files, etc.. via this portlet. + Portal includes a basic Content Management System (CMS). Portal provides a 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 - <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> + file, located in <emphasis>/default/foo/bar.zip</emphasis>, we 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 files. Keep in mind, however, that binary files are displayed outside of the portal pages, but text/html are displayed inside the CMSPortlet Window. @@ -349,10 +345,7 @@ 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>Administrators should view, - <xref linkend="admincmsPortlet"/> - , for managing the data in the CMS. - </note> + <note>Administrators should read <xref linkend="admincmsPortlet"/> for managing the data in the CMS.</note> </sect3> </sect2> <sect2> @@ -360,22 +353,43 @@ <para> <mediaobject> <imageobject> - <imagedata fileref="images/intro/newspage.gif" format="gif" align="center" valign="middle"/> + <imagedata fileref="images/intro/newspage.png" format="png" align="center" valign="middle"/> </imageobject> </mediaobject> - The News Page contains customizable weather and news displays from common internet feeds. An open internet + 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> + <sect3 id="newsportlet"> + <title>News Portlet</title> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="images/intro/newsportlet.png" format="png" align="center" valign="middle"/> + </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 + <imageobject> + <imagedata fileref="images/intro/ico_edit.gif" format="gif"/> + </imageobject> + ). 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. + <mediaobject> + <imageobject> + <imagedata fileref="images/intro/newsportlet_edit.png" format="png" align="center" + valign="middle"/> + </imageobject> + </mediaobject> + </para> + <note>This portlet is capable of handling most RSS 1.0 and RSS 2.0 feeds.</note> + </sect3> + </sect2> + <sect2> + <title>Weather Page</title> <para> - This page contains the following portlets: - <itemizedlist> - <listitem> - <xref linkend="weatherportlet"/> - </listitem> - <listitem> - <xref linkend="newsportlet"/> - </listitem> - </itemizedlist> + This page contains a portlet displaying the weather forecast for a specific location. </para> <sect3 id="weatherportlet"> <title>Weather Portlet</title> @@ -386,16 +400,15 @@ </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. + displays it as HTML to the user. </para> - <para>Additionally, a user is able to modify his preference in location by going in to the Portlet's Edit - Mode (click + <para>Additionally, a logged-in user is able to modify her preference in location by using the + Portlet's Edit Mode (click <imageobject> <imagedata fileref="images/intro/ico_edit.gif" format="gif"/> </imageobject> - ). Any valid US Postal Code can be inputted here. Once the form is submitted, this property will be saved - in the user's preference, so he will always see the same weather data for his 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 she will always see the same weather data for her location, when logged in. <mediaobject> <imageobject> <imagedata fileref="images/intro/weatherportlet_edit.gif" format="gif" align="center" @@ -416,16 +429,15 @@ <para>Enter your city name in the location field, found on the page: <mediaobject> <imageobject> - <imagedata fileref="images/intro/weather_config1.gif" format="gif" align="center" + <imagedata fileref="images/intro/weather_config1.png" format="png" align="center" valign="middle"/> </imageobject> </mediaobject> </para> </listitem> <listitem> - <para>Find your location on the list under the form and click on it (In this case, its - <emphasis>Marseille, France</emphasis> - ): + <para>Find your location on the list under the form and click on it + (<emphasis>Marseille, France</emphasis>, in this case): <mediaobject> <imageobject> <imagedata fileref="images/intro/weather_config2.gif" format="gif" align="center" @@ -435,9 +447,8 @@ </para> </listitem> <listitem> - <para>Copy the location digits from the address bar in your browser (In this case, its - <emphasis>FRXX0059</emphasis> - ): + <para>Copy the location digits from the address bar in your browser (<emphasis>FRXX0059</emphasis> + in this case): <mediaobject> <imageobject> <imagedata fileref="images/intro/weather_config3.gif" format="gif" align="center" @@ -447,18 +458,15 @@ </para> </listitem> <listitem> - <para>Paste these numbers in to the weather portlet edit form (In this case, its - <emphasis>FRXX0059</emphasis> - ): + <para>Paste these numbers in to the weather portlet edit form (<emphasis>FRXX0059</emphasis> in + this case): <mediaobject> <imageobject> <imagedata fileref="images/intro/weather_config4.gif" format="gif" align="center" valign="middle"/> </imageobject> </mediaobject> - Hit - <emphasis>submit</emphasis> - ... + Hit <emphasis>submit</emphasis>... <mediaobject> <imageobject> <imagedata fileref="images/intro/weather_config5.gif" format="gif" align="center" @@ -470,258 +478,119 @@ </orderedlist> </para> </sect3> - <sect3 id="newsportlet"> - <title>News Portlet</title> - <para> - <mediaobject> - <imageobject> - <imagedata fileref="images/intro/newsportlet.gif" format="gif" align="center" valign="middle"/> - </imageobject> - </mediaobject> - The News Portlet retrieves an RSS news feed, based on a url, and displays it as HTML to the user. - </para> - <para>Additionally, a user is able to modify his preference in RSS feed source by going in to the Portlet's - Edit - Mode (click - <imageobject> - <imagedata fileref="images/intro/ico_edit.gif" format="gif"/> - </imageobject> - ). Once the form is submitted, this property will be saved - in the user's preference, so he will always see the same news source, when logged in. - <mediaobject> - <imageobject> - <imagedata fileref="images/intro/newsportlet_edit.gif" format="gif" align="center" - valign="middle"/> - </imageobject> - </mediaobject> - </para> - <note>This portlet is capable of handling most RSS 1.0 and RSS 2.0 feeds.</note> - </sect3> </sect2> - <sect2> - <title>Test Page</title> - <para> - Items in this test page change frequently. They are used mainly by the JBoss Portal Development team to - debug and test new functionality. For that reason, these items are not covered in this document. It is - recommended that Portal Administrators remove this page for that reason. - </para> - </sect2> </sect1> <sect1 id="dashboard"> <title>Personal Dashboard</title> - <para>Once logged in, all users/administrations of the portal will have a personal dashboard they can navigate to, - by clicking the - <emphasis>My Dashboard</emphasis> - link at the top-right of the portal page. + <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. <mediaobject> <imageobject> - <imagedata fileref="images/intro/dashboard.jpg" format="jpg" align="center" - valign="middle"/> + <imagedata fileref="images/intro/dashboard.png" format="png" align="center" valign="middle"/> </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. - <mediaobject> - <imageobject> - <imagedata fileref="images/intro/dashboard_dnd.gif" format="gif" align="center" - valign="middle"/> - </imageobject> - </mediaobject> 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. + 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. + This will clone the page and add it to your personal dashboard as a page with the same name. <mediaobject> <imageobject> - <imagedata fileref="images/intro/dashboard_add.gif" format="gif" align="center" - valign="middle"/> + <imagedata fileref="images/intro/dashboard_copy_to.png" format="png" align="center" valign="middle"/> </imageobject> </mediaobject> - You are also able to add(clone) shared pages to your personal dashboard, by selecting the - <emphasis>Add to Dashboard</emphasis> - link. This will clone the page and add it to your personal dashboard as a page with the same name. </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: + You can configure your dashboard by using the top-right menu item labeled <emphasis>'Edit Page'</emphasis>: <mediaobject> <imageobject> - <imagedata fileref="images/intro/dashboard_configure.gif" format="gif" align="center" + <imagedata fileref="images/intro/dashboard_configure.png" format="png" 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> + <sect3> + <title>Dashboard-wide operations</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> + You can select a theme and layout for your dashboard by selecting from the available ones and then + clicking on select in the <emphasis>Theme and Layout</emphasis> form. + </para> + <para> + You can also create new pages that will be added to your dashboard by simply entering the name of the new + page in the <emphasis>Create New Page</emphasis> form at the top left of the screen. <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. + Upon creating a new page, the screen will refresh and allow a user to customize the new page. </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. + <mediaobject> + <imageobject> + <imagedata fileref="images/intro/dashboard_deletepage.png" format="png" align="center" valign="middle"/> + </imageobject> + </mediaobject> + <warning> + Deleted pages are NOT recoverable. This change is permanent! + </warning> + </para> </sect3> <sect3 id="dashboard_assignportlets"> - <title>Managing Portlets</title> + <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 + 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 TODO: Add section xref <mediaobject> <imageobject> - <imagedata fileref="images/intro/dashboard_assignportlets.gif" format="gif" align="center" + <imagedata fileref="images/intro/dashboard_assignportlets.png" format="png" 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> <para> - <note>You - <emphasis role="bold">must be</emphasis> - logged in as an administrator, or have proper priviledges to see this page. + <note>You <emphasis role="bold">must be</emphasis> logged in as an administrator, or have proper priviledges + to see this portal. </note> <mediaobject> <imageobject> - <imagedata fileref="images/intro/adminpage.gif" format="gif" align="center" valign="middle"/> + <imagedata fileref="images/intro/adminportal.png" format="png" align="center" valign="middle"/> </imageobject> </mediaobject> - The Admin Page's purpose is to allow an administrator to manage all aspects of the portal (Follow the links - for in-depth reviews of - these functions): + 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> <listitem> - <para>Users/Roles (See: - <xref linkend="useradmin"/> - , - <xref linkend="roleadmin"/> - ) + <para>Users/Roles (See: <xref linkend="useradmin"/>, <xref linkend="roleadmin"/>) </para> </listitem> <listitem> - <para>Content Management System (See: - <xref linkend="admincmsPortlet"/> - ) + <para>Content Management System (See: <xref linkend="admincmsPortlet"/>) </para> </listitem> <listitem> <para>Portal Objects (themes, layouts, portal instances, pages, windows, security, and deployed - portlets) (See: - <xref linkend="dynamicity"/> - ) + portlets) (See: <xref linkend="dynamicity"/>) </para> </listitem> </itemizedlist> - </para> </sect1> </chapter> \ No newline at end of file