[gatein-commits] gatein SVN: r1862 - in portal/trunk/docs/user-guide/en: modules and 3 other directories.

Author: luc.texier(a)jboss.com Date: 2010-02-25 06:02:56 -0500 (Thu, 25 Feb 2010) New Revision: 1862 Removed: portal/trunk/docs/user-guide/en/Introduction.xml Modified: portal/trunk/docs/user-guide/en/modules/Introduction.xml portal/trunk/docs/user-guide/en/modules/Terms.xml portal/trunk/docs/user-guide/en/modules/account/Account_and_Password_Retrieval.xml portal/trunk/docs/user-guide/en/modules/account/Change_Account_Settings.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/portletsUser/Dashboard_Portlet.xml portal/trunk/docs/user-guide/en/modules/portletsUser/Functional_Portlets.xml portal/trunk/docs/user-guide/en/modules/portletsUser/Interface_Portlets.xml portal/trunk/docs/user-guide/en/modules/terms/Gadget_concept.xml portal/trunk/docs/user-guide/en/modules/terms/Permission_levels.xml portal/trunk/docs/user-guide/en/modules/terms/Portal_concept.xml portal/trunk/docs/user-guide/en/modules/terms/Public_mode_and_Private_mode.xml portal/trunk/docs/user-guide/en/modules/terms/Toolbar_concept.xml Log: GTNPORTAL-719: Luc's review is finished, hand over to ScottM Deleted: portal/trunk/docs/user-guide/en/Introduction.xml =================================================================== --- portal/trunk/docs/user-guide/en/Introduction.xml 2010-02-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/Introduction.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -1,65 +0,0 @@ -<!-- - - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - ---> - -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> -<chapter> - <title>Introduction</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/Frontpage.png" scalefit="1" /> - </imageobject> - </mediaobject> - - <para>GateIn portal is a merge of two mature projects that have - been around for a while, JBoss Portal and eXo Portal. It takes the - best of both into a single new project. The aim is to provide both an - intuitive portal to use as-is and a portal framework to build upon - depending on your needs.</para> - <section> - <title>Links</title> - <itemizedlist> - <listitem> - <para> - GateIn homepage: - <ulink url="http://www.gatein.org">www.gatein.org</ulink> - </para> - </listitem> - <listitem> - <para> - GateIn videos: - <ulink url="http://www.jboss.org/gatein/videos.html">www.jboss.org/... - </para> - </listitem> - <listitem> - <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> - </itemizedlist> - </section> -</chapter> Modified: portal/trunk/docs/user-guide/en/modules/Introduction.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Introduction.xml 2010-02-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/Introduction.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -6,7 +6,7 @@ <chapter id="chap-User_Guide-Introduction"> <title>Introduction</title> <para> - &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. + &PRODUCT; is the merge of two mature Java projects; JBoss Portal and eXo Portal. This new community project takes the best of both offerings and incorporates them into a single j2ee deployment archive. The aim is to provide an intuitive user-friendly portal and a framework to address the needs of today's Web 2.0 applications. </para> <mediaobject> <imageobject> @@ -14,29 +14,38 @@ </imageobject> </mediaobject> <para> - This book explains various apsects of &PRODUCT;, such as managing users and access permissions, using portlets and changing simple interface features such as skins, langauage and page orientation. + This book introduces and provides detailed information about most features and capabilities of &PRODUCT; such as user/group management and access permissions, using portlets and changing basic interface objects such as skins, language and page orientation. </para> <para> - Refer to the <ulink type="http" url="http://redhat.com/docs">&PRODUCT; Installation Guide</ulink> for information on downloading and installing the product or the <ulink type="http" url="http://redhat.com/docs">&PRODUCT; Reference Guide</ulink> for information on more advanced topics. + Refer to <ulink type="http" url="http://www.jboss.org/gatein/documentation.html">&PR...; Installation Guide</ulink> for information on downloading and installing the project or <ulink type="http" url="http://www.jboss.org/gatein/documentation.html">&PR...; Reference Guide</ulink> for detailed information on all aspects of the project. </para> <section id="sect-Install_Guide-Introduction-Related_Links"> <title>Related Links</title> <itemizedlist> <listitem> <para> - GateIn 3.0 is the community project that &PRODUCT; is based on. GateIn project homepage. <ulink url="http://www.gatein.org" /> + GateIn homepage: + <ulink url="http://www.gatein.org">www.gatein.org</ulink> </para> </listitem> <listitem> <para> - GateIn downloads: <ulink url="http://www.jboss.org/gatein/downloads.html">www.jboss.o... + GateIn videos: + <ulink url="http://www.jboss.org/gatein/videos.html">www.jboss.org/... </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" /> + 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> </itemizedlist> </section> Modified: portal/trunk/docs/user-guide/en/modules/Terms.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/Terms.xml 2010-02-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/Terms.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -4,7 +4,7 @@ %BOOK_ENTITIES; ]> <chapter id="chap-User_Guide-Terms"> - <title>Terms &PRODUCT;</title> + <title>Glossary</title> <xi:include href="terms/Portal_concept.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="terms/Portlet_concept.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="terms/Toolbar_concept.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 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-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/account/Account_and_Password_Retrieval.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -4,43 +4,32 @@ %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Account_and_Password_Retrieval"> - <!-- - - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - - --><title>Account and Password Retrieval</title> + <title>Account and Password Retrieval</title> <para> You can recover your username or password should you forget them by following these steps: </para> <procedure> <step> <para> - Click the link '<emphasis role="bold">Forgot your User Name/Password?</emphasis>' (beneath the <emphasis role="bold">Password</emphasis> field of the <emphasis role="bold">Sign in</emphasis> form). This presents the form that guides you through recovering your username and/or password. + Click the link '<emphasis role="bold">Forgot your User Name/Password?</emphasis>' </para> +<note> +<title>DOC TODO</title> +<para> +please redo the screenshot without "Click here when..." and instead display a mouse pointer on the box being checked +</para> +</note> + <mediaobject> <imageobject> <imagedata fileref="images/SignIn1.png" format="PNG" width="444" /> </imageobject> </mediaobject> </step> + <step> <para> - This form offers two options to select: + This form offers two options: </para> <itemizedlist> <listitem> @@ -54,6 +43,13 @@ </para> </listitem> </itemizedlist> +<note> +<title>DOC TODO</title> +<para> +please redo the screenshot, it is too big +</para> +</note> + <mediaobject> <imageobject> <imagedata fileref="images/Forgot1.png" format="PNG" width="444" /> @@ -72,6 +68,13 @@ <para> If you selected the <emphasis role="bold">Forgot my password</emphasis> option you will be prompted for your username: </para> +<note> +<title>DOC TODO</title> +<para> +please redo the screenshot without "Click Send to send...", the circle around the field and "Enter your username" +</para> +</note> + <mediaobject> <imageobject> <imagedata fileref="images/ForgotUserName1.png" format="PNG" width="444" /> @@ -82,6 +85,12 @@ <para> If you selected <emphasis role="bold">Forgot my username</emphasis> you will be prompted for your email address. </para> +<note> +<title>DOC TODO</title> +<para> +please redo the screenshot without "Click Send to send...", the circle around the field and "Enter your email" +</para> +</note> <mediaobject> <imageobject> <imagedata fileref="images/ForgotEmail1.png" format="PNG" width="444" /> @@ -90,22 +99,12 @@ </listitem> </itemizedlist> </step> - <step> - <para> - Enter the approprate value into the open field. - </para> - </step> - <step> - <para> - Click the <emphasis role="bold">Send</emphasis> button to send the entered values. - </para> - </step> </procedure> <para> After you submit the form an email will be send to your email address with the requested information, either your username or password. </para> <para> - If you forgot your password you will be sent a new (temporary) password. Your original password will not be valid after this email is sent. You will be directed to update your password the next time you sign in. + If you forgot your password you will be sent a new (temporary) password. Your original password will not be valid after this email is sent. You will be directed to a page to update your password the next time you sign in. </para> </section> Modified: portal/trunk/docs/user-guide/en/modules/account/Change_Account_Settings.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/account/Change_Account_Settings.xml 2010-02-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/account/Change_Account_Settings.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -4,27 +4,8 @@ %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Change_Account_Settings"> - <!-- + <title>Change Account Settings</title> - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - - --><title>Change Account Settings</title> - <para> To change your account information, click on the account name in the top navigation bar: </para> @@ -36,18 +17,26 @@ <para> The <emphasis role="bold">Account Profiles</emphasis> form will appear: </para> + + +<note> +<title>DOC TODO</title> +<para> +please redo the screenshot without "Click Save to..." and using a smaller window, it is too big right now +</para> +</note> <mediaobject> <imageobject> <imagedata fileref="images/AccountProfiles3.png" format="PNG" width="444" /> </imageobject> </mediaobject> <para> - If you want to change your Account Profile information: + To change your Account Profile information: </para> <procedure> <step> <para> - Select the <emphasis role="bold">Account Profiles</emphasis> tab. This will display your current basic information. + Select the <emphasis role="bold">Account Profiles</emphasis> tab. </para> </step> <step> @@ -69,6 +58,12 @@ <para> Select the <emphasis role="bold">Change Password</emphasis> tab, it will display the following form: </para> +<note> +<title>DOC TODO</title> +<para> +please redo the screenshot without "Click Save to..." and using a smaller window, it is too big right now +</para> +</note> <mediaobject> <imageobject> <imagedata fileref="images/ChangePassword.png" format="PNG" width="444" /> 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-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/account/Register_New_Accounts.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -4,47 +4,34 @@ %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Register_New_Accounts"> - <!-- - - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - - --><title>Register New Accounts</title> + <title>Register New Accounts</title> <para> Unregistered users who visit the portal are limited in the content they can see. </para> <para> - Users who need access to deeper content or who need to undertake actions within the portal should register themselves and then contact the portal administrator to have appropriate permissions added to their account. + Users who need access to deeper content or who need to perform actions within the portal should register themselves and then contact the portal administrator to gain appropriate access permissions to their account. </para> <para> - Users can quickly and easily register a new account for themselves. Complete the steps below: + Users can quickly and easily register a new account for themselves. </para> <procedure> <step> <para> Click <emphasis role="bold">Register</emphasis> on the Navigation bar. </para> +<note> +<title>DOC TODO</title> +<para> +please update with latest display + mouse pointer on "Register" +</para> +</note> <mediaobject> <imageobject> <imagedata fileref="images/Frontpage.png" format="PNG" width="444" /> </imageobject> </mediaobject> <para> - The Register page will appear: + The Register page appears: </para> <mediaobject> <imageobject> @@ -114,7 +101,7 @@ </step> <step> <para> - Click the 'find' icon beside the user name field to check if the chosen username is available. + Click the 'find' icon beside the user name field to check whether the chosen username is available. </para> </step> <!-- <step> @@ -142,7 +129,7 @@ </listitem> <listitem> <para> - The nominated <emphasis role="bold">Password</emphasis> has less than 6 characters or more than 30 characters. + The <emphasis role="bold">Password</emphasis> has less than 6 characters or more than 30 characters. </para> </listitem> <listitem> @@ -164,11 +151,11 @@ </step> </procedure> <para> - After adding a new account, you should contact the administrator to get appropriate permissions added to your account. + After adding a new account, you should contact the administrator to set appropriate permissions on your account. <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 from this email address. + Be sure you enter your email address carefully. Should you forget your user name or password, you can recover it from 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-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/account/Remember_User_Account.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -4,28 +4,9 @@ %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Remember_User_Account"> - <!-- - - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - - --><title>Remember User Account</title> + <title>Remember User Account</title> <para> - Users can return to the &PRODUCT; and be automatically authenticated with a cookie provided by their browser. This means users do not have to perform an explicit authentication each time they access the portal. + Users who return to &PRODUCT; can be automatically authenticated thanks to a cookie set the first time they've logged in. Users do not have to perform an explicit authentication each time they access the portal. </para> <mediaobject> <imageobject> @@ -50,7 +31,7 @@ </step> </procedure> <para> - 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. + You must remember to close your browser without signing out (as signing out will delete the cookie). </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-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/account/Sign_in_and_Sign_out.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -4,29 +4,10 @@ %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Sign_In_and_Sign_Out"> - <!-- + <title>Sign In and Sign Out</title> - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - - --><title>Sign In and Sign Out</title> - <para> - After registering your account, you can sign in to &PRODUCT; to go into private mode. + In order to enter the portal in private mode, you should use the account previously registered. </para> <para> To sign in to a portal, users must complete the <emphasis role="bold">Sign in</emphasis> form. This form contains the following elements: @@ -58,7 +39,7 @@ </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. + Check this box to avoid log in every time </para> </listitem> </varlistentry> @@ -93,8 +74,10 @@ </listitem> </varlistentry> </variablelist> + + <section id="sect-User_Guide-Sign_In"> + <title>Sign In</title> <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). @@ -132,16 +115,21 @@ <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/PortalHome.png" format="PNG" width="444" /> </imageobject> </mediaobject> +--> + </section> + + <section id="sect-User_Guide-Sign_Out"> + <title>Sign Out</title> <procedure> - <title>Sign Out</title> <step> <para> - This function lets you get back to the anonymous portal. It ends your current portal session. + This feature lets you get back to the anonymous portal. It ends your current portal session. </para> </step> <step> @@ -155,6 +143,7 @@ </mediaobject> </step> </procedure> + </section> </section> 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-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/portletsUser/Dashboard_Portlet.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -17,7 +17,6 @@ </imageobject> </mediaobject> - <section id="sect-User_Guide-Dashboard_Portlet-Using_the_Dashboard_Workspace"> <title>Using the Dashboard Workspace</title> <procedure> @@ -34,7 +33,7 @@ </procedure> <para> - 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. + 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 and entering a new name. </para> <mediaobject> <imageobject> @@ -43,7 +42,7 @@ </mediaobject> <para> - The Dashboard Workspace lists all available gadgets. There are four gadgets built into &PRODUCT; by default, however you can add many more. + The Dashboard Workspace lists all available gadgets. Four gadgets are provided by default with &PRODUCT;, however you can add many more. </para> <mediaobject> <imageobject> @@ -56,7 +55,7 @@ <term>Calendar</term> <listitem> <para> - The calendar gadget allows users to switch easily between daily, monthly and yearly view and, again, is customizable to match your portal's theme. + The calendar gadget allows users to switch easily between daily, monthly and yearly view and, is customizable to match your portal's theme. </para> <mediaobject> <imageobject> @@ -108,7 +107,7 @@ <term>More Gadgets</term> <listitem> <para> - Further gadgets can be obtained from the <ulink type="http" url="http://www.google.com/ig/directory?synd=open">Google Gadget</ulink> site. &PRODUCT; is compatible with most of the gadgets available here. + Many more gadgets can be found at <ulink type="http" url="http://www.google.com/ig/directory?synd=open">Google Gadget</ulink>. &PRODUCT; is compatible with most of the gadgets available there. </para> </listitem> </varlistentry> @@ -117,6 +116,13 @@ <section id="sect-User_Guide-Dashboard_Portlet-Add_Gadgets"> <title>Add Gadgets</title> + +<note> +<title>DOC TODO</title> +<para> +please redo this section wich screenshots to demonstrate the addition of an external gadget provided by Google +</para> +</note> <para> To add more gadgets from external sources: </para> @@ -126,12 +132,12 @@ 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> + 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 with <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: <ulink type="http" url="http://feeds.feedburner.com/gatein">http://feeds.feedbu...>), a new RSS reader gadget will be created automatically even if the URL does not end in <literal>.rss</literal>. + 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: <ulink type="http" url="http://feeds.feedburner.com/gatein">http://feeds.feedbu...>), a new RSS reader gadget will be created automatically even if the URL does not end with <literal>.rss</literal>. </para> </note> </step> 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-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/portletsUser/Functional_Portlets.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -9,15 +9,15 @@ 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. + &PRODUCT; provides the following portlets by default: </para> <variablelist> <varlistentry> - <term>Account Portlet</term> + <term><emphasis role="bold">Account Portlet</emphasis></term> <listitem> <para> - This Portlet allows users to register a new account and choose a preferred language for displaying the Portal interface. + The Account Portlet allows users to register a new account and choose a preferred language for displaying the Portal interface. </para> <mediaobject> <imageobject> @@ -27,10 +27,10 @@ </listitem> </varlistentry> <varlistentry> - <term>Organization Portlet</term> + <term><emphasis role="bold">Organization Portlet</emphasis></term> <listitem> <para> - This Portlet is used to manage user information, groups of users and groups memberships. + The Organization Portlet is used to manage user information, groups of users and groups memberships. </para> <mediaobject> <imageobject> @@ -40,11 +40,18 @@ </listitem> </varlistentry> <varlistentry> - <term>Application Registry Portlet</term> + <term><emphasis role="bold">Application Registry Portlet</emphasis></term> <listitem> <para> - This Portlet is used to manage different application categories. You can add, edit, set permissions and delete a category and its applications. + The Application Registry Portlet is used to manage different application categories. You can add, edit, set permissions and delete a category and its applications. </para> + +<note> +<title>DOC TODO</title> +<para> +please redo screenshot, it is not up-to-date +</para> +</note> <mediaobject> <imageobject> <imagedata fileref="images/ApplicationRegistry.png" format="PNG" width="444" /> @@ -52,8 +59,9 @@ </mediaobject> </listitem> </varlistentry> +<!-- <varlistentry> - <term>Internationalization Portlet</term> + <term><emphasis role="bold">Internationalization Portlet</emphasis></term> <listitem> <para> This Portlet is used to translate a word or a phrase from the current language to another language. @@ -65,6 +73,7 @@ </mediaobject> </listitem> </varlistentry> +--> <!-- Doesn't exist anymore AFAIK <varlistentry> <term>Administration Toolbar Portlet</term> @@ -84,13 +93,13 @@ <term>Star Toolbar Portlet</term> <listitem> <para> - The Star Toolbar Portlet is used to change language and skin of the portal or to sign out. + The Star Toolbar Portlet is used to change the default language, the skin of the portal or to sign out. </para> - <!-- <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/StarPortlet.png" format="PNG"></imagedata> </imageobject> - </mediaobject> --> + </mediaobject> </listitem> </varlistentry> <!--<varlistentry> Modified: portal/trunk/docs/user-guide/en/modules/portletsUser/Interface_Portlets.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portletsUser/Interface_Portlets.xml 2010-02-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/portletsUser/Interface_Portlets.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -6,7 +6,7 @@ <section id="sect-User_Guide-Interface_Portlets"> <title>Interface Portlets</title> <para> - The Interface Portlets are the face of the Portal. They provide the means for users to interact with the portal. &PRODUCT; consists of the following Interface Portlets: + The Interface Portlets are the front-end components of the Portal. They provide ways for users to interact with the portal. &PRODUCT; provides the following Interface Portlets: </para> <variablelist> @@ -40,7 +40,7 @@ <term>Navigation Portlet</term> <listitem> <para> - This Portlet provides a navigation bar. A navigation is a menu that helps users to visualize the structure of a site and provide links to quickly move from page to page. + This Portlet provides a navigation bar. A navigation bar is a menu that helps users to visualize the structure of a site and provide links to quickly move from page to page. </para> <!-- <mediaobject> <imageobject> @@ -53,7 +53,7 @@ <term>Sitemap Portlet</term> <listitem> <para> - This Portlet is used to provide a site map page of a web site. It lists pages on a website, typically organized in hierarchical fashion. + This Portlet displays a site map page of a web site. It lists pages on a website, typically organized in hierarchical fashion. </para> <!-- <mediaobject> <imageobject> @@ -94,11 +94,13 @@ <para> This portlet is used for hosting mini-applications known as gadgets. The dashboard uses a variety of graphical effects for displaying, opening, and using gadgets. </para> +<!-- <mediaobject> <imageobject> <imagedata fileref="images/Dashboard1.png" format="PNG" width="444" /> </imageobject> </mediaobject> +--> <para> Refer to <xref linkend="sect-User_Guide-Dashboard_Portlet" /> or <xref linkend="chap-User_Guide-Gadgets_Administration" /> for more information. </para> Modified: portal/trunk/docs/user-guide/en/modules/terms/Gadget_concept.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/terms/Gadget_concept.xml 2010-02-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/terms/Gadget_concept.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -6,10 +6,10 @@ <section id="sect-User_Guide-Gadgets"> <title>Gadgets</title> <para> - A gadget is a mini web application that a portal user can add to their web page. Some useful gadgets that are packaged by default with &PRODUCT;: + A gadget is a customizable mini web application that portal users may add to their web pages. </para> <para> - See the <emphasis role="bold">Default Gadgets</emphasis> section of <xref linkend="sect-User_Guide-Dashboard_Portlet-Using_the_Dashboard_Workspace" /> for more information about these gadgets. + For more information about the gadgets shipped by default with &PRODUCT;, please check out <xref linkend="sect-User_Guide-Dashboard_Portlet-Using_the_Dashboard_Workspace" /> </para> </section> Modified: portal/trunk/docs/user-guide/en/modules/terms/Permission_levels.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/terms/Permission_levels.xml 2010-02-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/terms/Permission_levels.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -9,12 +9,12 @@ Permission settings control what users can and cannot do within the portal and are set by portal administrators. </para> <para> - Permission <emphasis role="bold">types</emphasis> dictate what a user can do within the portal. There are two permission types used in &PRODUCT;: + Permission <emphasis role="bold">types</emphasis> dictate what a user can do within the portal. Two permission types are available as follows: </para> <variablelist> <varlistentry> - <term>Access</term> + <term><emphasis role="bold">Access</emphasis></term> <listitem> <para> This permission type allows users to utilize portal content, that is; sign in, rearrange portlets, etc. This permission can be set for multiple member groups. @@ -22,7 +22,7 @@ </listitem> </varlistentry> <varlistentry> - <term>Edit</term> + <term><emphasis role="bold">Edit</emphasis></term> <listitem> <para> This permission type allows users to change portal content. This includes actions such as changing page information, deleting pages etc. The <emphasis>edit</emphasis> permission is set for only one group at a time. @@ -37,7 +37,7 @@ <variablelist> <varlistentry> - <term>Portal</term> + <term><emphasis role="bold">Portal</emphasis></term> <listitem> <para> The portal permission level includes all pages within the portal. Therefore, a user with the <emphasis role="bold">access</emphasis> permission type can view (but not edit) all the pages within the portal. A user with <emphasis role="bold">edit</emphasis> permission at the portal level, can change any page in the portal. @@ -45,7 +45,7 @@ </listitem> </varlistentry> <varlistentry> - <term>Page</term> + <term><emphasis role="bold">Page</emphasis></term> <listitem> <para> The page permission level restricts the user to particular pages. Users are only able to see and/or edit (depending on their permission <emphasis role="bold">type</emphasis>) pages they have been given access to. @@ -53,10 +53,10 @@ </listitem> </varlistentry> <varlistentry> - <term>Portlet</term> + <term><emphasis role="bold">Portlet</emphasis></term> <listitem> <para> - The portlet permission level allows users create a page by dragging and dropping portlets into a page. Some portlets are only used for administrators while some are used for individuals thus administrators have to set the appropriate access permissions. + The portlet permission level allows users to create a page by dragging and dropping portlets into a page. Some portlets are only used for administrators while some are used for individuals thus administrators have to set the appropriate access permissions. </para> </listitem> </varlistentry> Modified: portal/trunk/docs/user-guide/en/modules/terms/Portal_concept.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/terms/Portal_concept.xml 2010-02-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/terms/Portal_concept.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -6,35 +6,8 @@ <section id="sect-User_Guide-Portal"> <title>Portal</title> <para> - &PRODUCT; is a web-based application that provides users with a personalized User Interface (UI). This interface allows users to easily search applications and information or communicate with other users. +An enterprise portal is a Web application that provides means to aggregate and personalize information via application-specific portlets. The users and administrators are able via a web-based user interface to integrate information, people and processes across organizational boundaries. The framework enables aggregation of enterprise content and business applications with flexible management and personalization options. </para> - <para> - The Portal provides a graphical aggregation of enterprise content and business applications with flexible management and personalization options. - </para> - <!-- - <para> - Portal has two main components: - </para> - - <variablelist> - <varlistentry> - <term>Portal Engine</term> - <listitem> - <para> - The engine renders and runs pages, navigations and preferences. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>WebUI Framework</term> - <listitem> - <para> - The WebUI Framework has <ulink type="http" url="http://www.xul.fr/en-xml-ajax.html">AJAX</ulink> support and is designed for easy screen composition. - </para> - </listitem> - </varlistentry> - </variablelist> - --> </section> Modified: portal/trunk/docs/user-guide/en/modules/terms/Public_mode_and_Private_mode.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/terms/Public_mode_and_Private_mode.xml 2010-02-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/terms/Public_mode_and_Private_mode.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -6,7 +6,7 @@ <section id="sect-User_Guide-Modes"> <title>Modes</title> <para> - &PRODUCT; has two <emphasis role="bold">modes</emphasis>: + By default &PRODUCT; offers two access <emphasis role="bold">modes</emphasis>: </para> <variablelist> <varlistentry> @@ -21,7 +21,7 @@ <term>Private</term> <listitem> <para> - This mode is for registered users. Users set a username and password during registration which they can use to sign in. This mode allows users more site privileges. Registered users can manage private resources (creating, editing or deleting private pages), "borrow" pages from other users by creating hyperlinks and change the language for individual needs. + This mode is for registered users only. Users set a username and password during registration which they can then use to sign in. This mode offers users more site privileges. Registered users can manage private resources (creating, editing or deleting private pages), "borrow" pages from other users by creating hyperlinks and change the language for individual needs. </para> </listitem> </varlistentry> Modified: portal/trunk/docs/user-guide/en/modules/terms/Toolbar_concept.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/terms/Toolbar_concept.xml 2010-02-25 09:44:27 UTC (rev 1861) +++ portal/trunk/docs/user-guide/en/modules/terms/Toolbar_concept.xml 2010-02-25 11:02:56 UTC (rev 1862) @@ -6,18 +6,15 @@ <section id="sect-User_Guide-Toolbar-Concept"> <title>Toolbar</title> <para> - The Toolbar spans the top of the portal application and contains links to user and administrative actions. It helps users and the administrator access and perform actions easily, quickly and effectively. - </para> - <para> - You can see the toolbar below as it appears in the Portal: - </para> + The Toolbar spans the top of the portal application and provides links to user and administrative actions. + </para> <mediaobject> <imageobject> <imagedata fileref="images/Toolbar.png" format="PNG" width="444" /> </imageobject> </mediaobject> <para> - In this image you can see the three Navigations referred to in <xref linkend="sect-User_Guide-Navigation" /> as well as the main Menu button (on the far left of the toolbar) and the name of the current user (on the far right). + This screenshot displays three Navigations referred to in <xref linkend="sect-User_Guide-Navigation" /> as well as the main Menu button (on the far left of the toolbar) and the name of the current user (on the far right). </para> <para> In this example the current user is the site administrator, hence the extra "Site Editor" menu.