[TASK] EXT:Scheduler: Update documentation 05/55105/4
authorMichael Oehlhof <typo3@oehlhof.de>
Sat, 16 Dec 2017 01:14:06 +0000 (02:14 +0100)
committerChristian Kuhn <lolli@schwarzbu.ch>
Sat, 16 Dec 2017 16:20:25 +0000 (17:20 +0100)
Replaced images with new ones from current master.
Adjust the description text where necessary.

Resolves: #72628
Releases: 8.7
Change-Id: If2c93eabe185d6c0b40a400a0f9053d679d29f02
Reviewed-on: https://review.typo3.org/55105
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
23 files changed:
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/ManualExecution/Index.rst
typo3/sysext/scheduler/Documentation/Images/AddingATask.png
typo3/sysext/scheduler/Documentation/Images/BackendModuleMainView.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/Installation/CronJob/Index.rst
typo3/sysext/scheduler/Documentation/Installation/Index.rst
typo3/sysext/scheduler/Documentation/Installation/Installing/Index.rst
typo3/sysext/scheduler/Documentation/Installation/SchedulerShellScript/Index.rst
typo3/sysext/scheduler/Documentation/Installation/SchedulerUser/Index.rst [deleted file]
typo3/sysext/scheduler/Documentation/Settings.cfg

index c159fdb..42799f7 100644 (file)
@@ -57,7 +57,12 @@ confirmation message.
    Input validation 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
 Scheduler's built-in cron parser tries to provide an explanation about
 what's wrong.
-
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 ddc9980..9c90db0 100644 (file)
@@ -19,3 +19,10 @@ 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..dd36c2f 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/AddingATask.png and b/typo3/sysext/scheduler/Documentation/Images/AddingATask.png differ
index dcbf78b..2055b0e 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/BackendModuleMainView.png and b/typo3/sysext/scheduler/Documentation/Images/BackendModuleMainView.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..245719a
Binary files /dev/null and b/typo3/sysext/scheduler/Documentation/Images/ExtensionConfiguration.png differ
index 8b62dfc..f3ba4ef 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/GroupRecords.png and b/typo3/sysext/scheduler/Documentation/Images/GroupRecords.png differ
index a6678e0..8a0b8c5 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/GroupedTasks.png and b/typo3/sysext/scheduler/Documentation/Images/GroupedTasks.png differ
index d17fc09..be32e83 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/InformationScreen.png and b/typo3/sysext/scheduler/Documentation/Images/InformationScreen.png differ
index d73c854..32c83ce 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..2a1f2d9
Binary files /dev/null and b/typo3/sysext/scheduler/Documentation/Images/InputValidationOk.png differ
index 182b4c0..7b35c0c 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/LateTask.png and b/typo3/sysext/scheduler/Documentation/Images/LateTask.png differ
index 424bbd0..a7ac50b 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/MissingTaskClass.png and b/typo3/sysext/scheduler/Documentation/Images/MissingTaskClass.png differ
index 55f251d..484d40d 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/SetupCheck.png and b/typo3/sysext/scheduler/Documentation/Images/SetupCheck.png differ
index 08cdad3..d4d3559 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/StoppingATask.png and b/typo3/sysext/scheduler/Documentation/Images/StoppingATask.png differ
index 65badb0..d48bdfa 100644 (file)
Binary files a/typo3/sysext/scheduler/Documentation/Images/TableGarbageCollectionTaskConfiguration.png and b/typo3/sysext/scheduler/Documentation/Images/TableGarbageCollectionTaskConfiguration.png differ
index f406ee3..4942de1 100644 (file)
@@ -57,7 +57,7 @@ and add a line like
 
 ::
 
-   */15 * * * * /usr/local/bin/php /home/bob/www/typo3/cli_dispatch.phpsh scheduler
+   */15 * * * * /usr/local/bin/php /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run
 
 Save the modified crontab. Obviously the paths have to be adapted to
 your system. The above command will call up the Scheduler every 15
@@ -70,7 +70,7 @@ to enter, i.e. the user with which the job should run. Example
 
 ::
 
-   */15 * * * * www /usr/local/bin/php /home/bob/www/typo3/cli_dispatch.phpsh scheduler
+   */15 * * * * www /usr/local/bin/php /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run
 
 This will run the job as user "www".
 
@@ -95,7 +95,7 @@ following command line to create a new task:
 
 ::
 
-   schtasks /create /sc minute /mo 15 /tn "T3scheduler" /tr "c:\winstaller\php\php.exe c:\winstaller\htdocs\quickstart\typo3\cli_dispatch.phpsh scheduler"
+   schtasks /create /sc minute /mo 15 /tn "T3scheduler" /tr "c:\winstaller\php\php.exe c:\winstaller\htdocs\quickstart\typo3\sysext\core\bin\typo3 scheduler:run"
 
 At task creation you will be prompted to give a password or you can
 use the :code:`/u` and :code:`/p` switches to provide user and
@@ -104,4 +104,3 @@ Administrators group on the computer where the command will run.
 
 The full reference for :code:`schtasks` is available at:
 http://technet.microsoft.com/en-us/library/bb490996.aspx
-
index 08da373..55152a9 100644 (file)
@@ -20,8 +20,6 @@ Installation
 
    Installing/Index
    SetupCheck/Index
-   SchedulerUser/Index
    SchedulerShellScript/Index
    CronJob/Index
    BaseTasks/Index
-
index 05fbd31..0f4f60e 100644 (file)
@@ -36,3 +36,7 @@ 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
index 7449236..4001684 100644 (file)
@@ -14,12 +14,22 @@ The Scheduler shell script
 
 The Scheduler provides a PHP shell script designed to be run using
 TYPO3's command-line dispatcher. To try and run that script a first
-time, type the following command (adapting the path to PHP and TYPO3
-to match your system):
+time, type the following command (adapting the path to TYPO3
+to match your system and add the full path to the php interpreter
+in front of the command if php is not on the search path):
 
 ::
 
-   /usr/local/bin/php /home/bob/www/typo3/cli_dispatch.phpsh scheduler
+   /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run
+   /usr/local/bin/php /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run
+
+If your installation is a composer based instance you can use this command line
+in your installation directory:
+
+::
+
+   bin/typo3 scheduler:run
+   /usr/local/bin/php bin/typo3 scheduler:run
 
 
 .. _options:
@@ -34,7 +44,7 @@ To run a specific scheduler task you need to provide the uid of the task:
 
 ::
 
-   /usr/local/bin/php /home/bob/www/typo3/cli_dispatch.phpsh scheduler --task=8
+   /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run --task=8
 
 The example will trigger the task with uid 8.
 
@@ -42,6 +52,6 @@ To run a task even if it is disabled, you need to provide the force option
 
 ::
 
-   /usr/local/bin/php /home/bob/www/typo3/cli_dispatch.phpsh scheduler --task=8 -f
+   /home/user/www/typo3/sysext/core/bin/typo3 scheduler:run --task=8 -f
 
 This will also run the task with uid 8 if it is disabled.
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 81212a8..a52a769 100644 (file)
@@ -1,12 +1,11 @@
 [general]
 
 project     = Scheduler
-version     = 7
-release     = 7
+version     = 8.7
+release     = 8.7
 t3author    = Fran├žois Suter
 copyright   = 1997-2017
 
 description = This is the documentation of TYPO3's system
       extension 'scheduler' which lets you register tasks
       to happen at a specific time.
-