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

Last change on this file since 5706 was 5706, checked in by Nicklas Nordborg, 10 years ago

References #1590: Documentation cleanup

User documentation chapter 10 to 15. Added new chapter about "Item subtypes". Removed sections about protocol types, hardware types and software types. Merged "Hardware" and "Software" into a single chapter.

Added some menu separators in the New annotation type menu.

As usual, screen shots have not yet been updated.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 4.8 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: wares.xml 5706 2011-08-23 13:20:30Z nicklas $
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="wares" chunked="0">
27  <?dbhtml dir="wares"?>
28  <title>Hardware and software</title>
29
30  <sect1 id="wares.hardware">
31    <title>Hardware</title>
32   
33    <para>
34      A hardware is used in BASE to represent a piece of equipment in the lab
35      that is used in the experiments.
36      Information about hardware is typically added to a BASE server by an administrator
37      and can be managed from <menuchoice>
38        <guimenu>Administrate</guimenu>
39        <guimenuitem>Hardware</guimenuitem>
40      </menuchoice>.
41    </para>
42   
43    <figure
44      id="hardware.figures.edit_hardware">
45      <title>Hardware properties</title>
46      <screenshot>
47        <mediaobject>
48          <imageobject>
49            <imagedata
50              fileref="figures/edit_hardware.png" format="PNG" />
51          </imageobject>
52        </mediaobject>
53      </screenshot>
54    </figure>
55   
56    <helptext external_id="hardware.edit" 
57      title="Edit hardware">
58      <variablelist>
59      <varlistentry>
60        <term><guilabel>Name</guilabel></term>
61        <listitem>
62          <para>
63          The name of the hardware.
64          </para>
65        </listitem>
66      </varlistentry>
67      <varlistentry>
68        <term><guilabel>Type</guilabel></term>
69        <listitem>
70          <para>
71          The hardware type of the hardware. The list
72          may evolve depending on additions by the server
73          administrator. Selecting the proper hardware type
74          is important and enables BASE to automatically guess
75          the most likely hardware when creating new items.
76          <nohelp>
77            See <xref linkend="subtypes" /> for more information.
78          </nohelp>
79          </para>
80        </listitem>
81      </varlistentry>
82      <varlistentry>
83        <term><guilabel>Version</guilabel></term>
84        <listitem>
85          <para>
86          The version number or model of the hardware.
87          </para>
88        </listitem>
89      </varlistentry>
90      <varlistentry>
91        <term><guilabel>Description</guilabel></term>
92        <listitem>
93          <para>
94          A description of the hardware.
95          </para>
96        </listitem>
97      </varlistentry>
98      </variablelist>
99    </helptext>
100   
101  </sect1>
102 
103  <sect1 id="wares.software">
104    <title>Software</title>
105   
106    <para>
107      A hardware is used in BASE to represent the software that is used to
108      process and analyze data outside of BASE. Analysis that is done inside
109      BASE is usually represented as plug-ins.
110      Information about software is typically added to a BASE server by an administrator
111      and can be managed from <menuchoice>
112        <guimenu>Administrate</guimenu>
113        <guimenuitem>Software</guimenuitem>
114      </menuchoice>.
115    </para>
116   
117    <figure
118      id="software.figures.edit_softwware">
119      <title>Software properties</title>
120      <screenshot>
121        <mediaobject>
122          <imageobject>
123            <imagedata
124              fileref="figures/edit_software.png" format="PNG" />
125          </imageobject>
126        </mediaobject>
127      </screenshot>
128    </figure>
129         
130    <helptext external_id="software.edit" 
131      title="Edit software">
132      <variablelist>
133      <varlistentry>
134        <term><guilabel>Name</guilabel></term>
135        <listitem>
136          <para>
137          The name of the software.
138          </para>
139        </listitem>
140      </varlistentry>
141      <varlistentry>
142        <term><guilabel>Type</guilabel></term>
143        <listitem>
144          <para>
145          The software type of the software. The list
146          may evolve depending on additions by the server
147          administrator. Selecting the proper software type
148          is important and enables BASE to automatically guess
149          the most likely software when creating new items.
150          <nohelp>
151            See <xref linkend="subtypes" /> for more information.
152          </nohelp>
153          </para>
154        </listitem>
155      </varlistentry>
156      <varlistentry>
157        <term><guilabel>Version</guilabel></term>
158        <listitem>
159          <para>
160          The version number of the software.
161          </para>
162        </listitem>
163      </varlistentry>
164      <varlistentry>
165        <term><guilabel>Description</guilabel></term>
166        <listitem>
167          <para>
168          A description of the software.
169          </para>
170        </listitem>
171      </varlistentry>
172      </variablelist>
173    </helptext>
174 
175  </sect1>
176 
177</chapter>
Note: See TracBrowser for help on using the repository browser.