[gatein-commits] gatein SVN: r9274 - in epp/docs/JPP/trunk/User_Guide/en-US: modules and 3 other directories.

Author: jaredmorgs Date: 2013-05-08 01:35:47 -0400 (Wed, 08 May 2013) New Revision: 9274 Modified: epp/docs/JPP/trunk/User_Guide/en-US/Revision_History.xml epp/docs/JPP/trunk/User_Guide/en-US/modules/Introduction.xml epp/docs/JPP/trunk/User_Guide/en-US/modules/Language.xml epp/docs/JPP/trunk/User_Guide/en-US/modules/gadgetsAdmin/Manage_Portlets_and_Gadgets.xml epp/docs/JPP/trunk/User_Guide/en-US/modules/language/Change_Interface_Language.xml epp/docs/JPP/trunk/User_Guide/en-US/modules/language/Multi-Language_Navigation_Nodes.xml epp/docs/JPP/trunk/User_Guide/en-US/modules/language/Right_To_Left_Support_(RTL).xml epp/docs/JPP/trunk/User_Guide/en-US/modules/portal/Manage_Pages.xml epp/docs/JPP/trunk/User_Guide/en-US/modules/portal/Manage_Permission.xml epp/docs/JPP/trunk/User_Guide/en-US/modules/portal/User_Management.xml Log: All Figures now have correct alt text appended to them. Modified: epp/docs/JPP/trunk/User_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/JPP/trunk/User_Guide/en-US/Revision_History.xml 2013-05-08 05:35:04 UTC (rev 9273) +++ epp/docs/JPP/trunk/User_Guide/en-US/Revision_History.xml 2013-05-08 05:35:47 UTC (rev 9274) @@ -8,8 +8,8 @@ <simpara> <revhistory> <revision> - <revnumber>6.1.0-1</revnumber> - <date>Tue Mar 05 2013</date> + <revnumber>6.1.0-2</revnumber> + <date>Tue Apr 30 2013</date> <author> <firstname>Jared</firstname> <surname>Morgan</surname> Modified: epp/docs/JPP/trunk/User_Guide/en-US/modules/Introduction.xml =================================================================== --- epp/docs/JPP/trunk/User_Guide/en-US/modules/Introduction.xml 2013-05-08 05:35:04 UTC (rev 9273) +++ epp/docs/JPP/trunk/User_Guide/en-US/modules/Introduction.xml 2013-05-08 05:35:47 UTC (rev 9274) @@ -27,7 +27,7 @@ <term>Technical documentation</term> <listitem> <para> - Other technical documentation, including an <emphasis role="bold">Installation Guide</emphasis>, a <emphasis role="bold">Reference Guide</emphasis> and component specific documentation, can be found at <ulink url="http://www.redhat.com/docs" type="http">www.redhat.com/docs</ulink> + Other technical documentation, including an <citetitle role="bold">Installation Guide</citetitle>, a <citetitle>Development Guide</citetitle>, and an <citetitle>Administration and Configuration Guide</citetitle> can be found at <ulink url="https://access.redhat.com/site/documentation/JBoss_Portal_Platf... type="http"/> </para> </listitem> </varlistentry> Modified: epp/docs/JPP/trunk/User_Guide/en-US/modules/Language.xml =================================================================== --- epp/docs/JPP/trunk/User_Guide/en-US/modules/Language.xml 2013-05-08 05:35:04 UTC (rev 9273) +++ epp/docs/JPP/trunk/User_Guide/en-US/modules/Language.xml 2013-05-08 05:35:47 UTC (rev 9274) @@ -1,15 +1,11 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../User_Guide.ent"> %BOOK_ENTITIES; ]> <chapter id="chap-User_Guide-Language_administration"> - <title>Language administration</title> - <xi:include href="language/Change_Interface_Language.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="language/Right_To_Left_Support_(RTL).xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="language/Multi-Language_Navigation_Nodes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- - <xi:include href="language/Internationalization_Portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - --> + <title>Language administration</title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="language/Change_Interface_Language.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="language/Right_To_Left_Support_(RTL).xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="language/Multi-Language_Navigation_Nodes.xml"/> </chapter> - Modified: epp/docs/JPP/trunk/User_Guide/en-US/modules/gadgetsAdmin/Manage_Portlets_and_Gadgets.xml =================================================================== --- epp/docs/JPP/trunk/User_Guide/en-US/modules/gadgetsAdmin/Manage_Portlets_and_Gadgets.xml 2013-05-08 05:35:04 UTC (rev 9273) +++ epp/docs/JPP/trunk/User_Guide/en-US/modules/gadgetsAdmin/Manage_Portlets_and_Gadgets.xml 2013-05-08 05:35:47 UTC (rev 9274) @@ -46,9 +46,9 @@ <imageobject role="html"> <imagedata align="center" scale="100" fileref="images/Column.png" format="PNG"/> </imageobject> - <imageobject role="fo"> - <imagedata contentwidth="120mm" align="center" scalefit="1" fileref="images/Column.png" format="PNG"/> - </imageobject> + <textobject> + <phrase>The Dashboard Portlet menu, with the mouse pointer hovering over the pencil icon.</phrase> + </textobject> </mediaobject> </step> <step> @@ -180,9 +180,9 @@ <imageobject role="html"> <imagedata align="center" scale="100" fileref="images/AddPortlet2.png" format="PNG"/> </imageobject> - <imageobject role="fo"> - <imagedata contentwidth="140mm" align="center" scalefit="1" fileref="images/AddPortlet2.png" format="PNG"/> - </imageobject> + <textobject> + <phrase>The Categories window, with the Gadgets category expanded, and the mouse hovering over the Add application to category (plus sign) button.</phrase> + </textobject> </mediaobject> <variablelist> <varlistentry> @@ -307,9 +307,14 @@ <imageobject role="html"> <imagedata align="center" scale="100" fileref="images/AddGadgetnew.png" format="PNG"/> </imageobject> - <imageobject role="fo"> - <imagedata contentwidth="150mm" align="center" fileref="images/AddGadgetnew.png" format="PNG"/> - </imageobject> + <textobject> + <phrase>The <menuchoice> + <guimenu> Group</guimenu> + <guimenu> Administration</guimenu> + <guimenu> Application Registry</guimenu> + <guimenu> Gadget</guimenu> + </menuchoice> menu, with the mouse pointer hovering over the Add a remote gadget menu item.</phrase> + </textobject> </mediaobject> </step> <step> @@ -360,9 +365,9 @@ <imageobject role="html"> <imagedata align="center" scale="100" fileref="images/Source.png" format="PNG"/> </imageobject> - <imageobject role="fo"> - <imagedata contentwidth="150mm" align="center" fileref="images/Source.png" format="PNG"/> - </imageobject> + <textobject> + <phrase>The rssAggregator Gadget source window open, with the gadget code displayed.</phrase> + </textobject> </mediaobject> </section> <!--Covered in section above SM Modified: epp/docs/JPP/trunk/User_Guide/en-US/modules/language/Change_Interface_Language.xml =================================================================== --- epp/docs/JPP/trunk/User_Guide/en-US/modules/language/Change_Interface_Language.xml 2013-05-08 05:35:04 UTC (rev 9273) +++ epp/docs/JPP/trunk/User_Guide/en-US/modules/language/Change_Interface_Language.xml 2013-05-08 05:35:47 UTC (rev 9274) @@ -53,9 +53,9 @@ <imageobject role="html"> <imagedata align="center" scale="110" fileref="images/InterfaceLanguage.png" format="PNG"/> </imageobject> - <imageobject role="fo"> - <imagedata contentwidth="150mm" align="center" scalefit="1" fileref="images/InterfaceLanguage.png" format="PNG"/> - </imageobject> + <textobject> + <phrase>The Interface Language Setting window displayed, with English selected.</phrase> + </textobject> </mediaobject> </step> <step> Modified: epp/docs/JPP/trunk/User_Guide/en-US/modules/language/Multi-Language_Navigation_Nodes.xml =================================================================== --- epp/docs/JPP/trunk/User_Guide/en-US/modules/language/Multi-Language_Navigation_Nodes.xml 2013-05-08 05:35:04 UTC (rev 9273) +++ epp/docs/JPP/trunk/User_Guide/en-US/modules/language/Multi-Language_Navigation_Nodes.xml 2013-05-08 05:35:47 UTC (rev 9274) @@ -32,7 +32,7 @@ <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Creating_Keys"> <title>Creating Keys</title> <para> - There are two <!--three--> ways to create a key for a node: + There are two ways to create a key for a node: </para> <orderedlist numeration="arabic"> <listitem> @@ -72,9 +72,9 @@ <imageobject role="html"> <imagedata align="center" scale="110" fileref="images/PageWizard.png" format="PNG"/> </imageobject> - <imageobject role="fo"> - <imagedata contentwidth="160mm" align="center" scalefit="1" fileref="images/PageWizard.png" format="PNG"/> - </imageobject> + <textobject> + <phrase>The Page Creation Wizard window, at Wizard Step 1, with the Home navigation node selected.</phrase> + </textobject> </mediaobject> </step> <step> @@ -89,36 +89,7 @@ </step> </procedure> </section> -<!-- <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-CreatingEditing_Keys_by_Edit_Page_Wizard"> - <title>Creating/Editing Keys using <emphasis role="bold">Edit Page Wizard</emphasis></title> - -<warning> -<title>DOC TODO</title> -<para> -broken right now -https://jira.jboss.org/jira/browse/GTNPORTAL-787 -SM: The menu path described below does not exist. Not sure if this is related to the JIRA listed here. -</para> -</warning> - - <procedure> - <step> - <para> - Go to <emphasis role="bold">GateIn Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Basic</emphasis> &gt; <emphasis role="bold">Edit Page Wizard</emphasis> - </para> - </step> - <step> - <para> - Click on the <emphasis role="bold">Next</emphasis> button. - </para> - </step> - <step> - <para> - 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"> + <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-CreatingEditing_Keys_using_the_Edit_Page_and_Navigation"> <title>Creating/Editing Keys using <emphasis role="bold">Navigation Management</emphasis></title> <procedure> <step> @@ -149,182 +120,10 @@ <para> To provide a translation for the resource key used as page name, resource bundles must be provided within the web archive. </para> + <remark>Docs Note - jmorgan - This file path needs to be reviewed.</remark> <para> Property files (or XML resource bundles) must be located in: <filename>/jboss-as/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/classes/locale/navigation/portal/<replaceable>&lt;PORTAL_NAME&gt;</replaceable>_<replaceable>&lt;LANGUAGE_CODE&gt;</replaceable>.properties</filename> </para> </section> -<!-- - <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Internationalize_Resource_Keys"> - <title>Internationalize Resource Keys</title> - <para> - JBoss Enterprise Portal Platform 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: - </para> - <procedure> - <step> - <para> - 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> - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Internal2.png" format="PNG" align="center" width="444" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> - Select a data resource that you want to internationalize. You also may search the desired resource name with a specific language: - </para> - <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. - </para> - </listitem> - <listitem> - <para> - 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 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 <emphasis>[locale.navigation.portal.portal name]</emphasis> - </para> - </listitem> - </orderedlist> - <para> - 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 for a resource like <emphasis>locale.navigation.group.group path]</emphasis> - </para> - </listitem> - </itemizedlist> - <para> - 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 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. - </para> - </step> - <step> - <para> - Click on the <emphasis role="bold">Save</emphasis> button. - </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-Multi_Language_Navigation_Nodes-Example"> - <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 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 complete the values as shown below: - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/PageWizard.png" format="PNG" align="center" width="444" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> - Click <emphasis role="bold">Next</emphasis>, at step 2 and 3, set layout for page Test button. - </para> - </step> - <step> - <para> - After creating page with that key, the node on the navigation bar will be displayed with name #{AAA} - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/AAANavi.png" format="PNG" align="center" width="444" /> - </imageobject> - </mediaobject> - </step> - </procedure> - <para> - Now you have to define what to display instead of displaying the key. - </para> - <procedure> - <step> - <para> - 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 for the resource <emphasis>locale.navigation.portal.classic</emphasis> with the language set to French (<emphasis role="bold">fr</emphasis>) - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Search.png" format="PNG" align="center" width="444" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> - Click the magnifying glass icon to see the content of that resource. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/ResourceData1.png" format="PNG" align="center" width="444" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> - 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> - <imagedata fileref="images/AfterEdit1.png" format="PNG" align="center" width="444" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> - Click on the <emphasis role="bold">Save</emphasis> button. - </para> - </step> - <step> - <para> - Go to GateIn <emphasis role="bold">Start</emphasis> -&gt; <emphasis role="bold">Administration</emphasis> -&gt; <emphasis role="bold">Language Settings</emphasis>: select French -&gt; Apply. - </para> - </step> - <step> - <para> - The French translation of your new resource key appears on the menu. - </para> - <mediaobject> - <imageobject> - <imagedata fileref="images/Nouvel.png" format="PNG" align="center" width="444" /> - </imageobject> - </mediaobject> - </step> - </procedure> --></section> +</section> Modified: epp/docs/JPP/trunk/User_Guide/en-US/modules/language/Right_To_Left_Support_(RTL).xml =================================================================== --- epp/docs/JPP/trunk/User_Guide/en-US/modules/language/Right_To_Left_Support_(RTL).xml 2013-05-08 05:35:04 UTC (rev 9273) +++ epp/docs/JPP/trunk/User_Guide/en-US/modules/language/Right_To_Left_Support_(RTL).xml 2013-05-08 05:35:47 UTC (rev 9274) @@ -12,59 +12,8 @@ <imageobject role="html"> <imagedata align="center" scale="130" fileref="images/HomePage2.png" format="PNG"/> </imageobject> - <imageobject role="fo"> - <imagedata contentwidth="150mm" align="center" scalefit="1" fileref="images/HomePage2.png" format="PNG"/> - </imageobject> + <textobject> + <phrase>The Main portal screen, with the right-to-left Arabic language selected to demonstrate the support.</phrase> + </textobject> </mediaobject> -<!-- DOCS NOTE: BZ#856442: Commented out the following images and formalparas as they add nothing to the manual. - <formalpara> - <title>The Account Portlet</title> - <para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/NewAccount3.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/NewAccount3.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </para> - </formalpara> - - <formalpara> - <title>The Application Registry Portlet</title> - <para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/ApplicationRegistry2.png" format="PNG" align="center" scale="100"/> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/ApplicationRegistry2.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </para> - </formalpara> - - - <formalpara> - <title>The Organization Portlet:</title> - <para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Organization5.png" format="PNG" align="center" scale="120" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Organization5.png" format="PNG" align="center" scalefit="1" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </para> - </formalpara> - - Deprecated <section id="sect-User_Guide-RTL_Support_Right_To_Left-The_User_Workspace"> - <title>The User Workspace</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/UserWorkspace2.png" format="PNG" align="center" width="444" /> - </imageobject> - </mediaobject> - </section> --></section> +</section> Modified: epp/docs/JPP/trunk/User_Guide/en-US/modules/portal/Manage_Pages.xml =================================================================== --- epp/docs/JPP/trunk/User_Guide/en-US/modules/portal/Manage_Pages.xml 2013-05-08 05:35:04 UTC (rev 9273) +++ epp/docs/JPP/trunk/User_Guide/en-US/modules/portal/Manage_Pages.xml 2013-05-08 05:35:47 UTC (rev 9274) @@ -26,9 +26,9 @@ <imageobject role="html"> <imagedata align="center" scale="100" fileref="images/Wizard1.png" format="PNG"/> </imageobject> - <imageobject role="fo"> - <imagedata contentwidth="150mm" align="center" fileref="images/Wizard1.png" format="PNG"/> - </imageobject> + <textobject> + <phrase>Page Creation Wizard window displayed, with the Home node selected, and the the Add a new page parameters group displayed.</phrase> + </textobject> </mediaobject> <para> In the left pane, you can navigate up and down the node/page structure. Modified: epp/docs/JPP/trunk/User_Guide/en-US/modules/portal/Manage_Permission.xml =================================================================== --- epp/docs/JPP/trunk/User_Guide/en-US/modules/portal/Manage_Permission.xml 2013-05-08 05:35:04 UTC (rev 9273) +++ epp/docs/JPP/trunk/User_Guide/en-US/modules/portal/Manage_Permission.xml 2013-05-08 05:35:47 UTC (rev 9274) @@ -1,379 +1,359 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-Manage_Permissions"> - <title>Manage Permissions</title> - <para> + <title>Manage Permissions</title> + <para> Permissions play an important part in accessing and performing actions in the Portal. Depending on these permissions assigned by an administrator, users gain access to various components and actions such as edit portals, pages or portlets. </para> - <para> + <para> Details about permission types and levels can be found in <xref linkend="sect-User_Guide-Permissions"/> </para> - - <section id="sect-User_Guide-Manage_Permission-Set_Portal_Permission"> - <title>Set Portal Permissions</title> - <variablelist> - <varlistentry> - <term><emphasis role="bold">New portals</emphasis></term> - <listitem> - <para> - Click on <menuchoice><guimenu>Site</guimenu></menuchoice> on the <guilabel>Toolbar</guilabel> , then click on <menuchoice><guimenuitem>Add New Portal</guimenuitem><guimenuitem>Permission Setting</guimenuitem></menuchoice> + <section id="sect-User_Guide-Manage_Permission-Set_Portal_Permission"> + <title>Set Portal Permissions</title> + <variablelist> + <varlistentry> + <term> + <emphasis role="bold">New portals</emphasis> + </term> + <listitem> + <para> + Click on <menuchoice> + <guimenu>Site</guimenu> + </menuchoice> on the <guilabel>Toolbar</guilabel> , then click on <menuchoice> + <guimenuitem>Add New Portal</guimenuitem> + <guimenuitem>Permission Setting</guimenuitem> + </menuchoice> </para> - - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Existing portals</emphasis></term> - <listitem> - <para> - On the Toolbar click <emphasis role="bold">Site</emphasis> then <emphasis role="bold">Edit Portal's Config</emphasis>. Then select the <emphasis role="bold">Permission Setting</emphasis> tab. + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Existing portals</emphasis> + </term> + <listitem> + <para> + On the Toolbar click <emphasis role="bold">Site</emphasis> then <emphasis role="bold">Edit Portal&apos;s Config</emphasis>. Then select the <emphasis role="bold">Permission Setting</emphasis> tab. </para> - </listitem> - </varlistentry> - </variablelist> - - - <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Portal"> - <title>Set Access permissions</title> - - <note> - <title>Public access</title> - <para> + </listitem> + </varlistentry> + </variablelist> + <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Portal"> + <title>Set Access permissions</title> + <note> + <title>Public access</title> + <para> If you do not want your Portal to be publicly accessible, make sure the <emphasis role="bold">Make it public</emphasis> check box is clear. - </para> - </note> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/PortalPermission.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/PortalPermission.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - - <para> + </para> + </note> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/PortalPermission.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>The Permission Setting tab, with the Make it public check box selected.</phrase> + </textobject> + </mediaobject> + <para> If <emphasis role="bold">Make it public</emphasis> is clear, you need to add permissions by member group. </para> - - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/PermissionSetting2.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/PermissionSetting2.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - - <procedure> - <step> - <para> - Click <emphasis role="bold">Add Permission</emphasis> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/PermissionSetting2.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>The Select Permission window, with the group and membership options for the portal displayed.</phrase> + </textobject> + </mediaobject> + <procedure> + <step> + <para> + Click <emphasis role="bold">Add Permission</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> Make the appropriate selections from the group and membership options presented in the <guilabel>Select Permission</guilabel> dialogue box. </para> - </step> - <step> - <para> + </step> + <step> + <para> After selecting a membership type, the selected permission is displayed in the access permission list. You can only select one group with one membership type at a time. If you want to add more, click <emphasis role="bold">Add Permission</emphasis> and select again. Repeat the process for as many permission settings as you require. </para> - </step> - </procedure> - - - - </section> - - <section id="sect-User_Guide-Manage_Permission-Set_the_Edit_Permission_on_a_Portal"> - - <title>Set Edit Permissions</title> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-Manage_Permission-Set_the_Edit_Permission_on_a_Portal"> + <title>Set Edit Permissions</title> + <para> Only members of the Editor group can edit that portal. Access rights can be given to several groups but edit rights can only be given to a group with a membership type. To assign an edit permission to a user, you must add him/her to the editor group of the respective portal. </para> - <procedure> - <step> - <para> + <procedure> + <step> + <para> Click <emphasis role="bold">Edit Permission Setting</emphasis> </para> - </step> - - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">Select Permission</emphasis> to choose a group. </para> - </step> - <step> - <para> + </step> + <step> + <para> Select a group and a membership type from the left and right panes, respectively, of the <emphasis role="bold">Permission Selector</emphasis> window (select * if you want to assign all available membership types to the selected group). </para> - </step> - - </procedure> - </section> - + </step> + </procedure> </section> - - - -<!-- Set_Page_Permission --> - - - - <section id="sect-User_Guide-Manage_Permission-Set_Page_Permission"> - <title>Set Page Permission</title> - <variablelist> - <varlistentry> - <term><emphasis role="bold">Group</emphasis></term> - <listitem> - <para> - If the Owner type of a page is "group", initial permissions on page are: + </section> +<!-- Set_Page_Permission --> <section id="sect-User_Guide-Manage_Permission-Set_Page_Permission"> + <title>Set Page Permission</title> + <variablelist> + <varlistentry> + <term> + <emphasis role="bold">Group</emphasis> + </term> + <listitem> + <para> + If the Owner type of a page is &quot;group&quot;, initial permissions on page are: </para> - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> Access permission: everyone in that group. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> Edit permission: the manager of that group. </para> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Portal</emphasis></term> - <listitem> - <para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Portal</emphasis> + </term> + <listitem> + <para> If the Owner type of a page is portal, initial permissions are: </para> - <itemizedlist> - <listitem> - <para> + <itemizedlist> + <listitem> + <para> Access permission: users who can access that portal. </para> - </listitem> - <listitem> - <para> + </listitem> + <listitem> + <para> Edit permission: users who can edit that portal. </para> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - </variablelist> - - <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Page"> - <title>Set Access Permission on a Page</title> - - <procedure> - <step> - <para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + </variablelist> + <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Page"> + <title>Set Access Permission on a Page</title> + <procedure> + <step> + <para> Open up the page you wish to configure. Select <emphasis role="bold">Site Editor</emphasis> on the Toolbar and select <emphasis role="bold">Edit Page</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">View Page Properties</emphasis> in the <emphasis role="bold">Page Editor</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the <emphasis role="bold">Permission Setting</emphasis> tab. </para> - <para> + <para> To be able to access a page users have to be in one of the groups that have access permission to that page. There may be several groups that have access rights to a page. A list of the permissions for that page will be shown (provided the <emphasis role="bold">Make it public</emphasis> check-box has not been used). </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">Add Permission</emphasis> </para> - </step> - <step> - <para> + </step> + <step> + <para> Select a group in the left pane then select a membership type. </para> - </step> - <step> - <para> + </step> + <step> + <para> After selecting a membership type, the selected permission is displayed in the access right list. Note that you may associate group and membership only one at a time. To add more access permissions, click the <emphasis role="bold">Add Permission</emphasis> button and apply the same process again. </para> - </step> - </procedure> - <para> + </step> + </procedure> + <para> If you want to allow any visitors to access the page tick the <emphasis role="bold">Make it public</emphasis> check-box. Any permission set for that page will be relaxed and the permissions list will disappear. </para> - - </section> - - <section id="sect-User_Guide-Manage_Permission-Set_the_Edit_Permission_on_a_Page"> - <title>Set Edit Permission on a Page</title> - <para> - Only users who are in the page's editor group can edit it. The access right can be set for several groups but the edit right only can be set for one group. To give a user the edit permission, you must add them to the editors group of that page. + </section> + <section id="sect-User_Guide-Manage_Permission-Set_the_Edit_Permission_on_a_Page"> + <title>Set Edit Permission on a Page</title> + <para> + Only users who are in the page&apos;s editor group can edit it. The access right can be set for several groups but the edit right only can be set for one group. To give a user the edit permission, you must add them to the editors group of that page. </para> - <para> + <para> The Permission Setting tab is available in two different ways: </para> - <procedure> - <title>Via Edit Page:</title> - <step> - <para> + <procedure> + <title>Via Edit Page:</title> + <step> + <para> Mouse over <emphasis role="bold">Site Editor</emphasis> on the Toolbar and select <emphasis role="bold">Edit Page</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click on <emphasis role="bold">View Page Properties</emphasis> in the <emphasis role="bold">Page Editor</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the <emphasis role="bold">Permission Setting</emphasis> tab then the <emphasis role="bold">Edit Permission Setting</emphasis> sub tab. </para> - </step> - </procedure> - <procedure> - <title>Via Page Management:</title> - <step> - <para> + </step> + </procedure> + <procedure> + <title>Via Page Management:</title> + <step> + <para> Mouse over <emphasis role="bold">Group</emphasis> on the Toolbar, highlight <emphasis role="bold">Administration</emphasis> and click on <emphasis role="bold">Page Management</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> Locate the page you want to edit using the <emphasis role="bold">Page Id</emphasis> column then click the edit icon (next to the trash icon). You will be taken to the <emphasis role="bold">Page Editor</emphasis>. - </para> - </step> - <step> - <para> + </para> + </step> + <step> + <para> Click on <emphasis role="bold">View Page Properties</emphasis> in the <emphasis role="bold">Page Editor</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click on the <emphasis role="bold">Permission Setting</emphasis> tab then the <emphasis role="bold">Edit Permission Setting</emphasis> sub tab. </para> - <para> + <para> You will see the <emphasis role="bold">Current Permission</emphasis> listed. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the <emphasis role="bold">Select Permission</emphasis> button to set new or change another group. </para> - </step> - <step> - <para> + </step> + <step> + <para> Select a group with a membership type (select * if you want all membership types in a selected group) </para> - </step> - <step> - <para> + </step> + <step> + <para> After selecting a specific membership from the right, the selected information is displayed. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the <emphasis role="bold">Save</emphasis> </para> - </step> - </procedure> - </section> - + </step> + </procedure> </section> - - <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Category"> - <title>Set Access Permission on a Category</title> - <para> + </section> + <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Category"> + <title>Set Access Permission on a Category</title> + <para> Setting access permission on a category allows to be able to list those categories when editing a page in order to add portlets or gadgets. </para> - <procedure> - <step> - <para> + <procedure> + <step> + <para> Mouse over <emphasis role="bold">Group</emphasis> on the Toolbar, highlight <emphasis role="bold">Administration</emphasis> then click on <emphasis role="bold">Application Registry</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> In the list of categories available in the left pane, click the edit icon, then choose the <emphasis role="bold">Permission Setting</emphasis> tab. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/EditCategoryPermissions.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/EditCategoryPermissions.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/EditCategoryPermissions.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>The Permission Setting tab of the Application Registry group focused, with the groups displayed.</phrase> + </textobject> + </mediaobject> + </step> + <step> + <para> To set permissions for a category: </para> - <procedure> - <step> - <para> + <procedure> + <step> + <para> Click the <emphasis role="bold">Add Permission</emphasis> button to add access permissions to more groups. </para> - </step> - <step> - <para> + </step> + <step> + <para> Or select the <emphasis role="bold">Make it public</emphasis> check box to allow everyone to access. </para> - </step> - </procedure> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Portlet"> - <title>Set Access Permission on a Portlet</title> - <procedure> - <step> - <para> + </step> + </procedure> + </step> + </procedure> + </section> + <section id="sect-User_Guide-Manage_Permission-Set_the_Access_Permission_on_a_Portlet"> + <title>Set Access Permission on a Portlet</title> + <procedure> + <step> + <para> Select <emphasis role="bold">Group</emphasis> on the Toolbar. Highlight the <emphasis role="bold">Administration</emphasis> entry and click on <emphasis role="bold">Application Registry</emphasis>. <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/Application1.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/Application1.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/Application1.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>The Application Registry window, with the Administration group open in the left pane, and the Application Registry details displayed.</phrase> + </textobject> + </mediaobject> </para> - </step> - <step> - <para> + </step> + <step> + <para> Select a category on the left pane that includes the portlet you want to set rights for. Then all portlets of the selected category are listed immediately and detail information of each portlet is displayed on the right pane. </para> - </step> - <step> - <para> + </step> + <step> + <para> To set permissions for a portlet: </para> - <procedure> - <step> - <para> + <procedure> + <step> + <para> Click the <emphasis role="bold">Add Permission</emphasis> button to add access permissions to more groups . </para> - </step> - <step> - <para> + </step> + <step> + <para> Or select the <emphasis role="bold">Make it public</emphasis> check box to allow everyone to access. </para> - </step> - </procedure> - </step> - </procedure> - </section> - + </step> + </procedure> + </step> + </procedure> + </section> </section> - - Modified: epp/docs/JPP/trunk/User_Guide/en-US/modules/portal/User_Management.xml =================================================================== --- epp/docs/JPP/trunk/User_Guide/en-US/modules/portal/User_Management.xml 2013-05-08 05:35:04 UTC (rev 9273) +++ epp/docs/JPP/trunk/User_Guide/en-US/modules/portal/User_Management.xml 2013-05-08 05:35:47 UTC (rev 9274) @@ -1,55 +1,53 @@ -<?xml version='1.0' encoding='utf-8' ?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../../User_Guide.ent"> %BOOK_ENTITIES; ]> <section id="sect-User_Guide-User_management"> - <title>Manage Users and Groups</title> - - <para> + <title>Manage Users and Groups</title> + <para> Several tools are offered to assist Administrators manage users, groups and memberships easily and effectively. </para> - - <!-- DOCS NOTE: Bug 793802: Added Info about EPP roles. Added in discrete file for relocation. --> - <xi:include href="EPP_Roles.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - - <section id="sect-User_Guide-User_Management-Manage_users"> - <title>Manage users</title> - <para> +<!-- DOCS NOTE: Bug 793802: Added Info about EPP roles. Added in discrete file for relocation. --> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="EPP_Roles.xml"/> + <section id="sect-User_Guide-User_Management-Manage_users"> + <title>Manage users</title> + <para> Mouse over <emphasis role="bold">Group</emphasis> in the Toolbar. Highlight <emphasis role="bold">Organization</emphasis> and select <emphasis role="bold">Users and Groups Management</emphasis> </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/UserManage.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/UserManage.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - <para> - Administrators can see all existing registered users and search, edit or even delete them. Each user's groups and memberships (roles) in these groups are also available. + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/UserManage.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>The <menuchoice> + <guimenu>Group</guimenu> + <guimenu>Organization</guimenu> + <guimenu>Users and Groups Management</guimenu> + </menuchoice> User Management window with the default portal user profiles displayed. </phrase> + </textobject> + </mediaobject> + <para> + Administrators can see all existing registered users and search, edit or even delete them. Each user&apos;s groups and memberships (roles) in these groups are also available. </para> - - - <section id="sect-User_Guide-User_Management-Add_a_user"> - <title>Add a user</title> - <para> + <section id="sect-User_Guide-User_Management-Add_a_user"> + <title>Add a user</title> + <para> To add a new user to the portal user lists follow these steps: </para> - <procedure> - <step> - <para> + <procedure> + <step> + <para> Mouse over <emphasis role="bold">Group</emphasis> in the <emphasis role="bold">Toolbar</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> Highlight <emphasis role="bold">Organization</emphasis> and then click on <emphasis role="bold">New Staff</emphasis>. </para> - <para> + <para> The <emphasis role="bold">New Staff</emphasis> window will open: </para> - <!-- DOCS NOTE: BZ#856442: This image may no longer be required +<!-- DOCS NOTE: BZ#856442: This image may no longer be required <mediaobject> <imageobject role="html"> <imagedata fileref="images/NewStaff.png" format="PNG" align="center" scale="100" /> @@ -58,407 +56,404 @@ <imagedata fileref="images/NewStaff.png" format="PNG" align="center" contentwidth="150mm" /> </imageobject> </mediaobject> - --> - <para> + --> <para> This window has two tabs; <emphasis role="bold">Account Setting</emphasis> and <emphasis role="bold">User Profile</emphasis>. </para> - </step> - <step> - <para> + </step> + <step> + <para> To create a new user, all fields on the <emphasis role="bold">Account Settings</emphasis> tab that are marked with an asterisk must be filled in. The <emphasis role="bold">Display Name</emphasis> field is optional and when left blank, a value in format <emphasis>&lt;First Name&gt; &lt;Last Name&gt;</emphasis> is used. </para> - <para> + <para> Further information about the user (such as nickname and birthday) can be added in the <emphasis role="bold">User Profile</emphasis> tab. This information is not required for the creation of the account. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click either <emphasis role="bold">Save</emphasis> or <emphasis role="bold">Reset</emphasis> to create or discard the new account. </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-User_Management-Search_a_user"> - <title>Search for users</title> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-User_Management-Search_a_user"> + <title>Search for users</title> + <para> The Administrator can search for specific users by username, first name, last name or email address. </para> - <procedure> - <step> - <para> + <procedure> + <step> + <para> Mouse over <guilabel>Group</guilabel> in the Toolbar. Highlight <guilabel>Organization</guilabel> and select <guilabel>Users and Groups Management</guilabel>. </para> - </step> - <step> - <para> + </step> + <step> + <para> Select the information type (name, email, etc) to search against </para> - </step> - <step> - <para> + </step> + <step> + <para> Type in a partial/full string which identifies the user record being searched. The <emphasis role="bold">*</emphasis> character can be used as a wild-card. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the magnifying glass icon to begin the search. </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-User_Management-Edit_a_user"> - <title>Edit a user</title> - <procedure> - <step> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-User_Management-Edit_a_user"> + <title>Edit a user</title> + <procedure> + <step> + <para> Locate the user you wish to edit. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the edit icon (next to the trash icon). </para> - </step> - <step> - <para> + </step> + <step> + <para> Select the <emphasis role="bold">Account Info</emphasis> tab to edit the main user information set including first name, last name or email address. </para> - <variablelist> - <varlistentry> - <term>User Name</term> - <listitem> - <para> - The <emphasis role="bold">User Name</emphasis> field cannot be changed. Other fields &#8212; <emphasis role="bold">First Name</emphasis>, <emphasis role="bold">Last Name</emphasis>, <emphasis role="bold">Display Name</emphasis> and <emphasis role="bold">Email Address</emphasis> &#8212; can be changed. + <variablelist> + <varlistentry> + <term>User Name</term> + <listitem> + <para> + The <emphasis role="bold">User Name</emphasis> field cannot be changed. Other fields — <emphasis role="bold">First Name</emphasis>, <emphasis role="bold">Last Name</emphasis>, <emphasis role="bold">Display Name</emphasis> and <emphasis role="bold">Email Address</emphasis> — can be changed. </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Change Password</term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term>Change Password</term> + <listitem> + <para> The <emphasis role="bold">Change Password</emphasis> option allows an administrator to set a new password for a user. When the <emphasis role="bold">Change Password</emphasis> option is unchecked, <emphasis role="bold">New Password</emphasis> and <emphasis role="bold">Confirm Password</emphasis> are hidden. Passwords must contain between 6 and 30 characters. </para> - </listitem> - </varlistentry> - </variablelist> - </step> - <step> - <para> - Select the <emphasis role="bold">User Profile</emphasis> tab to edit additional information about the user's profile such as the birthdate or the job title as well as some home and business metadata. You may also switch the default display language for that user. + </listitem> + </varlistentry> + </variablelist> + </step> + <step> + <para> + Select the <emphasis role="bold">User Profile</emphasis> tab to edit additional information about the user&apos;s profile such as the birthdate or the job title as well as some home and business metadata. You may also switch the default display language for that user. </para> - </step> - <step> - <para> - Select the <emphasis role="bold">User Membership</emphasis> tab to see a user's group membership information. + </step> + <step> + <para> + Select the <emphasis role="bold">User Membership</emphasis> tab to see a user&apos;s group membership information. </para> - <variablelist> - <varlistentry> - <term>User Membership</term> - <listitem> - <para> - The <emphasis role="bold">User Membership</emphasis> tab displays which group(s) the selected user belongs to. In the above figure, the user "demo" is a member of two groups: "guests" and "users". The parent group of both is "platform". + <variablelist> + <varlistentry> + <term>User Membership</term> + <listitem> + <para> + The <emphasis role="bold">User Membership</emphasis> tab displays which group(s) the selected user belongs to. In the above figure, the user &quot;demo&quot; is a member of two groups: &quot;guests&quot; and &quot;users&quot;. The parent group of both is &quot;platform&quot;. </para> - <para> + <para> To remove the user from a group, click the trash can icon. </para> - </listitem> - </varlistentry> - </variablelist> - </step> - <step> - <para> + </listitem> + </varlistentry> + </variablelist> + </step> + <step> + <para> Click the <emphasis role="bold">Save</emphasis>. </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-User_Management-Delete_a_user"> - <title>Delete a user</title> - <procedure> - <step> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-User_Management-Delete_a_user"> + <title>Delete a user</title> + <procedure> + <step> + <para> Locate the user you wish to delete - </para> - <para> + </para> + <para> Click the trash icon in the Action column </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">OK</emphasis> to confirm. </para> - </step> - </procedure> - </section> - + </step> + </procedure> </section> - - <section id="sect-User_Guide-User_Management-Manage_groups"> - <title>Manage groups</title> - <para> + </section> + <section id="sect-User_Guide-User_Management-Manage_groups"> + <title>Manage groups</title> + <para> Mouse over <emphasis role="bold">Group</emphasis> on the Toolbar. Highlight <emphasis role="bold">Organization</emphasis> and select <emphasis role="bold">Users and Groups Management</emphasis> </para> - <para>Select the tab <emphasis role="bold">Group Management</emphasis></para> - <para> + <para>Select the tab <emphasis role="bold">Group Management</emphasis></para> + <para> By default, all existing groups will be displayed on the left pane. This tab is used to add new, edit or delete a group. The right pane shows information about the selected group including information about the members in the specific group along with a small form to add a new user to a group. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/GroupManage.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/GroupManage.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - <section id="sect-User_Guide-User_Management-Add_a_new_group"> - <title>Add a New Group</title> - <procedure> - <step> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/GroupManage.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>The <menuchoice> + <guimenu>Group</guimenu> + <guimenu>Organization</guimenu> + <guimenu>Users and Groups Management</guimenu> + </menuchoice> Groups Management window displayed.</phrase> + </textobject> + </mediaobject> + <section id="sect-User_Guide-User_Management-Add_a_new_group"> + <title>Add a New Group</title> + <procedure> + <step> + <para> First choose where in the existing group structure you want the new group to be created. You may navigate up the tree by clicking on the green vertical little arrow at the top of the tree. The current path is displayed in the path bar. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">Add New Group</emphasis>. </para> - <variablelist> - <varlistentry> - <term><emphasis role="bold">Group Name</emphasis></term> - <listitem> - <para> + <variablelist> + <varlistentry> + <term> + <emphasis role="bold">Group Name</emphasis> + </term> + <listitem> + <para> The name of the new group. This field is required and any length from 3 to 30 characters is allowed. Once saved this name cannot be edited. </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Label</emphasis></term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Label</emphasis> + </term> + <listitem> + <para> The display name of the group. Any length from 3 to 30 characters is allowed. </para> - </listitem> - </varlistentry> - <varlistentry> - <term><emphasis role="bold">Description</emphasis></term> - <listitem> - <para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <emphasis role="bold">Description</emphasis> + </term> + <listitem> + <para> A description of the group. Any length from 0 to 255 characters is allowed. </para> - </listitem> - </varlistentry> - </variablelist> - </step> - <step> - <para> + </listitem> + </varlistentry> + </variablelist> + </step> + <step> + <para> Fill in the required fields. Only letters, numbers, dash and underscore characters are allowed for the <guilabel>Group Name</guilabel> field. The name must be unique within the portal. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">Save</emphasis> </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-User_Management-Edit-a-group"> - <title>Edit a group</title> - <procedure> - <step> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-User_Management-Edit-a-group"> + <title>Edit a group</title> + <procedure> + <step> + <para> Find the group in the existing tree and click on the label </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the edit icon to display the <emphasis role="bold">Edit Selected Group</emphasis> window. </para> - </step> - <step> - <para> + </step> + <step> + <para> Make the desired changes in the appropriate fields. You can not change the Group Name, however you may change to the <emphasis role="bold">Label</emphasis> field. You are also able to edit the <emphasis role="bold">Description</emphasis> field. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">Save</emphasis> </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-User_Management-Add_a_new_user_to_a_group"> - <title>Add a new user to a group</title> - <procedure> - <step> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-User_Management-Add_a_new_user_to_a_group"> + <title>Add a new user to a group</title> + <procedure> + <step> + <para> Find the group in the existing tree and click on its label. Existing group memberships are listed on the right hand side along with the <emphasis role="bold">Add Member</emphasis> window. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/AddMember1.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/AddMember1.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/AddMember1.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>The Add member modal window displayed over the Group Management window.</phrase> + </textobject> + </mediaobject> + </step> + <step> + <para> Click on the magnify glass to open up the User selector. </para> - <para> - Refer to <xref linkend="sect-User_Guide-User_Management-Search_a_user" /> for instructions on how to locate a user. + <para> + Refer to <xref linkend="sect-User_Guide-User_Management-Search_a_user"/> for instructions on how to locate a user. </para> - <para> + <para> Check the box next to the user name then click <emphasis role="bold">Add</emphasis> </para> - </step> - <step> - <para> + </step> + <step> + <para> Select the membership appropriate for this user. If the desired membership does not appear you may try to click on the refresh icon to get the latest list. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">Save</emphasis> </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-User_Management-Edit_the_user_membership_in_a_group"> - <title>Edit the user membership in a group</title> - <procedure> - <step> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-User_Management-Edit_the_user_membership_in_a_group"> + <title>Edit the user membership in a group</title> + <procedure> + <step> + <para> Click the edit icon in the Action column. </para> - - </step> - <step> - <para> + </step> + <step> + <para> Select another membership. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">Save</emphasis>. </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-User_Management-Delete_a_group"> - <title>Delete a group</title> - <procedure> - <step> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-User_Management-Delete_a_group"> + <title>Delete a group</title> + <procedure> + <step> + <para> Find the group in the tree </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the trash icon. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/DeleteGroup.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/DeleteGroup.png" format="PNG" align="center" contentwidth="150mm" /> - </imageobject> - </mediaobject> - </step> - <step> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/DeleteGroup.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>The Group Management window, with the mouse pointer hovering over the Delete Selected Group button. The Partners group is highlighted.</phrase> + </textobject> + </mediaobject> + </step> + <step> + <para> Click <emphasis role="bold">OK</emphasis>. </para> - </step> - </procedure> - </section> - + </step> + </procedure> </section> - - <section id="sect-User_Guide-User_Management-Manage_memberships"> - <title>Manage memberships</title> - <para> + </section> + <section id="sect-User_Guide-User_Management-Manage_memberships"> + <title>Manage memberships</title> + <para> The role of a user in a specific group is managed using memberships. </para> - <para> + <para> By default three membership types are available: <emphasis>Manager</emphasis>, <emphasis>Member</emphasis> and <emphasis>Validator</emphasis>. By definition, Manager has got the highest rights in a group. </para> - <para> + <para> Mouse over <emphasis role="bold">Group</emphasis> on the Toolbar. Highlight <emphasis role="bold">Organization</emphasis> and select <emphasis role="bold">Users and Groups Management</emphasis>. Select the <emphasis role="bold">Membership Management</emphasis> tab. </para> - <para> + <para> This tab remembers the last action taken by a user in this page. Clicking <emphasis role="bold">Reset</emphasis> will clear any legacy details. </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/MembershipManage1.png" format="PNG" align="center" scale="100" /> - </imageobject> - <imageobject role="fo"> - <imagedata fileref="images/MembershipManage1.png" format="PNG" align="center" contentwidth="110mm"/> - </imageobject> - </mediaobject> - - <section id="sect-User_Guide-User_Management-Add_a_new_membership_type"> - <title>Add a new membership type</title> - <procedure> - <step> - <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" scale="100" fileref="images/MembershipManage1.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>The <menuchoice> + <guimenu>Group</guimenu> + <guimenu>Organization</guimenu> + <guimenu>Users and Groups Management</guimenu> + </menuchoice> Membership Management window, with the Add/Edit Membership fields displayed. </phrase> + </textobject> + </mediaobject> + <section id="sect-User_Guide-User_Management-Add_a_new_membership_type"> + <title>Add a new membership type</title> + <procedure> + <step> + <para> In the <emphasis role="bold">Add/Edit Membership</emphasis> form, enter the values for the membership name field (required) and the description field (optional). Only letters, digits, dots, dashes and underscores are allowed for the membership name and it must be between 3 and 30 characters. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click the <emphasis role="bold">Save</emphasis> </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-User_Management-Edit_a_membership_type"> - <title>Edit a membership type</title> - <procedure> - <step> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-User_Management-Edit_a_membership_type"> + <title>Edit a membership type</title> + <procedure> + <step> + <para> Click the edit icon in the Action column. </para> - </step> - <step> - <para> + </step> + <step> + <para> Make the desired changes to the description. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">Save</emphasis> </para> - </step> - </procedure> - </section> - - <section id="sect-User_Guide-User_Management-Delete_a_membership_type"> - <title>Delete a membership type</title> - <procedure> - <step> - <para> + </step> + </procedure> + </section> + <section id="sect-User_Guide-User_Management-Delete_a_membership_type"> + <title>Delete a membership type</title> + <procedure> + <step> + <para> Click the trash icon in the Action column. </para> - </step> - <step> - <para> + </step> + <step> + <para> Click <emphasis role="bold">OK</emphasis> </para> - </step> - </procedure> - </section> + </step> + </procedure> </section> - + </section> </section>