Commit bc4093af authored by Alexander Nitsche's avatar Alexander Nitsche Committed by Lina Wolf
Browse files

[DOCS] Align with new TYPO3 documentation standards

- align README.rst, Index.rst, Includes.txt, Includes.rst.txt,
  Settings.cfg
- add genindex.rst, Sitemap.rst
- remove outdated Targets.rst
- reference manual's start page with :doc:`<manual>:Index`

Adding the custom label `start` to the beginning of the manual's
Index.rst is redundant. Use :doc:`<manual>:Index` instead of
:ref:`<manual:start>` to refer to it.

- replace :ts: with :typoscript: text role

The ambiguous :ts: text role has been removed to
not confuse the writer with typescript and typoscript.

- rename Includes.txt to Includes.rst.txt
- align reST validator at Build/Scripts/validateRstFiles.php
- remove outdated encoding note

- fix rendering warnings of EXT:core
- fix rendering warnings of EXT:dashboard
- fix rendering warnings of EXT:linkvalidator
- fix rendering warnings of EXT:lowlevel

See https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html for further details.

Resolves: #97258
Releases: main, 11.5, 10.4
Change-Id: I791c905d294a1eb71bd30ff2260f68be2b22f41e
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/74232

Tested-by: core-ci's avatarcore-ci <typo3@b13.com>
Tested-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Tested-by: Lina Wolf's avatarLina Wolf <112@linawolf.de>
Reviewed-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Lina Wolf's avatarLina Wolf <112@linawolf.de>
parent 8005da65
.. include:: ../../Includes.txt
.. include:: /Includes.rst.txt
========================
Feature: #12345 - Test 2
......
.. include:: ../../Includes.txt
.. include:: /Includes.rst.txt
========================
Feature: #12345 - Test 3
......
.. include:: ../../Includes.txt
.. include:: /Includes.rst.txt
============================
Deprecation: #12345 - Test 4
......
......@@ -140,9 +140,9 @@ class validateRstFiles
$checkFor = [
[
'type' => 'include',
'regex' => '#^\\.\\. include:: \\.\\./\\.\\./Includes.txt#m',
'regex' => '#^\\.\\. include:: /Includes.rst.txt#m',
'title' => 'no include',
'message' => 'insert \'.. include:: ../../Includes.txt\' in first line of the file',
'message' => 'insert \'.. include:: /Includes.rst.txt\' in first line of the file',
],
[
'type' => 'reference',
......
.. include:: /Includes.txt
.. include:: /Includes.rst.txt
.. _configuration:
......
.. include:: ../Includes.txt
.. include:: /Includes.rst.txt
.. _extending:
......
.. This is 'Includes.txt'. It is included at the very top of each and
every ReST source file in THIS documentation project (= manual).
.. More information about this file:
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
.. role:: aspect (emphasis)
.. ----------
.. text roles
.. ----------
.. role:: aspect(emphasis)
.. role:: bash(code)
.. role:: html(code)
.. role:: js(code)
.. role:: php(code)
.. role:: sep (strong)
.. role:: rst(code)
.. role:: sep(strong)
.. role:: sql(code)
.. role:: typoscript(code)
.. role:: yaml(code)
.. role:: ts(typoscript)
.. 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
.. every .rst file should include Includes.txt
.. use correct path!
.. include:: /Includes.rst.txt
.. include:: /Includes.txt
.. Every manual should have a start label for cross-referencing to
.. start page. Do not remove this!
.. _start:
===========
Admin Panel
===========
=================
TYPO3 Admin Panel
=================
:Extension key:
adminpanel
:Package name:
typo3/cms-adminpanel
:Version:
|release|
:Language:
en
:Description:
Manual for the TYPO3 Admin Panel.
:Keywords:
admin panel, frontend, debug
:Copyright:
2021
:Authors:
Felicity Brand
:Author:
Felicity Brand & TYPO3 contributors
:License:
This extension documentation is published under the `CC BY-NC-SA 4.0 <https://creativecommons.org/licenses/by-nc-sa/4.0/>`__ (Creative Commons) license.
This document is published under the
`Creative Commons BY-NC-SA 4.0 <https://creativecommons.org/licenses/by-nc-sa/4.0/>`__
license.
:Rendered:
|today|
**TYPO3**
----
The content of this document is related to TYPO3 CMS,
a GNU/GPL CMS/Framework available from `typo3.org <https://typo3.org/>`_ .
The Admin Panel displays information about your site in the frontend and
contains a range of metrics including debug and caching information.
**For Contributors**
----
You are welcome to help improve this guide.
Just click on "Edit me on GitHub" on the top right to submit your change
request.
**Table of Contents:**
.. toctree::
:maxdepth: 3
:maxdepth: 2
:titlesonly:
Introduction/Index
Installation/Index
......@@ -59,4 +46,11 @@ request.
Inspecting/Index
Settings/Index
Extending/Index
.. Meta Menu
.. toctree::
:hidden:
Sitemap
genindex
.. include:: ../Includes.txt
.. include:: /Includes.rst.txt
.. _debug:
......
.. include:: ../Includes.txt
.. include:: /Includes.rst.txt
.. _inspecting:
......
.. include:: ../Includes.txt
.. include:: /Includes.rst.txt
.. _info:
......
.. include:: ../Includes.txt
.. include:: /Includes.rst.txt
.. _TypoScript:
......
.. include:: ../Includes.txt
.. include:: /Includes.rst.txt
.. _installation:
......
.. include:: ../Includes.txt
.. include:: /Includes.rst.txt
.. _introduction:
......
# #####
#
# Settings.cfg - A TYPO3 Documentation Project's Configuration File
# Information about Settings.cfg:
# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/DirectoryFilenames.html#settings-cfg
#
# About Syntax:
# See https://docs.python.org/2/library/configparser.html
#
# Attention:
# Only " ;" can start an inline comment.
# This is: blank PLUS semicolon!
#
# #####
# 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 = 11.5
release = 11.5
copyright = 2021
description = This is the documentation of TYPO3's system extension 'adminpanel'.
It displays a bar at the bottom of the screen on the frontend,
from which you can access information per page.
copyright = since 2018 by the TYPO3 contributors
[html_theme_options]
# Add 'Edit me on Github' button
github_branch = 11.5
github_repository = typo3/typo3
path_to_documentation_dir = typo3/sysext/adminpanel/Documentation
# "Edit on GitHub" button
github_repository = typo3/typo3
github_branch = 11.5
path_to_documentation_dir = typo3/sysext/adminpanel/Documentation
# Show as related links
project_contact =
project_discussions =
project_home = https://forge.typo3.org/projects/typo3cms-core
project_issues = https://forge.typo3.org/projects/typo3cms-core/issues
# 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 =
[intersphinx_mapping]
# .................................................................................
# for cross-referencing across manuals (intersphinx) with :ref:
#
# You must uncomment all manuals you use in your cross-references
#
# Example usage:
# :ref:`t3contribute:start` will link to start page of Contribution Guide
# .................................................................................
h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/11.5/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/
# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/main/en-us/Index.html
t3install = https://docs.typo3.org/m/typo3/guide-installation/11.5/en-us/
# t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/
# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/
# t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/
# t3templating = https://docs.typo3.org/m/typo3/tutorial-templating-with-fluid/main/en-us/
# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/
t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/11.5/en-us/
t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/11.5/en-us/
[extensions]
# This is required for embedding YouTube videos
any_name_youtube = sphinxcontrib.youtube
# Official TYPO3 manuals
# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/
# t3cheatsheets = https://docs.typo3.org/m/typo3/docs-cheatsheets/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/
# t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/main/en-us/
# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/
# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/main/en-us/
# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/
# t3home = https://docs.typo3.org/
# t3install = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/
# t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
# 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/
# t3templating = https://docs.typo3.org/m/typo3/tutorial-templating/main/en-us/
# t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/11.5/en-us/
t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/11.5/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_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/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.txt
.. include:: /Includes.rst.txt
.. _settings:
......
:template: sitemap.html
.. _sitemap:
.. include:: /Includes.rst.txt
=======
Sitemap
=======
.. template 'sitemap.html' will insert the toctree as a sitemap here below normal contents
.. The sitemap.html template will insert here the page tree automatically.
.. include:: /Includes.rst.txt
=====
Index
=====
.. Sphinx will insert here the general index automatically.
\|
`Contributing <https://docs.typo3.org/m/typo3/guide-contributionworkflow/master/en-us/Index.html>`__ \|
`Help & Support <https://typo3.org/help>`__ \|
==============================
TYPO3 extension ``adminpanel``
==============================
========================================
TYPO3 Admin Panel (typo3/cms-adminpanel)
========================================
The Admin Panel displays information about your site in the frontend and
contains a range of metrics including debug and caching information.
The TYPO3 admin panel provides a panel with additional functionality in
the frontend (Debugging, Caching, Preview...)
:Repository: https://github.com/typo3/typo3
:Issues: https://forge.typo3.org/
:Documentation: https://docs.typo3.org/c/typo3/cms-adminpanel/11.5/en-us/
:Repository: https://github.com/typo3/typo3
:Issues: https://forge.typo3.org/
:Read online: https://docs.typo3.org/c/typo3/cms-adminpanel/11.5/en-us/
:TER: https://extensions.typo3.org/extension/adminpanel/
===========================
TYPO3 extension ``backend``
===========================
This extension includes the TYPO3 backend frame and its basic backend modules,
for example the Login, the Site Configuration, the Pages and the Content module.
:Repository: https://github.com/typo3/typo3
:Issues: https://forge.typo3.org/
:Read online: https://docs.typo3.org/
:TER: https://extensions.typo3.org/extension/backend/
Supports Markdown
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