Skip to content
Snippets Groups Projects
Commit cf4d8531 authored by linawolf's avatar linawolf Committed by Lina Wolf
Browse files

[DOCS] Switch adminpanel docs to PHP-based rendering

* 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: default avatarBenni Mack <benni@typo3.org>
Tested-by: default avatarChris Müller <typo3@krue.ml>
Reviewed-by: default avatarLina Wolf <112@linawolf.de>
Tested-by: default avatarcore-ci <typo3@b13.com>
Tested-by: default avatarLina Wolf <112@linawolf.de>
Reviewed-by: default avatarChris Müller <typo3@krue.ml>
Tested-by: default avatarBenni Mack <benni@typo3.org>
parent 7cbc2484
Branches
Tags
No related merge requests found
......@@ -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**
......@@ -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
......@@ -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.
......@@ -89,7 +92,7 @@ admPanel.enable
admPanel.hide
-------------
.. t3-user-tsconfig:: admPanel.hide
.. confval:: admPanel.hide
:Type: boolean
......@@ -105,7 +108,7 @@ admPanel.hide
admPanel.override
-----------------
.. t3-user-tsconfig:: admPanel.override
.. confval:: admPanel.override
:Type: object
......
.. 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
......@@ -53,4 +53,3 @@ contains a range of metrics including debug and caching information.
:hidden:
Sitemap
genindex
# More information about this file:
# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg
[general]
project = Admin Panel
version = main (development)
release = main (development)
copyright = since 2018 by the TYPO3 contributors
[html_theme_options]
# "Edit on GitHub" button
github_repository = typo3/typo3
github_branch = main
path_to_documentation_dir = typo3/sysext/adminpanel/Documentation/
# Footer links
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
project_discussions =
use_opensearch =
[sphinx_object_types_to_add]
t3-typoscript = t3-typoscript // t3-typoscript // TypoScript
t3-user-tsconfig = t3-user-tsconfig // t3-user-tsconfig // User TSconfig
[intersphinx_mapping]
# Official TYPO3 manuals
# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/
# t3content = https://docs.typo3.org/m/typo3/guide-contentandmarketing/main/en-us/
# t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/
# t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/
# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/
# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/
# t3home = https://docs.typo3.org/
# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/
# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/
# t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/
# t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/
t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/
# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/
# t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/
# t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/
# TYPO3 system extensions
# ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/main/en-us/
# ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/
# ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/main/en-us/
# ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/
# ext_form = https://docs.typo3.org/c/typo3/cms-form/main/en-us/
# ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/
# ext_impexp = https://docs.typo3.org/c/typo3/cms-impexp/main/en-us/
# ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/
# ext_linkvalidator = https://docs.typo3.org/c/typo3/cms-linkvalidator/main/en-us/
# ext_lowlevel = https://docs.typo3.org/c/typo3/cms-lowlevel/main/en-us/
# ext_reactions = https://docs.typo3.org/c/typo3/cms-reactions/main/en-us/
# ext_recycler = https://docs.typo3.org/c/typo3/cms-recycler/main/en-us/
# ext_redirects = https://docs.typo3.org/c/typo3/cms-redirects/main/en-us/
# ext_reports = https://docs.typo3.org/c/typo3/cms-reports/main/en-us/
# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/
# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/
# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/
# ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/
.. include:: /Includes.rst.txt
=====
Index
=====
.. Sphinx will insert here the general index automatically.
<?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% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment