Skip to content

Commit f23df9c

Browse files
authored
[TASK] Command: Correct indentation and headlines (#5897)
Releases: main, 13.4, 12.4
1 parent 1548935 commit f23df9c

File tree

3 files changed

+50
-49
lines changed

3 files changed

+50
-49
lines changed

Documentation/ApiOverview/CommandControllers/Index.rst

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
:navigation-title: Commands
2-
.. include:: /Includes.rst.txt
32

4-
.. _cli-mode:
5-
.. _cli-mode-dispatcher:
6-
.. _cli-mode-command-controllers:
7-
.. _symfony-console-commands:
3+
.. include:: /Includes.rst.txt
4+
5+
.. _cli-mode:
6+
.. _cli-mode-dispatcher:
7+
.. _cli-mode-command-controllers:
8+
.. _symfony-console-commands:
89

910
======================
1011
Console commands (CLI)
@@ -35,49 +36,49 @@ TYPO3 installation.
3536
may cause problems. Use the :ref:`query builder <database-query-builder>`
3637
or :ref:`DataHandler <datahandler-basics>` where appropriate.
3738

38-
.. _symfony-console-commands-cli:
39+
.. _symfony-console-commands-cli:
3940

4041
Run a command from the command line
4142
===================================
4243

4344
You can list the available commands by calling:
4445

45-
.. tabs::
46+
.. tabs::
4647

47-
.. group-tab:: Composer-based installation
48+
.. group-tab:: Composer-based installation
4849

49-
.. code-block:: bash
50+
.. code-block:: bash
5051
51-
vendor/bin/typo3
52+
vendor/bin/typo3
5253
53-
.. group-tab:: Classic mode installation (no Composer)
54+
.. group-tab:: Classic mode installation (no Composer)
5455

55-
.. code-block:: bash
56+
.. code-block:: bash
5657
57-
typo3/sysext/core/bin/typo3
58+
typo3/sysext/core/bin/typo3
5859
5960
For example, you can clear all caches by calling:
6061

61-
.. include:: /_includes/CliCacheFlush.rst.txt
62+
.. include:: /_includes/CliCacheFlush.rst.txt
6263

6364
Show help for the command:
6465

65-
.. tabs::
66+
.. tabs::
6667

67-
.. group-tab:: Composer-based installation
68+
.. group-tab:: Composer-based installation
6869

69-
.. code-block:: bash
70+
.. code-block:: bash
7071
71-
vendor/bin/typo3 cache:flush -h
72+
vendor/bin/typo3 cache:flush -h
7273
73-
.. group-tab:: Classic mode installation (no Composer)
74+
.. group-tab:: Classic mode installation (no Composer)
7475

75-
.. code-block:: bash
76+
.. code-block:: bash
7677
77-
typo3/sysext/core/bin/typo3 cache:flush -h
78+
typo3/sysext/core/bin/typo3 cache:flush -h
7879
7980
80-
.. _symfony-console-commands-scheduler:
81+
.. _symfony-console-commands-scheduler:
8182

8283
Running the command from the scheduler
8384
======================================
@@ -86,8 +87,8 @@ By default, it is possible to run a command from the :doc:`TYPO3 scheduler
8687
<ext_scheduler:Index>` as well. To do this, select the task :guilabel:`Execute console commands`
8788
followed by your command in the :guilabel:`Schedulable Command` field.
8889

89-
.. note::
90-
You need to save and reopen the task to define command arguments.
90+
.. note::
91+
You need to save and reopen the task to define command arguments.
9192

9293
In order to prevent commands from being set up as scheduler tasks,
9394
see :ref:`deactivating-the-command-in-scheduler`.
@@ -100,6 +101,7 @@ for details on how to create commands.
100101

101102
DataHandler usage
102103
=================
104+
103105
Using the :ref:`DataHandler <datahandler-basics>` in a CLI command requires
104106
backend authentication.
105107
See :ref:`dataHandler-cli-command` for more information.

Documentation/ApiOverview/CommandControllers/ListCommands.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:navigation-title: List Core commands
2+
23
.. include:: /Includes.rst.txt
34

45
.. _symfony-console-commands-list:

Documentation/ApiOverview/CommandControllers/Tutorial.rst

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
1-
.. include:: /Includes.rst.txt
1+
:navigation-title: Create a command
22

3-
.. _console-command-tutorial:
3+
.. include:: /Includes.rst.txt
4+
.. _console-command-tutorial:
45

5-
========
6-
Tutorial
7-
========
8-
9-
Create a console command from scratch
10-
=====================================
6+
===============================================
7+
Tutorial: Create a console command from scratch
8+
===============================================
119

1210
A console command is always situated in an extension. If you want to create
1311
one, :ref:`kickstart a custom extension <extension-kickstart>` or use your
1412
sitepackage extension.
1513

16-
.. _console-command-tutorial-create:
14+
.. _console-command-tutorial-create:
1715

1816
Creating a basic command
1917
========================
@@ -27,7 +25,7 @@ created by different means.
2725
This command can be found in the
2826
`Examples extension <https://github.com/TYPO3-Documentation/t3docs-examples>`__.
2927

30-
.. _console-command-tutorial-registration-services:
28+
.. _console-command-tutorial-registration-services:
3129

3230
1. Register the command
3331
-----------------------
@@ -74,8 +72,8 @@ The following attributes are available:
7472
Give a short description. It will be displayed in the list of commands and
7573
the help information of the command.
7674

77-
.. _deactivating-the-command-in-scheduler:
78-
.. _schedulable:
75+
.. _deactivating-the-command-in-scheduler:
76+
.. _schedulable:
7977

8078
:yaml:`schedulable`
8179
By default, a command can be used in the :doc:`scheduler
@@ -116,7 +114,7 @@ The following two methods should be overridden by your class:
116114
return the constants
117115
:php:`Command::SUCCESS` or :php:`Command::FAILURE`.
118116

119-
.. seealso::
117+
.. seealso::
120118

121119
A detailed description and an example can be found in
122120
`the Symfony Command Documentation <https://symfony.com/doc/current/console.html>`_.
@@ -126,17 +124,17 @@ The following two methods should be overridden by your class:
126124

127125
The above example can be run via command line:
128126

129-
.. tabs::
127+
.. tabs::
130128

131-
.. group-tab:: Composer-based installation
129+
.. group-tab:: Composer-based installation
132130

133-
.. code-block:: bash
131+
.. code-block:: bash
134132
135133
vendor/bin/typo3 examples:dosomething
136134
137-
.. group-tab:: Classic mode installation (no Composer)
135+
.. group-tab:: Classic mode installation (no Composer)
138136

139-
.. code-block:: bash
137+
.. code-block:: bash
140138
141139
typo3/sysext/core/bin/typo3 examples:dosomething
142140
@@ -146,7 +144,7 @@ succeeded.
146144
.. note::
147145
If a newly created or changed command is not found, clear the cache:
148146

149-
.. code-block:: bash
147+
.. code-block:: bash
150148
151149
vendor/bin/typo3 cache:flush
152150
@@ -198,17 +196,17 @@ Add an optional argument and an optional option to your command:
198196
This command takes one optional argument :php:`wizardName` and one optional option,
199197
which can be passed on the command line:
200198

201-
.. tabs::
199+
.. tabs::
202200

203-
.. group-tab:: Composer-based installation
201+
.. group-tab:: Composer-based installation
204202

205-
.. code-block:: bash
203+
.. code-block:: bash
206204
207205
vendor/bin/typo3 examples:createwizard [-b] [wizardName]
208206
209-
.. group-tab:: Classic mode installation (No Composer)
207+
.. group-tab:: Classic mode installation (No Composer)
210208

211-
.. code-block:: bash
209+
.. code-block:: bash
212210
213211
typo3/sysext/core/bin/typo3 examples:createwizard [-b] [wizardName]
214212
@@ -224,7 +222,7 @@ User interaction on the console
224222
You can create a :php:`SymfonyStyle` console user interface from the
225223
:php:`$input` and :php:`$output` parameters to the :php:`execute()` function:
226224

227-
.. code-block:: php
225+
.. code-block:: php
228226
:caption: EXT:examples/Classes/Command/CreateWizardCommand.php
229227
230228
use Symfony\Component\Console\Style\SymfonyStyle;

0 commit comments

Comments
 (0)