Skip to content

Commit fb20a83

Browse files
linawolfgarvinhicking
linawolf
authored and
garvinhicking
committed
[DOCS] Adjust indentation and headlines in EXT:lowlevel
Non-generic headlines are crucial to both external search engines and our on-site elastic search. Subheadlines in chapter "Command line" are excluded, as they will be overhauled and restructured in a follow up. Anchors and therefore permalinks were missing in places, and are now fixed. Indentations are adjusted, too. Resolves: #106923 Releases: main, 13.4, 12.4 Change-Id: Idafa617cae64b4483a0b0dec503940902f0fef84 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/89784 Reviewed-by: Garvin Hicking <garvin@hick.ing> Tested-by: Garvin Hicking <garvin@hick.ing> Tested-by: core-ci <typo3@b13.com> Reviewed-by: Stefan Bürk <stefan@buerk.tech> Tested-by: Stefan Bürk <stefan@buerk.tech>
1 parent 5ab86d2 commit fb20a83

File tree

8 files changed

+109
-108
lines changed

8 files changed

+109
-108
lines changed

‎typo3/sysext/lowlevel/Documentation/BackendModules/DbCheck.rst‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
.. include:: /Includes.rst.txt
1+
:navigation-title: DB Check
22

3-
.. _module-db-check:
3+
.. include:: /Includes.rst.txt
4+
.. _module-db-check:
45

5-
=========================
6-
DB Check
7-
=========================
6+
========================
7+
Module System > DB Check
8+
========================
89

910
Access this module in the TYPO3 backend under :guilabel:`System > DB Check`.
1011

11-
.. include:: /Images/AutomaticScreenshots/Modules/DB_Check.rst.txt
12+
.. include:: /Images/AutomaticScreenshots/Modules/DB_Check.rst.txt
1213

1314
.. card-grid::
1415
:columns: 1
@@ -33,7 +34,7 @@ Access this module in the TYPO3 backend under :guilabel:`System > DB Check`.
3334
Can be used on smaller installations to check or update the
3435
reference index.
3536

36-
.. toctree::
37+
.. toctree::
3738
:hidden:
3839
:titlesonly:
3940

‎typo3/sysext/lowlevel/Documentation/BackendModules/Index.rst‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
.. include:: /Includes.rst.txt
1+
:navigation-title: Backend Modules
22

3-
.. _backend-modules:
3+
.. include:: /Includes.rst.txt
4+
.. _backend-modules:
45

5-
===============
6-
Backend modules
7-
===============
6+
========================================
7+
Backend modules provided by EXT:lowlevel
8+
========================================
89

910
The Lowlevel system extension provides two backend modules:
1011

@@ -26,7 +27,7 @@ The Lowlevel system extension provides two backend modules:
2627
module can be used to debug the final output. Configuration values
2728
cannot be changed in this module.
2829

29-
.. toctree::
30+
.. toctree::
3031
:hidden:
3132
:titlesonly:
3233

‎typo3/sysext/lowlevel/Documentation/CommandLine/Index.rst‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,32 @@
1-
.. include:: /Includes.rst.txt
1+
:navigation-title: Command line
22

3-
.. _command-line:
3+
.. include:: /Includes.rst.txt
4+
.. _command-line:
45

5-
============
6-
Command line
7-
============
6+
===========================================
7+
Command line tools provided by EXT:lowlevel
8+
===========================================
89

910
Preparations
1011
============
1112

12-
.. warning::
13+
.. warning::
1314
**THERE IS ABSOLUTELY NO WARRANTY** associated with this script! It is completely on
1415
your OWN RISK that you run it. It may cause accidental data loss due to software
1516
bugs or circumstances that it does not know about yet - or data loss might
1617
happen due to misuse!
1718

1819
**Always** make a complete backup of your website! That means:
1920

20-
* Dump the complete database to an SQL file. This can usually be done from the
21-
command line like this::
21+
* Dump the complete database to an SQL file. This can usually be done from the
22+
command line like this::
2223

23-
mysqldump [database name] -u [database user] -p --add-drop-table > ./mywebsite.sql
24+
mysqldump [database name] -u [database user] -p --add-drop-table > ./mywebsite.sql
2425

25-
* Save all files in the webroot of your site. This can be achieved from the
26-
command line like this::
26+
* Save all files in the webroot of your site. This can be achieved from the
27+
command line like this::
2728

28-
tar czf ./mywebsite.tgz [webroot directory of your site]
29+
tar czf ./mywebsite.tgz [webroot directory of your site]
2930

3031
It could be a good idea to run a `myisamchk` on your database just to make sure
3132
MySQL has everything pulled together right.
@@ -69,30 +70,30 @@ It kind of gets simpler that way since the complexity mostly is when you wish to
6970
run all tests successively in which case there is an optimal order that ensures
7071
you don't have to run the tests all over again.
7172

