Changeset 4324
- Timestamp:
- Jun 3, 2008, 10:58:09 AM (15 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/src/docbook/userdoc/jobs.xml
r4311 r4324 30 30 <?dbhtml dir="jobs"?> 31 31 <title>Jobs</title> 32 <para>Job is a configured task performed by a plug in.</para>32 <para>Job is a configured task performed by a plug-in.</para> 33 33 <para> 34 Creating/configuring a job is made from a context, which is supported by the plug in you want34 Creating/configuring a job is made from a context, which is supported by the plug-in you want 35 35 to use. If no particularly context is needed, the job configuration is started from the 36 plug in's single item view.36 plug-in's single item view. 37 37 </para> 38 38 <para> 39 Some jobs can be configured to execute immediately (for a few plug ins it is mandatory that39 Some jobs can be configured to execute immediately (for a few plug-ins it is mandatory that 40 40 the job runs immediately), but normally jobs are placed in the job queue after they have 41 41 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 57 57 finished. The window contain two tabs, one with information about the job and another 58 with the p lugin-parameters for the plugin used in the job.58 with the parameters for the plug-in used in the job. 59 59 </para> 60 60 <helptext external_id="job.view.parameters" title="Job parameters"> 61 61 <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. 64 65 </para> 65 66 </helptext> 66 67 <helptext external_id="job.view.properties" title="Job properties"> 67 68 <para> 68 Job-parameters are set either when configuring the job or by the system. No69 The properties are set either when configuring the job or by the system. No 69 70 parameters can be edit after a job is created. 70 71 <variablelist> … … 98 99 <listitem> 99 100 <para> 100 The type of job, which is depending on the plug in that is used. It101 The type of job, which is depending on the plug-in that is used. It 101 102 can be one of these five: 102 103 <itemizedlist> … … 129 130 <para> 130 131 <emphasis>Not configured</emphasis> 131 - The plugin has not been configured properly and is not132 - The plug-in has not been configured properly and is not 132 133 placed in the job queue. 133 134 </para> … … 136 137 <para> 137 138 <emphasis>Waiting</emphasis> 138 - Job is waiting in the job queue.139 - Job is waiting in the job queue. 139 140 </para> 140 141 </listitem> … … 142 143 <para> 143 144 <emphasis>Executing</emphasis> 144 - Job is being executed.145 - Job is being executed. 145 146 </para> 146 147 </listitem> … … 154 155 <para> 155 156 <emphasis>Error</emphasis> 156 - The job was aborted cause of some error.157 - The job was aborted cause of some error. 157 158 </para> 158 159 </listitem> … … 160 161 <para> 161 162 <emphasis>Preparing</emphasis> 162 - Doing some preparing tasks befor executing the job.163 - Doing some preparing tasks befor executing the job. 163 164 </para> 164 165 </listitem> … … 166 167 <para> 167 168 <emphasis>Aborting</emphasis> 168 - Job has received an abort signal and tries to abort the169 - Job has received an abort signal and tries to abort the 169 170 work. 170 171 </para> … … 180 181 <listitem> 181 182 <para> 182 A message, given by the plug in, with more information about the183 A message, given by the plug-in, with more information about the 183 184 status. 184 185 </para> … … 192 193 <para> 193 194 Progress of the job. How detailed this is depends on how often the 194 plug in reports it's progress.195 plug-in reports it's progress. 195 196 </para> 196 197 </listitem> … … 279 280 </term> 280 281 <listitem> 281 <para>The plug in to use in the job.</para>282 <para>The plug-in to use in the job.</para> 282 283 </listitem> 283 284 </varlistentry> … … 287 288 </term> 288 289 <listitem> 289 <para>Name of the plug in configuration that is used.</para>290 <para>Name of the plug-in configuration that is used.</para> 290 291 </listitem> 291 292 </varlistentry> 292 293 </variablelist> 293 294 </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 294 350 </helptext> 295 351 </sect1>
Note: See TracChangeset
for help on using the changeset viewer.