source: trunk/doc/src/docbook/userdoc/hardware.xml @ 4509

Last change on this file since 4509 was 4509, checked in by Jari Häkkinen, 13 years ago

Addresses #1106. Missed to change reference wherefrom retrive GPLv3 license text. And some other changes.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 4.7 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE chapter PUBLIC
3    "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN"
4    "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
5<!--
6  $Id: hardware.xml 4509 2008-09-11 20:01:44Z jari $
7 
8  Copyright (C) 2007 Nicklas Nordborg, Philippe Rocca-Serra, Martin Svensson
9 
10  This file is part of BASE - BioArray Software Environment.
11  Available at http://base.thep.lu.se/
12 
13  BASE is free software; you can redistribute it and/or
14  modify it under the terms of the GNU General Public License
15  as published by the Free Software Foundation; either version 3
16  of the License, or (at your option) any later version.
17 
18  BASE is distributed in the hope that it will be useful,
19  but WITHOUT ANY WARRANTY; without even the implied warranty of
20  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  GNU General Public License for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with BASE. If not, see <http://www.gnu.org/licenses/>.
25-->
26<chapter id="hardware">
27  <?dbhtml dir="hardware"?>
28  <title>Hardware</title>
29  <para>
30    Information about laboratory equipment can be tracked in
31    BASE using two structures, the use of which is detailed in
32    the following sections.
33  </para>
34  <sect1 id="hardware.hardwaretypes">
35    <title>Hardware types</title>
36
37    <helptext external_id="hardwaretype.view.properties"
38      title="Hardware types">
39
40      <para>
41        <guilabel>Hardware Type</guilabel>
42        allows classification of hardware based on their usage
43        and purpose in the laboratory workflow. By default, BASE
44        creates the 3 main hardware types and
45        those correspond to the main hardware families
46        identified by
47        <ulink
48          url="http://www.mged.org/Workgroups/MIAME/miame.html">
49          MIAME requirements</ulink>.
50        These 3 hardware types are
51        <guilabel>Print Robot</guilabel>,
52        <guilabel>Scanner</guilabel>,
53        and
54        <guilabel>Hybridization station</guilabel>.
55      </para>
56      <para>
57        In case those built-in types are not enough, it
58        is possible to create new ones.
59      </para>
60    </helptext>
61
62    <para>
63      You can manage the hardware types by going to
64      <menuchoice>
65        <guimenu>Administrate</guimenu>
66        <guimenuitem>Types</guimenuitem>
67        <guisubmenu>Hardware types</guisubmenu>
68      </menuchoice>.
69    </para>
70   
71    <figure
72      id="hardware.figures.hardwaretype">
73      <title>Hardware type properties</title>
74      <screenshot>
75        <mediaobject>
76          <imageobject>
77            <imagedata
78              fileref="figures/edit_hardwaretype.png" format="PNG" />
79          </imageobject>
80        </mediaobject>
81      </screenshot>
82    </figure>
83
84    <helptext external_id="hardwaretype.edit" 
85      title="Edit hardware type">
86   
87      <variablelist>
88      <varlistentry>
89        <term><guilabel>Name</guilabel></term>
90        <listitem>
91          <para>
92            The name of the hardware type.
93            <tip>
94              <para>
95                It is advised to define the name
96                so that it is compatible with the MIAME
97                requirements and recommendations issues by
98                microarray data repositories.
99              </para>
100            </tip>
101          </para>
102        </listitem>
103      </varlistentry>
104      <varlistentry>
105        <term><guilabel>Description</guilabel></term>
106        <listitem>
107          <para>
108            A description of the hardware type.
109          </para>
110        </listitem>
111      </varlistentry>
112      </variablelist>
113    </helptext>
114  </sect1>
115 
116  <sect1 id="hardware.hardware">
117    <title>Hardware</title>
118   
119    <para>
120      In BASE, hardware can be created by two routes. Either
121      from the single-item view of a hardware type or from the
122      list view of hardware.
123    </para>
124   
125    <figure
126      id="hardware.figures.edit_hardware">
127      <title>Hardware properties</title>
128      <screenshot>
129        <mediaobject>
130          <imageobject>
131            <imagedata
132              fileref="figures/edit_hardware.png" format="PNG" />
133          </imageobject>
134        </mediaobject>
135      </screenshot>
136    </figure>
137   
138    <helptext external_id="hardware.edit" 
139      title="Edit hardware">
140      <variablelist>
141      <varlistentry>
142        <term><guilabel>Name</guilabel></term>
143        <listitem>
144          <para>
145          The name of the hardware.
146          </para>
147        </listitem>
148      </varlistentry>
149      <varlistentry>
150        <term><guilabel>Version</guilabel></term>
151        <listitem>
152          <para>
153          The version number or model of the hardware.
154          </para>
155        </listitem>
156      </varlistentry>
157      <varlistentry>
158        <term><guilabel>Type</guilabel></term>
159        <listitem>
160          <para>
161          The hardware type of the hardware. The list
162          may evolve depending on additions by the server
163          administrator.
164          </para>
165        </listitem>
166      </varlistentry>
167      <varlistentry>
168        <term><guilabel>Description</guilabel></term>
169        <listitem>
170          <para>
171          A description of the hardware.
172          </para>
173        </listitem>
174      </varlistentry>
175      </variablelist>
176    </helptext>
177   
178  </sect1>
179</chapter>
Note: See TracBrowser for help on using the repository browser.