72-
- `[base command] cleanup:orphanrecords`
73+
- `[base command] cleanup:orphanrecords`
7374

74-
- As a beginning, get all orphaned records out of the system since you
75-
probably want to. Since orphan records may keep some missing relations from
76-
being detected it's a good idea to get them out immediately.
75+
- As a beginning, get all orphaned records out of the system since you
76+
probably want to. Since orphan records may keep some missing relations from
77+
being detected it's a good idea to get them out immediately.
7778

78-
- `[base command] cleanup:deletedrecords`
79+
- `[base command] cleanup:deletedrecords`
7980

80-
- Flush deleted records. As a rule of thumb, tools that create deleted records
81-
should be run before this one so the deleted records they create are also
82-
flushed (if you like to of course).
81+
- Flush deleted records. As a rule of thumb, tools that create deleted records
82+
should be run before this one so the deleted records they create are also
83+
flushed (if you like to of course).
8384

84-
- `[base command] cleanup:missingrelations`
85+
- `[base command] cleanup:missingrelations`
8586

86-
- Remove missing relations at this point.
87-
- If you get an error like this: "\TYPO3\CMS\Core\Database\ReferenceIndex::setReferenceValue(): ERROR: No reference
88-
record with hash="132ddb399c0b15593f0d95a58159439f" was found!" just run the test again until no errors occur.
89-
The reason is that another fixed reference in the same record and field changed the reference index hash. Running
90-
the test again will find the new hash string which will then work for you.
87+
- Remove missing relations at this point.
88+
- If you get an error like this: "\TYPO3\CMS\Core\Database\ReferenceIndex::setReferenceValue(): ERROR: No reference
89+
record with hash="132ddb399c0b15593f0d95a58159439f" was found!" just run the test again until no errors occur.
90+
The reason is that another fixed reference in the same record and field changed the reference index hash. Running
91+
the test again will find the new hash string which will then work for you.
9192

92-
- `[base command] cleanup:flexforms`
93+
- `[base command] cleanup:flexforms`
9394

94-
- After the "deleted" tool since we cannot clean-up deleted records and to
95-
make sure nothing unimportant is cleaned up.
95+
- After the "deleted" tool since we cannot clean-up deleted records and to
96+
make sure nothing unimportant is cleaned up.
9697

9798

9899
Nightly reports of problems in the system

‎typo3/sysext/lowlevel/Documentation/Configuration/Index.rst‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
.. include:: /Includes.rst.txt
1+
:navigation-title: Configuration
22

3-
.. _configuration:
3+
.. include:: /Includes.rst.txt
4+
.. _configuration:
45

5-
=============
6-
Configuration
7-
=============
6+
=========================================
7+
Configuration of the EXT:lowlevel modules
8+
=========================================
89

910
.. card-grid::
1011
:columns: 1
@@ -17,7 +18,7 @@ Configuration
1718

1819
Configures display and function of the backend modules.
1920

20-
.. toctree::
21+
.. toctree::
2122
:hidden:
2223
:titlesonly:
2324

‎typo3/sysext/lowlevel/Documentation/Configuration/TSconfig.rst‎

Lines changed: 30 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
1-
.. include:: /Includes.rst.txt
2-
3-
.. _configuration-tsconfig:
4-
5-
========
6-
TSconfig
7-
========
8-
9-
.. _configuration-full-search:
1+
:navigation-title: TSconfig
2+
.. include:: /Includes.rst.txt
3+
.. _configuration-tsconfig:
4+
.. _configuration-full-search:
105

6+
=========================================
117
User TSconfig of the module "Full Search"
128
=========================================
139

@@ -18,29 +14,27 @@ can be configured with the following
1814
See also the chapter of :ref:`Setting user TSconfig
1915
<t3tsref:setting-page-tsconfig>`.
2016

21-
.. include:: /Images/AutomaticScreenshots/Modules/DB_Check_Advanced_query_tt_content.rst.txt
22-
23-
.. confval:: disableStoreControl
17+
.. include:: /Images/AutomaticScreenshots/Modules/DB_Check_Advanced_query_tt_content.rst.txt
2418

25-
:Path: mod.dbint
19+
.. confval:: disableStoreControl
20+
:Path: mod.dbint.disableStoreControl
2621
:type: bool
2722
:Default: false
2823

2924
By default administrators can store and load their search configurations.
3025

3126
Disable the display of the load and save configuration controls:
3227

