doc/src/docbook/user/protocols.xml

Code
Comments
Other
Rev Date Author Line
3157 05 Mar 07 martin 1 <?xml version="1.0" encoding="UTF-8"?>
3159 05 Mar 07 martin 2 <!DOCTYPE chapter PUBLIC 
3159 05 Mar 07 martin 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
3192 13 Mar 07 martin 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
3387 28 May 07 nicklas 5 <!--
3387 28 May 07 nicklas 6   $Id$
3387 28 May 07 nicklas 7   
3675 16 Aug 07 jari 8   Copyright (C) 2007 Nicklas Nordborg, Philippe Rocca-Serra, Martin Svensson
3387 28 May 07 nicklas 9   
3387 28 May 07 nicklas 10   This file is part of BASE - BioArray Software Environment.
3387 28 May 07 nicklas 11   Available at http://base.thep.lu.se/
3387 28 May 07 nicklas 12   
3387 28 May 07 nicklas 13   BASE is free software; you can redistribute it and/or
3387 28 May 07 nicklas 14   modify it under the terms of the GNU General Public License
4477 05 Sep 08 jari 15   as published by the Free Software Foundation; either version 3
3387 28 May 07 nicklas 16   of the License, or (at your option) any later version.
3387 28 May 07 nicklas 17   
3387 28 May 07 nicklas 18   BASE is distributed in the hope that it will be useful,
3387 28 May 07 nicklas 19   but WITHOUT ANY WARRANTY; without even the implied warranty of
3387 28 May 07 nicklas 20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3387 28 May 07 nicklas 21   GNU General Public License for more details.
3387 28 May 07 nicklas 22   
3387 28 May 07 nicklas 23   You should have received a copy of the GNU General Public License
4509 11 Sep 08 jari 24   along with BASE. If not, see <http://www.gnu.org/licenses/>.
3387 28 May 07 nicklas 25 -->
5706 23 Aug 11 nicklas 26 <chapter id="protocols" chunked="0">
5706 23 Aug 11 nicklas 27   <title>Protocols</title>
3157 05 Mar 07 martin 28
5706 23 Aug 11 nicklas 29     <para>
5706 23 Aug 11 nicklas 30       A protocol is a document describing some kind of process that
5706 23 Aug 11 nicklas 31       is typically performed in the lab to create an item
5706 23 Aug 11 nicklas 32       of some type (for example, how to create an extract from a sample). 
5706 23 Aug 11 nicklas 33       It can also represent a procedure for running software programs to
5706 23 Aug 11 nicklas 34       extract measured data (for example, from a scanned microarray image).
5706 23 Aug 11 nicklas 35       A protocol in the simplest form is just a name with an optional link to a file. 
5706 23 Aug 11 nicklas 36       The file may for example be a PDF or some other document with a more
5706 23 Aug 11 nicklas 37       detailed description.
5706 23 Aug 11 nicklas 38     </para>
3387 28 May 07 nicklas 39     
3387 28 May 07 nicklas 40     <para>
5706 23 Aug 11 nicklas 41       Protocols are typically added to a BASE server by an administrator
5706 23 Aug 11 nicklas 42       and can be managed from <menuchoice>
3387 28 May 07 nicklas 43         <guimenu>Administrate</guimenu>
5706 23 Aug 11 nicklas 44         <guimenuitem>Protocols</guimenuitem>
3387 28 May 07 nicklas 45       </menuchoice>.
3387 28 May 07 nicklas 46     </para>
5706 23 Aug 11 nicklas 47
5706 23 Aug 11 nicklas 48       
3387 28 May 07 nicklas 49     <figure
5706 23 Aug 11 nicklas 50       id="protocols.figures.edit_protocol">
5706 23 Aug 11 nicklas 51       <title>Protocol properties</title>
3387 28 May 07 nicklas 52       <screenshot>
3387 28 May 07 nicklas 53         <mediaobject>
3387 28 May 07 nicklas 54           <imageobject>
3387 28 May 07 nicklas 55             <imagedata
5706 23 Aug 11 nicklas 56               fileref="figures/edit_protocol.png" format="PNG" />
3387 28 May 07 nicklas 57           </imageobject>
3387 28 May 07 nicklas 58         </mediaobject>
3387 28 May 07 nicklas 59       </screenshot>
3387 28 May 07 nicklas 60     </figure>
3387 28 May 07 nicklas 61       
3387 28 May 07 nicklas 62       <helptext external_id="protocol.edit" 
3387 28 May 07 nicklas 63         title="Edit protocol">
3387 28 May 07 nicklas 64         
3387 28 May 07 nicklas 65         <para>
3387 28 May 07 nicklas 66         This tab allows users to enter essential
3387 28 May 07 nicklas 67         information about a protocol.
5706 23 Aug 11 nicklas 68         </para>
3387 28 May 07 nicklas 69         
3387 28 May 07 nicklas 70         <variablelist>
3387 28 May 07 nicklas 71         <varlistentry>
3387 28 May 07 nicklas 72           <term><guilabel>Name</guilabel></term>
3387 28 May 07 nicklas 73           <listitem>
3387 28 May 07 nicklas 74             <para>
3387 28 May 07 nicklas 75             The name of the protocol.
3387 28 May 07 nicklas 76             </para>
3387 28 May 07 nicklas 77           </listitem>
3387 28 May 07 nicklas 78         </varlistentry>
3387 28 May 07 nicklas 79         <varlistentry>
3387 28 May 07 nicklas 80           <term><guilabel>Type</guilabel></term>
3387 28 May 07 nicklas 81           <listitem>
3387 28 May 07 nicklas 82             <para>
3387 28 May 07 nicklas 83             The protocol type of the protocol. The list
3387 28 May 07 nicklas 84             may evolve depending on additions by the server
5706 23 Aug 11 nicklas 85             administrator. Selecting the proper protocol type
5706 23 Aug 11 nicklas 86             is important and enables BASE to automatically guess 
5706 23 Aug 11 nicklas 87             the most likely protocol when creating new items.
5706 23 Aug 11 nicklas 88             <nohelp>
5706 23 Aug 11 nicklas 89             See <xref linkend="subtypes" /> for more information.
5706 23 Aug 11 nicklas 90             </nohelp>
3387 28 May 07 nicklas 91             </para>
3387 28 May 07 nicklas 92           </listitem>
3387 28 May 07 nicklas 93         </varlistentry>
3387 28 May 07 nicklas 94         <varlistentry>
5706 23 Aug 11 nicklas 95           <term><guilabel>External ID</guilabel></term>
5706 23 Aug 11 nicklas 96           <listitem>
5706 23 Aug 11 nicklas 97             <para>
5706 23 Aug 11 nicklas 98             An ID identifying this protocol in an external
5706 23 Aug 11 nicklas 99             database. The value does not have to be unique.
5706 23 Aug 11 nicklas 100             </para>
5706 23 Aug 11 nicklas 101           </listitem>
5706 23 Aug 11 nicklas 102         </varlistentry>
5706 23 Aug 11 nicklas 103         <varlistentry>
3387 28 May 07 nicklas 104           <term><guilabel>File</guilabel></term>
3387 28 May 07 nicklas 105           <listitem>
3387 28 May 07 nicklas 106             <para>
3387 28 May 07 nicklas 107             A document containing the protocol description,      
5706 23 Aug 11 nicklas 108             e.g. PDF documents from kit providers to
3387 28 May 07 nicklas 109             the protocol. Use the <guibutton>Select</guibutton>
3387 28 May 07 nicklas 110             button to select or upload a file.
3387 28 May 07 nicklas 111             </para>
3387 28 May 07 nicklas 112           </listitem>
3387 28 May 07 nicklas 113         </varlistentry>
3387 28 May 07 nicklas 114         <varlistentry>
3387 28 May 07 nicklas 115           <term><guilabel>Description</guilabel></term>
3387 28 May 07 nicklas 116           <listitem>
3387 28 May 07 nicklas 117             <para>
3387 28 May 07 nicklas 118             A description of the protocol.
3387 28 May 07 nicklas 119             </para>
3387 28 May 07 nicklas 120           </listitem>
3387 28 May 07 nicklas 121         </varlistentry>
3387 28 May 07 nicklas 122         </variablelist>
3387 28 May 07 nicklas 123         
3387 28 May 07 nicklas 124         <seeother>
3387 28 May 07 nicklas 125           <other external_id="protocol.edit.parameters">Protocol parameters</other>
5795 10 Oct 11 nicklas 126           <other external_id="annotations.edit">Annotations</other>
3387 28 May 07 nicklas 127         </seeother>
3387 28 May 07 nicklas 128       </helptext>
3387 28 May 07 nicklas 129     
5706 23 Aug 11 nicklas 130     <sect1 id="protocols.parameters">
3387 28 May 07 nicklas 131       <title>Protocol parameters</title>
3157 05 Mar 07 martin 132
3387 28 May 07 nicklas 133       <helptext external_id="protocol.edit.parameters" 
3387 28 May 07 nicklas 134         title="Protocol parameters">
3157 05 Mar 07 martin 135
3387 28 May 07 nicklas 136         <para>
3387 28 May 07 nicklas 137           BASE users may declare parameters attached to a particular
3387 28 May 07 nicklas 138           protocol. Parameters are selected from a list of annotation 
3387 28 May 07 nicklas 139           types which have been flagged as parameters. Annotation
3387 28 May 07 nicklas 140           types which has been selected as parameters show up in the
3387 28 May 07 nicklas 141           regular annotation dialog whenever the protocol is used for
3387 28 May 07 nicklas 142           an item. <nohelp>For more information see 
3387 28 May 07 nicklas 143           <xref linkend="annotations" />.</nohelp>
3387 28 May 07 nicklas 144         </para>
3387 28 May 07 nicklas 145     
3387 28 May 07 nicklas 146         <nohelp>
3387 28 May 07 nicklas 147         <figure
3387 28 May 07 nicklas 148           id="protocols.figures.protocol_parameters">
3387 28 May 07 nicklas 149           <title>Protocol parameters</title>
3387 28 May 07 nicklas 150           <screenshot>
3387 28 May 07 nicklas 151             <mediaobject>
3387 28 May 07 nicklas 152               <imageobject>
3387 28 May 07 nicklas 153                 <imagedata
3387 28 May 07 nicklas 154                   fileref="figures/protocol_parameters.png" format="PNG" />
3387 28 May 07 nicklas 155               </imageobject>
3387 28 May 07 nicklas 156             </mediaobject>
3387 28 May 07 nicklas 157           </screenshot>
3387 28 May 07 nicklas 158         </figure>
3387 28 May 07 nicklas 159         </nohelp>
3157 05 Mar 07 martin 160
3387 28 May 07 nicklas 161         <variablelist>
3387 28 May 07 nicklas 162         <varlistentry>
3387 28 May 07 nicklas 163           <term><guilabel>Annotation types</guilabel></term>
3387 28 May 07 nicklas 164           <listitem>
3387 28 May 07 nicklas 165             <para>
3387 28 May 07 nicklas 166             This list contains the annotation types selected 
3387 28 May 07 nicklas 167             as parameters for the protocol.
3387 28 May 07 nicklas 168             </para>
3387 28 May 07 nicklas 169           </listitem>
3387 28 May 07 nicklas 170         </varlistentry>
3387 28 May 07 nicklas 171         <varlistentry>
3387 28 May 07 nicklas 172           <term><guibutton>Add annotation types</guibutton></term>
3387 28 May 07 nicklas 173           <listitem>
3387 28 May 07 nicklas 174             <para>
4487 08 Sep 08 jari 175             Use this button to open a pop-up where you can select
3387 28 May 07 nicklas 176             annotation type to use for parameters. The list only
3387 28 May 07 nicklas 177             shows annotations types which has the 
3387 28 May 07 nicklas 178             <guilabel>Protocol parameter</guilabel> flag set.
3387 28 May 07 nicklas 179             </para>
3387 28 May 07 nicklas 180           </listitem>
3387 28 May 07 nicklas 181         </varlistentry>
3387 28 May 07 nicklas 182         <varlistentry>
3387 28 May 07 nicklas 183           <term><guibutton>Remove</guibutton></term>
3387 28 May 07 nicklas 184           <listitem>
3387 28 May 07 nicklas 185             <para>
3387 28 May 07 nicklas 186             Removes the selected annotation types from the list.
3387 28 May 07 nicklas 187             </para>
3387 28 May 07 nicklas 188           </listitem>
3387 28 May 07 nicklas 189         </varlistentry>
3387 28 May 07 nicklas 190         </variablelist>
3387 28 May 07 nicklas 191       
3387 28 May 07 nicklas 192         <seeother>
3387 28 May 07 nicklas 193           <other external_id="protocol.edit">Edit protocol</other>
5795 10 Oct 11 nicklas 194           <other external_id="annotations.edit">Annotations</other>
3387 28 May 07 nicklas 195         </seeother>
3387 28 May 07 nicklas 196       
3387 28 May 07 nicklas 197       </helptext>
5795 10 Oct 11 nicklas 198       
5795 10 Oct 11 nicklas 199       <para>
5795 10 Oct 11 nicklas 200         The <guilabel>Annotations</guilabel> tab allows BASE users to use 
5795 10 Oct 11 nicklas 201         annotation types to refine protocol description. More about annotating items 
5795 10 Oct 11 nicklas 202         can be read in <xref linkend="annotations.annotating" />.
5795 10 Oct 11 nicklas 203       </para>
3387 28 May 07 nicklas 204   </sect1>
3372 24 May 07 philippe 205 </chapter>

Generated on Sat Oct  7 02:27:34 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)