-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Split up "Help within TYPO3" chapter (#161)
Previously, the keyboard commands were already a separate page which was displayed as a link at the bottom of a page and can easily overlooked. As the keyboard commands chapter is already a bit longer, the other topics have been moved to separate pages (instead of integrating the keyboard commands into the existing page). This also leaves room for improvement of each topic. Releases: main, 12.4
- Loading branch information
1 parent
bb7a91c
commit 7938371
Showing
4 changed files
with
73 additions
and
77 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
.. include:: /Includes.rst.txt | ||
|
||
.. _backend-search: | ||
|
||
============== | ||
Backend search | ||
============== | ||
|
||
The backend search tool accepts text and searches against | ||
various types of records in the backend. | ||
|
||
The search can be opened by selecting the magnifying glass in the top right | ||
corner of the toolbar or - starting with TYPO3 v12 - by hitting :kbd:`Shift` | ||
twice in a row. | ||
|
||
.. figure:: /Images/ManualScreenshots/Help/BackendSearch.png | ||
:alt: The backend search modal with some search results | ||
:class: with-border | ||
|
||
The backend search modal with some search results |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,85 +1,24 @@ | ||
.. include:: /Includes.rst.txt | ||
.. include:: /Includes.rst.txt | ||
|
||
.. _help-inside: | ||
.. _help-inside: | ||
|
||
===================== | ||
Help within TYPO3 CMS | ||
===================== | ||
|
||
There are several features built-in to the user interface of the backend to | ||
help guide you when using the TYPO3 CMS. | ||
|
||
.. versionchanged:: 12.0 | ||
The context sensitive help, also called "CSH" has been removed as it was | ||
outdated and not maintained. Refer to the | ||
:ref:`typo3-online-documentation` instead. | ||
|
||
Tooltips | ||
======== | ||
|
||
Hover your mouse pointer over buttons and icons to display a short description of the function. | ||
|
||
.. figure:: /Images/ManualScreenshots/Help/Tooltip.png | ||
:alt: Tooltip for the Forms module | ||
:class: with-border | ||
|
||
See the Tooltip help for the Forms module | ||
|
||
.. _typo3-online-documentation: | ||
|
||
TYPO3 online documentation | ||
=========================== | ||
|
||
You can find the startpage of the official TYPO3 documentation at | ||
https://docs.typo3.org/ . | ||
|
||
You can conveniently open this documentation from your TYPO3 backend: | ||
|
||
In the top bar, click the question mark icon to access the | ||
Help section, then select the :guilabel:`TYPO3 Online Documentation` module. | ||
|
||
.. figure:: /Images/ManualScreenshots/Help/Typo3OnlineDocumentation.png | ||
:alt: The TYPO3 Online Documentation in the Help menu | ||
:class: with-border | ||
|
||
The :guilabel:`TYPO3 Online Documentation` in the :guilabel:`Help` menu | ||
|
||
|
||
Keyboard commands | ||
================= | ||
Help within TYPO3 | ||
================= | ||
|
||
Tooltips | ||
======== | ||
|
||
Hover your mouse pointer over buttons and icons to display a short description of the function. | ||
|
||
.. figure:: /Images/ManualScreenshots/Help/Tooltip.png | ||
:alt: Tooltip for the Forms module | ||
:class: with-border | ||
|
||
See the Tooltip help for the Forms module | ||
|
||
.. _backend-search: | ||
|
||
Backend search | ||
============== | ||
|
||
The backend search tool accepts text and searches against | ||
various types of records in the backend. | ||
|
||
The search can be opened by selecting the magnifying glass in the top right corner of | ||
the toolbar or - starting with TYPO3 v12 - by hitting :kbd:`Shift` twice in a | ||
row. | ||
There are several features built-in to the user interface of the backend to | ||
help guide you when using the TYPO3. | ||
|
||
.. figure:: /Images/ManualScreenshots/Help/BackendSearch.png | ||
:alt: The backend search modal with some search results. | ||
:class: with-border | ||
.. versionchanged:: 12.0 | ||
The context sensitive help, also called "CSH" has been removed as it was | ||
outdated and not maintained. Refer to the | ||
:ref:`typo3-online-documentation` instead. | ||
|
||
The backend search modal with some search results. | ||
Topics | ||
====== | ||
|
||
.. toctree:: | ||
:maxdepth: 5 | ||
:titlesonly: | ||
:glob: | ||
.. toctree:: | ||
:titlesonly: | ||
:glob: | ||
|
||
KeyboardCommands/Index | ||
*/Index |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
.. include:: /Includes.rst.txt | ||
|
||
.. _typo3-online-documentation: | ||
|
||
========================== | ||
TYPO3 online documentation | ||
========================== | ||
|
||
You can find the startpage of the official TYPO3 documentation at | ||
https://docs.typo3.org/ . | ||
|
||
You can conveniently open this documentation from your TYPO3 backend: | ||
|
||
In the top bar, click the question mark icon to access the | ||
Help section, then select the :guilabel:`TYPO3 Online Documentation` module. | ||
|
||
.. figure:: /Images/ManualScreenshots/Help/Typo3OnlineDocumentation.png | ||
:alt: The TYPO3 Online Documentation in the Help menu | ||
:class: with-border | ||
|
||
The :guilabel:`TYPO3 Online Documentation` in the :guilabel:`Help` menu |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
.. include:: /Includes.rst.txt | ||
|
||
.. _tooltips: | ||
|
||
======== | ||
Tooltips | ||
======== | ||
|
||
Hover your mouse pointer over buttons and icons to display a short description | ||
of the function. | ||
|
||
.. figure:: /Images/ManualScreenshots/Help/Tooltip.png | ||
:alt: Tooltip for the Forms module | ||
:class: with-border | ||
|
||
See the Tooltip help for the Forms module |