Changeset 5789

Timestamp:

Oct 6, 2011, 3:49:33 PM (11 years ago)

Author:

Nicklas Nordborg

Message:

References #1590: Documentation cleanup

New screenshots for chapter 4 and 5 in User documentation (except for "Item overview" since it is not yet fully working). Minor changes in the texts.

Location:

trunk

Files:

• doc/src/docbook/figures/configure_columns.png (modified) (previous)
• doc/src/docbook/figures/homepage.png (modified) (previous)
• doc/src/docbook/figures/listpage.png (modified) (previous)
• doc/src/docbook/figures/manage_presets.png (modified) (previous)
• doc/src/docbook/figures/rss.png (added)
• doc/src/docbook/figures/save_preset.png (modified) (previous)
• doc/src/docbook/figures/select_owner.png (modified) (previous)
• doc/src/docbook/figures/set_permissions.png (modified) (previous)
• doc/src/docbook/figures/trashview.png (modified) (previous)
• doc/src/docbook/figures/view_presets.png (modified) (previous)
• doc/src/docbook/user/overview.xml (modified) (2 diffs)
• doc/src/docbook/user/webclient.xml (modified) (12 diffs)
• lib/docbook/custom-styles/docbook/plain/css/docbook.css (modified) (2 diffs)

trunk/doc/src/docbook/user/overview.xml

@@ -184 +184 @@
             <para>
               Next step is to create raw bioassays and up-load raw data to BASE. This is done in the raw
-              bioassay section.(
-              <menuchoice>
+              bioassay section. (<menuchoice>
                 <guimenuitem>View</guimenuitem>
                 <guimenuitem>Raw bioassays</guimenuitem>
-              </menuchoice>
-              ) . More information see
-              <xref linkend="experiments_analysis.rawbioassay" />
+              </menuchoice>) . For more information see
+              <xref linkend="experiments_analysis.rawbioassay" />.
             </para>
           </listitem>
@@ -200 +198 @@
                 <guimenuitem>View</guimenuitem>
                 <guimenuitem>Experiments</guimenuitem>
-              </menuchoice>
+              </menuchoice>.
               Further reading in
-              <xref linkend="experiments_analysis.experiments" />
+              <xref linkend="experiments_analysis.experiments" />.
             </para>
           </listitem>

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

@@ -99 +99 @@
         using the 
         <menuchoice><guimenu>View</guimenu><guimenuitem>Home</guimenuitem></menuchoice>
+        menu.
       </para>
         
@@ -116 +117 @@
           <listitem>
             <para>
-            Messages are sent by plug-ins to notify you about finished jobs. In the
+            Messages are, for example, sent by plug-ins 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.
@@ -167 +168 @@
             information about server upgrades and maintenance.
             </para>
+            
+            <tip>
+              <title>Subscribe to the RSS news feed.</title>
+              <para>
+                Click on the RSS icon <guiicon>
+              <inlinemediaobject>
+              <imageobject><imagedata fileref="figures/rss.png" format="PNG" /></imageobject>
+              </inlinemediaobject>
+            </guiicon> in the <interface>News and announcements</interface>
+                title bar. This allows you to subscribe to the news feed 
+                from the BASE server so that you don't miss anything interesting.
+              </para>
+            </tip>
           </listitem>
         </varlistentry>
@@ -319 +333 @@
               <para>
               Whenever you find a small help icon 
-              (<guiicon>
+              <guiicon>
                 <inlinemediaobject>
                 <imageobject><imagedata fileref="figures/help.gif" format="GIF" /></imageobject>
                 </inlinemediaobject>
-              </guiicon>) 
+              </guiicon>
               or button you may
               click it to get help about the part of the page
@@ -1003 +1017 @@
           <listitem>
             <para>
-            Displays information about a single item. Sometimes it is very little,
-            sometimes it is very much and the information may be divided
+            Displays information about a single item. For some items it is very little,
+            but for some it is very much and the information may be divided
             into multiple tabs.
             </para>
@@ -1014 +1028 @@
           <listitem>
             <para>
-            This view is used for editing the information
-            about a single item. It is always displayed as a pop-up window.
+            This view is used for editing the information about a single item. 
+            It is always displayed as a pop-up window. Quite often the popup has
+            multiple tabs, but the most important information is found on the
+            first tab. Information that is required is always found on the
+            first tab.
             </para>
           </listitem>
@@ -1297 +1314 @@
                 <para>
                 When you select a user, group or project in the
-                list, the checkboxes will display the current permission. 
+                list, the checkboxes will change to indicate the current permissions. 
                 The exception is if the permissions are varying, in which
                 case no checkboxes are checked.
@@ -1327 +1344 @@
                   <listitem>
                     <para>
-                    you share group memberships with 
-                    (the <emphasis>Everyone</emphasis> group doesn't count)
+                    you share group memberships with  (the <emphasis>Everyone</emphasis> 
+                    group or groups with hidden members doesn't count)
                     </para>
                   </listitem>
@@ -1355 +1372 @@
                 button. Unless you are an administrator, the pop-up window 
                 will only list groups where you are a member. It will not list
-                groups that already have access to the items.
+                groups that already have access to the items. The
+                <emphasis>Everyone</emphasis> groups is normally not visible unless
+                have a specific permission to share items with this group.
                 </para>
               </listitem>
@@ -1481 +1500 @@
         </figure>
         
-        <note>
+        <warning>
           <para>
-          The original owner may not have access permissions to the items
-          any longer. If that is desired, the new owner must share the items
-          to the original owner.
+          If you are the original owner of the items, you should be aware of that
+          after the change you may no longer have access to the items. If you
+          make a mistake you may have to talk to an administrator to correct it.
           </para>
-        </note>
+        </warning>
         
       </sect2>
@@ -2268 +2287 @@
               <para>
                 This icon indicates that the item cannot be deleted
-                permanently cause of some dependencies, see
-                #<xref linkend="webclient.trashcan.lists.dependentitem3" />.
+                permanently cause of some dependencies, listed below.
               </para>
             </listitem>
@@ -2276 +2294 @@
             </listitem>
             <listitem id="webclient.trashcan.lists.dependentitem3">
-              <para>A list of other items that are using the current item.</para>
+              <para>
+                A list of other items that are using the current item, 
+                blocking permanent removal.
+              </para>
             </listitem>
           </orderedlist>

trunk/lib/docbook/custom-styles/docbook/plain/css/docbook.css

@@ -267 +267 @@
     margin-left:    15%;
     margin-right:   15%;
+    margin-top:     0em;
+    margin-bottom:  0em;
 }
 
@@ -278 +280 @@
 
 div.figure img {
-    border:         1px solid gray;
     padding:        0.5em;
-    margin:         0.5em;
 }