Changeset 5798 for trunk/doc/src/docbook/user/import_data.xml

Timestamp:

Oct 11, 2011, 6:32:48 PM (11 years ago)

Author:

Nicklas Nordborg

Message:

References #1590: Documentation cleanup

New and updated screenshots for chapter 18+19 - Import/export.

File:

• trunk/doc/src/docbook/user/import_data.xml (modified) (11 diffs)

trunk/doc/src/docbook/user/import_data.xml

@@ -41 +41 @@
   <para>
     In some places the only way to get data into BASE is to import it
-    from a file. This typically includes raw data, array design
-    features, reporters and other things, which would be inconvenient
+    from a file. This typically includes <emphasis>raw data</emphasis>, 
+    <emphasis>array design features</emphasis>, <emphasis>reporters</emphasis>
+    and other things, which would be inconvenient
     to enter by hand due to the large number of data items. There is
     also convenience batch importers for importing other items such as
-    biosources, samples, and annotations. The batch importers are
+    <emphasis>biosources</emphasis>, <emphasis>samples</emphasis>, and 
+    <emphasis>annotations</emphasis>. The batch importers are
     described later in this chapter after the general import
     description.
@@ -51 +53 @@
   <para>
     Normally, a plug-in handles one type of items and may require a
-    configuration, for example, the import plug-ins need some
+    configuration. For example, most import plug-ins need some
     information about how to find headers and data lines in
     files. BASE ships with a number of import plug-ins as a part of
@@ -104 +106 @@
       <listitem>
         <simpara>
-          Select a plug-in and file format to use, or select the
-          auto detect option.
+          Select a plug-in and file format to use, or use the
+          <emphasis>auto detect</emphasis> option.
         </simpara>
       </listitem>
@@ -164 +166 @@
                 includes combinations that
                 the logged in user has permission to use. If you select
-                an entry a short description of about the plug-in and configuration
+                an entry a short description about the plug-in and configuration
                 is displayed
                 below the lists. More information about the plug-ins can
@@ -260 +262 @@
               <listitem>
                 <para>
-                  Displayes the selected plug-in or <guilabel>all</guilabel> if the 
+                  Displays the selected plug-in or <guilabel>all</guilabel> if the 
                   auto-detection is used on all supporting plug-ins.
                 </para>
@@ -285 +287 @@
                   with a character set the correct option is automatically selected. In all 
                   cases, you have the option to override the default selection. Most files,
-                  typically use one of the UTF-8 or ISO-8859-1 character sets.
+                  typically use either the UTF-8 or ISO-8859-1 character set.
                 </para>
               </listitem>
@@ -350 +352 @@
       </para>
       
-      <figure id="import_export_data.figures.confiure_plugin">
+      <figure id="import_export_data.figures.configure_plugin">
         <title>Specify plug-in parameters</title>
         <screenshot>
@@ -386 +388 @@
         
         <varlistentry>
+          <term><guilabel>File parser regular expressions</guilabel></term>
+          <listitem>
+            <para>
+            Various regular expressions that are used when parsing the file
+            to ensure that the data is found. In most cases, all values
+            are taken from the matched configuration and can be left as is.
+            </para>
+          </listitem>
+        </varlistentry>
+        
+        <varlistentry>
           <term><guilabel>Error handling</guilabel></term>
           <listitem>
@@ -413 +426 @@
       <title>Add the import job to the job queue</title>
 
+      <figure id="import_export_data.figures.finish_job">
+        <title>Job name and options</title>
+        <screenshot>
+          <mediaobject>
+            <imageobject>
+              <imagedata 
+                fileref="figures/finish_job.png" format="PNG" />
+            </imageobject>
+          </mediaobject>
+        </screenshot>
+      </figure>
+      
+      <helptext external_id="runplugin.finshjob" 
+        title="Set job name and options">
       <para>
         In this window should information about the job be filled in, like name and
@@ -418 +445 @@
         are also two check boxes in this page.
         <variablelist>
+          <varlistentry>
+            <term>
+              <guilabel>Name</guilabel>
+            </term>
+            <listitem>
+              <para>
+                Most plug-ins should suggest a name for the job, but you can change it if
+                you want to.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>
+              <guilabel>Use job agent</guilabel>
+            </term>
+            <listitem>
+              <para>
+                This option is only available if the BASE system has been configured with
+                job agents and the logged in user has <constant>SELECT_JOBAGENT</constant>
+                permission. Select the <guilabel>automatic</guilabel> option to let
+                BASE automatically select a job agent or select a specific option
+                to force the use of that particular job agent.
+              </para>
+            </listitem>
+          </varlistentry>
           <varlistentry>
             <term>
@@ -463 +515 @@
         </para>
       </tip>
+      </helptext>
     </sect2>