source: trunk/doc/src/docbook/userdoc/trashcan.xml @ 3398

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC 
    "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
    "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
<!--
  $Id: trashcan.xml 3398 2007-05-28 15:04:01Z jari $
  
  Copyright (C) Authors contributing to this file.
  
  This file is part of BASE - BioArray Software Environment.
  Available at http://base.thep.lu.se/
  
  BASE is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.
  
  BASE is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330,
  Boston, MA  02111-1307, USA.
-->

<chapter id="trashcan">
  <?dbhtml dir="trashcan"?>
  <title>Trashcan</title>
  <para>
    All items that have been removed and are owned by you are listed in the 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 is able to contain more then one item type,
    actually all item types in BASE that are removable. 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>

  <sect1 id="trashcan.deleteitem">
    <title>Delete items permanently</title>
    <para>
      Items can be permanently deleted from BASE only if they aren't 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="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 trashcan you
      first have to select them and then 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>

    <sect2 id="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 delete all items that are listed in your
        trashcan, except those items which other items, not marked for
        deletion or can't be deleted, are dependent on.
      </para>
    </sect2>
  </sect1>

  <sect1 id="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="trashcan.figures.viewtrasheditem">
          <title>Item view of a trashed item.</title>
          <screenshot>
            <mediaobject>
              <imageobject>
                <imagedata fileref="figures/trashview.png" format="PNG" />
              </imageobject>
            </mediaobject>
          </screenshot>
        </figure>
      </nohelp>
      <orderedlist>
        <listitem>
          <para>
            This icon indicates that the item can't be deleted permanently cause of some
            dependencies, see #<xref linkend="trashcan.lists.dependentitem3" />.
          </para>
        </listitem>
        <listitem>
          <para>Common properties for all removable items.</para>
        </listitem>
        <listitem id="trashcan.lists.dependentitem3">
          <para>A list of other items that are using the current item.</para>
        </listitem>
      </orderedlist>
    </para>
  </sect1>

</chapter>