Changeset 3276


Ignore:
Timestamp:
Apr 26, 2007, 1:57:29 PM (16 years ago)
Author:
Nicklas Nordborg
Message:

References #525: Write "Using the web client"

Cleaned up first sections and added some missing sections.

Location:
trunk/doc/src/docbook
Files:
2 added
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/userdoc/webclient.xml

    r3246 r3276  
    3232    <sect1 id="webclient.introduction">
    3333      <title>Introduction</title>
    34       <para></para>
    3534     
    3635      <sect2 id="webclient.intro.login">
     
    5554       
    5655        <para>
    57           You will need to get all three things from a adminstrator
     56          You need to get all three things from a adminstrator
    5857          of the BASE server. If you know only the address to the
    5958          BASE server, you may check the front page if the administrator
    6059          has added any information about how to get a username/password
    61           there. Look for a link named <guilabel>Get an account!</guilabel>.
     60          there. Look for the <guilabel>Get an account!</guilabel> link on
     61          the front page.
    6262        </para>
    6363       
    6464        <para>
    6565          Logging in is simple, just enter your <guilabel>login</guilabel>
    66           and <guilabel>password</guilabel> in the input fields. There is
     66          and <guilabel>password</guilabel> in the form on the front page
     67          and click the <guibutton>Login</guibutton> button. There is
    6768          a checkbox which allows you to <guilabel>encrypt the password</guilabel>
    68           before it is sent to the BASE server. It is enabled by default, and
     69          before it is sent to the BASE server. It is checked by default, and
    6970          it is a good idea to leave it checked unless you have problems logging
    7071          in. If you are sure you are entering the correct login and password,
    7172          but still can't log in, try unchecking the encyption option.
    72         </para>
    73       </sect2>
    74  
     73          If the checkbox isn't visible, which happens if the server is
     74          using an external authentication server, the password is not encrypted.
     75        </para>
     76      </sect2>
     77     
     78      <sect2 id="webclient.intro.forgotten_password">
     79        <title>Forgotten password</title>
     80        <para>
     81          If you forget your password you will need to get a new one.
     82          BASE stores the passwords in an encrypted form that doesn't allow
     83          anyone, not even the server administrator, to find out the
     84          un-encrypted password.
     85        </para>
     86        <para>
     87          To get a new password you will have to contact the server
     88          administrator. There may be a <guilabel>Forgot your password?</guilabel>
     89          link on the front page where the server administrator has entered
     90          information about how to get a new password.
     91        </para>
     92      </sect2>
     93
    7594      <sect2 id="webclient.intro.homepage">
    7695        <title>The home page</title>
     
    7897      <para>
    7998        When you have been logged in the home page will be displayed. It
    80         displays some useful information.
     99        displays some useful information. You can also go to the home page
     100        using the
     101        <menuchoice><guimenu>View</guimenu><guimenuitem>Home</guimenuitem></menuchoice>
    81102      </para>
    82103       
     
    106127          <listitem>
    107128            <para>
    108             A list of projects that you are a member of. It is possible
    109             to activate a project from this list. We recommend
    110             that you always use a project when working with BASE. It will
    111             make your life much easier once you start to cooperate with
    112             other users. For more information read <xref linkend="project_permission"/>.
     129            A list of projects that you are a member of. Projects are an important
     130            part of BASE and are the best way to share data when you are
     131            cooperating with other users. We recommend
     132            that you always use a project when working with BASE.
     133            For more information read <xref linkend="project_permission"/>.
    113134            </para>
    114135          </listitem>
     
    130151            <para>
    131152            Links for getting help and reporting bugs. The number
    132             of links displayed here may vary depending on how the administrator
    133             have set up the server.
     153            of links displayed here may vary depending on the server
     154            configuration.
    134155            </para>
    135156          </listitem>
     
    156177          This is the main navigation tool in BASE. It works the same way
    157178          as the regular menu system found in most other applications. Use
    158           the mouse to click and select an item from the menu.
     179          the mouse to click and select a items from the menu.
    159180        </para>
    160181       
     
    162183          Most of the menu is in two levels, ie. clicking on a top-level menu
    163184          will open a submenu just below it. Clicking on something in the
    164           submenu will take you to another page or open a popup. For example, the
     185          submenu will take you to another page or open a popup dialog window.
     186          For example, the
    165187          <menuchoice><guimenu>View</guimenu><guimenuitem>Samples</guimenuitem></menuchoice>
    166           menu will take you to the page listing
    167           samples.
     188          menu will take you to the page listing samples and
     189          <menuchoice><guimenu>File</guimenu><guimenuitem>Contact information</guimenuitem></menuchoice>
     190          opens a dialog where you can modify your contact information details.
    168191        </para>
    169192       
     
    194217            <warning>
    195218              <para>
    196               Do not use your browser's <guibutton>Refresh</guibutton> button
    197               since it will take you to the login page again.
     219              Do not use your browser's <guibutton>Refresh</guibutton> button.
     220              Most browsers will take you to the login page again.
    198221              </para>
    199222            </warning>
     
    261284      <sect2 id="webclient.intro.help">
    262285        <title>Getting help</title>
    263         <para>TODO</para>
     286        <para>
     287          Besides reading this document there are more ways to get help:
     288        </para>
     289        <variablelist>
     290          <varlistentry>
     291            <term>
     292              Online context-sensitive help
     293            </term>
     294            <listitem>
     295              <para>
     296              Whenever you find a small help icon (
     297              <inlinemediaobject>
     298              <imageobject><imagedata fileref="figures/help.gif" format="GIF" /></imageobject>
     299              </inlinemediaobject>
     300              ) or button you may
     301              click it to get help about the part of the page
     302              you are currently viewing. The icon is located in the title
     303              bar in most popup dialog windows and in the toolbar in most
     304              other pages.
     305              </para>
     306            </listitem>
     307          </varlistentry>
     308
     309          <varlistentry>
     310            <term>
     311              Using the <menuchoice><guimenu>Help</guimenu></menuchoice> menu
     312            </term>
     313            <listitem>
     314              <para>
     315              The <menuchoice><guimenu>Help</guimenu></menuchoice> menu
     316              contains links for getting online help. These links
     317              may be configured by a server administrator, so they may be
     318              different from server to server. By default links for reporting
     319              a bug and accessing this document are installed.
     320              </para>
     321            </listitem>
     322          </varlistentry>
     323
     324          <varlistentry>
     325            <term>
     326              Mailing lists and other resources
     327            </term>
     328            <listitem>
     329              <para>
     330              See <xref linkend="resources" />.
     331              </para>
     332            </listitem>
     333          </varlistentry>
     334
     335        </variablelist>
     336       
    264337      </sect2>
    265338   
     
    275348          Use the <menuchoice><guimenu>File</guimenu>
    276349          <guimenuitem>Contact information</guimenuitem></menuchoice>
    277           menu to bring up the contact information dialog. It contains
    278           the following information:
     350          menu to bring up the user information dialog.
    279351        </para>
    280352       
    281353        <helptext external_id="userpreferences.contact" title="Contact information">
     354       
     355          <para>
     356          This dialog has three tabs, <guilabel>Contact information</guilabel>
     357          (selected), <guilabel>Password</guilabel> and <guilabel>Other information</guilabel>.
     358          The logged in user can update the following contact information
     359          details.
     360          </para>
     361       
     362          <note>
     363            <title>Multi-user accounts</title>
     364            If you are using a multi-user account, for example a demo-account, you
     365            don't have permission to change the contact information.
     366          </note>
     367       
    282368          <variablelist>
    283369            <varlistentry>
    284370              <term>
    285                 <guilabel>Email</guilabel>
    286               </term>
    287               <listitem>
     371                <userinput>Full name</userinput>
     372              </term>
     373              <listitem>
     374                <para>
     375                Your full name. You are not allowed to change this. If
     376                it is not correct, contact an administrator to do it for
     377                you.
     378                </para>
     379              </listitem>
     380            </varlistentry>
     381            <varlistentry>
     382              <term>
     383                <userinput>Email</userinput>
     384              </term>
     385              <listitem>
     386                <para>
    288387                Your email address (optional).
    289               </listitem>
    290             </varlistentry>
    291             <varlistentry>
    292               <term>
    293                 <guilabel>Organisation</guilabel>
    294               </term>
    295               <listitem>
     388                </para>
     389              </listitem>
     390            </varlistentry>
     391            <varlistentry>
     392              <term>
     393                <userinput>Organisation</userinput>
     394              </term>
     395              <listitem>
     396                <para>
    296397                The name of the organisation you work for or represent (optional).
    297               </listitem>
    298             </varlistentry>
    299             <varlistentry>
    300               <term>
    301                 <guilabel>Address</guilabel>
    302               </term>
    303               <listitem>
     398                </para>
     399              </listitem>
     400            </varlistentry>
     401            <varlistentry>
     402              <term>
     403                <userinput>Address</userinput>
     404              </term>
     405              <listitem>
     406                <para>
    304407                Your postal address as it should be printed on letters to you
    305408                (optional).
    306               </listitem>
    307             </varlistentry>
    308             <varlistentry>
    309               <term>
    310                 <guilabel>Phone</guilabel>
    311               </term>
    312               <listitem>
     409                </para>
     410              </listitem>
     411            </varlistentry>
     412            <varlistentry>
     413              <term>
     414                <userinput>Phone</userinput>
     415              </term>
     416              <listitem>
     417                <para>
    313418                Your phone number (optional). You may enter multiple phone numbers,
    314419                for example your work phone number and a mobile number.
    315               </listitem>
    316             </varlistentry>
    317             <varlistentry>
    318               <term>
    319                 <guilabel>Fax</guilabel>
    320               </term>
    321               <listitem>
     420                </para>
     421              </listitem>
     422            </varlistentry>
     423            <varlistentry>
     424              <term>
     425                <userinput>Fax</userinput>
     426              </term>
     427              <listitem>
     428                <para>
    322429                Your fax number (optional).
    323               </listitem>
    324             </varlistentry>
    325             <varlistentry>
    326               <term>
    327                 <guilabel>Url</guilabel>
    328               </term>
    329               <listitem>
     430                </para>
     431              </listitem>
     432            </varlistentry>
     433            <varlistentry>
     434              <term>
     435                <userinput>Url</userinput>
     436              </term>
     437              <listitem>
     438                <para>
    330439                An URL to your home page or your organisations home page (optional).
     440                </para>
    331441              </listitem>
    332442            </varlistentry>
    333443          </variablelist>
    334444         
    335           <note>
    336             If you are using a multi-user account, for example a demo-account, you
    337             are not able to change theese settings.
    338           </note>
    339          
     445          <para>
     446            Press <guibutton>Save</guibutton> to save the changes or
     447            <guibutton>Cancel</guibutton> to abort.
     448          </para>
     449         
     450          <seeother>
     451            <other external_id="userpreferences.password">Change password</other>
     452            <other external_id="userpreferences.other">Other information</other>
     453          </seeother>
    340454        </helptext>
     455       
    341456      </sect2>
    342457
     
    351466       
    352467        <helptext external_id="userpreferences.password" title="Change password">
     468
     469          <para>
     470          This dialog has three tabs, <guilabel>Contact information</guilabel>,
     471          <guilabel>Password</guilabel> (selected) and <guilabel>Other information</guilabel>.
     472          </para>
     473
    353474          <variablelist>
    354475            <varlistentry>
    355476              <term>
    356                 <guilabel>New password</guilabel>
    357               </term>
    358               <listitem>
     477                <userinput>New password</userinput>
     478              </term>
     479              <listitem>
     480                <para>
    359481                Enter the new password.
    360               </listitem>
    361             </varlistentry>
    362             <varlistentry>
    363               <term>
    364                 <guilabel>Retype password</guilabel>
    365               </term>
    366               <listitem>
     482                </para>
     483              </listitem>
     484            </varlistentry>
     485            <varlistentry>
     486              <term>
     487                <userinput>Retype password</userinput>
     488              </term>
     489              <listitem>
     490                <para>
    367491                Retype the same password. You must do this to
    368492                avoid spelling mistakes.
     493                </para>
    369494              </listitem>
    370495            </varlistentry>
    371496          </variablelist>
    372          
     497
    373498          <note>
     499            <title>Multi-user accounts</title>
     500            If you are using a multi-user account, for example a demo-account, you
     501            don't have permission to change the password.
     502          </note>
     503       
     504          <note>
     505            <title>Empty passwords</title>
    374506            If you leave both fields empty the password will not be changed. It
    375507            is not possible to have an empty password.
    376508          </note>
    377509         
    378           <note>
    379             If you are using a multi-user account, for example a demo-account, you
    380             are not able to change theese settings.
    381           </note>
     510          <seeother>
     511            <other external_id="userpreferences.contact">Contact information</other>
     512            <other external_id="userpreferences.other">Other information</other>
     513          </seeother>
    382514         
    383515        </helptext>
     
    390522          Use the <menuchoice><guimenu>File</guimenu>
    391523          <guimenuitem>Preferences</guimenuitem></menuchoice>
    392           menu to bring up the preferences dialog. It is divided into
    393           three tabs.
     524          menu to bring up the preferences dialog.
     525          This dialog has three tabs, <guilabel>Appearance</guilabel>,
     526          <guilabel>Plugins</guilabel> and <guilabel>Most recent</guilabel>.
    394527        </para>
    395528       
    396529        <sect3 id="webclient.configuration.preferences.appearance">
    397           <title>Appearance</title>
     530          <title>The Appearance tab</title>
    398531         
    399532          <helptext external_id="userpreferences.appearance" title="Preferences - Appearance">
     
    407540            <varlistentry>
    408541              <term>
    409                 <guilabel>Font size</guilabel>
    410               </term>
    411               <listitem>
     542                <userinput>Font size</userinput>
     543              </term>
     544              <listitem>
     545                <para>
    412546                Select a basic font size. You can choose between
    413547                five sizes: extra small (XS), small (S), medium (M),
    414548                large (L) and extra large (XL). The default font size is
    415549                medium.
    416               </listitem>
    417             </varlistentry>
    418             <varlistentry>
    419               <term>
    420                 <guilabel>Scale factor</guilabel>
    421               </term>
    422               <listitem>
     550                </para>
     551              </listitem>
     552            </varlistentry>
     553            <varlistentry>
     554              <term>
     555                <userinput>Scale factor</userinput>
     556              </term>
     557              <listitem>
     558                <para>
    423559                The scale factor affects the size of popup windows.
    424560                This setting exists because different browsers render
     
    426562                are too small you can change this setting to make them
    427563                bigger.
     564                </para>
    428565                <note>
    429566                  The scale factor is automatically changed if the
     
    434571            <varlistentry>
    435572              <term>
    436                 <guilabel>Toolbar</guilabel>
    437               </term>
    438               <listitem>
     573                <userinput>Toolbar</userinput>
     574              </term>
     575              <listitem>
     576                <para>
    439577                You may choose if the toolbar buttons should
    440578                have only images, only text or both images and text.
    441579                The default is that they have both images and text.
    442               </listitem>
    443             </varlistentry>
    444             <varlistentry>
    445               <term>
    446                 <guilabel>Recently used items</guilabel>
    447               </term>
    448               <listitem>
     580                </para>
     581              </listitem>
     582            </varlistentry>
     583            <varlistentry>
     584              <term>
     585                <userinput>Recently used items</userinput>
     586              </term>
     587              <listitem>
     588                <para>
    449589                The number of items to remember in the list
    450                 of recently used items. This will make data input
    451                 faster since fewer clicks are required to select
    452                 items. The default is to remember 4 items.
    453               </listitem>
    454             </varlistentry>
    455             <varlistentry>
    456               <term>
    457                 <guilabel>Ratio color range</guilabel>
    458               </term>
    459               <listitem>
     590                of recently used items. The default is to remember
     591                4 items.
     592                </para>
     593              </listitem>
     594            </varlistentry>
     595            <varlistentry>
     596              <term>
     597                <userinput>Ratio color range</userinput>
     598              </term>
     599              <listitem>
     600                <para>
    460601                Select three colors to use when displaying
    461602                data that is suitable for color coding, for
     
    465606                (for example, the BASE 1 red-yellow-green) and the most
    466607                recently used color combinations.
    467               </listitem>
    468             </varlistentry>
    469             <varlistentry>
    470               <term>
    471                 <guilabel>Date format</guilabel>
     608                </para>
     609              </listitem>
     610            </varlistentry>
     611            <varlistentry>
     612              <term>
     613                <userinput>Date format</userinput>
    472614              </term>
    473615              <listitem>
     
    499641            <varlistentry>
    500642              <term>
    501                 <guilabel>Date-time format</guilabel>
     643                <userinput>Date-time format</userinput>
    502644              </term>
    503645              <listitem>
     
    523665            <varlistentry>
    524666              <term>
    525                 <guilabel>Decimals</guilabel>
    526               </term>
    527               <listitem>
     667                <userinput>Decimals</userinput>
     668              </term>
     669              <listitem>
     670                <para>
    528671                The number of decimals to display for numeric values.
    529672                The default is 2.
     673                </para>
    530674              </listitem>
    531675            </varlistentry>
     
    538682       
    539683        <sect3 id="webclient.configuration.preferences.plugins">
    540           <title>Plugins</title>
     684          <title>The Plugins tab</title>
    541685         
    542686          <helptext external_id="userpreferences.plugins" title="Preferences - Plugins">
     
    549693            <varlistentry>
    550694              <term>
    551                 <guilabel>Messages</guilabel>
    552               </term>
    553               <listitem>
     695                <userinput>Messages</userinput>
     696              </term>
     697              <listitem>
     698                <para>
    554699                Mark the checkbox if you want to have a message sent
    555700                to you when a plugin completes execution. This setting
    556701                can be overridden each time you start a plugin.
     702                </para>
    557703              </listitem>
    558704            </varlistentry>
     
    563709       
    564710        <sect3 id="webclient.configuration.preferences.mostrecent">
    565           <title>Most recent</title>
     711          <title>The Most recent tab</title>
    566712         
    567713          <helptext external_id="userpreferences.mostrecent" title="Preferences - Most recent">
     
    575721         
    576722          <para>
    577             If the <guilabel>Load the names of all recent items</guilabel> checkbox
     723            If the <userinput>Load the names of all recent items</userinput> checkbox
    578724            is checked the name of the items will be displayed in the menu (for example,
    579725            Experiment: My experiment). Otherwise only the type of the item is
     
    9801126       
    9811127        <para>
     1128          In some places you will also find actions that create items
     1129          directly in the list. For example in the list of samples or on
     1130          the single-item view you can create an extract using that
     1131          sample as the parent. If you use such links the parent
     1132          item will in most cases be selected automatically, which saves
     1133          you a few clicks when creating new items.
     1134        </para>
     1135       
     1136        <para>
    9821137          Click on the <guibutton>Save</guibutton> button to save the new
    983           experiment to the database or on the <guibutton>Cancel</guibutton> button
     1138          item to the database or on the <guibutton>Cancel</guibutton> button
    9841139          to abort.
    9851140        </para>
     
    9951150        <orderedlist>         
    9961151          <listitem>
     1152            <para>
    9971153            If the list have an active filter the filter values are
    9981154            used as default property values for the new item. For example,
     
    10001156            raw data type the new experiment will automatically have
    10011157            <guilabel>Genepix</guilabel> selected. This trick should work
    1002             for all properties except annotations.       
    1003           </listitem>
    1004          
    1005           <listitem>
     1158            for all properties except annotations, if it doesn't
     1159            report it as a bug to the development team.
     1160            </para>
     1161          </listitem>
     1162         
     1163          <listitem>
     1164            <para>
    10061165            When you link to other items the same item will be used the next time.
    1007             For example the extraction protocol used to create an extract from a sample
    1008             is remembered and the same protocol is used the next time you create an extract.
     1166            For example, if you create an extract and selects an extraction protocol
     1167            the same protocol is used the next time you create another extract.
    10091168            In fact, BASE will remember as many items as specified by
    10101169            the <link linkend="webclient.configuration.preferences.appearance">
    1011             <guilabel>Recently used items</guilabel></link> setting (default is 4).
    1012           </listitem>
    1013          
    1014           <listitem>
     1170            <guilabel>Recently used items</guilabel></link> setting (default is 4),
     1171            allowing you to quickly select one of those protocols.
     1172            </para>
     1173          </listitem>
     1174         
     1175          <listitem>
     1176            <para>
    10151177            If you have a project active and that project has specified default
    10161178            values those values will be used for new items. A project can specify
    10171179            defaults for protocols, hardware and software and a few other settings.
     1180            </para>
    10181181          </listitem>
    10191182         
     
    10351198       
    10361199        <para>
    1037           You don't have to go to the single-item view to edit an item.
    1038           Whenever an item appear in a list or another place and has a link
    1039           on it, you can use a shortcut to open it's edit popup. Press
    1040           and hold one of the <keycap>CTRL</keycap>,
     1200          You can also open the edit popup in most other places where
     1201          the item appears, for example, in lists or the single-item view
     1202          of a related item. If you just click on the link you will be taken
     1203          to the single-item view page of the item, but if you also
     1204          hold down one of the <keycap>CTRL</keycap>,
    10411205          <keycap>ALT</keycap> or <keycap>SHIFT</keycap> keys while clicking on the
    1042           link. This will open the edit popup dialog for the item. If you don't
    1043           have write permission you will be taken to the single-item view of
    1044           that item instead.
     1206          link the edit dialog will open instead. If you don't have write permission
     1207          on the item there is no meaning to open the edit popup and you will
     1208          be taken to the single-item view page.
    10451209        </para>
    10461210
     
    10531217        <para>
    10541218          You can delete items either from the list view or from
    1055           a single-item view. In both cases, the item is only marked
    1056           as beeing removed. It is not deleted from the database. This allows
     1219          a single-item view. In both cases, the item is only put into
     1220          the trashcan. It is not deleted from the database. This allows
    10571221          you to restore the item if you later find out that you need it again.
    10581222          In fact, there is nothing special about a removed item. It can still be
     
    10731237          the <guilabel>Removed</guilabel> option. The removed items should now
    10741238          be displayed in the list with a small trashcan icon to indicate that
    1075           they have been removed.
     1239          they are located in the trashcan.
    10761240        </para>
    10771241
     
    10811245          itself automatically and a small trashcan icon should be displayed.
    10821246          If you don't have permission to delete the item the delete button
    1083           will be disabled.
     1247          is disabled.
    10841248        </para>
    10851249
     
    10901254       
    10911255        <para>
    1092           You can restore deleted items either from the <link linkend="trashcan">trashcan</link>,
     1256          You can restore deleted items either from the trashcan,
    10931257          from the list view or from the single-item view. This section only covers the last two
    1094           cases. The trashcan has a chapter of it's own.
     1258          cases. The trashcan has a <link linkend="trashcan">chapter of it's own</link>.
    10951259        </para>
    10961260
     
    10981262          To delete items from the list view you must first make the deleted
    10991263          items appear in the list. This is easy, just use the <guilabel>view / presets</guilabel>
    1100           dropdown and select the <guilabel>Removed</guilabel> option. This list should
     1264          dropdown and select the <guilabel>Removed</guilabel> option. The list should
    11011265          refresh itself automatically. The removed items should now
    11021266          be displayed in the list with a small trashcan icon to indicate that
    1103           they have been removed. Then, mark the checkbox for each item that you want
     1267          they are located in the trashcan. Then, mark the checkbox for each item that you want
    11041268          to restore and click the <guibutton>Restore</guibutton> button. The list should
    11051269          refresh iteself automatically and the trashcan icon should be gone from the
     
    11121276          itself automatically and the small trashcan icon should be gone.
    11131277          If you don't have permission to restore the item the restore button
    1114           will be disabled.
     1278          is disabled.
    11151279        </para>
    11161280
     
    11201284        <title>Share items to other users</title>
    11211285        <para>
    1122           TODO
    1123         </para>
     1286          Sharing data with other users is an important feature
     1287          of BASE, which allows you cooperate in teams. If you have
     1288          followed the instructions in <xref linkend="project_permission" />
     1289          you will find that you almost never have to share items manually
     1290          to other users. This is because whenever you work with an active
     1291          project each new item you create will automatically be shared
     1292          to that project.
     1293        </para>
     1294       
     1295        <para>
     1296          If you still need to manually share your data with other users,
     1297          here is how to do it.
     1298        </para>
     1299       
     1300        <para>
     1301          From a list view, mark the checkbox for each item you want to share.
     1302          Then, click on the <guibutton>Share&hellip;</guibutton> button.
     1303          If you are on a single-item page you just have
     1304          to click on the <guibutton>Share&hellip;</guibutton> button on that
     1305          page. In both cases, this will open the <guilabel>Set access permissions</guilabel>
     1306          dialog window.
     1307        </para>
     1308       
     1309        <figure id="webclient.items.share.set_permissions">
     1310          <title>Sharing items to other users</title>
     1311          <screenshot>
     1312          <mediaobject>
     1313            <imageobject>
     1314              <imagedata fileref="figures/set_permissions.png" format="PNG"/>
     1315            </imageobject>
     1316          </mediaobject>
     1317          </screenshot>
     1318        </figure>
     1319       
     1320        <helptext external_id="share.setpermissions" title="Set access permissions">
     1321          <variablelist>
     1322            <varlistentry>
     1323              <term><userinput>Members</userinput></term>
     1324              <listitem>
     1325                <para>
     1326                The list displays the user, groups and project
     1327                that already has acess to the items you selected.
     1328                The list shows the name and the permission level.
     1329                The permission level uses a one-letter code as follows:
     1330                </para>
     1331               
     1332                <itemizedlist>
     1333                <listitem><guilabel>R</guilabel> = Read</listitem>
     1334                <listitem><guilabel>U</guilabel> = Use</listitem>
     1335                <listitem><guilabel>W</guilabel> = Write</listitem>
     1336                <listitem><guilabel>D</guilabel> = Delete</listitem>
     1337                <listitem><guilabel>O</guilabel> = Take ownership</listitem>
     1338                <listitem><guilabel>P</guilabel> = Set permission</listitem>
     1339                </itemizedlist>
     1340               
     1341                <para>
     1342                  Instead of a permission code, the word <guilabel>varying</guilabel>
     1343                  may be displayed. This happens if the items you selected have been
     1344                  shared with different permission
     1345                </para>
     1346               
     1347              </listitem>
     1348            </varlistentry>
     1349           
     1350            <varlistentry>
     1351              <term><userinput>Permissions</userinput></term>
     1352              <listitem>
     1353                <para>
     1354                When you select a user, group or project in the
     1355                list the checkboxes will display the current permission,
     1356                except if the permissions are varying. In this case no
     1357                checkboxes are checked.
     1358               
     1359                To change the permissions just check the permissions you want to
     1360                grant or uncheck the permissions you want to revoke.
     1361                You can select more than one user, group or project
     1362                and change the permissions for all of them at once.
     1363                </para>
     1364              </listitem>
     1365            </varlistentry>           
     1366
     1367            <varlistentry>
     1368              <term><guibutton>Add users</guibutton></term>
     1369              <listitem>
     1370                <para>
     1371                Opens a popup window that allows you to select
     1372                users to share the items to. In the popup window, mark
     1373                one or more users and click on the <guibutton>Ok</guibutton>
     1374                button. Unless you are an administrator, the popup window
     1375                will only list users that are members of at least one of the
     1376                groups where you also are a member. It will not list users that
     1377                already have access to the items.
     1378                </para>
     1379              </listitem>
     1380            </varlistentry>
     1381
     1382            <varlistentry>
     1383              <term><guibutton>Add groups</guibutton></term>
     1384              <listitem>
     1385                <para>
     1386                Opens a popup window that allows you to select
     1387                groups to share the items to. In the popup window, mark
     1388                one or more groups and click on the <guibutton>Ok</guibutton>
     1389                button. Unless you are an administrator, the popup window
     1390                will only list groups where you are a member. It will not list
     1391                groups that already have access to the items.
     1392                </para>
     1393              </listitem>
     1394            </varlistentry>
     1395           
     1396            <varlistentry>
     1397              <term><guibutton>Add projects</guibutton></term>
     1398              <listitem>
     1399                <para>
     1400                Opens a popup window that allows you to select
     1401                projects to share the items to. In the popup window, mark
     1402                one or more projects and click on the <guibutton>Ok</guibutton>
     1403                button. Unless you are an administrator, the popup window
     1404                will only list projects where you are a member. It will not list
     1405                projects that already have access to the items.
     1406                </para>
     1407              </listitem>
     1408            </varlistentry>
     1409
     1410            <varlistentry>
     1411              <term><guibutton>Remove</guibutton></term>
     1412              <listitem>
     1413                <para>
     1414                Click on this button to revoke access permissions from
     1415                the selected users, groups and projects.
     1416                </para>
     1417              </listitem>   
     1418            </varlistentry>
     1419          </variablelist>
     1420       
     1421          <para>
     1422            Use the <guibutton>Save</guibutton> button to save your
     1423            changes or the <guibutton>Cancel</guibutton> button to
     1424            clost the popup without saving.
     1425          </para>
     1426        </helptext>
     1427
    11241428      </sect2>
    11251429
Note: See TracChangeset for help on using the changeset viewer.