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

Author: smumford Date: 2010-01-09 04:42:17 -0500 (Sat, 09 Jan 2010) New Revision: 1208 Modified: portal/trunk/docs/user-guide/en/modules/account/Register_New_Accounts.xml portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Gadgets_in_User_Workspace.xml portal/trunk/docs/user-guide/en/modules/language/Change_Interface_Language.xml portal/trunk/docs/user-guide/en/modules/language/Internationalization_Portlet.xml portal/trunk/docs/user-guide/en/modules/language/Multi-Language_Navigation_Nodes.xml portal/trunk/docs/user-guide/en/modules/language/Right_To_Left_Support_(RTL).xml portal/trunk/docs/user-guide/en/modules/portal/Create_a_New_Portal.xml portal/trunk/docs/user-guide/en/modules/portal/Manage_Portals.xml portal/trunk/docs/user-guide/en/modules/portal/Switching_between_Portals.xml Log: further edits 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-01-08 18:02:27 UTC (rev 1207) +++ portal/trunk/docs/user-guide/en/modules/account/Register_New_Accounts.xml 2010-01-09 09:42:17 UTC (rev 1208) @@ -64,7 +64,7 @@ <term>Password</term> <listitem> <para> - The *Password* must be between 6 and 30 characters and can contain space characters. Since Portal 2.6, space characters are either at the beginning or in the end can be counted. + The password must be between 6 and 30 characters and can contain spaces. </para> </listitem> </varlistentry> 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-01-08 18:02:27 UTC (rev 1207) +++ portal/trunk/docs/user-guide/en/modules/gadgetsAdmin/Manage_Gadgets_in_User_Workspace.xml 2010-01-09 09:42:17 UTC (rev 1208) @@ -19,21 +19,22 @@ 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. + 02110-1301 USA, or see the FSF site: http://www.fsf.org. --><title>Manage Gadgets</title> - <orderedlist numeration="arabic"> - <listitem> - <para> - Gadgets are a small convenient applications that helps you perform private actions. &PRODUCT; provides you with some useful gadgets: todo, calendar, calculator and RSS Reader. Besides using ready-to-use gadgets, you can easily add gadgets organized in categories to meet the need of your work : - </para> - </listitem> - </orderedlist> - <section id="sect-User_Guide-Manage_Gadgets_in_User_Workspace-Add_a_Gadget"> - <title>Add a Gadget</title> - <para> - To add a gadget, you can follow these steps: - </para> + <para> + Gadgets are a small convenient applications that help portal users perform private actions. &PRODUCT; provides you with some useful gadgets by default (see <xref linkend="sect-User_Guide-Dashboard_Portlet-Using_the_Dashboard_Workspace"/>. + </para> + <para> + In addition to these ready-to-use gadgets, &PRODUCT; allows you to easily add gadgets organized in categories to meet your needs. + </para> + + <section id="sect-User_Guide-Manage_Gadgets_in_User_Workspace-Manage_Gadget_Categories"> + <title>Manage Gadget Categories</title> + <formalpara> + <title>Add a Category</title> + <para></para> + </formalpara> <procedure> <step> <para> @@ -42,7 +43,7 @@ </step> <step> <para> - Click the tool!images/Tool.png! icon to add a new category + Click the tool icon to add a new category </para> <mediaobject> <imageobject> @@ -62,7 +63,7 @@ </step> <step> <para> - Click the add icon !images/AddIcon.png! to show the <emphasis role="bold">Gadget Container Form</emphasis> . + Click the add icon to show the <emphasis role="bold">Gadget Container Form</emphasis> . </para> <mediaobject> <imageobject> @@ -82,7 +83,7 @@ <term>Description</term> <listitem> <para> - The brief description of the category.A length from 0 to 255 characters is allowed. This field is not required. + The brief description of the category. A length from 0 to 255 characters is allowed. This field is not required. </para> </listitem> </varlistentry> @@ -95,33 +96,39 @@ </step> <step> <para> - Click on the <emphasis role="bold">Save</emphasis> button to accept adding a new category or click <emphasis role="bold">Cancel</emphasis> to quit. After you added the new category you will see it in the dialog : + Click on the <emphasis role="bold">Save</emphasis> button to accept the new category or click <emphasis role="bold">Cancel</emphasis> to quit. After you added the new category you will see it in the dialog : </para> <mediaobject> <imageobject> <imagedata fileref="images/GadgetManagement1.png" format="PNG" width="444" /> </imageobject> </mediaobject> - </step> - <step> - <para> - Edit the information of an existing category by selecting it from the left pane, the selected category is marked by a symbol. Then click the edit icon to show the edit form. Change the current category information and click on the <emphasis role="bold">button</emphasis> to accept changes. - </para> - </step> - <step> - <para> - Delete an existing category by selecting it from the left pane. In the message box Click on the <emphasis role="bold">OK</emphasis> button to confirm the deletion or click the <emphasis role="bold">Cancel</emphasis> button. - </para> </step> + </procedure> + <formalpara> + <title>Edit Categories</title> + <para> + Edit the information of an existing category by selecting it from the left pane, the selected category is marked by a symbol. Then click the edit icon to show the edit form. Change the current category information and click on the <emphasis role="bold">button</emphasis> to accept changes. + </para> + </formalpara> + + <formalpara> + <title>Deleting a Category</title> + <para> + Delete an existing category by selecting it from the left pane. In the message box Click on the <emphasis role="bold">OK</emphasis> button to confirm the deletion or click the <emphasis role="bold">Cancel</emphasis> button. + </para> + </formalpara> + <para> + Click on the <emphasis role="bold">Save</emphasis> button in the <emphasis role="bold">Gadget Containers Management</emphasis> dialog to accept or on the <emphasis role="bold">Cancel</emphasis> button to quit. Added categories will be displayed in list in the User Workspace. + </para> + </section> + <section id="sect-User_Guide-Manage_Gadgets_in_User_Workspace-Add_Gadgets"> + <title>Add Gadgets</title> + <procedure> <step> <para> - Click on the <emphasis role="bold">Save</emphasis> button in the <emphasis role="bold">Gadget Containers Management</emphasis> dialog to accept or on the <emphasis role="bold">Cancel</emphasis> button to quit. Added categories will be displayed in list in the User Workspace. + Click the list icon to see category list and select the one you want to add a gadget to. </para> - </step> - <step> - <para> - 4. Click the list icon!images/ListIcon.png! to see category list and select one in list. - </para> <mediaobject> <imageobject> <imagedata fileref="images/UserWorkspace1.png" format="PNG" width="444" /> @@ -130,7 +137,7 @@ </step> <step> <para> - 5. Click the add icon!images/AddIcon1.png! at the bottom of the User Workspace to open the <emphasis role="bold">Add Application</emphasis> dialog: + Click the add icon at the bottom of the User Workspace to open the <emphasis role="bold">Add Application</emphasis> dialog: </para> <mediaobject> <imageobject> @@ -140,12 +147,12 @@ </step> <step> <para> - Select a gadget by clicking the add icon !images/PlusIcon.png! that is located next to the the gadget. The selected gadget is displayed immediately in the user workspace. Normally, you can see only two gadgets in the User Workspace. When there are more gadgets, some gadgets are not visible. + Select a gadget by clicking the add icon (located next to the the gadget). The selected gadget is displayed immediately in the user workspace. Normally, you can see only two gadgets in the User Workspace. When there are more gadgets, some gadgets are not visible. </para> </step> <step> <para> - Click the scroll down icon !images/DownIcon.png!images/ or the scroll up icon!images/ UpIcon.png! at the bottom of the User Workspace to see the other gadgets. If there are no more gadgets to scroll to, the color of the scroll down and scroll up icon switches to gray color. + Click the scroll down icon or the scroll up icon at the bottom of the User Workspace to see the other gadgets. The scroll icons will be greyed out when you reach the end of the available gadgets. </para> </step> </procedure> @@ -154,20 +161,18 @@ <section id="sect-User_Guide-Manage_Gadgets_in_User_Workspace-Edit_a_Gadget"> <title>Edit a Gadget</title> <para> - To edit a gadget, click !images/EditIcon.png! icon. + To edit a gadget, click the edit icon. </para> </section> <section id="sect-User_Guide-Manage_Gadgets_in_User_Workspace-Remove_a_Gadget"> <title>Remove a Gadget</title> <para> - Remove a gadget from the User Workspace by using the functional bar!images/FunctionBar.png! at the upper right corner of that gadget. + Remove a gadget from the User Workspace by using the functional bar at the upper right corner of that gadget. </para> <para> - Click the remove icon !images/RemoveIcon.png! . When the confirmation message appears, click the <emphasis role="bold">OK</emphasis> button to accept or the <emphasis role="bold">Cancel</emphasis> to quit. + Click the remove icon. When the confirmation message appears, click the <emphasis role="bold">OK</emphasis> button to accept or the <emphasis role="bold">Cancel</emphasis> to quit. </para> </section> </section> - - Modified: portal/trunk/docs/user-guide/en/modules/language/Change_Interface_Language.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/language/Change_Interface_Language.xml 2010-01-08 18:02:27 UTC (rev 1207) +++ portal/trunk/docs/user-guide/en/modules/language/Change_Interface_Language.xml 2010-01-09 09:42:17 UTC (rev 1208) @@ -23,8 +23,11 @@ --><title>Change Interface Language</title> <para> - &PRODUCT; provides users with the most familiar interface language to work with and perform all actions efficiently. The priority of the interface language is as follows: + &PRODUCT; allows users to choose their interface language to work with. </para> + <para> + The priority of the interface language setting is: + </para> <orderedlist numeration="arabic"> <listitem> <para> @@ -38,26 +41,26 @@ </listitem> <listitem> <para> - Portal 's language + Portal's language </para> </listitem> </orderedlist> <para> - Thus to display your prefered language, you should pay attention to this order to change the language type appropriately. + Users should pay attention to this order to change the language type appropriately. </para> <para> - You can change the interface language permanently by three ways : + You can change the interface language permanently in three ways : </para> <section id="sect-User_Guide-Change_Interface_Language-The_1st_way"> <title>Method One</title> <para> - This way supports you to change the interface language of the current Portal. + This methods allows you to change the interface language of the current Portal. </para> - <procedure> + <!-- <procedure> <step> <para> - Go to <emphasis role="bold">&PRODUCT; Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Current portal</emphasis>. + Go to <emphasis role="bold">&PRODUCT; Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> &gt; <emphasis role="bold">Edit Current portal</emphasis>. </para> </step> <step> @@ -75,35 +78,45 @@ Click <emphasis role="bold">Save</emphasis> and <emphasis role="bold">Finish</emphasis>!images/FinishIcon.png! icon to take affect. </para> </step> - </procedure> - <!-- <para> + </procedure> --> + <para> For Portal 2.6 </para> <para> You easily change the interface language of the current Portal by following guides: </para> - <para> - 1. Go to <emphasis role="bold">Editor</emphasis> on the Toolbar &gt; click <emphasis role="bold">Edit Page</emphasis>. The <emphasis role="bold">Edit Inline Composer</emphasis> popup will appear: - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/EditInline.png" format="PNG" /> - </imageobject> - </mediaobject> - <para> - 2. Click on <emphasis role="bold">Portal Properties</emphasis> to edit portal's properties. - </para> - <para> - 3. In the <emphasis role="bold">Portal Setting</emphasis> tab: You can change display language of Portal by selecting another language in the <emphasis role="bold">Locale</emphasis> field. - </para> - <para> - 4. Click <emphasis role="bold">Save</emphasis> and <emphasis role="bold">Finish</emphasis>!images/DiskIcon.png! icon to take affect. - </para> --> + <procedure> + <step> + <para> + Go to <emphasis role="bold">Editor</emphasis> on the Toolbar and click <emphasis role="bold">Edit Page</emphasis>. The <emphasis role="bold">Edit Inline Composer</emphasis> popup will appear: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditInline.png" format="PNG" /> + </imageobject> + </mediaobject> + </step> + <step> + <para> + Click on <emphasis role="bold">Portal Properties</emphasis> to edit the portal's properties. + </para> + </step> + <step> + <para> + You can change display language of the portal by selecting another language in the <emphasis role="bold">Locale</emphasis> field of the <emphasis role="bold">Portal Setting</emphasis> tab. + </para> + </step> + <step> + <para> + Click <emphasis role="bold">Save</emphasis> and <emphasis role="bold">Finish</emphasis> to set the new language. + </para> + </step> + </procedure> </section> <section id="sect-User_Guide-Change_Interface_Language-The_2nd_way"> <title>Method Two</title> - <para> +<!-- <para> If you can access &PRODUCT; Start, you can do this way to set interface language for yourself, not for interface language of Portal by these following steps: </para> <procedure> @@ -132,41 +145,49 @@ Click the <emphasis role="bold">Apply</emphasis> button and wait for few seconds to take affect. </para> </step> - </procedure> - <!--<para> + </procedure> --> + <para> For Portal 2.6 </para> <para> - You can set the interface language for yourself by following guides: + You can set the interface language for yourself by doing the following: </para> - <para> - 1. Go to &PRODUCT; on the Toolbar &gt; click <emphasis role="bold">Change Language</emphasis> - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/InterfaceLanguage2.6.png" format="PNG" width="444" /> - </imageobject> - </mediaobject> - <para> - The <emphasis role="bold">Interface Language Setting</emphasis> form is displayed with a list of all supported languages. The current using language is marked by!images/MarkedIcon.png! icon. - </para> - <para> - 2. Select another one by clicking on the name of language. - </para> - <para> - 3. Click the <emphasis role="bold">Apply</emphasis> button and wait for few seconds to take affect. - </para> --> + <procedure> + <step> + <para> + Go to <emphasis role="bold">Editor</emphasis> on the Toolbar and click <emphasis role="bold">Change Language</emphasis> + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/InterfaceLanguage2.6.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> + <para> + The <emphasis role="bold">Interface Language Setting</emphasis> form is displayed with a list of all supported languages. The current using language is marked with an icon. + </para> + </step> + <step> + <para> + Select another language by clicking on its name in the list of available languages. + </para> + </step> + <step> + <para> + Click the <emphasis role="bold">Apply</emphasis> button and wait for few seconds for the change to take affect. + </para> + </step> + </procedure> </section> <section id="sect-User_Guide-Change_Interface_Language-The_3rd_way"> <title>Method Three</title> <para> - You also set interface language for yourself, not for interface language of the Portal by this way. + You can also set the interface language for yourself alone (and not for the entire Portal) this way: </para> <procedure> <step> <para> - Click <emphasis role="bold">Change Language</emphasis> on the right corner to show the <emphasis role="bold">Interface Language Setting</emphasis> form: + Click on <emphasis role="bold">Change Language</emphasis> on the right corner to show the <emphasis role="bold">Interface Language Setting</emphasis> form: </para> <mediaobject> <imageobject> @@ -186,12 +207,12 @@ </step> <step> <para> - Select another language in list. The selected language will be marked by !images/MarkedIcon.png! icon. + Select another language in list. The selected language will be marked with an icon. </para> </step> <step> <para> - Click the <emphasis role="bold">Apply</emphasis> button to change the interface language and wait for few seconds to take affect or click the <emphasis role="bold">Cancel</emphasis> button to quit without changes. + Click the <emphasis role="bold">Apply</emphasis> button to change the interface language or click the <emphasis role="bold">Cancel</emphasis> button to quit without changes. </para> </step> </procedure> @@ -200,35 +221,32 @@ <section id="sect-User_Guide-Change_Interface_Language-Set_language_for_a_user"> <title>Set language for a user</title> <para> - There are two modes to set displaying language for a user. + There are two modes to set the interface language for a specific user. </para> <variablelist> <varlistentry> <term>Public Mode</term> <listitem> <para> - Displaying language of this mode depends on the language of browser that you are using. + When accessing the portal in <emphasis role="bold">Public Mode</emphasis>, the interface language is dictated by the language setting of your web broweser. </para> <para> - If you set language of browser that Portal does not support, the displaying language will be the language of Portal. + If you have set the language of your browser to one that &PRODUCT; does not support, the displaying language will be the language set at the Portal level (see above). </para> - <para> - If you set language of browser that Portal supports, the displaying language will be the language of browser. - </para> </listitem> </varlistentry> <varlistentry> <term>Private Mode</term> <listitem> <para> - Displaying language of this mode belongs to the language of each user which is set when registering. + The interface language in <emphasis role="bold">Private Mode</emphasis> is set when registering each user. See step four of the process to register a new account <xref linkend="sect-User_Guide-Register_New_Accounts" />. </para> - <para> - When you sign in by a default account (root, john, demo, marry): the displaying language of these users are none, so it will belong to browser's language. If you change value in the <emphasis role="bold">Language</emphasis> field in the <emphasis role="bold">User Profile</emphasis> tab (only default user: root and john can change this value by access 'Management' page: Go to <emphasis role="bold">Organization</emphasis>--&gt; <emphasis role="bold">Management</emphasis> page), your displaying language will be the set value. Your displaying language has also directly affect when you change language by other ways. +<!-- <para> + When you sign in with one of the default accounts in &PRODUCT; (Root, John, Demo or Mary) the displaying language of these users are none, so it will belong to browser's language. If you change value in the <emphasis role="bold">Language</emphasis> field in the <emphasis role="bold">User Profile</emphasis> tab (only default user: root and john can change this value by access 'Management' page: Go to <emphasis role="bold">Organization</emphasis> &gt; <emphasis role="bold">Management</emphasis> page), your displaying language will be the set value. Your displaying language has also directly affect when you change language by other ways. </para> <para> When you sign in by a new registered user: by default, your displaying language is English. However, if you set by another language in the <emphasis role="bold">Language</emphasis> field in the <emphasis role="bold">User Profile</emphasis> tab when you register a new account, your displaying language is the set language. - </para> + </para> --> </listitem> </varlistentry> </variablelist> Modified: portal/trunk/docs/user-guide/en/modules/language/Internationalization_Portlet.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/language/Internationalization_Portlet.xml 2010-01-08 18:02:27 UTC (rev 1207) +++ portal/trunk/docs/user-guide/en/modules/language/Internationalization_Portlet.xml 2010-01-09 09:42:17 UTC (rev 1208) @@ -23,7 +23,7 @@ --><title>Internationalization Portlet</title> <para> - This portlet is used to define a word or a phrase of the current language to an expected language. The form of this portlet is like: + This portlet is used to define a word or a phrase of the current language in another language. </para> <mediaobject> <imageobject> @@ -31,7 +31,7 @@ </imageobject> </mediaobject> <para> - Each resource supports a language. So, you can define a word or a phrase according to the supported language. + Each resource supports a language. You can define a word or a phrase according to the supported language. </para> <section id="sect-User_Guide-Internationalization_Portlet-Add_a_new_Resource"> @@ -59,7 +59,7 @@ <term>Language</term> <listitem> <para> - The language that this resource 'll support. This field is required. + The language that this resource will support. This field is required. </para> </listitem> </varlistentry> @@ -89,8 +89,11 @@ <section id="sect-User_Guide-Internationalization_Portlet-View_and_Edit_a_Resource"> <title>View and Edit a Resource</title> <para> - Click the magnifying icon !images/GlassIcon.png! corresponding to resource which you want to view. On the view form, you also can edit information again by clicking the <emphasis role="bold">Edit</emphasis> button. You only can change <emphasis role="bold">Resource</emphasis> field, then click the <emphasis role="bold">Save</emphasis> button to accept changes or click the <emphasis role="bold">Cancel</emphasis> button to quit without saving any changes. + 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. </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. + </para> <mediaobject> <imageobject> <imagedata fileref="images/Resource2.png" format="PNG" width="444" /> @@ -101,14 +104,14 @@ <section id="sect-User_Guide-Internationalization_Portlet-Delete_a_Resource"> <title>Delete a Resource</title> <para> - Click the trash can icon!images/DeleIcon.png! corresponding to the resource which you want to delete. There 'll be a confirmation message, click the <emphasis role="bold">OK</emphasis> button to confirm deleting and the <emphasis role="bold">Cancel</emphasis> button to quit. + Click the trash can icon corresponding to the resource which you want to delete. When prompted by the confirmation message, click the <emphasis role="bold">OK</emphasis> button to confirm the deletion or the <emphasis role="bold">Cancel</emphasis> button to quit. </para> </section> <section id="sect-User_Guide-Internationalization_Portlet-Search_a_Resource"> <title>Search a Resource</title> <para> - The <emphasis role="bold">Search Resource</emphasis> form displays directly on the portlet: + The <emphasis role="bold">Search Resource</emphasis> form displays directly on the portlet. </para> <mediaobject> <imageobject> @@ -116,7 +119,7 @@ </imageobject> </mediaobject> <para> - Enter the name of the resource which you want to search and select the supported language. Click the <emphasis role="bold">Search</emphasis> button to perform searching and displaying a list of the expected Resource. + Enter the name of the resource which you want to search and select the supported language. Click the <emphasis role="bold">Search</emphasis> button to perform the search and display a list of the matching Resources. </para> </section> Modified: portal/trunk/docs/user-guide/en/modules/language/Multi-Language_Navigation_Nodes.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/language/Multi-Language_Navigation_Nodes.xml 2010-01-08 18:02:27 UTC (rev 1207) +++ portal/trunk/docs/user-guide/en/modules/language/Multi-Language_Navigation_Nodes.xml 2010-01-09 09:42:17 UTC (rev 1208) @@ -22,20 +22,29 @@ 02110-1301 USA, or see the FSF site: http://www.fsf.org. --><title>Multi-Language Navigation Nodes</title> - <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Overview"> - <title>Overview</title> +<warning> +<para> + The <emphasis role="bold">Add New Portal</emphasis> button mentioned in this section does not appear under the <emphasis role="bold">Site</emphasis> navigation in GateIn 3.0 Beta 3, even when logged in as the Administrator. +</para> +</warning> + <para> - &PRODUCT; supports a multi-language environment for your portal. You can internationalize any menu entry on the navigation. As the navigation bar is composed by nodes so you have to modify the display names of the nodes. Instead of entering the display name in English you have to use a so called resource key. This resource key is used to define the label that is shown on the navigation bar, the menu, and the breadcrumb. + &PRODUCT; supports a multi-language environment for your portal allowing you to internationalize any menu entry on the navigation. </para> - </section> - + <para> + As the navigation bar is composed of nodes, you have to modify the display names of the nodes to enable this. Instead of entering the display name of the node in a defined language (English, for example) you have to use a language-neutral 'resource key'. + </para> + <para> + This resource key is then used to define the label that is shown for that node on the navigation bar, the menu and the breadcrumb. + </para> + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Key_Format"> <title>Key Format</title> <para> The resource key format is: <emphasis role="bold">#{key}</emphasis> </para> <para> - The resource key is the can contain any text that you consider to be fine. It should be human-readable and must not contain spaces. + The resource key can contain any text that you consider to be reasonable. It should, however, be human-readable and must not contain spaces. </para> </section> @@ -65,9 +74,9 @@ </section> <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Creating_Keys_using_the_Create_Page_Wizard"> - <title>Creating Keys using the *Create Page Wizard*</title> + <title>Creating Keys using the <emphasis role="bold">Create Page Wizard</emphasis></title> <para> - You can follow these steps: + To use a guided wizard to create keys, follow these steps: </para> <procedure> <step> @@ -77,12 +86,12 @@ </step> <step> <para> - Click <emphasis role="bold">Next</emphasis> to move to step 1 + Click the <emphasis role="bold">Next</emphasis> button. </para> </step> <step> <para> - At step 1, continue as usual, but enter a resource key in the <emphasis role="bold">Display Name</emphasis> field. + Enter a resource key in the <emphasis role="bold">Display Name</emphasis> field. </para> <mediaobject> <imageobject> @@ -92,7 +101,7 @@ </step> <step> <para> - Click on the <emphasis role="bold">Next</emphasis> button and continue and click on the <emphasis role="bold">Save</emphasis> button. For example, create a key named "AAA". + Click on the <emphasis role="bold">Next</emphasis> button to continue and click on the <emphasis role="bold">Save</emphasis> button. </para> </step> </procedure> @@ -100,7 +109,7 @@ </section> <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-CreatingEditing_Keys_by_Edit_Page_Wizard"> - <title>Creating/Editing Keys by *Edit Page Wizard*</title> + <title>Creating/Editing Keys by <emphasis role="bold">Edit Page Wizard</emphasis></title> <procedure> <step> <para> @@ -109,19 +118,19 @@ </step> <step> <para> - Click on the <emphasis role="bold">Next</emphasis> button to move to step 1 + Click on the <emphasis role="bold">Next</emphasis> button. </para> </step> <step> <para> - At step 1, continue as usual, but enter a resource key in the <emphasis role="bold">Display Name</emphasis> field. + Enter a resource key in the <emphasis role="bold">Display Name</emphasis> field. </para> </step> </procedure> </section> <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-CreatingEditing_Keys_using_the_Edit_Page_and_Navigation"> - <title>Creating/Editing Keys using the *Edit Page and Navigation*</title> + <title>Creating/Editing Keys using the <emphasis role="bold">Edit Page and Navigation</emphasis></title> <procedure> <step> <para> @@ -132,7 +141,7 @@ <para> There are two alternatives: </para> - <itemizedlist> + <orderedlist numeration="arabic"> <listitem> <para> Create a new node: Select the parent path, right click and click on <emphasis role="bold">Add new node</emphasis> option . @@ -143,26 +152,29 @@ Edit an existing node: Right click on the node you want to create/edit key and click on <emphasis role="bold">Edit this node</emphasis> in the pop-up menu. </para> </listitem> - </itemizedlist> + </orderedlist> </step> <step> <para> - A Create/Edit node dialog appears, enter a resource key in the <emphasis role="bold">Label</emphasis> field + A Create/Edit node dialog appears. Enter a resource key in the <emphasis role="bold">Label</emphasis> field </para> </step> </procedure> - <note> - <para> - You can reuse the same resource key in several nodes. - </para> - </note> + <note> + <para> + You can reuse the same resource key in several nodes. + </para> + </note> </section> <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Internationalize_Resource_Keys"> <title>Internationalize Resource Keys</title> <para> - &PRODUCT; organizes resource keys in resource files. Each file contains a list of keys and their meanings (translations) in one specific language. Normally one resource file has one language supported by Portal. This helps to structure the resource keys. Each resource file has a name and a language attribute. One resource file only can contain translations for one single language. + &PRODUCT; organizes resource keys in resource files. Each file contains a list of keys and their translations in one specific language. </para> + <para> + Each resource file holds keys for one language supported by Portal. This helps to structure the resource keys. Each resource file has a name and a language attribute. + </para> <para> To utilize Internationalization features do the following: @@ -182,50 +194,50 @@ <para> Select a data resource that you want to internationalize. You also may search the desired resource name with a specific language: </para> - <itemizedlist> + <orderedlist numeration="arabic"> <listitem> <para> - Enter a resource name in the <emphasis role="bold">Name</emphasis> field in the <emphasis role="bold">Search Resource</emphasis> form + Enter a resource name in the <emphasis role="bold">Name</emphasis> field in the <emphasis role="bold">Search Resource</emphasis> form. </para> </listitem> <listitem> <para> - Select a corresponding language of the resource. + Select a corresponding language for the resource. </para> </listitem> <listitem> <para> - Click on the <emphasis role="bold">Search</emphasis> button to match all data resource and display the result on the table above. + Click on the <emphasis role="bold">Search</emphasis> button to match all data resource and display the result in the table above. </para> </listitem> <listitem> <para> - If you want to define a key for a node which belongs to a specific portal, search for a resource like:locale.navigation.portal.portal name] + If you want to define a key for a node which belongs to a specific portal, search for a resource like <emphasis>[locale.navigation.portal.portal name]</emphasis> </para> </listitem> - </itemizedlist> + </orderedlist> <para> - +Example:+ if you want to define a key of a node of portal "classic" in language French, search resource: locale.navigation.portal.classic with value in the <emphasis role="bold">Language</emphasis> field is "fr" + For example: if you want to define a key for a node of your portal <emphasis>Classic</emphasis> in French, you could search for the resource: <emphasis>locale.navigation.portal.classic</emphasis> with a value of <emphasis>fr</emphasis>in the <emphasis role="bold">Language</emphasis> field. </para> <itemizedlist> <listitem> <para> - If you want to define a key for the node that belongs to a specific group, search resource like: locale.navigation.group.group path] + If you want to define a key for the node that belongs to a specific group, search for a resource like <emphasis>locale.navigation.group.group path]</emphasis> </para> </listitem> </itemizedlist> <para> - +Example:+ if you want to define a key for a node on navigation of "administrators" group that is the sub one of the "platform" group in language French, search resource: locale.navigation.group.platform.administrators with the value in the <emphasis role="bold">Language</emphasis> field is "fr" + For example: if you want to define a key for a node on the navigation <emphasis>administrators</emphasis> group that is the sub-set of the <emphasis>platform</emphasis> group in French, you could search for a resource: <emphasis>locale.navigation.group.platform.administrators</emphasis> which has <emphasis role="bold">fr</emphasis> in the <emphasis role="bold">Language</emphasis> field. </para> </step> <step> <para> - Click the magnifying glass!images/MagnifyIcon.png! icon corresponding to a data resource to see details of the resource file. Click the <emphasis role="bold">Edit</emphasis> button in order to modify the content. + Click the magnifying glass icon corresponding to a data resource to see details of the resource file. Click the <emphasis role="bold">Edit</emphasis> button in order to modify the content. </para> </step> <step> <para> - Enter the resource key with the string that will be displayed as node name on the navigation bar . + Enter the resource key with the string that will be displayed as node name on the navigation bar. </para> </step> <step> @@ -240,11 +252,11 @@ <title>Walk-through</title> <procedure> <para> - Below is a graphical walk-through illustrating how to change the language of a resource. In this case the current language is English and will be changed to French. + Below is a graphical walk-through illustrating how to change the language of a resource. In this case the language will be changed from English to French. </para> <step> <para> - Go to <emphasis role="bold">Create Page Wizard</emphasis>, at step 1, select navigation and enter values like in the figure below: + Go to <emphasis role="bold">Create Page Wizard</emphasis>, at step 1, select navigation and complete the values as shown below: </para> <mediaobject> <imageobject> @@ -267,14 +279,19 @@ </imageobject> </mediaobject> </step> + </procedure> + <para> + Now you have to define what to display instead of displaying the key. + </para> + <procedure> <step> <para> - And now you have to define what to display instead of displaying the key. Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Page Navigation</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> --&gt; <emphasis role="bold">Internationalization</emphasis>. + Go to <emphasis role="bold">GateIn Start</emphasis>, highlight <emphasis role="bold">Page Navigation</emphasis> and then <emphasis role="bold">Administration</emphasis>. Click on <emphasis role="bold">Internationalization</emphasis>. </para> </step> <step> <para> - Search resource locale.navigation.portal.classic with language French (fr) + Search for the resource <emphasis>locale.navigation.portal.classic</emphasis> with the language set to French (<emphasis role="bold">fr</emphasis>) </para> <mediaobject> <imageobject> @@ -284,7 +301,7 @@ </step> <step> <para> - Click the magnifying icon!images/MagnifyIcon.png! to see the content. + Click the magnifying glass icon to see the content of that resource. </para> <mediaobject> <imageobject> @@ -294,7 +311,7 @@ </step> <step> <para> - Click on the <emphasis role="bold">Edit</emphasis> button to modify. In the <emphasis role="bold">Resource</emphasis> field, enter the key and assign the string to display. + Click on the <emphasis role="bold">Edit</emphasis> button to modify the resource contents. In the <emphasis role="bold">Resource</emphasis> field, enter the key and assign the string to display. </para> <mediaobject> <imageobject> Modified: portal/trunk/docs/user-guide/en/modules/language/Right_To_Left_Support_(RTL).xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/language/Right_To_Left_Support_(RTL).xml 2010-01-08 18:02:27 UTC (rev 1207) +++ portal/trunk/docs/user-guide/en/modules/language/Right_To_Left_Support_(RTL).xml 2010-01-09 09:42:17 UTC (rev 1208) @@ -21,13 +21,10 @@ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF site: http://www.fsf.org. - --><title>RTL Support (Right To Left)</title> + --><title>Right To Left Support</title> <para> - GateIn Portal supports RTL (Right to Left) to meet the demand of Arabian customers who want to use the Portal by their own language for more convenient and easy to use. When you change from other languages to Arabic or set the displaying language as Arabic, the displaying on Portal will be changed to Right to Left (RTL) direction because Arabian usually read from Right to Left. + &PRODUCT; supports Right to Left (RTL) languages. </para> - <para> - Some screen shots of Portal with RTL: - </para> <mediaobject> <imageobject> <imagedata fileref="images/HomePage2.png" format="PNG" width="444" /> Modified: portal/trunk/docs/user-guide/en/modules/portal/Create_a_New_Portal.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Create_a_New_Portal.xml 2010-01-08 18:02:27 UTC (rev 1207) +++ portal/trunk/docs/user-guide/en/modules/portal/Create_a_New_Portal.xml 2010-01-09 09:42:17 UTC (rev 1208) @@ -77,7 +77,7 @@ <term>Never</term> <listitem> <para> - It never happens even if an application requests it &lt;-- <emphasis role="bold"> WHAT never happens?</emphasis> + The session will never timeout, even if an application requests it. </para> </listitem> </varlistentry> @@ -85,7 +85,7 @@ <term>On-demand</term> <listitem> <para> - It starts to be used as soon as an application requests it + The session will timeout if an application requests it </para> </listitem> </varlistentry> @@ -93,7 +93,7 @@ <term>Always</term> <listitem> <para> - It's always enabled + The session will time out after a set period. </para> </listitem> </varlistentry> Modified: portal/trunk/docs/user-guide/en/modules/portal/Manage_Portals.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Manage_Portals.xml 2010-01-08 18:02:27 UTC (rev 1207) +++ portal/trunk/docs/user-guide/en/modules/portal/Manage_Portals.xml 2010-01-09 09:42:17 UTC (rev 1208) @@ -23,17 +23,97 @@ --><title>Manage Portals</title> <para> - You can easily manage a portal by editing or deleting it. + Portals can easily be managed by editing or deleting. </para> <section id="sect-User_Guide-Manage_Portals-Edit_a_Portal"> <title>Edit a Portal</title> <para> - You can change information of the current using portal such as properties or layout. However, you must have the edit right given by an Admininstrator. When you have edit right, follow these steps to edit the current portal: + You can change aspects of the current using portal, such as properties or layout if you have the edit right (granted by an Admininstrator). </para> + <para> + If you have edit rights, follow these steps to edit the current portal: + </para> <procedure> + <step> + <para> + Go to <emphasis role="bold">Editor</emphasis> on the Toolbar and click <emphasis role="bold">Edit Site Layout</emphasis>. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditPortal.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> + </step> + <step> + <para> + Click the Properties button in the <emphasis role="bold">Edit Inline Composer</emphasis>. The edit Form of the portal will be shown: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="images/EditPortal2.6New.png" format="PNG" width="444" /> + </imageobject> + </mediaobject> + </step> + <step> + <para> + Change the properties of the current portal. + </para> + </step> + <step> + <para> + Click the <emphasis role="bold">Propertites</emphasis> tab. Select an option for <emphasis role="bold">Keep session alive</emphasis> + </para> + <para> + This option controls how long your session is kept alive. There are 3 options: + </para> + <variablelist> + <varlistentry> + <term>Never</term> + <listitem> + <para> + The session will never timeout, even if an application requests it. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>On-demand</term> + <listitem> + <para> + The session will timeout if an application requests it + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Always</term> + <listitem> + <para> + The session will time out after a set period. + </para> + </listitem> + </varlistentry> + </variablelist> + </step> + <step> + <para> + Set permissions for the portal: + </para> + <para> + To change any permission, click the <emphasis role="bold">Select Permission</emphasis> button and then select a group with the Membership type you want. Only one group can have the Edit Permission of the portal. + </para> + <para> + You can set the Edit Permission for the portal when you create or edit it. + </para> + </step> + <step> + <para> + Click the <emphasis role="bold">Save</emphasis> button to accept changes or the <emphasis role="bold">Cancel</emphasis> button to quit. + </para> + </step> + </procedure> +<!-- <procedure> <step> <para> - Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> --&gt; <emphasis role="bold">Edit Current Portal</emphasis>. A form to edit the current portal will appear: + Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Advanced</emphasis> &gt; <emphasis role="bold">Edit Current Portal</emphasis>. A form to edit the current portal will appear: </para> <mediaobject> <imageobject> @@ -107,86 +187,6 @@ </varlistentry> </variablelist> </step> - <!-- <informaltable colsep="0" frame="none" rowsep="0"> - <tgroup cols="2"> - <colspec align="center"></colspec> - <colspec align="center"></colspec> - <tbody> - <row> - <entry> - <emphasis role="bold"> Indicator </emphasis> - </entry> - <entry> - <emphasis role="bold"> Meaning </emphasis> - </entry> - </row> - <row> - <entry> - !images/preview.png! - </entry> - <entry> - *Preview page*: allows viewing node's page in preview mode. - </entry> - </row> - <row> - <entry> - !images/EditPage.png! - </entry> - <entry> - *Edit page properties*: allows editing node's page properties. - </entry> - </row> - <row> - <entry> - !images/ShowContainer.png! - </entry> - <entry> - *Show container*: allows listing all existing containers when editing node's page. - </entry> - </row> - <row> - <entry> - !images/ShowPortlet.png! - </entry> - <entry> - *Show portlet*: allows listing all existing portlets when editing node's page. - </entry> - </row> - <row> - <entry> - !images/Savepage.png! - </entry> - <entry> - *Save page*: allows saving changes of page when editing node's page. - </entry> - </row> - <row> - <entry> - !images/RollBack.png! - </entry> - <entry> - *Rollback*: allows canceling all changes that have not been saved. - </entry> - </row> - <row> - <entry> - !images/Abort.png! - </entry> - <entry> - *Abort*: allows canceling all changes that have not been saved and escaping Edit page and navigation form. - </entry> - </row> - <row> - <entry> - !images/Finish1.png! - </entry> - <entry> - *Finish*: allows saving all changes and escaping Edit page and navigation form. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> --> <step> <para> Click!images/EditPage.png! icon to edit portal properties. @@ -207,76 +207,8 @@ Click!images/Savepage.png! icon to save changes. </para> </step> - </procedure> - <!-- <orderedlist id="orde-User_Guide-Edit_a_Portal-For_GateIn_Portal_2.6"> - <title>For GateIn Portal 2.6</title> - <para> - You must have the edit right to change information of the current using portal: - </para> - <listitem> - <para> - 1. Go to <emphasis role="bold">Editor</emphasis> on the Toolbar -&gt;click <emphasis role="bold">Edit Site Layout</emphasis>. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/EditPortal.png" format="PNG" width="444" /> - </imageobject> - </mediaobject> - </listitem> - <listitem> - <para> - 2. Click the!images/PortalProperties.png! button in the <emphasis role="bold">Edit Inline Composer</emphasis>. The edit Form of the portal will be shown: - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/EditPortal2.6New.png" format="PNG" width="444" /> - </imageobject> - </mediaobject> - </listitem> - <listitem> - <para> - 3. Change the properties of the current portal. - </para> - </listitem> - <listitem> - <para> - 4. Click the <emphasis role="bold">Propertites</emphasis> tab. Select an option for <emphasis role="bold">Keep session alive</emphasis> that means keeping the working session for a long time to avoid the working time out. There are 3 options: - </para> - <itemizedlist> - <listitem> - <para> - Never : it never happens even if an application requests it. - </para> - </listitem> - <listitem> - <para> - On-demand : it starts to be used as soon as an application requests it. - </para> - </listitem> - <listitem> - <para> - Always: it's always enabled (which has a cost but the administrator will be aware of that). - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - 5. Set permissions for a portal: - </para> - <para> - To change any permission, click the <emphasis role="bold">Select Permission</emphasis> button and then select a group with the Membership type you want. Only one group can have the Edit Permission of the portal. - </para> - <para> - You can set the Edit Permission for the portal when you create or edit it. - </para> - </listitem> - <listitem> - <para> - 6. Click the <emphasis role="bold">Save</emphasis> button to accept changes or the <emphasis role="bold">Cancel</emphasis> button to quit. - </para> - </listitem> - </orderedlist> --> + </procedure> --> + </section> <section id="sect-User_Guide-Manage_Portals-Delete_a_Portal"> @@ -296,7 +228,7 @@ </step> <step> <para> - Click the trash can !images/deleteIcon.png! icon in the row of the portal you want to delete in the portal list. + Click the trash can icon in the row of the portal you want to delete in the portal list. </para> </step> <step> @@ -316,7 +248,7 @@ </step> <step> <para> - Click on!images/DeletePortal2.6.png! .The confirmation message will appear: + Click on the Delete icon.The confirmation message will appear. </para> </step> <step> Modified: portal/trunk/docs/user-guide/en/modules/portal/Switching_between_Portals.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Switching_between_Portals.xml 2010-01-08 18:02:27 UTC (rev 1207) +++ portal/trunk/docs/user-guide/en/modules/portal/Switching_between_Portals.xml 2010-01-09 09:42:17 UTC (rev 1208) @@ -23,10 +23,10 @@ --><title>Switching between Portals</title> <para> - GateIn Portal allows users to switch between Portals simply and easily. You can use another portals such as gateway, starting site if you are given the appropriate permissions by the administrators. + &PRODUCT; allows users to switch between portals simply and easily. </para> <para> - Go to <emphasis role="bold">Site</emphasis> on the Toolbarm it will list all portals in which you have at least the access right + Go to <emphasis role="bold">Site</emphasis> on the Toolbar for a list all portals in which you have at least the access right </para> <mediaobject> <imageobject> @@ -34,7 +34,7 @@ </imageobject> </mediaobject> <para> - You easily switch between Portals by simply clicking on the portal that you want to choose and wait for few seconds to take effect. + You easily switch between Portals by simply clicking on the portal that you wish to switch to and waiting for few seconds for the change to take effect. </para> </section>