source: trunk/doc/src/docbook/userdoc/wares.xml @ 5706

<?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: wares.xml 5706 2011-08-23 13:20:30Z nicklas $
  
  Copyright (C) 2007 Nicklas Nordborg, Philippe Rocca-Serra, Martin Svensson
  
  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 3
  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 BASE. If not, see <http://www.gnu.org/licenses/>.
-->
<chapter id="wares" chunked="0">
  <?dbhtml dir="wares"?>
  <title>Hardware and software</title>

  <sect1 id="wares.hardware">
    <title>Hardware</title>
    
    <para>
      A hardware is used in BASE to represent a piece of equipment in the lab
      that is used in the experiments.
      Information about hardware is typically added to a BASE server by an administrator
      and can be managed from <menuchoice>
        <guimenu>Administrate</guimenu>
        <guimenuitem>Hardware</guimenuitem>
      </menuchoice>.
    </para>
    
    <figure
      id="hardware.figures.edit_hardware">
      <title>Hardware properties</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata
              fileref="figures/edit_hardware.png" format="PNG" />
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
    
    <helptext external_id="hardware.edit" 
      title="Edit hardware">
      <variablelist>
      <varlistentry>
        <term><guilabel>Name</guilabel></term>
        <listitem>
          <para>
          The name of the hardware.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><guilabel>Type</guilabel></term>
        <listitem>
          <para>
          The hardware type of the hardware. The list
          may evolve depending on additions by the server
          administrator. Selecting the proper hardware type
          is important and enables BASE to automatically guess 
          the most likely hardware when creating new items.
          <nohelp>
            See <xref linkend="subtypes" /> for more information.
          </nohelp>
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><guilabel>Version</guilabel></term>
        <listitem>
          <para>
          The version number or model of the hardware.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><guilabel>Description</guilabel></term>
        <listitem>
          <para>
          A description of the hardware.
          </para>
        </listitem>
      </varlistentry>
      </variablelist>
    </helptext>
    
  </sect1>
  
  <sect1 id="wares.software">
    <title>Software</title>
    
    <para>
      A hardware is used in BASE to represent the software that is used to
      process and analyze data outside of BASE. Analysis that is done inside
      BASE is usually represented as plug-ins.
      Information about software is typically added to a BASE server by an administrator
      and can be managed from <menuchoice>
        <guimenu>Administrate</guimenu>
        <guimenuitem>Software</guimenuitem>
      </menuchoice>.
    </para>
    
    <figure
      id="software.figures.edit_softwware">
      <title>Software properties</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata
              fileref="figures/edit_software.png" format="PNG" />
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
          
    <helptext external_id="software.edit" 
      title="Edit software">
      <variablelist>
      <varlistentry>
        <term><guilabel>Name</guilabel></term>
        <listitem>
          <para>
          The name of the software.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><guilabel>Type</guilabel></term>
        <listitem>
          <para>
          The software type of the software. The list
          may evolve depending on additions by the server
          administrator. Selecting the proper software type
          is important and enables BASE to automatically guess 
          the most likely software when creating new items.
          <nohelp>
            See <xref linkend="subtypes" /> for more information.
          </nohelp>
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><guilabel>Version</guilabel></term>
        <listitem>
          <para>
          The version number of the software.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><guilabel>Description</guilabel></term>
        <listitem>
          <para>
          A description of the software.
          </para>
        </listitem>
      </varlistentry>
      </variablelist>
    </helptext>
  
  </sect1>
  
</chapter>