33-
.. code-block:: typoscript
28+
.. code-block:: typoscript
3429
:caption: User TSconfig
3530
3631
mod.dbint {
3732
disableStoreControl = 1
3833
disableSelectATable = 0
3934
}
4035
41-
.. confval:: disableShowSQLQuery
42-
43-
:Path: mod.dbint
36+
.. confval:: disableShowSQLQuery
37+
:Path: mod.dbint.disableShowSQLQuery
4438
:type: bool
4539
:Default: false
4640

@@ -50,16 +44,15 @@ See also the chapter of :ref:`Setting user TSconfig
5044
If this option is set to true the raw SQL query of the search is
5145
not displayed in either case:
5246

53-
.. code-block:: typoscript
47+
.. code-block:: typoscript
5448
:caption: User TSconfig
5549
5650
mod.dbint {
5751
disableShowSQLQuery = 1
5852
}
5953
60-
.. confval:: disableSelectATable
61-
62-
:Path: mod.dbint
54+
.. confval:: disableSelectATable
55+
:Path: mod.dbint.disableSelectATable
6356
:type: bool
6457
:Default: false
6558

@@ -71,17 +64,16 @@ See also the chapter of :ref:`Setting user TSconfig
7164
:guilabel:`System > DB Check > Full Search > Advanced query` cannot be used
7265
at all by the affected administrator.
7366

74-
.. code-block:: typoscript
67+
.. code-block:: typoscript
7568
:caption: User TSconfig
7669
7770
mod.dbint {
7871
disableStoreControl = 0
7972
disableSelectATable = 1
8073
}
8174
82-
.. confval:: disableSelectFields
83-
84-
:Path: mod.dbint
75+
.. confval:: disableSelectFields
76+
:Path: mod.dbint.disableSelectFields
8577
:type: bool
8678
:Default: false
8779

@@ -93,69 +85,65 @@ See also the chapter of :ref:`Setting user TSconfig
9385
default fields or the fields specified by a saved query and cannot change
9486
them.
9587

96-
.. code-block:: typoscript
88+
.. code-block:: typoscript
9789
:caption: User TSconfig
9890
9991
mod.dbint {
10092
disableSelectFields = 1
10193
}
10294
103-
.. confval:: disableMakeQuery
104-
105-
:Path: mod.dbint
95+
.. confval:: disableMakeQuery
96+
:Path: mod.dbint.disableMakeQuery
10697
:type: bool
10798
:Default: false
10899

109100
Disables the :guilabel:`Make Query` section. Results cannot be filtered
110101
by fields then, unless saved queries are provided.
111102

112-
.. code-block:: typoscript
103+
.. code-block:: typoscript
113104
:caption: User TSconfig
114105
115106
mod.dbint {
116107
disableMakeQuery = 1
117108
}
118109
119-
.. confval:: disableGroupBy
120-
121-
:Path: mod.dbint
110+
.. confval:: disableGroupBy
111+
:Path: mod.dbint.disableGroupBy
122112
:type: bool
123113
:Default: false
124114

125115
Disables the group by functionality.
126116

127-
.. code-block:: typoscript
117+
.. code-block:: typoscript
128118
:caption: User TSconfig
129119
130120
mod.dbint {
131121
disableGroupBy = 1
132122
}
133123
134-
.. confval:: disableOrderBy
135-
136-
:Path: mod.dbint
124+
.. confval:: disableOrderBy
125+
:Path: mod.dbint.disableOrderBy
137126
:type: bool
138127
:Default: false
139128

140129
Disables the order by functionality.
141130

142131

143-
.. code-block:: typoscript
132+
.. code-block:: typoscript
144133
:caption: User TSconfig
145134
146135
mod.dbint {
147136
disableOrderBy = 1
148137
}
149138
150-
.. confval:: disableLimit
151-
152-
:Path: mod.dbint
139+
.. confval:: disableLimit
140+
:Path: mod.dbint.disableLimit
153141
:type: bool
154142
:Default: false
155143

156144
Disables changing the limit. The default limit is 100 records.
157145

158-
.. code-block:: typoscript
146+
.. code-block:: typoscript
159147
:caption: User TSconfig
160148
161149
mod.dbint {

‎typo3/sysext/lowlevel/Documentation/Events/Index.rst‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
.. include:: /Includes.rst.txt
1+
:navigation-title: Events
22

3+
.. include:: /Includes.rst.txt
34
.. _psr14events:
45

5-
============
6-
PSR-14 event
7-
============
6+
=============================
7+
PSR-14 events in EXT:lowlevel
8+
=============================
89

910
The following PSR-14 event is available to extend the functionality:
1011

12+
.. _psr14events-ModifyBlindedConfigurationOptionsEvent:
1113

1214
ModifyBlindedConfigurationOptionsEvent
1315
======================================

0 commit comments

Comments
 (0)