Changeset 3840

Timestamp:

Oct 16, 2007, 1:50:21 PM (16 years ago)

Author:

Jari Häkkinen

Message:

Fixes #667.

Location:

trunk/doc/src/docbook

Files:

• appendix/menuguide.xml (modified) (1 diff)
• userdoc/index.xml (modified) (1 diff)
• userdoc/reporters.xml (modified) (1 diff)
• userdoc/trashcan.xml (deleted)
• userdoc/webclient.xml (modified) (5 diffs)

trunk/doc/src/docbook/appendix/menuguide.xml

@@ -761 +761 @@
             </entry>
             <entry>
-              <xref linkend="trashcan" />
+              <xref linkend="webclient.trashcan" />
             </entry>
           </row>

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

@@ -32 +32 @@
   <include file="webclient.xml"/>
   <include file="project_permission.xml"/>
-  <include file="trashcan.xml"/>
   <include file="file_system.xml"/>
   <include file="jobs.xml"/>

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

@@ -314 +314 @@
           Reporters are treated differently from other
           items (e.g biosources or protocols) since they
-          does not use the trashcan mechanism (see <xref linkend="trashcan" />).
+          does not use the trashcan mechanism (see
+          <xref linkend="webclient.trashcan" />).
           The deletion happens immediately and is an unrecoverable
           event. BASE will always show a warning message which you must

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

@@ -6 +6 @@
   $Id$
 
-  Copyright (C) 2007 Peter Johansson, Nicklas Nordborg, Martin Svensson
+  Copyright (C) 2007 Jari Hakkinen, Peter Johansson, Nicklas Nordborg, Martin Svensson
 
   This file is part of BASE - BioArray Software Environment.
@@ -1062 +1062 @@
         <para>
           You can delete items either from the list view or from 
-          a single-item view. In both cases, the item is only moved to
-          the trashcan. No information is deleted from the database. This allows
-          you to restore the item if you later find out that you need it again.
+          a single-item view. In both cases, deleted items are only moved to
+          the trashcan. No information is removed from the database. This allows
+          you to restore items if you later find out that you need them again.
           In fact, there is nothing special about a removed item. It can still be
           used for the same things as any non-removed item can.
@@ -1071 +1071 @@
         <important>
           <para>
-          To really delete an item from the database you must use
-          the trashcan. See <xref linkend="trashcan"/>.
+          To really delete items from the database you must use
+          the trashcan. See <xref linkend="webclient.trashcan"/>.
           </para>
         </important>
@@ -1101 +1101 @@
         
         <para>
-          You can restore deleted items either from the trashcan,
-          from the list view or from the single-item view. This section only covers the last two
-          cases. The trashcan has a section of it's own(<xref linkend="trashcan"/>).
+          You can restore deleted items either from the trashcan, from
+          the list view, or from the single-item view. This section
+          only covers the last two cases. The trashcan is described in
+          another section (<xref linkend="webclient.trashcan"/>).
         </para>
 
@@ -1891 +1892 @@
       </sect2>
     </sect1>
-    
+
+
+    <sect1 id="webclient.trashcan">
+      <title>Trashcan</title>
+      <para>
+        All items that have been deleted, and are owned by you, are
+        listed in your trashcan. This list page is accessed with
+        <menuchoice>
+          <guimenu>View</guimenu>
+          <guimenuitem>Trashcan</guimenuitem>
+        </menuchoice>
+        and it differs a bit from the other common list pages. The
+        most significant difference is that the trashcan page can
+        contain more then one item type, actually all removable item
+        types in BASE can be listed in the trascan. Items that neither
+        can be removed or deleted, <emphasis>i.e.,</emphasis> items
+        like sessions, nor clients' help texts since these are deleted
+        from the database immediately in list/item view will be shown
+        in the trashcan page.
+      </para>
+      <warning>
+        <para>
+          Some item types do not have any owner and these are listed
+          in the trashcans for everyone with delete permission on that
+          specific item type.
+        </para>
+      </warning>
+
+      <para>
+        Things that the trashcan page have in common with other list
+        pages are the possibility to restore and view/edit items, see
+        <xref linkend="webclient.items.restore" /> and
+        <xref linkend="webclient.items.edit" /> . If an item is
+        restored, it will of course disappear from the trashcan.
+      </para>
+
+      <sect2 id="webclient.trashcan.deleteitem">
+        <title>Delete items permanently</title>
+        <para>
+          Items can be permanently deleted from BASE only if they are
+          not used by other items.  Items that are used have the icon
+          <inlinemediaobject>
+            <imageobject>
+              <imagedata fileref="figures/isused.gif" format="GIF" align="left" />
+            </imageobject>
+          </inlinemediaobject>
+          in the first column and by clicking on it you can get more
+          information about the dependencies, see
+          <xref linkend="webclient.trashcan.viewdependencies" /> .
+          <note>
+            <simpara>
+              This view is NOT the same view page as when clicking on
+              the item's name, which brings you to the item's view
+              page.
+            </simpara>
+          </note>
+        </para>
+        <para>
+          To delete one or several items permanently from the trashcan
+          you first have to select them and then to click on the
+          &gbDelete; button. Press then on either &gbOk; (completes
+          the deletion) or &gbCancel; (no items will be deleted) in
+          the dialog window that appears.
+        </para>
+
+        <sect3 id="webclient.trashcan.deleteitem.empty">
+          <title>Empty trashcan</title>
+          <para>
+            If all items in the trashcan should be deleted permanently
+            the <guibutton>Empty trash</guibutton> button can be
+            used. This function will remove all items that are listed
+            in your trashcan, except those items which other items,
+            not marked for deletion or cannot be deleted, are
+            dependent on.
+          </para>
+        </sect3>
+      </sect2>
+
+      <sect2 id="webclient.trashcan.viewdependencies">
+        <title>View dependencies of a trashed item</title>
+        <helptext external_id="trash.view.properties" title="Properties for a trashed item">
+          <para>
+            This view can only be accessed from trashed items that are
+            linked together with other items. Beside the item's
+            <guilabel>item type</guilabel>, <guilabel>name</guilabel>,
+            and <guilabel>description</guilabel> there is a list at
+            the bottom of the view page with those items that are
+            using the current item in some way.
+          </para>
+        </helptext>
+        <para>
+          <nohelp>
+            <figure id="webclient.trashcan.figures.viewtrasheditem">
+              <title>Item view of a trashed item.</title>
+              <screenshot>
+                <mediaobject>
+                  <imageobject>
+                    <imagedata fileref="figures/trashview.png" format="PNG" 
+                               scalefit="1" width="100%" />
+                  </imageobject>
+                </mediaobject>
+              </screenshot>
+            </figure>
+          </nohelp>
+          <orderedlist>
+            <listitem>
+              <para>
+                This icon indicates that the item cannot be deleted
+                permanently cause of some dependencies, see
+                #<xref linkend="webclient.trashcan.lists.dependentitem3" />.
+              </para>
+            </listitem>
+            <listitem>
+              <para>Common properties for all removable items.</para>
+            </listitem>
+            <listitem id="webclient.trashcan.lists.dependentitem3">
+              <para>A list of other items that are using the current item.</para>
+            </listitem>
+          </orderedlist>
+        </para>
+      </sect2>
+    </sect1>
+
 </chapter>