Changeset 4324


Ignore:
Timestamp:
Jun 3, 2008, 10:58:09 AM (13 years ago)
Author:
Nicklas Nordborg
Message:

Fixes #532.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/userdoc/jobs.xml

    r4311 r4324  
    3030  <?dbhtml dir="jobs"?>
    3131  <title>Jobs</title>
    32   <para>Job is a configured task performed by a plugin.</para>
     32  <para>Job is a configured task performed by a plug-in.</para>
    3333  <para>
    34     Creating/configuring a job is made from a context, which is supported by the plugin you want
     34    Creating/configuring a job is made from a context, which is supported by the plug-in you want
    3535    to use. If no particularly context is needed, the job configuration is started from the
    36     plugin's single item view.
     36    plug-in's single item view.
    3737  </para>
    3838  <para>
    39     Some jobs can be configured to execute immediately (for a few plugins it is mandatory that
     39    Some jobs can be configured to execute immediately (for a few plug-ins it is mandatory that
    4040    the job runs immediately), but normally jobs are placed in the job queue after they have
    4141    been configured. The jobs will then be picked out for execution depending on their priority
     
    5656      click on a job's name from the list page of jobs or when a job configuration is
    5757      finished. The window contain two tabs, one with information about the job and another
    58       with the plugin-parameters for the plugin used in the job.
     58      with the parameters for the plug-in used in the job.
    5959    </para>
    6060    <helptext external_id="job.view.parameters" title="Job parameters">
    6161      <para>
    62         The values listed on the plugin-parameter-tab are depending on what inputs the
    63         choosen plugin needs from the user.
     62        The values listed on the <guilabel>Parameters</guilabel> tab depends on
     63        what the plug-in needs from the user. If a specific plug-in configuration was
     64        use, those parameters are also listed here.
    6465      </para>
    6566    </helptext>
    6667    <helptext external_id="job.view.properties" title="Job properties">
    6768      <para>
    68         Job-parameters are set either when configuring the job or by the system. No
     69        The properties are set either when configuring the job or by the system. No
    6970        parameters can be edit after a job is created.
    7071        <variablelist>
     
    9899            <listitem>
    99100              <para>
    100                 The type of job, which is depending on the plugin that is used. It
     101                The type of job, which is depending on the plug-in that is used. It
    101102                can be one of these five:
    102103                <itemizedlist>
     
    129130                    <para>
    130131                      <emphasis>Not configured</emphasis>
    131                       -The plugin has not been configured properly and is not
     132                      - The plug-in has not been configured properly and is not
    132133                      placed in the job queue.
    133134                    </para>
     
    136137                    <para>
    137138                      <emphasis>Waiting</emphasis>
    138                       -Job is waiting in the job queue.
     139                      - Job is waiting in the job queue.
    139140                    </para>
    140141                  </listitem>
     
    142143                    <para>
    143144                      <emphasis>Executing</emphasis>
    144                       -Job is being executed.
     145                      - Job is being executed.
    145146                    </para>
    146147                  </listitem>
     
    154155                    <para>
    155156                      <emphasis>Error</emphasis>
    156                       -The job was aborted cause of some error.
     157                      - The job was aborted cause of some error.
    157158                    </para>
    158159                  </listitem>
     
    160161                    <para>
    161162                      <emphasis>Preparing</emphasis>
    162                       -Doing some preparing tasks befor executing the job.
     163                      - Doing some preparing tasks befor executing the job.
    163164                    </para>
    164165                  </listitem>
     
    166167                    <para>
    167168                      <emphasis>Aborting</emphasis>
    168                       -Job has received an abort signal and tries to abort the
     169                      - Job has received an abort signal and tries to abort the
    169170                      work.
    170171                    </para>
     
    180181            <listitem>
    181182              <para>
    182                 A message, given by the plugin, with more information about the
     183                A message, given by the plug-in, with more information about the
    183184                status.
    184185              </para>
     
    192193              <para>
    193194                Progress of the job. How detailed this is depends on how often the
    194                 plugin reports it's progress.
     195                plug-in reports it's progress.
    195196              </para>
    196197            </listitem>
     
    279280            </term>
    280281            <listitem>
    281               <para>The plugin to use in the job.</para>
     282              <para>The plug-in to use in the job.</para>
    282283            </listitem>
    283284          </varlistentry>
     
    287288            </term>
    288289            <listitem>
    289               <para>Name of the plugin configuration that is used.</para>
     290              <para>Name of the plug-in configuration that is used.</para>
    290291            </listitem>
    291292          </varlistentry>
    292293        </variablelist>
    293294      </para>
     295     
     296      <para>
     297        Depending on the status of the job, there may also be one or
     298        more buttons on the form.
     299      </para>
     300     
     301      <variablelist>
     302      <varlistentry>
     303        <term><guibutton>Refresh</guibutton></term>
     304        <listitem>
     305          <para>
     306          Update the page with the information. This button is available as long
     307          as the job has not finished. This button is only for the impatient since
     308          the page will automatically refresh every ten seconds anyway.
     309          </para>
     310        </listitem>
     311      </varlistentry>
     312     
     313      <varlistentry>
     314        <term><guibutton>Abort</guibutton></term>
     315        <listitem>
     316          <para>
     317          Aborts a job that is running or hasn't started yet. Jobs that hasn't
     318          started can always be aborted. Jobs that are already eecuting can only
     319          be aborted if the plug-in supports it. The button will not be visible if
     320          the plug-in doesn't supports being aborted.
     321          </para>
     322        </listitem>
     323      </varlistentry>
     324     
     325      <varlistentry>
     326        <term><guibutton>Restart</guibutton></term>
     327        <listitem>
     328          <para>
     329          Retry a failed job. Sometimes the reason that a job failed can be fixed. For
     330          example, by changing the permissions on items the job needs to access. Use
     331          this button to place the job in the job queue again. It is not possible to
     332          change job parameters with one exception, if the job uses a plug-in configuration
     333          and the configuration has been changed it is possible to select if
     334          the old or new configuration values should be used.
     335          </para>
     336        </listitem>
     337      </varlistentry>
     338     
     339      <varlistentry>
     340        <term><guibutton>Close</guibutton></term>
     341        <listitem>
     342          <para>
     343          Close the window.
     344          </para>
     345        </listitem>
     346      </varlistentry>
     347     
     348      </variablelist>
     349     
    294350    </helptext>
    295351  </sect1>
Note: See TracChangeset for help on using the changeset viewer.