Skip to content

Commit

Permalink
[DOCS] Switch adminpanel docs to PHP-based rendering
Browse files Browse the repository at this point in the history
* Introduce a guides.xml, the presence of this file
  triggers the new rendering.
* Replace sphinx-only syntax
* remove superfluous genindex, it is not supported anymore
* Remove old Settings.cfg, was only used for Sphinx

Attention: Backports need manual changes to the guides.xml.

Resolves: #103238
Releases: main, 12.4, 11.5
Change-Id: I5d9239a9217d8d6c2faa08cef58436971ee83113
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83171
Reviewed-by: Benni Mack <benni@typo3.org>
Tested-by: Chris Müller <typo3@krue.ml>
Reviewed-by: Lina Wolf <112@linawolf.de>
Tested-by: core-ci <typo3@b13.com>
Tested-by: Lina Wolf <112@linawolf.de>
Reviewed-by: Chris Müller <typo3@krue.ml>
Tested-by: Benni Mack <benni@typo3.org>
  • Loading branch information
linawolf committed Mar 1, 2024
1 parent 7cbc248 commit cf4d853
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 120 deletions.
17 changes: 10 additions & 7 deletions typo3/sysext/adminpanel/Documentation/Configuration/Index.rst
Expand Up @@ -6,12 +6,12 @@
Configuration
=============

If the TypoScript property :t3-typoscript:`config.admPanel` is set,
If the TypoScript property :ref:`typoscript-config-admpanel` is set,
the admin panel is displayed at the bottom of pages in the frontend for
logged-in backend users.

By default, the Admin Panel is displayed to logged-in admins only. This behaviour
can be changed by setting :t3-user-tsconfig:`admPanel.enable` for certain
can be changed by setting :ref:`tsconfig-admpanel-enable` for certain
backend users or groups.

.. contents:: **Available settings**
Expand All @@ -30,14 +30,14 @@ The following settings can be made in the project's TypoScript setup. See also
config.admPanel
---------------

.. t3-typoscript:: config.admPanel
.. confval:: config.admPanel

:Type: boolean
:Default: false

If set, the Admin Panel displays at the bottom of pages. This applies only
to logged-in admins or backend users with
:t3-user-tsconfig:`admPanel.enable` enabled.
:ref:`tsconfig-admpanel-enable` enabled.

.. rubric:: Example

Expand All @@ -53,10 +53,13 @@ The options below can be set in the user TSconfig of a backend backend user or
group. See also
:ref:`Using and setting user TSconfig <t3tsconfig:setting-user-tsconfig>`.


.. _tsconfig-admpanel-enable:

admPanel.enable
---------------

.. t3-user-tsconfig:: admPanel.enable
.. confval:: admPanel.enable

:Type: array<string, boolean>
:Default: For admin users, `admPanel.enable.all = 1` is default.
Expand Down Expand Up @@ -89,7 +92,7 @@ admPanel.enable
admPanel.hide
-------------

.. t3-user-tsconfig:: admPanel.hide
.. confval:: admPanel.hide

:Type: boolean

Expand All @@ -105,7 +108,7 @@ admPanel.hide
admPanel.override
-----------------

.. t3-user-tsconfig:: admPanel.override
.. confval:: admPanel.override

:Type: object

Expand Down
35 changes: 1 addition & 34 deletions typo3/sysext/adminpanel/Documentation/Includes.rst.txt
@@ -1,34 +1 @@
.. More information about this file:
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
.. ----------
.. text roles
.. ----------
.. role:: aspect(emphasis)
.. role:: bash(code)
.. role:: html(code)
.. role:: js(code)
.. role:: php(code)
.. role:: rst(code)
.. role:: sep(strong)
.. role:: sql(code)

.. role:: tsconfig(code)
:class: typoscript

.. role:: typoscript(code)
.. role:: xml(code)
:class: html

.. role:: yaml(code)

.. default-role:: code

.. ---------
.. highlight
.. ---------
.. By default, code blocks use PHP syntax highlighting
.. highlight:: php
.. You can put central messages to display on all pages here
1 change: 0 additions & 1 deletion typo3/sysext/adminpanel/Documentation/Index.rst
Expand Up @@ -53,4 +53,3 @@ contains a range of metrics including debug and caching information.
:hidden:

Sitemap
genindex
71 changes: 0 additions & 71 deletions typo3/sysext/adminpanel/Documentation/Settings.cfg

This file was deleted.

7 changes: 0 additions & 7 deletions typo3/sysext/adminpanel/Documentation/genindex.rst

This file was deleted.

17 changes: 17 additions & 0 deletions typo3/sysext/adminpanel/Documentation/guides.xml
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<guides xmlns="https://www.phpdoc.org/guides" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd"
links-are-relative="true">
<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
project-home="https://extensions.typo3.org/extension/adminpanel/"
project-contact="https://typo3.slack.com/archives/C025BQLFA"
project-repository="https://github.com/typo3/typo3"
project-issues="https://forge.typo3.org/projects/typo3cms-core/issues"
edit-on-github-branch="main"
edit-on-github="typo3/typo3"
typo3-core-preferred="main"/>
<project title="Admin Panel"
release="main (development)"
version="main (development)"
copyright="since 2018 by the TYPO3 contributors"/>
</guides>

0 comments on commit cf4d853

Please sign in to comment.