Changeset 3390
- Timestamp:
- May 28, 2007, 9:27:12 AM (16 years ago)
- Location:
- trunk/doc/src/docbook
- Files:
-
- 1 added
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/src/docbook/userdoc/software.xml
r3372 r3390 5 5 <!-- 6 6 $Id$ 7 7 8 8 Copyright (C) Authors contributing to this file. 9 9 10 10 This file is part of BASE - BioArray Software Environment. 11 11 Available at http://base.thep.lu.se/ 12 12 13 13 BASE is free software; you can redistribute it and/or 14 14 modify it under the terms of the GNU General Public License 15 15 as published by the Free Software Foundation; either version 2 16 16 of the License, or (at your option) any later version. 17 17 18 18 BASE is distributed in the hope that it will be useful, 19 19 but WITHOUT ANY WARRANTY; without even the implied warranty of 20 20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 21 GNU General Public License for more details. 22 22 23 23 You should have received a copy of the GNU General Public License 24 24 along with this program; if not, write to the Free Software … … 27 27 --> 28 28 29 <chapter id="software" >29 <chapter id="software" chunked="0"> 30 30 <?dbhtml dir="software"?> 31 31 <title>Software</title> 32 <sect1 id="software.manage">33 <title>Managing Software</title>34 32 35 <sect2 id="software.manage.typecreate"> 36 <title>Software Types</title> 37 <para><guilabel>There is only Software Type</guilabel> in BASE2 and it is not possible to create new types. This is a difference compared to the way Hardware can be managed.</para> 38 <para> By default, BASE2 creates the 1 Software Type: Feature Extraction</para> 39 </sect2> 40 <sect2 id="software.manage.create"> 41 <title>Creating Softwares</title> 42 <para>In BASE2, Softwares can be created by 2 routes:</para> 43 <orderedlist> 44 <listitem> 45 <para>Creating Softwares from the Software Type List View page</para> 46 <para>Clicking on the <inlinemediaobject> 47 <imageobject> 48 <imagedata fileref="figures/add.gif" format="GIF"/> 49 </imageobject> 50 </inlinemediaobject> add software button. 51 </para> 52 <figure id="write_docbook_doc.figures.software-frompt"> 53 <title>Create New software from the Software Type List View</title> 54 <screenshot> 55 <mediaobject> 56 <imageobject> 57 <imagedata contentwidth="10cm" width="10cm" fileref="figures/software-frompt.png" format="PNG"/> 58 </imageobject> 59 </mediaobject> 60 </screenshot> 61 </figure> 62 </listitem> 63 <listitem> 64 <para>Creating Software from the Software List View page</para> 65 <para>Go to 66 <menuchoice> 67 <guimenu>View</guimenu> 68 <guimenuitem>Software</guimenuitem> 69 </menuchoice></para> 70 <para>Click on <guibutton>New…</guibutton> button 71 </para> 72 </listitem> 73 </orderedlist> 33 <sect1 id="software.softwaretypes"> 34 <title>Software types</title> 74 35 75 <para>In both cases, a Software Create pop-up window opens. The window contains 2 mandatory fields:</para> 76 <itemizedlist> 77 <listitem> 78 <para> 79 <guilabel>Name</guilabel> and <guilabel>Software type</guilabel>.</para> 80 <para>The later is a select-list population from Software Types owned by or shared to the user.</para> 81 </listitem> 82 <listitem> 83 <para><guilabel>Version</guilabel> and <guilabel>Description</guilabel>, the other 2 fields, are optional and self explanatory.</para> 84 </listitem> 85 </itemizedlist> 86 <para>Click on the 87 <inlinemediaobject> 88 <imageobject> 89 <imagedata fileref="figures/save.gif" format="GIF"/> 90 </imageobject> 91 </inlinemediaobject> 92 Save button to store the information in BASE2 or on the 93 <inlinemediaobject> 94 <imageobject> 95 <imagedata fileref="figures/cancel.gif" format="GIF"/> 96 </imageobject> 97 </inlinemediaobject> 98 button to abort. 99 </para> 100 101 </sect2> 102 <sect2 id="software.manage.detail_view"> 103 <title>Viewing/Editing Softwares</title> 104 <itemizedlist> 105 <listitem> 106 <para> Press and hold one of the <keycap>CTRL</keycap>, <keycap>ALT</keycap> or 107 <keycap>SHIFT</keycap> keys while clicking on the name of an Software Item, which is a live 108 link. </para> 109 </listitem> 110 <listitem> 111 <para> Alternately, navigating to the Software Item View, one can hit the 112 <guibutton>Edit…</guibutton> to performed the task.</para> 113 <para>In both cases, an Edit pop-up windows opens. It is essentially identical to a Create 114 window and allows updating information about a particular Software item stored in BASE2</para> 115 <figure id="write_docbook_doc.figures.software-itemview"> 116 <title>Software Item View</title> 117 <screenshot> 118 <mediaobject> 119 <imageobject> 120 <imagedata contentwidth="10cm" width="10cm" fileref="figures/software-itemview.png" format="PNG"/> 121 </imageobject> 122 </mediaobject> 123 </screenshot> 124 </figure> 125 </listitem> 126 </itemizedlist> 127 </sect2> 128 <sect2 id="software.manage.delete"> 129 <title>Deleting/Restoring Softwares</title> 130 <para>As for other items in BASE2, Softwares can be removed and restored. To do so, do the 131 following</para> 132 <itemizedlist> 133 <listitem> 134 <para>Select one or more Softwares and click <guibutton>Delete</guibutton> button in the menu 135 bar. </para> 136 <para>All the selected Softwares have been marked as deleted and are no longer available from 137 the interface. </para> 138 <para>Only by selecting from the <guilabel>view/preset…</guilabel> select box the 139 <guilabel>Removed</guilabel> option, one can see those of the protocols earmarked for 140 deletion. They will be shown with a symbol 141 <inlinemediaobject> 142 <imageobject> 143 <imagedata fileref="figures/deleted.gif" format="GIF"/> 144 </imageobject> 145 </inlinemediaobject> in front of them. </para> 146 </listitem> 147 <listitem> 148 <para>Alternately, navigating to the Software Item View, one can hit the 149 <guibutton>Delete</guibutton> to performed the task. </para> 150 </listitem> 151 <listitem> 152 <para>Deletion errors at this stage can be easily recovered. Select the item to recover from 153 the List View (be sure to check the <guilabel>Removed</guilabel> option in the 154 <guilabel>view/preset…</guilabel> filter) and hit the 155 <guibutton>Restore</guibutton> button to performed the task. </para> 156 </listitem> 157 </itemizedlist> 158 <important> 159 <para>To really delete an item from the database you must use the trashcan. Items 160 deleted from the Trashcan can not be recovered. To learn more about the trashcan function, please refer to <xref linkend="trashcan"/> </para> 161 </important> 162 </sect2> 163 </sect1> 36 <para> 37 There is only one <guilabel>Software Type</guilabel> 38 (Feature Extraction) 39 in BASE and it is not possible to create new types. 40 This is a difference compared to the way hardware can be 41 managed. 42 </para> 43 </sect1> 44 45 <sect1 id="software.manage"> 46 <title>Softwares</title> 47 <para> 48 In BASE, software can be created by 2 routes. Either 49 from the single-item view of a software type or from the 50 list view of software. 51 </para> 52 53 <figure 54 id="software.figures.edit_softwware"> 55 <title>Software properties</title> 56 <screenshot> 57 <mediaobject> 58 <imageobject> 59 <imagedata 60 fileref="figures/edit_software.png" format="PNG" /> 61 </imageobject> 62 </mediaobject> 63 </screenshot> 64 </figure> 65 66 <helptext external_id="software.edit" 67 title="Edit software"> 68 <variablelist> 69 <varlistentry> 70 <term><guilabel>Name</guilabel></term> 71 <listitem> 72 <para> 73 The name of the software. 74 </para> 75 </listitem> 76 </varlistentry> 77 <varlistentry> 78 <term><guilabel>Version</guilabel></term> 79 <listitem> 80 <para> 81 The version number of the software. 82 </para> 83 </listitem> 84 </varlistentry> 85 <varlistentry> 86 <term><guilabel>Type</guilabel></term> 87 <listitem> 88 <para> 89 The software type of the software. 90 </para> 91 </listitem> 92 </varlistentry> 93 <varlistentry> 94 <term><guilabel>Description</guilabel></term> 95 <listitem> 96 <para> 97 A description of the software. 98 </para> 99 </listitem> 100 </varlistentry> 101 </variablelist> 102 </helptext> 103 104 </sect1> 164 105 </chapter>
Note: See TracChangeset
for help on using the changeset viewer.