Changeset 3364


Ignore:
Timestamp:
May 23, 2007, 9:52:38 AM (14 years ago)
Author:
Martin Svensson
Message:

References #527 Ready for reading

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

Legend:

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

    r3246 r3364  
    55<!--
    66  $Id$
    7 
     7 
    88  Copyright (C) Authors contributing to this file.
    9 
     9 
    1010  This file is part of BASE - BioArray Software Environment.
    1111  Available at http://base.thep.lu.se/
    12 
     12 
    1313  BASE is free software; you can redistribute it and/or
    1414  modify it under the terms of the GNU General Public License
    1515  as published by the Free Software Foundation; either version 2
    1616  of the License, or (at your option) any later version.
    17 
     17 
    1818  BASE is distributed in the hope that it will be useful,
    1919  but WITHOUT ANY WARRANTY; without even the implied warranty of
    2020  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    2121  GNU General Public License for more details.
    22 
     22 
    2323  You should have received a copy of the GNU General Public License
    2424  along with this program; if not, write to the Free Software
     
    3030  <?dbhtml dir="trashcan"?>
    3131  <title>Trashcan</title>
    32     <sect1>
    33       <title></title>
    34       <para></para>
    35     </sect1>
     32  <para>
     33    All items that have been removed and are owned by you are listed in the trashcan. This list
     34    page is accessed with
     35    <menuchoice>
     36      <guimenu>View</guimenu>
     37      <guimenuitem>Trashcan</guimenuitem>
     38    </menuchoice>
     39    and it differs a bit from the other common list pages. The most significant difference is
     40    that it's able to contain more then one item type, actually all item types in BASE that are
     41    removable. This exclude ie. items like sessions, that neither can be removed or deleted, and
     42    clients' helptexts that are deleted from the database immediately in list/item view.
     43  </para>
     44  <warning>
     45    <para>
     46      Some item types don't have any owner and these are listed in the trashcans for everyone
     47      with delete - permission on the specific item type.
     48    </para>
     49  </warning>
     50
     51  <para>
     52    Things that are common with other list pages are the possibility to restore items and to
     53    view/edit them, see
     54    <xref linkend="webclient.items.restore" />
     55    and
     56    <xref linkend="webclient.items.edit" />
     57    . If an item is restored, it will of course dissappear from the trashcan.
     58  </para>
     59
     60  <sect1 id="trashcan.deleteitem">
     61    <title>Delete items permanently</title>
     62    <para>
     63      Items can be permanently deleted from BASE only if they aren't used by other items.
     64      Items that are used have the icon
     65      <inlinemediaobject>
     66        <imageobject>
     67          <imagedata fileref="figures/isused.gif" format="GIF" align="left" />
     68        </imageobject>
     69      </inlinemediaobject>
     70      in the first column and by clicking on it you can get more information about the
     71      dependencies, see
     72      <xref linkend="trashcan.viewdependencies" />
     73      .
     74      <note>
     75        <simpara>
     76          This is NOT the same view page as when clicking on the item's name, which brings
     77          you to the item's view page.
     78        </simpara>
     79      </note>
     80    </para>
     81    <para>
     82      To delete one or several items permanently from trashcan you first have to select them,
     83      click then on the
     84      <guibutton>Delete</guibutton>
     85      button. Press then on either
     86      <guibutton>Ok</guibutton>
     87      (completes the deletion) or
     88      <guibutton>Cancel</guibutton>
     89      (no items will be deleted) in the dialog window that appears.
     90    </para>
     91
     92    <sect2 id="trashcan.deleteitem.empty">
     93      <title>Empty trashcan</title>
     94      <para>
     95        If all items in the trashcan should be deleted permanently the
     96        <guibutton>Empty trash</guibutton>
     97        button can be used. This function will delete all items that are listed in your
     98        trashcan, except those which other items, that aren't marked for deletion or that
     99        can't be deleted, are depending on.
     100      </para>
     101    </sect2>
     102  </sect1>
     103
     104  <sect1 id="trashcan.viewdependencies">
     105    <title>View dependencies of a trashed item</title>
     106    <helptext external_id="trash.view.properties" title="Properties for a trashed item">
     107      <para>
     108        This view can only be accessed from the trashed items that are linked together with
     109        other items. Beside the item's
     110        <guilabel>item type</guilabel>
     111        ,
     112        <guilabel>name</guilabel>
     113        and
     114        <guilabel>description</guilabel>
     115        there is a list at the bottom of the view page with those items that are using the
     116        current item in some way.
     117      </para>
     118    </helptext>
     119    <para>
     120      <nohelp>
     121        <figure>
     122          <title>Item view of a trashed item.</title>
     123          <screenshot>
     124            <mediaobject>
     125              <imageobject>
     126                <imagedata fileref="figures/trashview.png" format="PNG" />
     127              </imageobject>
     128            </mediaobject>
     129          </screenshot>
     130        </figure>
     131      </nohelp>
     132      <orderedlist>
     133        <listitem>
     134          <para>
     135            This icon indicates that the item can't be deleted permanently cause of some
     136            dependencies, see #<xref linkend="trashcan.lists.dependentitem3" />.
     137          </para>
     138        </listitem>
     139        <listitem>
     140          <para>Common properties for all removable items.</para>
     141        </listitem>
     142        <listitem id="trashcan.lists.dependentitem3">
     143          <para>A list of other items that are using the current item.</para>
     144        </listitem>
     145      </orderedlist>
     146    </para>
     147  </sect1>
     148
    36149</chapter>
Note: See TracChangeset for help on using the changeset viewer.