diff --git a/.editorconfig b/.editorconfig index a1fed51d..095b8cd9 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,9 +1,9 @@ -# EditorConfig is awesome: http://EditorConfig.org +# EditorConfig is awesome: https://EditorConfig.org # -# master file for TYPO3 docs: https://github.com/TYPO3-Documentation/T3DocTeam/blob/main/.editorconfig +# Use as master: https://github.com/TYPO3-Documentation/T3DocTeam/blob/main/.editorconfig # top-most EditorConfig file -root = false +root = true [{*.rst,*.rst.txt}] charset = utf-8 @@ -12,6 +12,7 @@ insert_final_newline = true trim_trailing_whitespace = true indent_style = space indent_size = 3 +max_line_length = 80 # MD-Files [*.md] @@ -21,3 +22,4 @@ insert_final_newline = true trim_trailing_whitespace = true indent_style = space indent_size = 4 +max_line_length = 80 diff --git a/Documentation/Extensions/Management.rst b/Documentation/Extensions/Management.rst index 01b799d3..3a4b43a5 100644 --- a/Documentation/Extensions/Management.rst +++ b/Documentation/Extensions/Management.rst @@ -38,8 +38,8 @@ with a dash in the package name. For example: -Use :shell:`composer require` to install the extension ------------------------------------------------------- +Use :bash:`composer require` to install the extension +----------------------------------------------------- .. code-block:: shell @@ -111,7 +111,7 @@ Then run `composer require` to the install the local extension `my-local-extensi By executing this command, Composer locates `vendor/my-local-extension` and then symlinks it to `typo3conf/ext/my-local-extension` once `composer install` is executed. -The setup from above defines that the extension is to be placed by composer into the folder `:file:packages/my-local-extension` +The setup from above defines that the extension is to be placed by composer into the folder `:file:packages/my-local-extension` if it has not been already there. diff --git a/Documentation/Includes.rst.txt b/Documentation/Includes.rst.txt index 8b536489..469841d3 100644 --- a/Documentation/Includes.rst.txt +++ b/Documentation/Includes.rst.txt @@ -1,16 +1,34 @@ -.. This is 'Includes.rst.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:: typoscript(code) -.. role:: shell(code) - :class: shell +.. role:: rst(code) +.. role:: sep(strong) +.. role:: sql(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 diff --git a/Documentation/Index.rst b/Documentation/Index.rst index c4658bce..701fbe3b 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -1,16 +1,36 @@ .. include:: /Includes.rst.txt -.. _start: +================================ +TYPO3 - Getting Started Tutorial +================================ -=============== -Getting Started -=============== +:Version: + |release| -Welcome to Getting Started, this guide features an introduction to TYPO3 that highlights some of its core concepts including the backend -administrative interface. +:Language: + en -This guide also contains information on how to configure the host operating system and features a detailed installation guide -that explains how TYPO3 is installed. +:Author: + TYPO3 contributors + +:License: + This document is published under the + `Open Publication License `__. + +:Rendered: + |today| + +---- + +Welcome to Getting Started, this guide features an introduction to TYPO3 that +highlights some of its core concepts including the backend administrative +interface. + +This guide also contains information on how to configure the host operating +system and features a detailed installation guide that explains how TYPO3 is +installed. + +---- .. container:: row m-0 p-0 @@ -124,6 +144,7 @@ that explains how TYPO3 is installed. Next Steps provides an overview of tasks that can be carried out once TYPO3 is installed, such as creating templates and adding content. +.. Table of Contents .. toctree:: :hidden: @@ -138,5 +159,11 @@ that explains how TYPO3 is installed. UserManagement/Index IntroductionPackage/Index NextSteps/Index - Sitemap - genindex + +.. Meta Menu + +.. toctree:: + :hidden: + + Sitemap + genindex diff --git a/Documentation/Installation/Install.rst b/Documentation/Installation/Install.rst index 89feaa82..ff669e97 100644 --- a/Documentation/Installation/Install.rst +++ b/Documentation/Installation/Install.rst @@ -8,32 +8,32 @@ Installing TYPO3 ================ -Welcome to the TYPO3 installation guide. This guide covers each of the steps required +Welcome to the TYPO3 installation guide. This guide covers each of the steps required to install TYPO3 using the dependency manager Composer. Installation and deployment --------------------------- -It is recommended to not use Composer on a productive system to update and install +It is recommended to not use Composer on a productive system to update and install additional packages. Such changes should be made on a development system (locally in DDEV, on a non-productive part of the server, ...) -This way it can be prevented to install unwanted versions of packages. The files +This way it can be prevented to install unwanted versions of packages. The files :file:`composer.json` and :file:`composer.lock` can be kept under version control and specify exactly what versions should be installed. -Deployment to the productive system can be achieved by deploying these two -:file:`composer.*` files and calling +Deployment to the productive system can be achieved by deploying these two +:file:`composer.*` files and calling .. code-block:: shell - + composer install --no-dev - -.. warning:: - Always use the :shell:`--no-dev` parameter to prevent installing packages marked as + +.. warning:: + Always use the :bash:`--no-dev` parameter to prevent installing packages marked as "development only" to be deployed on the productive server. - -Or by executing the above command on a development system or in a Docker container + +Or by executing the above command on a development system or in a Docker container in a deployment pipeline and then just transfer the following folders: .. code-block:: none diff --git a/Documentation/NextSteps/Index.rst b/Documentation/NextSteps/Index.rst index 95da55d1..353c3f60 100644 --- a/Documentation/NextSteps/Index.rst +++ b/Documentation/NextSteps/Index.rst @@ -11,7 +11,7 @@ Next Steps and Further Reading Once TYPO3 is installed, it is now possible to start the process of developing the site's visual appearance and creating pages and content inside the CMS. -:ref:`Building The Sites Structure And Adding Content ` +:doc:`Building The Sites Structure And Adding Content ` ======================================================================== Using the Page tree - start to define the structure of your site by creating pages. @@ -31,7 +31,7 @@ There are two main topics that cover templating in TYPO3, Fluid and Site package Fluid is TYPO3’s templating engine. Fluid acts as the link between a project's static HTML templates and the content that is created in TYPO3’s backend. -:ref:`Site Packages ` +:doc:`Site Packages ` ++++++++++++++++++++++++++++++++++++++++++ Site packages are a type of extension that act as a storage point for a projects diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg index 3aaf4b3f..a57d7e89 100644 --- a/Documentation/Settings.cfg +++ b/Documentation/Settings.cfg @@ -1,61 +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 = Getting Started version = main (development) release = main (development) -t3author = Documentation Team -copyright = since 2004 by the TYPO3 Documentation Team -description = A Tutorial to get started with TYPO3 - +copyright = since 2012 by the TYPO3 contributors [html_theme_options] -# for "Edit me on GitHub - -github_branch = main +# "Edit on GitHub" button github_repository = TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted +github_branch = main - -project_contact = https://typo3.org/community/teams/documentation/#c9886 -project_discussions = -project_home = -project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted/issues +# Footer links +project_home = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/ +project_contact = https://typo3.slack.com/archives/C028JEPJL project_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted +project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted/issues +project_discussions = -[intersphinx_mapping] - -; in this manual we actually use: - -h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/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/ -t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/ -workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/ - -[extensions] +use_opensearch = -; embed YouTube videos -any_name_youtube = sphinxcontrib.youtube +[intersphinx_mapping] +# 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/ diff --git a/Documentation/Sitemap.rst b/Documentation/Sitemap.rst index 9617022a..09d3c6f5 100644 --- a/Documentation/Sitemap.rst +++ b/Documentation/Sitemap.rst @@ -1,9 +1,9 @@ :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. diff --git a/Documentation/Targets.rst b/Documentation/Targets.rst deleted file mode 100644 index 07b94a41..00000000 --- a/Documentation/Targets.rst +++ /dev/null @@ -1,44 +0,0 @@ -:orphan: - -.. include:: /Includes.rst.txt - -.. only:: html - -.. _linktargets: - -=========== -Linktargets -=========== - -Explanation -=========== - -This page is only relevant for documentation contributors: - -It lists all the link targets in this manual. The link targets can -be used for linking from this manual or from other manuals with the -intersphinx mechanism. - -Example: - -.. code-block:: rest - - - :ref:`extension-manager` - - -You can use this construct to link to the section "Extension Manager". - -More information: - -* :ref:`h2document:intersphinx` in "Writing Documentation" - -.. _Targets-for-Cross-Referencing: - -Targets for Cross-Referencing -============================= - - - - -.. ref-targets-list:: diff --git a/Documentation/UserManagement/GroupPermissions/Index.rst b/Documentation/UserManagement/GroupPermissions/Index.rst index 05413ffd..4df7adfd 100644 --- a/Documentation/UserManagement/GroupPermissions/Index.rst +++ b/Documentation/UserManagement/GroupPermissions/Index.rst @@ -151,7 +151,7 @@ which parts of the page tree and the file system the members of the group may exert their rights over. We will cover only mounts here. Detailed information about -workspaces can be found in the :ref:`related extension manual `. +workspaces can be found in the :doc:`related extension manual `. .. _db-mounts: diff --git a/Documentation/genindex.rst b/Documentation/genindex.rst index 1f097f2c..806ec56a 100644 --- a/Documentation/genindex.rst +++ b/Documentation/genindex.rst @@ -1,10 +1,7 @@ .. include:: /Includes.rst.txt -.. _index: ===== Index ===== -.. About adding an index: -.. https://stackoverflow.com/questions/25243482/how-to-add-sphinx-generated-index-to-the-sidebar-when-using-read-the-docs-theme -.. https://stackoverflow.com/questions/36235578/how-can-i-include-the-genindex-in-a-sphinx-toc \ No newline at end of file +.. Sphinx will insert here the general index automatically. diff --git a/README.rst b/README.rst index 507ca2f9..c83b9daf 100644 --- a/README.rst +++ b/README.rst @@ -1,16 +1,9 @@ -\| -`Contribute (to this manual) `__ \| -`Help & Support (TYPO3 documentation) `__ \| -`Help & Support (TYPO3) `__ \| - ================================ TYPO3 - Getting Started Tutorial ================================ -This is the "Getting Started Tutorial" for TYPO3. It is part of the official TYPO3 documentation +This tutorial features an introduction to TYPO3 and highlights some of the key +concepts, including installation and the backend administration interface. -:Read online: https://docs.typo3.org/typo3cms/GettingStartedTutorial/ :Repository: https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted - - - +:Read online: https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/