Skip to content

Commit

Permalink
[TASK] Split up "Help within TYPO3" chapter (#161)
Browse files Browse the repository at this point in the history
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
brotkrueml committed Apr 9, 2024
1 parent bb7a91c commit 7938371
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 77 deletions.
20 changes: 20 additions & 0 deletions Documentation/HelpInside/BackendSearch/Index.rst
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
93 changes: 16 additions & 77 deletions Documentation/HelpInside/Index.rst
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
21 changes: 21 additions & 0 deletions Documentation/HelpInside/OnlineDocumentation/Index.rst
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
16 changes: 16 additions & 0 deletions Documentation/HelpInside/Tooltips/Index.rst
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

0 comments on commit 7938371

Please sign in to comment.