Changeset 3214

Timestamp:

Mar 26, 2007, 4:01:26 PM (17 years ago)

Author:

Nicklas Nordborg

Message:

Using the menu bar section.

Location:

trunk/doc/src/docbook

Files:

• figures/project.gif (added)
• figures/recent.png (added)
• figures/refresh.gif (added)
• userdoc/webclient.xml (modified) (6 diffs)

trunk/doc/src/docbook/userdoc/webclient.xml

@@ -67 +67 @@
           before it is sent to the BASE server. It is enabled by default, and
           it is a good idea to leave it checked unless you have problems logging
-          in. If you are sure you are entering the correct login and password
-          try unchecking the encyption option.
+          in. If you are sure you are entering the correct login and password,
+          but still can't log in, try unchecking the encyption option.
         </para>
       </sect2>
@@ -94 +94 @@
           <listitem>
             <para>
-            Messages are sent by plugins to notify you about finished jobs.
+            Messages are sent by plugins to notify you about finished jobs. In the
+            future, you may get messages from other sources as well. As of today,
+            messages are not used for communication between users.
             </para>
           </listitem>
@@ -104 +106 @@
             <para>
             A list of projects that you are a member of. It is possible
-            to select to activate a project from this list. We recommend
+            to activate a project from this list. We recommend
             that you always use a project when working with BASE. It will
             make your life much easier once you start to cooperate with 
@@ -126 +128 @@
           <listitem>
             <para>
-            Links for getting help and reportering bugs. The number
+            Links for getting help and reporting bugs. The number
             of links displayed here may vary depending on how the administrator
             have set up the server.
@@ -161 +163 @@
           submenu will take you to another page or open a popup. For example, the
           <menuchoice><guimenu>View</guimenu><guimenuitem>Samples</guimenuitem></menuchoice>
-          menu will take you to the <interface>Samples</interface> page listing
+          menu will take you to the page listing
           samples.
         </para>
+        
+        <para>
+          The menu bar also contains shortcuts to some often-used
+          actions:
+        </para>
+        
+        
+      <variablelist>
+        <varlistentry>
+          <term>
+            <interface>
+            <inlinemediaobject>
+            <imageobject><imagedata fileref="figures/refresh.gif" format="GIF" align="left"/></imageobject>
+            </inlinemediaobject>
+            Refresh button
+            </interface>
+          </term>
+          <listitem>
+            <para>
+            Refresh/reload the current page. This is useful when you add
+            or modify items in BASE. Most of the time the page is refreshed
+            automatically, but in some cases you will have to use
+            this button to refresh the page.
+            </para>
+            
+            <warning>
+              <para>
+              Do not use your browser's <guibutton>Refresh</guibutton> button
+              since it will take you to the login page again.
+              </para>
+            </warning>
+          </listitem>
+        </varlistentry>
+        
+        <varlistentry>
+          <term>
+            <interface>
+            <inlinemediaobject>
+            <imageobject><imagedata fileref="figures/recent.png" format="PNG" align="left"/></imageobject>
+            </inlinemediaobject>
+            Recent items
+            </interface>
+          </term>
+          <listitem>
+            <para>
+            Goto the most recently viewed item. By default, the list contains links to
+            the most recently viewed experiment and bioassayset, but this
+            is configurable. If you, for example, work a lot with protocols, you may
+            add a link to the most recently viewed protocol.
+            See <xref linkend="webclient.configuration.other"/>
+            </para>
+          </listitem>
+        </varlistentry>
+        
+        <varlistentry>
+          <term>
+            <interface>
+            <inlinemediaobject>
+            <imageobject><imagedata fileref="figures/project.gif" format="GIF" align="left"/></imageobject>
+            </inlinemediaobject>
+            Projects
+            </interface>
+          </term>
+          <listitem>
+            <para>
+            A list of all projects you are a member of. Selecting a project in the
+            list will make that project the active project.
+            </para>
+          </listitem>
+        </varlistentry>
+        
+        <varlistentry>
+          <term>
+            <interface>
+            <inlinemediaobject>
+            <imageobject><imagedata fileref="figures/user.png" format="PNG" align="left"/></imageobject>
+            </inlinemediaobject>
+            Logged in user
+            </interface>
+          </term>
+          <listitem>
+            <para>
+            Displays the name of the currently logged in user and allows
+            you to quickly logout and switch to another user.
+            </para>
+          </listitem>
+        </varlistentry>
+        
+      </variablelist>
         
       </sect2>
@@ -169 +260 @@
       <sect2 id="webclient.intro.help">
         <title>Getting help</title>
-        <para></para>
+        <para>TODO</para>
       </sect2>