[TASK] EXT:Scheduler: Update documentation 77/55077/3
authorMichael Oehlhof <typo3@oehlhof.de>
Thu, 14 Dec 2017 15:22:07 +0000 (16:22 +0100)
committerMarkus Klein <markus.klein@typo3.org>
Thu, 14 Dec 2017 19:34:12 +0000 (20:34 +0100)
Replaced images with new ones from current master.
Adjust the description text where necessary.
Change presentation of the "class not found" group.

Resolves: #72628
Releases: master
Change-Id: Icf6845c72b34afbf0105aa844e321a18878f16dd
Reviewed-on: https://review.typo3.org/55077
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Markus Klein <markus.klein@typo3.org>
Tested-by: Markus Klein <markus.klein@typo3.org>
26 files changed:
typo3/sysext/scheduler/Documentation/Administration/BackendModule/Index.rst
typo3/sysext/scheduler/Documentation/Administration/EditTask/Index.rst
typo3/sysext/scheduler/Documentation/Administration/ExecuteNextCronjob/Index.rst [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Administration/ExecuteNextCronjob/index.rst [deleted file]
typo3/sysext/scheduler/Documentation/Administration/GroupTask/Index.rst
typo3/sysext/scheduler/Documentation/Administration/ManualExecution/Index.rst
typo3/sysext/scheduler/Documentation/Images/AddingATask.png
typo3/sysext/scheduler/Documentation/Images/ExtensionConfiguration.png [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Images/GroupRecords.png
typo3/sysext/scheduler/Documentation/Images/GroupedTasks.png
typo3/sysext/scheduler/Documentation/Images/InformationScreen.png
typo3/sysext/scheduler/Documentation/Images/InputValidation.png
typo3/sysext/scheduler/Documentation/Images/InputValidationOk.png [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Images/LateTask.png
typo3/sysext/scheduler/Documentation/Images/MissingTaskClass.png
typo3/sysext/scheduler/Documentation/Images/SetupCheck.png
typo3/sysext/scheduler/Documentation/Images/StoppingATask.png
typo3/sysext/scheduler/Documentation/Images/TableGarbageCollectionTaskConfiguration.png
typo3/sysext/scheduler/Documentation/Images/TaskConfigurationSelectClass.png [new file with mode: 0644]
typo3/sysext/scheduler/Documentation/Installation/Index.rst
typo3/sysext/scheduler/Documentation/Installation/Installing/Index.rst
typo3/sysext/scheduler/Documentation/Installation/SchedulerUser/Index.rst [deleted file]
typo3/sysext/scheduler/Documentation/Installation/SetupCheck/Index.rst
typo3/sysext/scheduler/Documentation/Overview/Index.rst
typo3/sysext/scheduler/Resources/Private/Language/locallang.xlf
typo3/sysext/scheduler/Resources/Private/Partials/Backend/SchedulerModule/TaskList.html

index 4a7cedd..a54fbe2 100644 (file)
@@ -19,7 +19,6 @@ The setup check screen
 
 This screen has already been mentioned in the :ref:`Installation chapter <setup-check>`.
 It is mostly useful when setting up the Scheduler, as it indicates
-whether the necessary "\_cli\_scheduler" BE user exist or not and
 whether the CLI script is executable or not. When everything is
 running fine, it contains mostly one useful piece of information: when
 the last run took place, when it ended and whether it was started
@@ -62,11 +61,11 @@ information.
    Main screen of the Scheduler BE module
 
 
-Disabled tasks appear in grayed-out text. A disabled task is a
+Disabled tasks have a gray label sign near the task name. A disabled task is a
 task that will not be run automatically by the command-line script,
 but may still be executed from the BE module.
 
-A late task will appear this way:
+A late task will appear with an orange label sign near the task name:
 
 .. figure:: ../../Images/LateTask.png
    :alt: A late task in the Scheduler main screen
@@ -74,6 +73,9 @@ A late task will appear this way:
    A late task in the main screen of the Scheduler BE module
 
 
+The task list can be sorted by clicking the column label. With every click it
+switches between ascending and descending order of the items of the associated column.
+
 The table at the center of the above screenshot shows the
 following:
 
@@ -84,39 +86,42 @@ following:
   selected tasks" button. Read more in "Manually executing a task"
   below.
 
-- The second column contains possible actions, mainly editing or
-  deleting a task. The actions will be unavailable for a task that is
-  currently running, as it is unwise to edit or delete it a task in such
-  a case. Instead a running task will display a "stop" button (see
-  "Stopping a task" below).
-
-- The third column simply displays the id of the task.
+- The second column simply displays the id of the task.
 
-- The fourth column contains the name of the task, the extension it is
+- The third column contains the name of the task, the extension it is
   coming from and any additional information specific to the task (for
   example, the e-mail to which the "test" task will send a message or
   the sleep duration of the "sleep" task). It also show a summary of the
   task's status with an icon.
 
-- The fifth column shows whether the task is recurring or will run only
+- The fourth column shows whether the task is recurring or will run only
   a single time.
 
-- The sixth column shows the frequency.
+- The fifth column shows the frequency.
 
-- The seventh columns indicates whether parallel executions are allowed
+- The sixth columns indicates whether parallel executions are allowed
   or not.
 
-- The eighth column shows the last execution time and indicates whether
+- The seventh column shows the last execution time and indicates whether
   the task was launched manually or was run via the command-line script
   (cron).
 
-- The last column shows the planned execution time. If the task is
+- The eighth column shows the planned execution time. If the task is
   overdue, the time will show up in bold, red numbers. A task may have
   no future execution date if it has reached its end date, if it was
   meant to run a single time and that execution is done, or if the task
   is disabled. The next execution time is also hidden for running tasks,
   as this information makes no sense at that point in time.
 
+- The last column contains possible actions, mainly editing, disable or
+  deleting a task. There are also buttons for running the task on the
+  next cron job or run it directly.
+  The actions will be unavailable for a task that is currently running,
+  as it is unwise to edit or delete it a task in such a case. Instead a
+  running task will display a "stop" button (see "Stopping a task" below).
+
+
+
 Note that all dates and times are displayed in the server's time zone.
 The server time appears at the bottom of the screen.
 
index c159fdb..cae1287 100644 (file)
@@ -28,6 +28,12 @@ available by moving the mouse over the field labels):
 - The class selector is available only when adding a new task. The class
   cannot be changed when editing a task, since there's no sense in that.
 
+.. figure:: ../../Images/TaskConfigurationSelectClass.png
+   :alt: Select a class
+
+   Select the class of the scheduled task
+
+
 - A task must have a start date. The end date is not mandatory, though.
   A task without end date will run forever. Dates and times must be
   entered in the server's time zone. The server's time appears at the
@@ -54,7 +60,13 @@ confirmation message.
 .. figure:: ../../Images/InputValidation.png
    :alt: Input validation
 
-   Input validation when adding a new scheduled task or editing an existing one
+   Input validation failed when adding a new scheduled task or editing an existing one
+
+
+.. figure:: ../../Images/InputValidationOk.png
+   :alt: Input validation OK
+
+   Input validation succeeded when adding a new scheduled task or editing an existing one
 
 
 If an error occurs when validating a cron definition, the
diff --git a/typo3/sysext/scheduler/Documentation/Administration/ExecuteNextCronjob/Index.rst b/typo3/sysext/scheduler/Documentation/Administration/ExecuteNextCronjob/Index.rst
new file mode 100644 (file)
index 0000000..949958b
--- /dev/null
@@ -0,0 +1,18 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+
+.. _executing-a-task-on-next-cronjob:
+
+Executing a task on next cron job
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+It is possible to manually set the next execution time of one or more
+registered tasks from the BE module to the current time.
+The selected tasks will then be running on the next cron job.
+
diff --git a/typo3/sysext/scheduler/Documentation/Administration/ExecuteNextCronjob/index.rst b/typo3/sysext/scheduler/Documentation/Administration/ExecuteNextCronjob/index.rst
deleted file mode 100644 (file)
index 949958b..0000000
+++ /dev/null
@@ -1,18 +0,0 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
-
-
-
-.. _executing-a-task-on-next-cronjob:
-
-Executing a task on next cron job
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-It is possible to manually set the next execution time of one or more
-registered tasks from the BE module to the current time.
-The selected tasks will then be running on the next cron job.
-
index 5edcecb..5a6435b 100644 (file)
@@ -19,6 +19,7 @@ In case of a high number of different tasks, it may be useful to visually group
 
    Grouping related tasks together
 
+
 Scheduler task groups are records stored on the root page (pid=0). They may be created, edited and sorted with Web > List:
 
 .. figure:: ../../Images/GroupRecords.png
@@ -26,7 +27,12 @@ Scheduler task groups are records stored on the root page (pid=0). They may be c
 
    Management of scheduler task groups
 
+
 Individual tasks may then be edited as usual and associated to a given scheduler task group.
 
+The individual groups can be sorted independent of each other by clicking the column label.
+With every click it switches between ascending and descending order of the items of the associated column
+in the corresponding group.
+
 .. note::
    Tasks inside a hidden group are neither automatically executed nor displayed in the scheduler module.
index ddc9980..3fe79f7 100644 (file)
@@ -19,3 +19,11 @@ task's run. There's one important thing to note: if the task was
 overdue, a new execution date will be calculated. If the task was
 **not** overdue, the previously calculated next execution date stays.
 
+A single task can be started by pressing the appropriate button in
+the row of the task. Multiple tasks can be started by selecting the
+checkboxes on the left side of the task row and then pressing the
+appropriate button beneath the task list.
+
+There is one button for directly starting the task and another button
+for starting the task with the next cron job.
+
index 1893581..2b0148e 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/AddingATask.png and b/typo3/sysext/scheduler/Documentation/Images/AddingATask.png differ
diff --git a/typo3/sysext/scheduler/Documentation/Images/ExtensionConfiguration.png b/typo3/sysext/scheduler/Documentation/Images/ExtensionConfiguration.png
new file mode 100644 (file)
index 0000000..ee4e520
Binary files /dev/null and b/typo3/sysext/scheduler/Documentation/Images/ExtensionConfiguration.png differ
index 8b62dfc..34bc472 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/GroupRecords.png and b/typo3/sysext/scheduler/Documentation/Images/GroupRecords.png differ
index a6678e0..87b3c4d 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/GroupedTasks.png and b/typo3/sysext/scheduler/Documentation/Images/GroupedTasks.png differ
index d17fc09..3842b3d 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/InformationScreen.png and b/typo3/sysext/scheduler/Documentation/Images/InformationScreen.png differ
index d73c854..c51b557 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/InputValidation.png and b/typo3/sysext/scheduler/Documentation/Images/InputValidation.png differ
diff --git a/typo3/sysext/scheduler/Documentation/Images/InputValidationOk.png b/typo3/sysext/scheduler/Documentation/Images/InputValidationOk.png
new file mode 100644 (file)
index 0000000..1766f69
Binary files /dev/null and b/typo3/sysext/scheduler/Documentation/Images/InputValidationOk.png differ
index 182b4c0..dbccd77 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/LateTask.png and b/typo3/sysext/scheduler/Documentation/Images/LateTask.png differ
index 424bbd0..47829e8 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/MissingTaskClass.png and b/typo3/sysext/scheduler/Documentation/Images/MissingTaskClass.png differ
index 55f251d..33f6685 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/SetupCheck.png and b/typo3/sysext/scheduler/Documentation/Images/SetupCheck.png differ
index 08cdad3..155ebab 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/StoppingATask.png and b/typo3/sysext/scheduler/Documentation/Images/StoppingATask.png differ
index 65badb0..e153dc2 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/TableGarbageCollectionTaskConfiguration.png and b/typo3/sysext/scheduler/Documentation/Images/TableGarbageCollectionTaskConfiguration.png differ
diff --git a/typo3/sysext/scheduler/Documentation/Images/TaskConfigurationSelectClass.png b/typo3/sysext/scheduler/Documentation/Images/TaskConfigurationSelectClass.png
new file mode 100644 (file)
index 0000000..8973e8b
Binary files /dev/null and b/typo3/sysext/scheduler/Documentation/Images/TaskConfigurationSelectClass.png differ
index 08da373..3c7a64a 100644 (file)
@@ -20,7 +20,6 @@ Installation
 
    Installing/Index
    SetupCheck/Index
-   SchedulerUser/Index
    SchedulerShellScript/Index
    CronJob/Index
    BaseTasks/Index
index 05fbd31..c557a3b 100644 (file)
@@ -26,7 +26,7 @@ extension is installed, the following settings are available:
 - **Enable logging** : by default, the Scheduler will write an entry in
   the BE log every time it starts and ends, and also when it skips a
   (denied) parallel execution. This is helpful when setting up a system,
-  but it may end up cluttering the log in the log run. It's possible to
+  but it may end up cluttering the log in the long run. It's possible to
   turn off all logging by unchecking this option.
 
 - **Enable sample tasks** : the Scheduler provides two sample tasks
@@ -36,3 +36,10 @@ extension is installed, the following settings are available:
   off. If disabled, they won't appear in the list of available tasks
   anymore.
 
+.. figure:: ../../Images/ExtensionConfiguration.png
+    :alt: Extension configuration
+
+    Configuring the extension settings
+
+
+
diff --git a/typo3/sysext/scheduler/Documentation/Installation/SchedulerUser/Index.rst b/typo3/sysext/scheduler/Documentation/Installation/SchedulerUser/Index.rst
deleted file mode 100644 (file)
index 90d4964..0000000
+++ /dev/null
@@ -1,18 +0,0 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
-
-
-
-.. _scheduler-user:
-
-The Scheduler user
-^^^^^^^^^^^^^^^^^^
-
-When tasks are launched manually from the BE module, they are executed
-using the current BE user. When tasks are run from the command line,
-however, a specific command-line user, called "\_cli\_" with admin rights
-is created on-the-fly.
\ No newline at end of file
index 35211af..1274b2e 100644 (file)
@@ -20,12 +20,12 @@ installation. It will probably look something like this:
 
    Checking the setup of the Scheduler
 
-The first warning just means that the Scheduler has never run
-yet and can be safely ignored for now. The second message is an error
-and must be addressed. See next section.
+The first message shows a warning that the Scheduler has never run
+yet or an information about the last run.
 
-The third message should normally be okay. If there's an error
+The second message should normally be okay. If there's an error
 instead, it means that permissions to execute TYPO3's command-line
 dispatcher must be checked (this is not strictly related to the
 Scheduler).
 
+The third message shows information about the current server time.
index dfd5101..c170859 100644 (file)
@@ -75,7 +75,7 @@ Follow-up
 ^^^^^^^^^
 
 Whenever a task starts or ends a message is written to TYPO'3 system
-log (viewable in the Admin Tools > Log module). A message is also
+log (viewable in SYSTEM > Log). A message is also
 written when a parallel execution has been blocked. This makes it
 possible to follow what happens, since the main purpose of the
 Scheduler is to run things when nobody is watching.
index 9122e97..ce81ec6 100644 (file)
                                <source>Please select at least one cache backend.</source>
                        </trans-unit>
                        <trans-unit id="msg.invalidTaskClass">
-                               <source>Class %s of the registered task could not be found. You should re-install the extension that provided it or simply delete this task.</source>
+                               <source>The class of a registered task could not be found. You should re-install the extension that provided it or simply delete this task.</source>
                        </trans-unit>
                        <trans-unit id="msg.invalidTaskClassEdit">
                                <source>The current class (%s) could not be found. Change it below or consider deleting this task altogether.</source>
index 35ae06a..0a1ed7e 100644 (file)
@@ -79,7 +79,7 @@
                         <td><span class="t-span">{taskRecord.frequency}</span></td>
                         <td><span class="t-span">{taskRecord.multiple}</span></td>
                         <td><span class="t-span">{taskRecord.lastExecution}</span></td>
-                        <td><span class="t-span">{taskRecord.nextDate}</span></td>
+                        <td><span class="t-span {taskRecord.labels.nextexecution.class}">{taskRecord.nextDate}</span></td>
                         <td class="nowrap"><span class="t-span">
                         <f:if condition="{taskRecord.isRunning}">
                         <f:then>
 </f:for>
 
 <f:if condition="{missingClasses}">
+    <table class="table table-striped table-hover" style="margin-bottom: -2px;">
+        <tr class="taskGroup" data-task-group-id="0">
+            <td><span><strong><f:translate key="msg.invalidTaskClass" /></strong></span>
+            </td>
+        </tr>
+    </table>
     <table class="table table-striped table-hover">
         <thead>
             <th><span class="t-span"><f:translate key="label.id" /></span></th>
         <f:for each="{missingClasses}" as="missingClass">
             <tr>
                 <td class="right">{missingClass.uid}</td>
-                <td><span class="label label-danger" style="white-space: normal"><f:translate key="msg.invalidTaskClass" arguments="{0: '{missingClass.class}'}" /></span></td>
+                <td><span class="label label-danger">{missingClass.class}</span></td>
                 <td class="nowrap">
                     <div class="btn-group" role="group">
                         <a data-toggle="tooltip" data-container="body" class="btn btn-default t3js-modal-trigger" href="{moduleUri}&CMD=delete&tx_scheduler[uid]={missingClass.uid}"