From 8c64beaa47eb9fed39f18a0ed0a3c01860bc1288 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Chris=20M=C3=BCller?= <2566282+brotkrueml@users.noreply.github.com> Date: Mon, 8 Apr 2024 17:06:38 +0000 Subject: [PATCH] [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 --- .../HelpInside/BackendSearch/Index.rst | 20 ++++ Documentation/HelpInside/Index.rst | 93 ++++--------------- .../HelpInside/OnlineDocumentation/Index.rst | 21 +++++ Documentation/HelpInside/Tooltips/Index.rst | 16 ++++ .../HelpInside/BackendSearch/Index.rst | 19 ++++ .../Localization.ru_RU/HelpInside/Index.rst | 81 +++------------- .../HelpInside/OnlineDocumentation/Index.rst | 22 +++++ .../HelpInside/Tooltips/Index.rst | 16 ++++ 8 files changed, 144 insertions(+), 144 deletions(-) create mode 100644 Documentation/HelpInside/BackendSearch/Index.rst create mode 100644 Documentation/HelpInside/OnlineDocumentation/Index.rst create mode 100644 Documentation/HelpInside/Tooltips/Index.rst create mode 100644 Documentation/Localization.ru_RU/HelpInside/BackendSearch/Index.rst create mode 100644 Documentation/Localization.ru_RU/HelpInside/OnlineDocumentation/Index.rst create mode 100644 Documentation/Localization.ru_RU/HelpInside/Tooltips/Index.rst diff --git a/Documentation/HelpInside/BackendSearch/Index.rst b/Documentation/HelpInside/BackendSearch/Index.rst new file mode 100644 index 0000000..31461b9 --- /dev/null +++ b/Documentation/HelpInside/BackendSearch/Index.rst @@ -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 diff --git a/Documentation/HelpInside/Index.rst b/Documentation/HelpInside/Index.rst index daeb510..8b43f58 100644 --- a/Documentation/HelpInside/Index.rst +++ b/Documentation/HelpInside/Index.rst @@ -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 diff --git a/Documentation/HelpInside/OnlineDocumentation/Index.rst b/Documentation/HelpInside/OnlineDocumentation/Index.rst new file mode 100644 index 0000000..8f31b90 --- /dev/null +++ b/Documentation/HelpInside/OnlineDocumentation/Index.rst @@ -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 diff --git a/Documentation/HelpInside/Tooltips/Index.rst b/Documentation/HelpInside/Tooltips/Index.rst new file mode 100644 index 0000000..7e8c616 --- /dev/null +++ b/Documentation/HelpInside/Tooltips/Index.rst @@ -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 diff --git a/Documentation/Localization.ru_RU/HelpInside/BackendSearch/Index.rst b/Documentation/Localization.ru_RU/HelpInside/BackendSearch/Index.rst new file mode 100644 index 0000000..afb1b21 --- /dev/null +++ b/Documentation/Localization.ru_RU/HelpInside/BackendSearch/Index.rst @@ -0,0 +1,19 @@ +.. include:: /Includes.rst.txt + +.. _backend-search: + +============================== +Поиск во внутреннем интерфейсе +============================== + +Инструмент поиска по внутреннему интерфейсу воспринимает текст и осуществляет +поиск по различным типам записей во внутреннем интерфейсе. + +Поиск можно открыть, выбрав лупу в правом верхнем углу панели инструментов или, +начиная с TYPO3 v12, двойным нажатием клавиши :kbd:`Shift`. + +.. figure:: /Images/ManualScreenshots/Help/BackendSearch.png + :alt: Модуль поиска во внутреннем интерфейсе с результатами поиска. + :class: with-border + + Модуль поиска во внутреннем интерфейсе с результатами поиска. diff --git a/Documentation/Localization.ru_RU/HelpInside/Index.rst b/Documentation/Localization.ru_RU/HelpInside/Index.rst index 32d013d..03a17f6 100644 --- a/Documentation/Localization.ru_RU/HelpInside/Index.rst +++ b/Documentation/Localization.ru_RU/HelpInside/Index.rst @@ -1,77 +1,24 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. _help-inside: +.. _help-inside: -========================= -Помощь в рамках TYPO3 CMS -========================= - -Во внутренний интерфейс встроено несколько функций, облегчающих работу с TYPO3 CMS. - -.. versionchanged:: 12.0 - Контекстно-зависимая справка, называемая также "CSH", была удалена, так как она устарела и не поддерживалась. Вместо этого обращайтесь к :ref:`typo3-online-documentation`. - -Всплывающие подсказки ===================== - -При наведении указателя мыши на кнопки и значки отображается краткое описание функции. - -.. figure:: /Images/ManualScreenshots/Help/Tooltip.png - :alt: Всплывающая подсказка для модуля Формы / Forms - :class: with-border - - Просмотр справки по всплывающим подсказкам для модуля Формы / Forms - -.. _typo3-online-documentation: - -Онлайн-документация TYPO3 -========================= - -Начальную страницу официальной документации TYPO3 можно найти по адресу https://docs.typo3.org/ . - -Настоящий документ удобней просматривать из внутреннего интерфейса TYPO3: - -В верхней панели нажмите на значок вопросительного знака, для того для перехода в раздел "Справка", затем выберите модуль :guilabel:`Онлайн документация TYPO3` / :guilabel:`TYPO3 Online Documentation`. - -.. figure:: /Images/ManualScreenshots/Help/Typo3OnlineDocumentation.png - :alt: Онлайн-документация TYPO3 в меню Справка - :class: with-border - - :guilabel:`Онлайн документация TYPO3` / :guilabel:`TYPO3 Online Documentation` в меню :guilabel:`Справка` / :guilabel:`Help` - - -Клавиатурные команды -==================== - -Всплывающие подсказки +Помощь в рамках TYPO3 ===================== -При наведении указателя мыши на кнопки и значки отображается краткое описание функции. - -.. figure:: /Images/ManualScreenshots/Help/Tooltip.png - :alt: Всплывающая подсказка для модуля Формы / Forms - :class: with-border - - Просмотр справки по всплывающим подсказкам для модуля Формы / Forms - -.. _backend-search: - -Поиск во внутреннем интерфейсе -============================== - -Инструмент поиска по внутреннему интерфейсу воспринимает текст и осуществляет поиск по различным типам записей во внутреннем интерфейсе. +Во внутренний интерфейс встроено несколько функций, облегчающих работу с TYPO3. -Поиск можно открыть, выбрав лупу в правом верхнем углу панели инструментов или, начиная с TYPO3 v12, двойным нажатием клавиши :kbd:`Shift`. +.. versionchanged:: 12.0 + Контекстно-зависимая справка, называемая также "CSH", была удалена, так как + она устарела и не поддерживалась. Вместо этого обращайтесь к + :ref:`typo3-online-documentation`. -.. figure:: /Images/ManualScreenshots/Help/BackendSearch.png - :alt: Модуль поиска во внутреннем интерфейсе с результатами поиска. - :class: with-border - Модуль поиска во внутреннем интерфейсе с результатами поиска. +Topics +====== -.. toctree:: - :maxdepth: 5 - :titlesonly: - :glob: +.. toctree:: + :titlesonly: + :glob: - KeyboardCommands/Index + */Index diff --git a/Documentation/Localization.ru_RU/HelpInside/OnlineDocumentation/Index.rst b/Documentation/Localization.ru_RU/HelpInside/OnlineDocumentation/Index.rst new file mode 100644 index 0000000..eef6c6c --- /dev/null +++ b/Documentation/Localization.ru_RU/HelpInside/OnlineDocumentation/Index.rst @@ -0,0 +1,22 @@ +.. include:: /Includes.rst.txt + +.. _typo3-online-documentation: + +========================= +Онлайн-документация TYPO3 +========================= + +Начальную страницу официальной документации TYPO3 можно найти по адресу +https://docs.typo3.org/ . + +Настоящий документ удобней просматривать из внутреннего интерфейса TYPO3: + +В верхней панели нажмите на значок вопросительного знака, для того для перехода +в раздел "Справка", затем выберите модуль +:guilabel:`Онлайн документация TYPO3` / :guilabel:`TYPO3 Online Documentation`. + +.. figure:: /Images/ManualScreenshots/Help/Typo3OnlineDocumentation.png + :alt: Онлайн-документация TYPO3 в меню Справка + :class: with-border + + :guilabel:`Онлайн документация TYPO3` / :guilabel:`TYPO3 Online Documentation` в меню :guilabel:`Справка` / :guilabel:`Help` diff --git a/Documentation/Localization.ru_RU/HelpInside/Tooltips/Index.rst b/Documentation/Localization.ru_RU/HelpInside/Tooltips/Index.rst new file mode 100644 index 0000000..01ad4ad --- /dev/null +++ b/Documentation/Localization.ru_RU/HelpInside/Tooltips/Index.rst @@ -0,0 +1,16 @@ +.. include:: /Includes.rst.txt + +.. _tooltips: + +===================== +Всплывающие подсказки +===================== + +При наведении указателя мыши на кнопки и значки отображается краткое описание +функции. + +.. figure:: /Images/ManualScreenshots/Help/Tooltip.png + :alt: Всплывающая подсказка для модуля Формы / Forms + :class: with-border + + Просмотр справки по всплывающим подсказкам для модуля Формы / Forms