Changeset 4324

Timestamp:

Jun 3, 2008, 10:58:09 AM (13 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #532.

File:

• trunk/doc/src/docbook/userdoc/jobs.xml (modified) (13 diffs)

trunk/doc/src/docbook/userdoc/jobs.xml

@@ -30 +30 @@
   <?dbhtml dir="jobs"?>
   <title>Jobs</title>
-  <para>Job is a configured task performed by a plugin.</para>
+  <para>Job is a configured task performed by a plug-in.</para>
   <para>
-    Creating/configuring a job is made from a context, which is supported by the plugin you want
+    Creating/configuring a job is made from a context, which is supported by the plug-in you want
     to use. If no particularly context is needed, the job configuration is started from the
-    plugin's single item view.
+    plug-in's single item view.
   </para>
   <para>
-    Some jobs can be configured to execute immediately (for a few plugins it is mandatory that
+    Some jobs can be configured to execute immediately (for a few plug-ins it is mandatory that
     the job runs immediately), but normally jobs are placed in the job queue after they have
     been configured. The jobs will then be picked out for execution depending on their priority
@@ -56 +56 @@
       click on a job's name from the list page of jobs or when a job configuration is
       finished. The window contain two tabs, one with information about the job and another
-      with the plugin-parameters for the plugin used in the job.
+      with the parameters for the plug-in used in the job.
     </para>
     <helptext external_id="job.view.parameters" title="Job parameters">
       <para>
-        The values listed on the plugin-parameter-tab are depending on what inputs the
-        choosen plugin needs from the user.
+        The values listed on the <guilabel>Parameters</guilabel> tab depends on 
+        what the plug-in needs from the user. If a specific plug-in configuration was
+        use, those parameters are also listed here.
       </para>
     </helptext>
     <helptext external_id="job.view.properties" title="Job properties">
       <para>
-        Job-parameters are set either when configuring the job or by the system. No
+        The properties are set either when configuring the job or by the system. No
         parameters can be edit after a job is created.
         <variablelist>
@@ -98 +99 @@
             <listitem>
               <para>
-                The type of job, which is depending on the plugin that is used. It
+                The type of job, which is depending on the plug-in that is used. It
                 can be one of these five:
                 <itemizedlist>
@@ -129 +130 @@
                     <para>
                       <emphasis>Not configured</emphasis>
-                      -The plugin has not been configured properly and is not
+                      - The plug-in has not been configured properly and is not
                       placed in the job queue.
                     </para>
@@ -136 +137 @@
                     <para>
                       <emphasis>Waiting</emphasis>
-                      -Job is waiting in the job queue.
+                      - Job is waiting in the job queue.
                     </para>
                   </listitem>
@@ -142 +143 @@
                     <para>
                       <emphasis>Executing</emphasis>
-                      -Job is being executed.
+                      - Job is being executed.
                     </para>
                   </listitem>
@@ -154 +155 @@
                     <para>
                       <emphasis>Error</emphasis>
-                      -The job was aborted cause of some error.
+                      - The job was aborted cause of some error.
                     </para>
                   </listitem>
@@ -160 +161 @@
                     <para>
                       <emphasis>Preparing</emphasis>
-                      -Doing some preparing tasks befor executing the job.
+                      - Doing some preparing tasks befor executing the job.
                     </para>
                   </listitem>
@@ -166 +167 @@
                     <para>
                       <emphasis>Aborting</emphasis>
-                      -Job has received an abort signal and tries to abort the
+                      - Job has received an abort signal and tries to abort the
                       work.
                     </para>
@@ -180 +181 @@
             <listitem>
               <para>
-                A message, given by the plugin, with more information about the
+                A message, given by the plug-in, with more information about the
                 status.
               </para>
@@ -192 +193 @@
               <para>
                 Progress of the job. How detailed this is depends on how often the
-                plugin reports it's progress.
+                plug-in reports it's progress.
               </para>
             </listitem>
@@ -279 +280 @@
             </term>
             <listitem>
-              <para>The plugin to use in the job.</para>
+              <para>The plug-in to use in the job.</para>
             </listitem>
           </varlistentry>
@@ -287 +288 @@
             </term>
             <listitem>
-              <para>Name of the plugin configuration that is used.</para>
+              <para>Name of the plug-in configuration that is used.</para>
             </listitem>
           </varlistentry>
         </variablelist>
       </para>
+      
+      <para>
+        Depending on the status of the job, there may also be one or
+        more buttons on the form.
+      </para>
+      
+      <variablelist>
+      <varlistentry>
+        <term><guibutton>Refresh</guibutton></term>
+        <listitem>
+          <para>
+          Update the page with the information. This button is available as long
+          as the job has not finished. This button is only for the impatient since
+          the page will automatically refresh every ten seconds anyway.
+          </para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term><guibutton>Abort</guibutton></term>
+        <listitem>
+          <para>
+          Aborts a job that is running or hasn't started yet. Jobs that hasn't
+          started can always be aborted. Jobs that are already eecuting can only
+          be aborted if the plug-in supports it. The button will not be visible if
+          the plug-in doesn't supports being aborted.
+          </para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term><guibutton>Restart</guibutton></term>
+        <listitem>
+          <para>
+          Retry a failed job. Sometimes the reason that a job failed can be fixed. For
+          example, by changing the permissions on items the job needs to access. Use
+          this button to place the job in the job queue again. It is not possible to
+          change job parameters with one exception, if the job uses a plug-in configuration
+          and the configuration has been changed it is possible to select if
+          the old or new configuration values should be used. 
+          </para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term><guibutton>Close</guibutton></term>
+        <listitem>
+          <para>
+          Close the window.
+          </para>
+        </listitem>
+      </varlistentry>
+      
+      </variablelist>
+      
     </helptext>
   </sect1>