[gatein-commits] gatein SVN: r1173 - in portal/trunk/docs/user-guide/en/modules: portletsUser and 1 other directory.

Author: smumford Date: 2010-01-06 06:25:14 -0500 (Wed, 06 Jan 2010) New Revision: 1173 Modified: portal/trunk/docs/user-guide/en/modules/portal/Change_Node_Order.xml portal/trunk/docs/user-guide/en/modules/portal/Manage_Navigation_Nodes.xml portal/trunk/docs/user-guide/en/modules/portal/Manage_Page_Navigation.xml portal/trunk/docs/user-guide/en/modules/portletsUser/Dashboard_Portlet.xml Log: further edits Modified: portal/trunk/docs/user-guide/en/modules/portal/Change_Node_Order.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Change_Node_Order.xml 2010-01-06 08:37:18 UTC (rev 1172) +++ portal/trunk/docs/user-guide/en/modules/portal/Change_Node_Order.xml 2010-01-06 11:25:14 UTC (rev 1173) @@ -22,8 +22,13 @@ 02110-1301 USA, or see the FSF site: http://www.fsf.org. --><title>Change Node Order</title> +<warning> +<para> +The <emphasis role="bold">Administration</emphasis> menu entry reported to be under the <emphasis role="bold">GateIn Start</emphasis> button does not exist in GateIn 3.0 Beta 3. Therefore some of the instructions in this section may be incomplete or inaccurate. +</para> +</warning> <para> - You can easily change the position of node on the navigation bar on their own convenient order by following these steps: + You can easily change the position of nodes in the navigation bar following these steps: </para> <procedure> <step> @@ -53,7 +58,7 @@ </step> <step> <para> - The selected node will be moved up/down. + The selected node will be moved up or down within the list. </para> </step> </procedure> Modified: portal/trunk/docs/user-guide/en/modules/portal/Manage_Navigation_Nodes.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Manage_Navigation_Nodes.xml 2010-01-06 08:37:18 UTC (rev 1172) +++ portal/trunk/docs/user-guide/en/modules/portal/Manage_Navigation_Nodes.xml 2010-01-06 11:25:14 UTC (rev 1173) @@ -22,10 +22,15 @@ 02110-1301 USA, or see the FSF site: http://www.fsf.org. --><title>Manage Navigation Nodes</title> +<warning> +<para>The <emphasis role="bold">User Workspace</emphasis> has been deprecated in GateIn 3.0 Beta 3. The introductory paragraph below may be obsolete. +<emphasis role="bold">Also</emphasis> +The <emphasis role="bold">Administration</emphasis> menu entry reported to be under the <emphasis role="bold">GateIn Start</emphasis> button does not exist in GateIn 3.0 Beta 3. Therefore some of the instructions in this section may be incomplete or inaccurate. +</para> +</warning> <para> If you are allowed to access GateIn Start in the User Workspace, you can take all actions related to a node such as : add a new node, edit, copy, cut, delete and clone node. </para> - <section id="sect-User_Guide-Manage_Navigation_Nodes-Add_a_new_node"> <title>Add a new node</title> <procedure> @@ -41,12 +46,12 @@ </step> <step> <para> - Select a node from list (to create a new node like sub-node of the selected node) or click the icon!images/UpIcon.png! to create a new node on root + Select a node from list (to create a new node like sub-node of the selected node) or click the <emphasis role="bold">Up</emphasis> icon to create a new node at the root level of the portal. </para> </step> <step> <para> - Right-click on the selected navigation or node and select <emphasis role="bold">Add new Node</emphasis> option. Add new node form appears: + Right-click on the selected navigation or node and select <emphasis role="bold">Add new Node</emphasis> option. The <emphasis role="bold">Add new node</emphasis> form appears: </para> <mediaobject> <imageobject> @@ -56,78 +61,66 @@ <para> The <emphasis role="bold">Page Node Setting</emphasis> tab includes: </para> - <informaltable colsep="0" frame="none" rowsep="0"> - <tgroup cols="2"> - <colspec align="center"></colspec> - <colspec align="center"></colspec> - <tbody> - <row> - <entry> - <emphasis role="bold"> Name </emphasis> - </entry> - <entry> - <emphasis role="bold"> Description </emphasis> - </entry> - </row> - <row> - <entry> - Uri - </entry> - <entry> + + + <variablelist> + <varlistentry> + <term>Uri</term> + <listitem> + <para> An identification of the node. The Uri is automatically created after adding a new node - </entry> - </row> - <row> - <entry> - Node name - </entry> - <entry> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Node name</term> + <listitem> + <para> The name of the node. This field is required and must be unique. Only alpha, digit and underscore characters are allowed for this field and it must have at least 3 characters. - </entry> - </row> - <row> - <entry> - Label - </entry> - <entry> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Label</term> + <listitem> + <para> The display name of the node on the screen. This field is not required and may be changed. This field must have a length between 3 and 120 characters. - </entry> - </row> - <row> - <entry> - Visible - </entry> - <entry> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Visible</term> + <listitem> + <para> This check box allow to hide (and show) the page and its node at the navigation bar, the page navigation and the site map - </entry> - </row> - <row> - <entry> - Publication date &amp; time - </entry> - <entry> - This option allows publishing this node for a period of time. *Start Publication Date* and *End Publication Date* only appear when this option is selected. - </entry> - </row> - <row> - <entry> - Start Publication Date - </entry> - <entry> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Publication date &amp; time</term> + <listitem> + <para> + This option allows publishing this node for a period of time. <emphasis>Start Publication Date</emphasis> and <emphasis>End Publication Date</emphasis> only appear when this option is selected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Start Publication Date</term> + <listitem> + <para> The start date and time to publish the node. - </entry> - </row> - <row> - <entry> - End Publication Date - </entry> - <entry> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>End Publication Date</term> + <listitem> + <para> The end date and time to publish the node. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> + </para> + </listitem> + </varlistentry> + </variablelist> <para> In the <emphasis role="bold">Page Selector</emphasis> tab, you can select a page or not for this node. </para> @@ -136,48 +129,34 @@ <imagedata fileref="images/PageSelector.png" format="PNG" width="444" /> </imageobject> </mediaobject> - <informaltable colsep="0" frame="none" rowsep="0"> - <tgroup cols="2"> - <colspec align="center"></colspec> - <colspec align="center"></colspec> - <tbody> - <row> - <entry> - <emphasis role="bold"> Name </emphasis> - </entry> - <entry> - <emphasis role="bold"> Description </emphasis> - </entry> - </row> - <row> - <entry> - Page Id - </entry> - <entry> + <variablelist> + <varlistentry> + <term>Page Id</term> + <listitem> + <para> The identification string of the page. - </entry> - </row> - <row> - <entry> - Name - </entry> - <entry> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Name</term> + <listitem> + <para> The selected page's name. - </entry> - </row> - <row> - <entry> - Title - </entry> - <entry> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Title</term> + <listitem> + <para> The selected page's title. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> + </para> + </listitem> + </varlistentry> + </variablelist> <para> - You do not have to input values in these fields. It is automatically displayed after selecting an existing page by clicking the <emphasis role="bold">Search and Select Page</emphasis> button. The <emphasis role="bold">Select a page</emphasis> form appears like: + You do not have to input values in these fields. It is automatically displayed after selecting an existing page by clicking the <emphasis role="bold">Search and Select Page</emphasis> button. The <emphasis role="bold">Select a page</emphasis> form appears: </para> <mediaobject> <imageobject> @@ -213,12 +192,12 @@ </step> <step> <para> - Click the magnifying glass!images/NewGlassIcon.png! icon to perform searching. All pages matching with search term will be listed. + Click the magnifying glass icon to perform the search. All pages matching with search term will be listed. </para> </step> <step> <para> - Click the OK!images/NewOkIcon.png! icon on the row of the page to select. + Click the OK icon on the row of the page you wish to select. </para> </step> <step> @@ -257,7 +236,7 @@ </imageobject> </mediaobject> <para> - It will displays a form to edit this node: + This will display a form to edit this node: </para> <mediaobject> <imageobject> @@ -267,8 +246,24 @@ </step> <step> <para> - In the <emphasis role="bold">Page Node Setting</emphasis> tab: you can change the value of these fields: Label, Visible and Publication Date &amp; time. After finish changing, click the <emphasis role="bold">Save</emphasis> button to accept changing or <emphasis role="bold">Cancel</emphasis> button to refuse it. + In the <emphasis role="bold">Page Node Setting</emphasis> tab you can change the value of these fields: </para> + <itemizedlist> + <listitem> + <para>Label</para> + </listitem> + <listitem> + <para>Visible</para> + </listitem> + <listitem> + <para>Publication Date &amp; time</para> + </listitem> + </itemizedlist> + </step> + <step> + <para> + After you finish making the desired changes, click the <emphasis role="bold">Save</emphasis> button to accept changes or <emphasis role="bold">Cancel</emphasis> button to exit without change. + </para> <mediaobject> <imageobject> <imagedata fileref="images/PageSelector6.png" format="PNG" width="444" /> @@ -277,8 +272,14 @@ </step> <step> <para> - In the <emphasis role="bold">Page Selector</emphasis> tab : you also search and select another page for this node by clicking the <emphasis role="bold">Search and Select Page</emphasis> button. You can see more details on how to select a page for a node on the above <emphasis role="bold">Add a new node</emphasis> section. After finish changing another page for this node, click the <emphasis role="bold">Save</emphasis> button to accept changing or <emphasis role="bold">Cancel</emphasis> button to leave without saving any changes. + In the <emphasis role="bold">Page Selector</emphasis> tab you can also search and select another page for this node by clicking the <emphasis role="bold">Search and Select Page</emphasis> button. </para> + <para> +You can see more details on how to select a page for a node in <xref linkend="sect-User_Guide-Manage_Navigation_Nodes-Add_a_new_node" />. + </para> + <para> + After you finish edit any another page required for this node, click the <emphasis role="bold">Save</emphasis> button to accept changing or <emphasis role="bold">Cancel</emphasis> button to leave without saving any changes. + </para> </step> </procedure> </section> @@ -308,7 +309,7 @@ </step> <step> <para> - Select the position that you want to paste this node and select <emphasis role="bold">Paste Node</emphasis> option. Click the!images/MarkIcon.png! icon to <emphasis role="bold">Save</emphasis>. + Select the position that you want to paste this node and select <emphasis role="bold">Paste Node</emphasis> option. Click the mark icon to <emphasis role="bold">Save</emphasis>. </para> <mediaobject> <imageobject> @@ -322,8 +323,14 @@ <section id="sect-User_Guide-Manage_Navigation_Nodes-Clone_nodes"> <title>Clone nodes</title> <para> - <emphasis role="bold">Clone node</emphasis> function allows you to copy the node. However, the differences between <emphasis role="bold">copy node</emphasis> and <emphasis role="bold">clone node</emphasis> is that the clone node has its own page and this page has the same content as the selected node, so there will be a new page that has the same name with the selected node's page, is shown in the page list when you access<emphasis role="bold">Manage Pages</emphasis>. + The <emphasis role="bold">Clone node</emphasis> function allows you to copy a node. </para> + <para> + The differences between <emphasis role="bold">clone node</emphasis> and <emphasis role="bold">copy node</emphasis> is that the clone node has its own page and which has the same content as the selected node. + </para> + <para> +Therefore there will be a new page that has the same name as the cloned node's page shown in the page list when you access <emphasis role="bold">Manage Pages</emphasis>. + </para> <procedure> <step> <para> @@ -347,7 +354,7 @@ </step> <step> <para> - Select the position that you want to paste this node and select <emphasis role="bold">Paste Node</emphasis> option. Click the!images/MarkIcon.png! icon to <emphasis role="bold">Save</emphasis>. + Select the position that you want to paste this node and select <emphasis role="bold">Paste Node</emphasis> option. Click the mark icon to <emphasis role="bold">Save</emphasis>. </para> <mediaobject> <imageobject> @@ -391,7 +398,7 @@ </step> <step> <para> - Select the position that you want to paste this node and select <emphasis role="bold">Paste Node</emphasis> option. Click the!images/MarkIcon.png! icon to <emphasis role="bold">Save</emphasis>. + Select the position that you want to paste this node and select <emphasis role="bold">Paste Node</emphasis> option. mark icon to <emphasis role="bold">Save</emphasis>. </para> <mediaobject> <imageobject> @@ -425,7 +432,7 @@ </imageobject> </mediaobject> <para> - It will display an alert message, click the <emphasis role="bold">OK</emphasis> button to accept deleting or <emphasis role="bold">Cancel</emphasis> button to quit without deleting a node. + It will display an alert message confirming the removal of the node. Click the <emphasis role="bold">OK</emphasis> button to accept the deletion or <emphasis role="bold">Cancel</emphasis> button to quit without deleting the node. </para> <mediaobject> <imageobject> Modified: portal/trunk/docs/user-guide/en/modules/portal/Manage_Page_Navigation.xml =================================================================== --- portal/trunk/docs/user-guide/en/modules/portal/Manage_Page_Navigation.xml 2010-01-06 08:37:18 UTC (rev 1172) +++ portal/trunk/docs/user-guide/en/modules/portal/Manage_Page_Navigation.xml 2010-01-06 11:25:14 UTC (rev 1173) @@ -23,7 +23,7 @@ --><title>Manage Page Navigation</title> <para> - Navigation types that &PRODUCT; supports, please refer the <xref linkend="sect-User_Guide-Navigation" /> page. + Navigation types that &PRODUCT; supports are outlined in <xref linkend="sect-User_Guide-Navigation" />. </para> <!-- <section id="User_Guide-Manage_Page_Navigation-Portals_page_navigation"> @@ -53,15 +53,20 @@ <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 Page and Navigation</emphasis>. </para> +<warning> + <para> + The <emphasis role="bold">Administration</emphasis> menu entry mentioned above is not present in GateIn 3.0 Beta 3 + </para> +</warning> </step> <step> <para> - Select Portal navigation in list on the left pane (eg: portal: classic's Nav). + Select Portal navigation in the list in the left pane (eg: portal: classic's Nav). </para> </step> <step> <para> - Right click the blank space on the left pane and select <emphasis role="bold">Edit Navigation</emphasis> in the menu: + Right click the blank space on the left pane and select <emphasis role="bold">Edit Navigation</emphasis> in the context-menu: </para> <mediaobject> <imageobject> @@ -69,21 +74,21 @@ </imageobject> </mediaobject> <para> - The form for editing the portal navigation will be opened: + This will open a dialogue box allowing you to edit the navigation menu. </para> <mediaobject> <imageobject> <imagedata fileref="images/EditPortalNavigation2.png" format="PNG" width="444" /> </imageobject> </mediaobject> - <para> - The number that users select in the <emphasis role="bold">Priority</emphasis> field is the priority of a page navigation on the Navigation bar. - </para> </step> <step> <para> Make changes to fields in this form: <emphasis role="bold">Description</emphasis>, <emphasis role="bold">Priority</emphasis>. </para> + <para> + The <emphasis role="bold">Priority</emphasis> field sets the priority of a page navigation on the Navigation bar. + </para> </step> <step> <para> @@ -92,7 +97,7 @@ </step> <step> <para> - Click the!images/OKIcon.png! to take effect of new change or click the <emphasis role="bold">Cancel</emphasis> button to quit without saving any change. + Click the <emphasis role="bold">OK</emphasis> button to submit changes or click the <emphasis role="bold">Cancel</emphasis> button to quit without saving. </para> </step> </procedure> @@ -101,14 +106,14 @@ <section id="User_Guide-Manage_Page_Navigation-Deleting_a_portals_navigation"> <title>Deleting a portal's navigation</title> <para> - No one can create the portal's page navigation so no one can delete it. A navigation is deleted automatically after you delete its portal. + A navigation is deleted automatically after you delete the portal it correseponds to. </para> </section> <section id="User_Guide-Manage_Page_Navigation-Groups_page_navigation"> <title>Group's page navigation</title> <para> - Each group has only one page navigation. Only users of that group have the "manager" membership can create/edit/delete navigation for that group + Each group has only one page navigation. Only users of that group who have the "manager" membership can create, edit or delete navigation for that group. </para> </section> @@ -119,6 +124,12 @@ <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 Page and Navigation</emphasis>. </para> +<warning> + <para> + The <emphasis role="bold">Administration</emphasis> menu entry mentioned above is not present in GateIn 3.0 Beta 3 + </para> +</warning> + </step> <step> <para> @@ -127,7 +138,7 @@ </step> <step> <para> - Right click the blank space on the left pane and select <emphasis role="bold">Edit Navigation</emphasis> in the context menu: + Right click the blank space in the left pane and select <emphasis role="bold">Edit Navigation</emphasis> in the context menu: </para> <mediaobject> <imageobject> @@ -145,36 +156,36 @@ </step> <step> <para> - Make changes for two fields: <emphasis role="bold">Description</emphasis> and <emphasis role="bold">Priority</emphasis>. + Make changes in the <emphasis role="bold">Description</emphasis> and <emphasis role="bold">Priority</emphasis> fields. </para> <para> - The number that users select in the <emphasis role="bold">Priority</emphasis> field is the priority of a page navigation on the Navigation bar. + The <emphasis role="bold">Priority</emphasis> field is the priority of a page navigation on the Navigation bar. </para> </step> <step> <para> - Click the <emphasis role="bold">Save</emphasis> button to accept any changes. + Click the <emphasis role="bold">Save</emphasis> button to submit any changes. </para> </step> <step> <para> - Click the!images/OKIcon.png! to take effect new changes on the Navigation bar or click the <emphasis role="bold">Cancel</emphasis> button to quit without saving any change. + Click the <emphasis role='bold'>OK</emphasis> button to effect the changes on the Navigation bar or click the <emphasis role="bold">Cancel</emphasis> button to quit without saving any change. </para> </step> </procedure> </section> - <section id="User_Guide-Manage_Page_Navigation-Users_page_navigation"> +<!-- <section id="User_Guide-Manage_Page_Navigation-Users_page_navigation"> <title>User's page navigation</title> <para> Stuff Goes here? </para> - </section> + </section> Editing out pending content --> <section id="User_Guide-Manage_Page_Navigation-Creating_a_users_navigation"> <title>Creating a user's navigation</title> <para> - The page navigation of a user is created automatically when a user is created (registered). So an administrator don't have to create it. + The page navigation of a user is created automatically when a user is registered. </para> </section> @@ -188,7 +199,7 @@ <section id="User_Guide-Manage_Page_Navigation-Deleting_a_users_navigation"> <title>Deleting a user's navigation</title> <para> - No one can create user's page navigation so that no one can delete it. A user's navigation is deleted automatically when its user is deleted. + A user's navigation is deleted automatically when that user is deleted. </para> </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-01-06 08:37:18 UTC (rev 1172) +++ portal/trunk/docs/user-guide/en/modules/portletsUser/Dashboard_Portlet.xml 2010-01-06 11:25:14 UTC (rev 1173) @@ -114,7 +114,7 @@ </step> <step> <para> - The Dashboard Workspace dialog appear : + The Dashboard Workspace dialog appears: <mediaobject> <imageobject> <imagedata fileref="images/EnterLink.png" format="PNG" /> @@ -124,7 +124,7 @@ </step> <step> <para> - Enter a link (a .xml or .rss) in the text box above the gadgets list. + Enter a link (.xml or .rss) in the text box above the gadgets list. </para> <note> <title>Note</title>