Changeset 3290


Ignore:
Timestamp:
May 4, 2007, 4:10:27 PM (14 years ago)
Author:
Martin Svensson
Message:

References #549. More new text

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/admindoc/user_administration.xml

    r3288 r3290  
    2929<chapter id="user_administration">
    3030  <?dbhtml dir="user_administration"?>
    31   <title>Administration of users/groups/roles</title>
     31  <title>Users/groups/roles</title>
    3232
    3333  <sect1 id="user_administration.users">
    3434    <title>Users administration</title>
    35     <para></para>
     35    <para>
     36      The user list is accessed with
     37      <menuchoice>
     38        <guimenu>Administrate</guimenu>
     39        <guimenuitem>Users</guimenuitem>
     40      </menuchoice>
     41      and from here are users' account and contact information managed.
     42    </para>
    3643
    3744    <sect2 id="user_administration.users.edit">
    3845      <title>Edit user</title>
    39       <para></para>
     46      <para>
     47        The edit pop-up window is the same for both when creating a new user and when
     48        editing an existing user.
     49      </para>
    4050
    4151      <helptext external_id="user.edit" title="Edit user account">
    4252        <sect3 id="user_administration.users.edit.account">
    4353          <title>Account properties</title>
     54          <para>
     55            These are the properties for an user account.
     56          </para>
    4457          <variablelist>
    4558            <varlistentry>
     
    4962              <listitem>
    5063                <para>
    51                   The full name of the user, that is associated with this account,
    52                   should be written in this field. Required information.
     64                  The full name of the user that is associated with this account.
     65                  (Required)
    5366                </para>
    5467              </listitem>
     
    6073              <listitem>
    6174                <para>
    62                   A login name to use when logging in to this account. Required
    63                   information.
     75                  A login name to use when logging in to this account. (Required)
    6476                </para>
    6577              </listitem>
     
    7284              </term>
    7385              <listitem>
    74                 <para>
    75                   Id used identify the user outside BASE. This information is
    76                   optional.
    77                 </para>
     86                <para>Id used identify the user outside BASE. (Optional)</para>
    7887              </listitem>
    7988            </varlistentry>
     
    8594                <para>
    8695                  This is used together with the login name to log in with this
    87                   account. This is required for a new user or if a user's password
     96                  account. This is required for a new user or if the password
    8897                  should be changed.
    8998                </para>
     
    96105              <listitem>
    97106                <para>
    98                   This field is used to confirm the password in
    99                   <guilabel>New password</guilabel>
    100                   . Retype the password in this field.
    101                 </para>
    102               </listitem>
    103             </varlistentry>
    104             <varlistentry>
    105               <term>
    106                 <userinput>Quota</userinput>
    107               </term>
    108               <listitem>
    109                 <para>
    110                   Set disk quota for this account.This field is required to have
    111                   value set.
    112                 </para>
    113               </listitem>
    114             </varlistentry>
    115             <varlistentry>
    116               <term>
    117                 <userinput>Quota group</userinput>
     107                  Retype the password in <guilabel>New password</guilabel>.
     108                </para>
     109              </listitem>
     110            </varlistentry>
     111            <varlistentry>
     112              <term>
     113                <optional>
     114                  <userinput>Quota</userinput>
     115                </optional>
     116              </term>
     117              <listitem>
     118                <para>Set disk quota for this account.(Required)</para>
     119              </listitem>
     120            </varlistentry>
     121            <varlistentry>
     122              <term>
     123                <optional>
     124                  <userinput>Quota group</userinput>
     125                </optional>
    118126              </term>
    119127              <listitem>
    120128                <para>
    121129                  Set this if the account should belong to a group with specified
    122                   quota. This field is optional.
    123                 </para>
    124               </listitem>
    125             </varlistentry>
    126             <varlistentry>
    127               <term>
    128                 <userinput>Home directory</userinput>
     130                  quota.(Optional)
     131                </para>
     132              </listitem>
     133            </varlistentry>
     134            <varlistentry>
     135              <term>
     136                <optional>
     137                  <userinput>Home directory</userinput>
     138                </optional>
    129139              </term>
    130140              <listitem>
    131141                <para>
    132142                  Set the account's home directory. A new directory, either empty
    133                   or from a template, can be created if editing a new user.
    134                 </para>
    135               </listitem>
    136             </varlistentry>
    137             <varlistentry>
    138               <term>
    139                 <userinput>Expiration date</userinput>
     143                  or from a template, can be created if editing a new
     144                  user.(Optional)
     145                </para>
     146              </listitem>
     147            </varlistentry>
     148            <varlistentry>
     149              <term>
     150                <optional>
     151                  <userinput>Expiration date</userinput>
     152                </optional>
    140153              </term>
    141154              <listitem>
     
    145158                  this date. Use
    146159                  <guibutton>Calendar&hellip;</guibutton>
    147                   to pick a date from a calendar-pop-up window. This field is
    148                   optional.
     160                  to pick a date from a calendar-pop-up window.(Optional)
    149161                </para>
    150162              </listitem>
     
    175187          </variablelist>
    176188        </sect3>
     189        <para>
     190          Go to the other tabs if there are any changes to do otherwise press
     191          <guibutton>Save</guibutton>
     192          to save the values or
     193          <guibutton>Cancel</guibutton>
     194          to abort.
     195        </para>
    177196        <seeother>
    178197          <other external_id="user.edit.contact">Edit user's contact information</other>
     
    184203          <title>Contact information</title>
    185204          <para>
    186             All fields on this tab are optional and do not necessarily need to have a
    187             value.
     205            Information how get in contact with the user that is connected to the
     206            account. All fields on this tab are optional and do not necessarily need to
     207            have a value.
    188208          </para>
    189209          <variablelist>
    190210            <varlistentry>
    191211              <term>
    192                 <optional>Email</optional>
    193               </term>
    194               <listitem>
    195                 <para>The user's email address.</para>
    196               </listitem>
    197             </varlistentry>
    198             <varlistentry>
    199               <term>
    200                 <optional>Organisation</optional>
    201               </term>
    202               <listitem>
    203                 <para>
    204                   If the user works for an organisation, it should be defined
    205                   here.
    206                 </para>
    207               </listitem>
    208             </varlistentry>
    209             <varlistentry>
    210               <term><optional>Address</optional></term>
    211               <listitem>
    212                 <para>
    213                   A post address to the user. Use the magnifying glas down to the right, to
     212                <optional>
     213                  <userinput>Email</userinput>
     214                </optional>
     215              </term>
     216              <listitem>
     217                <para>
     218                  User's email address.There is some verification of the value but
     219                  their is no check if the email really exists.
     220                </para>
     221              </listitem>
     222            </varlistentry>
     223            <varlistentry>
     224              <term>
     225                <optional>
     226                  <userinput>Organisation</userinput>
     227                </optional>
     228              </term>
     229              <listitem>
     230                <para>
     231                  The company or organisation that the user works for.
     232                </para>
     233              </listitem>
     234            </varlistentry>
     235            <varlistentry>
     236              <term>
     237                <optional>
     238                  <userinput>Address</userinput>
     239                </optional>
     240              </term>
     241              <listitem>
     242                <para>
     243                  User's address. Use the magnifying glas down to the right, to
    214244                  edit this property in a larger window - opened in a pop-up
    215245                  window.
     
    218248            </varlistentry>
    219249            <varlistentry>
    220               <term><optional>Phone</optional></term>
    221               <listitem>
    222                 <para>
    223                   A phone number to get in contact with the user.
     250              <term>
     251                <optional>
     252                  <userinput>Phone</userinput>
     253                </optional>
     254              </term>
     255              <listitem>
     256                <para>
     257                  User's phone number(s)
    224258                  <note>
    225259                    <para>
    226                       There is no special field for cellular telephone, but
    227                       this field can contain more then one number.
     260                      There is no special field for mobile phone, but it works
     261                      fine to put more then one number in this field.
    228262                    </para>
    229263                  </note>
     
    232266            </varlistentry>
    233267            <varlistentry>
    234               <term><optional>Fax</optional></term>
    235               <listitem>
    236                 <para></para>
    237 
    238               </listitem>
    239             </varlistentry>
    240             <varlistentry>
    241               <term><optional>Url</optional></term>
    242               <listitem>
    243                 <para></para>
    244 
    245               </listitem>
    246             </varlistentry>
    247             <varlistentry>
    248               <term><optional>Description</optional></term>
    249               <listitem>
    250                 <para></para>
    251 
     268              <term>
     269                <optional>
     270                  <userinput>Fax</userinput>
     271                </optional>
     272              </term>
     273              <listitem>
     274                <para>User's fax number.</para>
     275              </listitem>
     276            </varlistentry>
     277            <varlistentry>
     278              <term>
     279                <optional>
     280                  <userinput>Url</userinput>
     281                </optional>
     282              </term>
     283              <listitem>
     284                <para>Fill in any URL associated with the user here.</para>
     285              </listitem>
     286            </varlistentry>
     287            <varlistentry>
     288              <term>
     289                <optional>
     290                  <userinput>Description</userinput>
     291                </optional>
     292              </term>
     293              <listitem>
     294                <para>
     295                  Other useful contact information or description about the user should be
     296                  written in this field. Use the magnifying glass to edit the information in
     297                  a pop-up window with a larger text-area.
     298                </para>
    252299              </listitem>
    253300            </varlistentry>
    254301          </variablelist>
    255302        </sect3>
     303        <para>
     304          Go to the other tabs if there are any changes to do otherwise press
     305          <guibutton>Save</guibutton>
     306          to save the values or
     307          <guibutton>Cancel</guibutton>
     308          to abort.
     309        </para>
    256310        <seeother>
    257311          <other external_id="user.edit">Edit account</other>
     
    266320          <sect4 id="user_administration.users.edit.membership.change">
    267321            <title>Add or remove membership</title>
    268             <para></para>
     322            <para >
     323              An user's membership in groups and roles can be set on this tab. The
     324              membership can also be changed by adding/removing the user to/from a
     325              group's/role's list of members that is described in
     326              <link linkend="user_administration.groups.edit">edit group</link>
     327              and
     328              <link linkend="user_administration.roles.edit">edit role</link>
     329            </para>
     330            <para>
     331              Use
     332              <guibutton>Add groups&hellip;</guibutton>
     333              or
     334              <guibutton>Add roles&hellip;</guibutton>
     335              to add a membership in a group or a role. Mark the checkboxes for those
     336              groups or roles that the user should become a member in.
     337            </para>
     338            <para>
     339              Use
     340              <guibutton>Remove</guibutton>
     341              to delete membership(s) from selected groups/roles in the list. The
     342              selected items will disappear from the list of memberships.
     343            </para>
    269344          </sect4>
    270345        </sect3>
     346        <para>
     347          Go to the other tabs if there are any changes to do otherwise press
     348          <guibutton>Save</guibutton>
     349          to save the values or
     350          <guibutton>Cancel</guibutton>
     351          to abort.
     352        </para>
    271353        <seeother>
    272354          <other external_id="user.edit">Edit account</other>
     
    284366      <title>Edit group</title>
    285367      <para></para>
     368      <helptext external_id="group.edit" title="Edit group">
     369        <sect3 id="user_administration.groups.edit.properties">
     370          <title>Properties</title>
     371          <variablelist>
     372            <varlistentry>
     373              <term>
     374                <userinput>Name</userinput>
     375              </term>
     376              <listitem>
     377                <para>Group's name.(Required)</para>
     378              </listitem>
     379            </varlistentry>
     380            <varlistentry>
     381              <term>
     382                <optional>
     383                  <userinput>Description</userinput>
     384                </optional>
     385              </term>
     386              <listitem>
     387                <para>
     388                  Description about the group. The magifying glass, down to the
     389                  right, can be used to open the text in a larger text area.
     390                </para>
     391              </listitem>
     392            </varlistentry>
     393            <varlistentry>
     394              <term>
     395                <optional>
     396                  <userinput>Quota</userinput>
     397                </optional>
     398              </term>
     399              <listitem>
     400                <para>
     401                  With this property it's possible to limit the quota of total
     402                  disk space for the group members. Select
     403                  <guilabel>-none-</guilabel>
     404                  from the dropdown list if the group shouldn't be a quota group.
     405                  There are some presets of quotas that comes with the BASE2
     406                  installation, besides a couple with different size of total disk
     407                  space there are one called
     408                  <guilabel>No quota</guilabel>
     409                  and one with
     410                  <guilabel>Unlimited quota</guilabel>
     411                  . The names speak for them self.
     412                </para>
     413              </listitem>
     414            </varlistentry>
     415          </variablelist>
     416        </sect3>
     417        <para>
     418          Go to the other tab,
     419          <guilabel>Members</guilabel>
     420          , if there are any changes to do otherwise press
     421          <guibutton>Save</guibutton>
     422          to save the values or
     423          <guibutton>Cancel</guibutton>
     424          to abort.
     425        </para>
     426        <seeother>
     427          <other external_id="group.edit.membership">Edit group members</other>
     428        </seeother>
     429      </helptext>
     430     
     431      <helptext external_id="group.edit.membership" title="Edit group members">
     432        <sect3 id="user_administration.groups.edit.members">
     433          <title>Group members</title>
     434          <para>
     435            The members in a group can be both users and other groups. Group members
     436            have access to those items that are shared to the group. Each user in the
     437            group can choose to share their own items to one or more of the other
     438            members or to the whole group.
     439          </para>
     440          <sect4 id="user_administration.groups.edit.members.change">
     441            <title>Members</title>
     442            <para>
     443              The members of a group are displayed in the members listbox. Press Save
     444              to save the settings or Cancel to abort and discard the changes.
     445
     446              Add users/groups Click on either Add users... - to add users or Add
     447              groups... - to add whole groups to the member list. This will open a
     448              popup window where the new members can be selected.
     449
     450              Remove members Removing a member from a group are done by first
     451              selecting one or more member in the list and then press Remove.
     452            </para>
     453          </sect4>
     454        </sect3>
     455        <para>
     456          Go to the other tab,
     457          <guilabel>Group</guilabel>
     458          , if there are any changes to do otherwise press
     459          <guibutton>Save</guibutton>
     460          to save the values or
     461          <guibutton>Cancel</guibutton>
     462          to abort.
     463        </para>
     464        <seeother>
     465          <other external_id="group.edit">Edit group properties</other>
     466        </seeother>
     467      </helptext>
    286468    </sect2>
    287469
     
    297479    </sect2>
    298480  </sect1>
     481 
     482  <sect1 id="user_administration.quota">
     483    <title>Disk space/quota</title>
     484    <para></para>
     485  </sect1>
    299486</chapter>
Note: See TracChangeset for help on using the changeset viewer.