doc/src/docbook/user/platforms.xml

Code
Comments
Other
Rev Date Author Line
3860 18 Oct 07 nicklas 1 <?xml version="1.0" encoding="UTF-8"?>
3860 18 Oct 07 nicklas 2 <!DOCTYPE chapter PUBLIC 
3860 18 Oct 07 nicklas 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
3860 18 Oct 07 nicklas 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
3860 18 Oct 07 nicklas 5 <!--
3860 18 Oct 07 nicklas 6   $Id$
3860 18 Oct 07 nicklas 7   
3860 18 Oct 07 nicklas 8   Copyright (C) 2007 Nicklas Nordborg, Philippe Rocca-Serra, Martin Svensson
3860 18 Oct 07 nicklas 9   
3860 18 Oct 07 nicklas 10   This file is part of BASE - BioArray Software Environment.
3860 18 Oct 07 nicklas 11   Available at http://base.thep.lu.se/
3860 18 Oct 07 nicklas 12   
3860 18 Oct 07 nicklas 13   BASE is free software; you can redistribute it and/or
3860 18 Oct 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
3860 18 Oct 07 nicklas 16   of the License, or (at your option) any later version.
3860 18 Oct 07 nicklas 17   
3860 18 Oct 07 nicklas 18   BASE is distributed in the hope that it will be useful,
3860 18 Oct 07 nicklas 19   but WITHOUT ANY WARRANTY; without even the implied warranty of
3860 18 Oct 07 nicklas 20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3860 18 Oct 07 nicklas 21   GNU General Public License for more details.
3860 18 Oct 07 nicklas 22   
3860 18 Oct 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/>.
3860 18 Oct 07 nicklas 25 -->
5706 23 Aug 11 nicklas 26 <chapter id="platforms" chunked="0">
3860 18 Oct 07 nicklas 27   <title>Experimental platforms and data file types</title>
3860 18 Oct 07 nicklas 28   
3860 18 Oct 07 nicklas 29   <sect1 id="platforms.platform">
3860 18 Oct 07 nicklas 30     <title>Platforms</title>
3860 18 Oct 07 nicklas 31
3860 18 Oct 07 nicklas 32     <helptext external_id="platform.view.properties" title="Platforms">
3860 18 Oct 07 nicklas 33     <para>
3860 18 Oct 07 nicklas 34       An experimental platform in BASE can be seen as an item 
3860 18 Oct 07 nicklas 35       representing the set of data file types that are produced
3860 18 Oct 07 nicklas 36       or needed by a given experimental setup. For example, the
3860 18 Oct 07 nicklas 37       Affymetrix platform (as defined in BASE) uses CEL files for 
3860 18 Oct 07 nicklas 38       raw data and CDF files for array design information.
3860 18 Oct 07 nicklas 39       The concept of a platform is also tightly coupled to the
3860 18 Oct 07 nicklas 40       ability to keep data in files instead of importing it to 
3860 18 Oct 07 nicklas 41       the database. When you have selected a platform for a
3860 18 Oct 07 nicklas 42       raw bioassay or an array design, you also know which files
3860 18 Oct 07 nicklas 43       you should provide.
3860 18 Oct 07 nicklas 44     </para>
3860 18 Oct 07 nicklas 45     
3860 18 Oct 07 nicklas 46     <para>
5795 10 Oct 11 nicklas 47       BASE comes pre-installed with three platforms.
5795 10 Oct 11 nicklas 48     </para>
5795 10 Oct 11 nicklas 49     
5795 10 Oct 11 nicklas 50     <itemizedlist>
5795 10 Oct 11 nicklas 51       <listitem>
5795 10 Oct 11 nicklas 52         <para>
5795 10 Oct 11 nicklas 53         A generic platform that can be used with almost any
5795 10 Oct 11 nicklas 54         type of data that can be imported into the database from
5795 10 Oct 11 nicklas 55         simple column-based text files.
5795 10 Oct 11 nicklas 56         </para>
5795 10 Oct 11 nicklas 57       </listitem>
5795 10 Oct 11 nicklas 58     
5795 10 Oct 11 nicklas 59       <listitem>
5795 10 Oct 11 nicklas 60         <para>
5795 10 Oct 11 nicklas 61         The Affymetrix platform which keep data in CEL and CDF files
5795 10 Oct 11 nicklas 62         instead of importing into the database.
5795 10 Oct 11 nicklas 63         </para>
5795 10 Oct 11 nicklas 64       </listitem>
5795 10 Oct 11 nicklas 65       
5795 10 Oct 11 nicklas 66       <listitem>
5795 10 Oct 11 nicklas 67         <para>
5795 10 Oct 11 nicklas 68         A sequencing platform which uses GTF files to define array designs
5795 10 Oct 11 nicklas 69         and FPKM counts as raw data.
5795 10 Oct 11 nicklas 70         </para>
5795 10 Oct 11 nicklas 71       </listitem>
5795 10 Oct 11 nicklas 72     
5795 10 Oct 11 nicklas 73     </itemizedlist>
5795 10 Oct 11 nicklas 74       
5795 10 Oct 11 nicklas 75     <para>
5795 10 Oct 11 nicklas 76       Other platforms, such as Illumina,
4350 24 Jun 08 jari 77       are available as non-core plug-in packages, see
4350 24 Jun 08 jari 78       <xref linkend="resources.plugins" />. An administrator may
4350 24 Jun 08 jari 79       define additional platforms and file types.
3860 18 Oct 07 nicklas 80     </para>
3860 18 Oct 07 nicklas 81     
3860 18 Oct 07 nicklas 82     <seeother>
3860 18 Oct 07 nicklas 83       <other external_id="platform.edit">Edit platform</other>
3860 18 Oct 07 nicklas 84       <other external_id="datafiletype.view.properties">Data file types</other>
3860 18 Oct 07 nicklas 85     </seeother>
3860 18 Oct 07 nicklas 86     </helptext>  
3860 18 Oct 07 nicklas 87
3860 18 Oct 07 nicklas 88     <para>
3860 18 Oct 07 nicklas 89       You can manage platforms going to
3860 18 Oct 07 nicklas 90       <menuchoice>
3860 18 Oct 07 nicklas 91         <guimenu>Administrate</guimenu>
3860 18 Oct 07 nicklas 92         <guimenuitem>Platforms</guimenuitem>
3860 18 Oct 07 nicklas 93         <guisubmenu>Experimental platforms</guisubmenu>
3860 18 Oct 07 nicklas 94       </menuchoice>.
3860 18 Oct 07 nicklas 95     </para>
3860 18 Oct 07 nicklas 96     
3860 18 Oct 07 nicklas 97     <figure
3860 18 Oct 07 nicklas 98       id="platforms.figures.platform">
3860 18 Oct 07 nicklas 99       <title>Platform properties</title>
3860 18 Oct 07 nicklas 100       <screenshot>
3860 18 Oct 07 nicklas 101         <mediaobject>
3860 18 Oct 07 nicklas 102           <imageobject>
3860 18 Oct 07 nicklas 103             <imagedata
3860 18 Oct 07 nicklas 104               fileref="figures/edit_platform.png" format="PNG" />
3860 18 Oct 07 nicklas 105           </imageobject>
3860 18 Oct 07 nicklas 106         </mediaobject>
3860 18 Oct 07 nicklas 107       </screenshot>
3860 18 Oct 07 nicklas 108     </figure>  
3860 18 Oct 07 nicklas 109     
3860 18 Oct 07 nicklas 110     <helptext external_id="platform.edit" 
3860 18 Oct 07 nicklas 111       title="Edit platform">
3860 18 Oct 07 nicklas 112     
3860 18 Oct 07 nicklas 113       <variablelist>
3860 18 Oct 07 nicklas 114       <varlistentry>
3860 18 Oct 07 nicklas 115         <term><guilabel>Name</guilabel></term>
3860 18 Oct 07 nicklas 116         <listitem>
3860 18 Oct 07 nicklas 117           <para>
3860 18 Oct 07 nicklas 118             The name of the platform
3860 18 Oct 07 nicklas 119           </para>
3860 18 Oct 07 nicklas 120         </listitem>
3860 18 Oct 07 nicklas 121       </varlistentry>
3860 18 Oct 07 nicklas 122       <varlistentry>
3860 18 Oct 07 nicklas 123         <term><guilabel>External ID</guilabel></term>
3860 18 Oct 07 nicklas 124         <listitem>
3860 18 Oct 07 nicklas 125           <para>
3860 18 Oct 07 nicklas 126             An ID that is used to identify the platform. The ID must
3860 18 Oct 07 nicklas 127             be unique and can't be changed once the platform has been
3860 18 Oct 07 nicklas 128             created.
3860 18 Oct 07 nicklas 129           </para>
3860 18 Oct 07 nicklas 130         </listitem>
3860 18 Oct 07 nicklas 131       </varlistentry>
3860 18 Oct 07 nicklas 132       <varlistentry>
3860 18 Oct 07 nicklas 133         <term><guilabel>File-only</guilabel></term>
3860 18 Oct 07 nicklas 134         <listitem>
3860 18 Oct 07 nicklas 135           <para>
3860 18 Oct 07 nicklas 136             If the platform is a file-only platform or not. File-only
3860 18 Oct 07 nicklas 137             platforms can't have it's data imported into the database.
3860 18 Oct 07 nicklas 138             This option can't be changed once the platform has been created.
3860 18 Oct 07 nicklas 139           </para>
3860 18 Oct 07 nicklas 140         </listitem>
3860 18 Oct 07 nicklas 141       </varlistentry>
3860 18 Oct 07 nicklas 142       <varlistentry>
3860 18 Oct 07 nicklas 143         <term><guilabel>Raw data type</guilabel></term>
3860 18 Oct 07 nicklas 144         <listitem>
3860 18 Oct 07 nicklas 145           <para>
3860 18 Oct 07 nicklas 146             If you have selected <guilabel>file-only=no</guilabel>, you
3860 18 Oct 07 nicklas 147             may select a raw data type. This will lock this platform to the
3872 23 Oct 07 nicklas 148             selected raw data type. If you select <guilabel>- any -</guilabel>,
3872 23 Oct 07 nicklas 149             raw data of any raw data type can be used. 
3860 18 Oct 07 nicklas 150             This option can't be changed once the platform has been created.
3860 18 Oct 07 nicklas 151           </para>
3860 18 Oct 07 nicklas 152         </listitem>
3860 18 Oct 07 nicklas 153       </varlistentry>
3860 18 Oct 07 nicklas 154       <varlistentry>
3860 18 Oct 07 nicklas 155         <term><guilabel>Channels</guilabel></term>
3860 18 Oct 07 nicklas 156         <listitem>
3860 18 Oct 07 nicklas 157           <para>
3860 18 Oct 07 nicklas 158             If you have selected <guilabel>file-only=yes</guilabel>, you
3872 23 Oct 07 nicklas 159             must enter the number of channels the platform uses. This information
3860 18 Oct 07 nicklas 160             is needed in the analysis module of BASE to create the proper
3860 18 Oct 07 nicklas 161             database tables. This option can't be changed once the platform has
3860 18 Oct 07 nicklas 162             been created.
3860 18 Oct 07 nicklas 163           </para>
3860 18 Oct 07 nicklas 164         </listitem>
3860 18 Oct 07 nicklas 165       </varlistentry>
3860 18 Oct 07 nicklas 166       <varlistentry>
3860 18 Oct 07 nicklas 167         <term><guilabel>Description</guilabel></term>
3860 18 Oct 07 nicklas 168         <listitem>
3860 18 Oct 07 nicklas 169           <para>
3860 18 Oct 07 nicklas 170             A description of the platform.
3860 18 Oct 07 nicklas 171           </para>
3860 18 Oct 07 nicklas 172         </listitem>
3860 18 Oct 07 nicklas 173       </varlistentry>
3860 18 Oct 07 nicklas 174       </variablelist>
3860 18 Oct 07 nicklas 175       
3860 18 Oct 07 nicklas 176       <seeother>
3860 18 Oct 07 nicklas 177         <other external_id="platform.edit.filetypes">Select data file types</other>
3860 18 Oct 07 nicklas 178       </seeother>
3860 18 Oct 07 nicklas 179       
3860 18 Oct 07 nicklas 180     </helptext>  
3860 18 Oct 07 nicklas 181     
3860 18 Oct 07 nicklas 182     
3860 18 Oct 07 nicklas 183     <figure
3860 18 Oct 07 nicklas 184       id="platforms.figures.platformfiletypes">
3860 18 Oct 07 nicklas 185       <title>Select data file types</title>
3860 18 Oct 07 nicklas 186       <screenshot>
3860 18 Oct 07 nicklas 187         <mediaobject>
3860 18 Oct 07 nicklas 188           <imageobject>
3860 18 Oct 07 nicklas 189             <imagedata
3860 18 Oct 07 nicklas 190               fileref="figures/edit_platformfiletypes.png" format="PNG" />
3860 18 Oct 07 nicklas 191           </imageobject>
3860 18 Oct 07 nicklas 192         </mediaobject>
3860 18 Oct 07 nicklas 193       </screenshot>
3860 18 Oct 07 nicklas 194     </figure>  
3860 18 Oct 07 nicklas 195     
3860 18 Oct 07 nicklas 196     <helptext external_id="platform.edit.filetypes" 
3860 18 Oct 07 nicklas 197       title="Select data file types">
3860 18 Oct 07 nicklas 198     
3860 18 Oct 07 nicklas 199       <variablelist>
3860 18 Oct 07 nicklas 200       <varlistentry>
3860 18 Oct 07 nicklas 201         <term><guilabel>Data file types</guilabel></term>
3860 18 Oct 07 nicklas 202         <listitem>
3860 18 Oct 07 nicklas 203           <para>
3860 18 Oct 07 nicklas 204             This list contains the file types already associated with
3860 18 Oct 07 nicklas 205             this platform. An [x] at the end of the name indicates 
3860 18 Oct 07 nicklas 206             a required file.
3860 18 Oct 07 nicklas 207           </para>
3860 18 Oct 07 nicklas 208         </listitem>
3860 18 Oct 07 nicklas 209       </varlistentry>
3860 18 Oct 07 nicklas 210       <varlistentry>
3860 18 Oct 07 nicklas 211         <term><guilabel>Required</guilabel></term>
3860 18 Oct 07 nicklas 212         <listitem>
3860 18 Oct 07 nicklas 213           <para>
5795 10 Oct 11 nicklas 214             Mark this checkbox to indicate that the file is required for
5795 10 Oct 11 nicklas 215             the platform.
3860 18 Oct 07 nicklas 216           </para>
3860 18 Oct 07 nicklas 217           
3860 18 Oct 07 nicklas 218           <note>
3860 18 Oct 07 nicklas 219             <para>
5795 10 Oct 11 nicklas 220             The requried flag is not enforced when creating items. It is 
5795 10 Oct 11 nicklas 221             used for generating warnings when validating an experiment and
5795 10 Oct 11 nicklas 222             can be checked by plug-ins that may need the file in order
5795 10 Oct 11 nicklas 223             to run.
3860 18 Oct 07 nicklas 224             </para>
3860 18 Oct 07 nicklas 225           </note>
3860 18 Oct 07 nicklas 226           
3860 18 Oct 07 nicklas 227         </listitem>
3860 18 Oct 07 nicklas 228       </varlistentry>
3860 18 Oct 07 nicklas 229       <varlistentry>
5795 10 Oct 11 nicklas 230         <term><guilabel>Allow multiple files</guilabel></term>
5795 10 Oct 11 nicklas 231         <listitem>
5795 10 Oct 11 nicklas 232           <para>
5795 10 Oct 11 nicklas 233             Mark this checkbox if it is possible to have more than one
5795 10 Oct 11 nicklas 234             file of the given type. In most cases, a single file is used,
5795 10 Oct 11 nicklas 235             but some platforms (for example Illumina) may split data into
5795 10 Oct 11 nicklas 236             multiple files.
5795 10 Oct 11 nicklas 237           </para>
5795 10 Oct 11 nicklas 238         </listitem>
5795 10 Oct 11 nicklas 239       </varlistentry>
5795 10 Oct 11 nicklas 240       <varlistentry>
3860 18 Oct 07 nicklas 241         <term><guilabel>Add data file types</guilabel></term>
3860 18 Oct 07 nicklas 242         <listitem>
3860 18 Oct 07 nicklas 243           <para>
3860 18 Oct 07 nicklas 244             Opens a popup window that allows you to add more
3860 18 Oct 07 nicklas 245             file types to the platform.
3860 18 Oct 07 nicklas 246           </para>
3860 18 Oct 07 nicklas 247         </listitem>
3860 18 Oct 07 nicklas 248       </varlistentry>
3860 18 Oct 07 nicklas 249       <varlistentry>
3860 18 Oct 07 nicklas 250         <term><guilabel>Remove</guilabel></term>
3860 18 Oct 07 nicklas 251         <listitem>
3860 18 Oct 07 nicklas 252           <para>
3860 18 Oct 07 nicklas 253             Removes the selected file types from the platform.
3860 18 Oct 07 nicklas 254           </para>
3860 18 Oct 07 nicklas 255         </listitem>
3860 18 Oct 07 nicklas 256       </varlistentry>
3860 18 Oct 07 nicklas 257       </variablelist>
3860 18 Oct 07 nicklas 258       
3860 18 Oct 07 nicklas 259       <seeother>
3860 18 Oct 07 nicklas 260         <other external_id="datafiletype.view.properties">Data file types</other>
3860 18 Oct 07 nicklas 261       </seeother>
3860 18 Oct 07 nicklas 262       
3860 18 Oct 07 nicklas 263     </helptext>
3860 18 Oct 07 nicklas 264     
5783 05 Oct 11 nicklas 265   </sect1>
3860 18 Oct 07 nicklas 266
5783 05 Oct 11 nicklas 267   <sect1 id="platforms.variants">
5783 05 Oct 11 nicklas 268     <title>Platform variants</title>
5783 05 Oct 11 nicklas 269
5783 05 Oct 11 nicklas 270     <para>
5783 05 Oct 11 nicklas 271       It is possible for an administrator to define variants of
5783 05 Oct 11 nicklas 272       a platform. The main purpose for this is to be able to 
5783 05 Oct 11 nicklas 273       select additional file types that are only used in some cases.
5783 05 Oct 11 nicklas 274       The file types defined by the parent platform are always inherited
5783 05 Oct 11 nicklas 275       by the variants.
5783 05 Oct 11 nicklas 276     </para>
3860 18 Oct 07 nicklas 277     
5783 05 Oct 11 nicklas 278     <para>
5783 05 Oct 11 nicklas 279       You can create new variants from the single-item view
5783 05 Oct 11 nicklas 280       of a platform. This view also has a <guilabel>Variants</guilabel>
5783 05 Oct 11 nicklas 281       tab which lists all variants that has been defined for a platform.
5783 05 Oct 11 nicklas 282     </para>
5783 05 Oct 11 nicklas 283     
3860 18 Oct 07 nicklas 284   </sect1>
3860 18 Oct 07 nicklas 285
3860 18 Oct 07 nicklas 286   <sect1 id="platforms.datafiletypes">
3860 18 Oct 07 nicklas 287     <title>Data file types</title>
3860 18 Oct 07 nicklas 288     
3860 18 Oct 07 nicklas 289     <helptext external_id="datafiletype.view.properties" title="Data file types">
3860 18 Oct 07 nicklas 290       <para>
3860 18 Oct 07 nicklas 291         Each file type used by a platform must be registered as a 
3872 23 Oct 07 nicklas 292         <guilabel>data file type</guilabel>. For example, <guilabel>CEL</guilabel>
3872 23 Oct 07 nicklas 293         and <guilabel>CDF</guilabel> files are file types used by the <guilabel>Affymetrix</guilabel>
3872 23 Oct 07 nicklas 294         platform. There are several purposes of a data file type:
3860 18 Oct 07 nicklas 295       </para>
3860 18 Oct 07 nicklas 296       
3860 18 Oct 07 nicklas 297       <itemizedlist>
3860 18 Oct 07 nicklas 298       <listitem>
3860 18 Oct 07 nicklas 299         <para>
3860 18 Oct 07 nicklas 300         Describe the file type and make it identifiable. Each file type must have
3860 18 Oct 07 nicklas 301         a unique ID which makes it possible to find out if a specific file
3860 18 Oct 07 nicklas 302         has been added to an item. For example, to find the CEL file of
3860 18 Oct 07 nicklas 303         a raw bioassay.
3860 18 Oct 07 nicklas 304         </para>
3860 18 Oct 07 nicklas 305       </listitem>
3860 18 Oct 07 nicklas 306       
3860 18 Oct 07 nicklas 307       <listitem>
3860 18 Oct 07 nicklas 308         <para>
3860 18 Oct 07 nicklas 309         Connect a specific file type with a generic file type. For example,
3860 18 Oct 07 nicklas 310         the CEL file is used to store raw data for an experiment. Another
3860 18 Oct 07 nicklas 311         platform may use a different file type. Both file types
3860 18 Oct 07 nicklas 312         are of the generic type <guilabel>raw data</guilabel>. This makes it possible
3860 18 Oct 07 nicklas 313         for client applications or plug-ins to find the raw data for an
3860 18 Oct 07 nicklas 314         experiment without actually knowing which file types that are
3940 08 Nov 07 martin 315         used on various platforms.
3860 18 Oct 07 nicklas 316         </para>
3860 18 Oct 07 nicklas 317       </listitem>
3860 18 Oct 07 nicklas 318       
3860 18 Oct 07 nicklas 319       <listitem>
3860 18 Oct 07 nicklas 320         <para>
3860 18 Oct 07 nicklas 321         Make it possible to validate and extract metadata from attached files.
5706 23 Aug 11 nicklas 322         This is done by extensions. Currently, BASE ships 
5795 10 Oct 11 nicklas 323         with extensions for CEL, CDF and GTF files, but the administrator may have installed
5706 23 Aug 11 nicklas 324         extensions for other file types. See <xref linkend="extensions_developer.fileset_validator"/> 
5706 23 Aug 11 nicklas 325         for more information about creating extensions.
3860 18 Oct 07 nicklas 326         </para>
3860 18 Oct 07 nicklas 327       </listitem>
3860 18 Oct 07 nicklas 328       </itemizedlist>
3860 18 Oct 07 nicklas 329       
3860 18 Oct 07 nicklas 330       <seeother>
3860 18 Oct 07 nicklas 331         <other external_id="datafiletype.edit">Edit data file type</other>
3860 18 Oct 07 nicklas 332         <other external_id="platform.view.properties">Platforms</other>
3860 18 Oct 07 nicklas 333       </seeother>
3860 18 Oct 07 nicklas 334     </helptext>
3860 18 Oct 07 nicklas 335     
3860 18 Oct 07 nicklas 336     <para>
3860 18 Oct 07 nicklas 337       You can manage data file types by going to
3860 18 Oct 07 nicklas 338       <menuchoice>
3860 18 Oct 07 nicklas 339         <guimenu>Administrate</guimenu>
3860 18 Oct 07 nicklas 340         <guimenuitem>Platforms</guimenuitem>
3860 18 Oct 07 nicklas 341         <guisubmenu>Data file types</guisubmenu>
3860 18 Oct 07 nicklas 342       </menuchoice>.
3860 18 Oct 07 nicklas 343     </para>
3860 18 Oct 07 nicklas 344     
3860 18 Oct 07 nicklas 345     <figure
3860 18 Oct 07 nicklas 346       id="platforms.figures.datafiletypes">
3860 18 Oct 07 nicklas 347       <title>Data file type properties</title>
3860 18 Oct 07 nicklas 348       <screenshot>
3860 18 Oct 07 nicklas 349         <mediaobject>
3860 18 Oct 07 nicklas 350           <imageobject>
3860 18 Oct 07 nicklas 351             <imagedata
3860 18 Oct 07 nicklas 352               fileref="figures/edit_datafiletype.png" format="PNG" />
3860 18 Oct 07 nicklas 353           </imageobject>
3860 18 Oct 07 nicklas 354         </mediaobject>
3860 18 Oct 07 nicklas 355       </screenshot>
3860 18 Oct 07 nicklas 356     </figure>  
3860 18 Oct 07 nicklas 357     
3860 18 Oct 07 nicklas 358     <helptext external_id="datafiletype.edit" 
3860 18 Oct 07 nicklas 359       title="Edit data file type">
3860 18 Oct 07 nicklas 360     
3860 18 Oct 07 nicklas 361       <variablelist>
3860 18 Oct 07 nicklas 362       <varlistentry>
3860 18 Oct 07 nicklas 363         <term><guilabel>Name</guilabel></term>
3860 18 Oct 07 nicklas 364         <listitem>
3860 18 Oct 07 nicklas 365           <para>
3860 18 Oct 07 nicklas 366             The name of the file type.
3860 18 Oct 07 nicklas 367           </para>
3860 18 Oct 07 nicklas 368         </listitem>
3860 18 Oct 07 nicklas 369       </varlistentry>
3860 18 Oct 07 nicklas 370       <varlistentry>
3860 18 Oct 07 nicklas 371         <term><guilabel>External ID</guilabel></term>
3860 18 Oct 07 nicklas 372         <listitem>
3860 18 Oct 07 nicklas 373           <para>
3860 18 Oct 07 nicklas 374             An ID that is used to identify the file type. The ID must
3860 18 Oct 07 nicklas 375             be unique and can't be changed once the file type has been
3860 18 Oct 07 nicklas 376             created.
3860 18 Oct 07 nicklas 377           </para>
3860 18 Oct 07 nicklas 378         </listitem>
3860 18 Oct 07 nicklas 379       </varlistentry>
3860 18 Oct 07 nicklas 380       <varlistentry>
3860 18 Oct 07 nicklas 381         <term><guilabel>Item type</guilabel></term>
3860 18 Oct 07 nicklas 382         <listitem>
3860 18 Oct 07 nicklas 383           <para>
3860 18 Oct 07 nicklas 384             The type of item files of this file type can be
3860 18 Oct 07 nicklas 385             attached to. This option can't be changed once the file
3860 18 Oct 07 nicklas 386             type has been created.
3860 18 Oct 07 nicklas 387           </para>
3860 18 Oct 07 nicklas 388         </listitem>
3860 18 Oct 07 nicklas 389       </varlistentry>
3860 18 Oct 07 nicklas 390       <varlistentry>
3860 18 Oct 07 nicklas 391         <term><guilabel>File extension</guilabel></term>
3860 18 Oct 07 nicklas 392         <listitem>
3860 18 Oct 07 nicklas 393           <para>
3860 18 Oct 07 nicklas 394             The commonly used file extension for files of this type.
3860 18 Oct 07 nicklas 395             Optional.
3860 18 Oct 07 nicklas 396           </para>
3860 18 Oct 07 nicklas 397         </listitem>
3860 18 Oct 07 nicklas 398       </varlistentry>
3860 18 Oct 07 nicklas 399       <varlistentry>
3860 18 Oct 07 nicklas 400         <term><guilabel>Generic type</guilabel></term>
3860 18 Oct 07 nicklas 401         <listitem>
3860 18 Oct 07 nicklas 402           <para>
3860 18 Oct 07 nicklas 403             The generic type of data that files of this type
3860 18 Oct 07 nicklas 404             contains. For example, CEL files contains raw data and
3860 18 Oct 07 nicklas 405             CDF files contains a reporter map (in BASE terms).
3860 18 Oct 07 nicklas 406           </para>
3860 18 Oct 07 nicklas 407         </listitem>
3860 18 Oct 07 nicklas 408       </varlistentry>
3860 18 Oct 07 nicklas 409       <varlistentry>
3860 18 Oct 07 nicklas 410         <term><guilabel>Description</guilabel></term>
3860 18 Oct 07 nicklas 411         <listitem>
3860 18 Oct 07 nicklas 412           <para>
3860 18 Oct 07 nicklas 413             A description of the file type.
3860 18 Oct 07 nicklas 414           </para>
3860 18 Oct 07 nicklas 415         </listitem>
3860 18 Oct 07 nicklas 416       </varlistentry>
3860 18 Oct 07 nicklas 417       </variablelist>    
3860 18 Oct 07 nicklas 418
3860 18 Oct 07 nicklas 419       <seeother>
3860 18 Oct 07 nicklas 420         <other external_id="platform.edit">Edit platform</other>
3860 18 Oct 07 nicklas 421         <other external_id="platform.edit.filetypes">Select platform file types</other>
3860 18 Oct 07 nicklas 422       </seeother>
3860 18 Oct 07 nicklas 423
3860 18 Oct 07 nicklas 424     </helptext>      
3860 18 Oct 07 nicklas 425
5783 05 Oct 11 nicklas 426   </sect1>
5783 05 Oct 11 nicklas 427   
5783 05 Oct 11 nicklas 428   <sect1 id="platforms.selectfiles">
5783 05 Oct 11 nicklas 429     <title>Selecting files for an item</title>
5783 05 Oct 11 nicklas 430
5783 05 Oct 11 nicklas 431     <para>
5783 05 Oct 11 nicklas 432       Selecting files for an item follows the same pattern
5783 05 Oct 11 nicklas 433       for all items that supports it. They all have a
5783 05 Oct 11 nicklas 434       <guilabel>Data files</guilabel> tab in their edit view.
5783 05 Oct 11 nicklas 435       On this tab you can select files for all file types
5783 05 Oct 11 nicklas 436       that are defined by the platform or subtype of the item.
5783 05 Oct 11 nicklas 437     </para>
5783 05 Oct 11 nicklas 438
5783 05 Oct 11 nicklas 439     <figure
5783 05 Oct 11 nicklas 440       id="platforms.figures.selectfiles">
5783 05 Oct 11 nicklas 441       <title>Selecting files for an array design</title>
5783 05 Oct 11 nicklas 442       <screenshot>
5783 05 Oct 11 nicklas 443         <mediaobject>
5783 05 Oct 11 nicklas 444           <imageobject>
5783 05 Oct 11 nicklas 445             <imagedata
5783 05 Oct 11 nicklas 446               fileref="figures/select_files.png" format="PNG" />
5783 05 Oct 11 nicklas 447           </imageobject>
5783 05 Oct 11 nicklas 448         </mediaobject>
5783 05 Oct 11 nicklas 449       </screenshot>
5783 05 Oct 11 nicklas 450     </figure>
5783 05 Oct 11 nicklas 451
5783 05 Oct 11 nicklas 452     <helptext external_id="datafiles.edit" title="Data files">
3860 18 Oct 07 nicklas 453       <para>
5783 05 Oct 11 nicklas 454       The list contains all file types that are defined by by the platform or subtype that
5783 05 Oct 11 nicklas 455       is selected on the <guilabel>Properties</guilabel>
5783 05 Oct 11 nicklas 456       tab. Use the &gbBrowse; or <guibutton>Add</guibutton> icons to select files from 
5783 05 Oct 11 nicklas 457       the file manager. Note that for some file types only a single file can be selected, 
5783 05 Oct 11 nicklas 458       but for other file types multiple files are allowed. The dropdown list contains
5783 05 Oct 11 nicklas 459       recently used files as well as an option to clear the selected file.
3860 18 Oct 07 nicklas 460       </para>
3860 18 Oct 07 nicklas 461       
3860 18 Oct 07 nicklas 462       <variablelist>
3860 18 Oct 07 nicklas 463       <varlistentry>
5783 05 Oct 11 nicklas 464         <term><guilabel>Validate files</guilabel></term>
3860 18 Oct 07 nicklas 465         <listitem>
3860 18 Oct 07 nicklas 466           <para>
5706 23 Aug 11 nicklas 467             Mark this checkbox if you want to validate and extract metadata
5706 23 Aug 11 nicklas 468             from the selected files. The checkbox is automatically checked 
5783 05 Oct 11 nicklas 469             if changes are made.
3860 18 Oct 07 nicklas 470           </para>
3860 18 Oct 07 nicklas 471         </listitem>
3860 18 Oct 07 nicklas 472       </varlistentry>
3860 18 Oct 07 nicklas 473       </variablelist>
3860 18 Oct 07 nicklas 474       
3860 18 Oct 07 nicklas 475       <note>
3860 18 Oct 07 nicklas 476         <para>
5706 23 Aug 11 nicklas 477           Validation and metadata extraction is performed by extensions.
5706 23 Aug 11 nicklas 478           The checkbox is only visible if there is at least one 
5706 23 Aug 11 nicklas 479           installed extension that supports validation of the
5706 23 Aug 11 nicklas 480           current file types.
3860 18 Oct 07 nicklas 481         </para>
3860 18 Oct 07 nicklas 482       </note>
3860 18 Oct 07 nicklas 483       
3860 18 Oct 07 nicklas 484     </helptext>
3860 18 Oct 07 nicklas 485   </sect1>
3860 18 Oct 07 nicklas 486
3860 18 Oct 07 nicklas 487 </chapter>

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