Merge pull request #51 from TYPO3-Documentation/task-update-docs

[TASK] Align with new TYPO3 documentation standards

.editorconfig

@@ -0,0 +1,25 @@
+# EditorConfig is awesome: http://EditorConfig.org
+#
+# Use as master: https://github.com/TYPO3-Documentation/T3DocTeam/blob/master/.editorconfig
+
+# top-most EditorConfig file
+root = true
+
+[{*.rst,*.rst.txt}]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 3
+max_line_length = 80
+
+# MD-Files
+[*.md]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+max_line_length = 80

Documentation/Includes.rst.txt

@@ -0,0 +1,34 @@
+.. 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

Documentation/Index.rst

@@ -1,4 +1,4 @@
-.. include:: Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _start:
 
@@ -99,13 +99,26 @@ Inside TYPO3 CMS
 
 .. attention::
 
-   This document has been merged into :ref:`TYPO3 Core API <t3coreapi:start>`
+   This document has been merged into :doc:`TYPO3 Explained <t3coreapi:Index>`
    since core version 9.
 
-.. rst-class:: horizbuttons-tip-xxl
+:Version:
+   |release|
 
-- :ref:`This manual has moved <t3coreapi:start>`
+:Language:
+   en
 
-*Older versions*
-(`v8.7 </typo3cms/InsideTypo3Reference/8.7/>`__):
-Please refer to "Related Links" in the lower left corner of the page.
+:Author:
+   TYPO3 contributors
+
+:License:
+   This document is published under the
+   `Open Publication License <https://www.opencontent.org/openpub/>`__.
+
+:Rendered:
+   |today|
+
+----
+
+This documentation allows a deep insight into the inner workings and
+architecture of the TYPO3 CMS.

Documentation/Settings.cfg

@@ -1,62 +1,62 @@
-# coding: utf-8
-
-# #####
-#
-# Settings.cfg - A TYPO3 Documentation Project's Configuration File
-#
-# About Syntax:
-#   See https://docs.python.org/2/library/configparser.html
-#
-# Put comments in separate lines!
-#
-# #####
-
-
-# Attention:
-#    LEAVE RIGHT SIDE EMPTY for a 'false' value like:
-#       example_of_false_value =
-
+# More information about this file:
+# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg
 
 [general]
 
-; endless list of all of the general simple settings
-; you can use in 'conf.py'
-
 project     = Inside TYPO3 CMS
-version     = latest (9-dev)
-release     = latest (9-dev)
-t3author    = Documentation Team
-copyright   = since 2000 by the TYPO3 Documentation Team
-description = A deep look into the inner workings and architecture of TYPO3 CMS
-
+version     = main
+release     = main
+copyright   = since 2012 by the TYPO3 contributors
 
 [html_theme_options]
 
-; for theme t3SphinxThemeRtd
-
-github_branch        = latest
-github_commit_hash   =
+# "Edit on GitHub" button
 github_repository    = TYPO3-Documentation/TYPO3CMS-Reference-InsideTypo3
-github_revision_msg  =
-github_sphinx_locale =
-project_contact      = mailto:documentation@typo3.org
-project_discussions  =
-project_home         =
-project_issues       = https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-InsideTypo3/issues
+github_branch        = latest
+
+# Footer links
+project_home         = https://docs.typo3.org/m/typo3/reference-inside/main/en-us/
+project_contact      = https://typo3.slack.com/archives/C028JEPJL
 project_repository   = https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-InsideTypo3
-use_opensearch       =
+project_issues       = https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-InsideTypo3/issues
+project_discussions  =
 
+use_opensearch       =
 
 [intersphinx_mapping]
 
-; in this manual we actually use:
-
-t3coreapi        = http://docs.typo3.org/typo3cms/CoreApiReference/
-
-# [extensions]
-
-# sphinxExtTodo = sphinx.ext.todo
-
-
-# For a reference about this file see:
-# https://github.com/marble/typo3-docs-typo3-org-resources/blob/master/userroot/scripts/bin/conf-2015-10.Reference.Settings.cfg
+# 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/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_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/

README.rst

@@ -1,3 +1,14 @@
-Has been merged into "TYPO3 Explained" for version 9+. Older branches still online.
+**Note:** This documentation has been merged into `TYPO3 Explained`_ for version
+9+. Older branches are still online.
 
-https://docs.typo3.org/m/typo3/reference-inside/master/en-us/
+================
+Inside TYPO3 CMS
+================
+
+This documentation allows a deep insight into the inner workings and
+architecture of the TYPO3 CMS.
+
+:Repository:  https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-InsideTypo3
+:Read online: https://docs.typo3.org/m/typo3/reference-inside/main/en-us/
+
+.. _TYPO3 Explained: https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-CoreApi