[DOCS] Align with new TYPO3 documentation standards (#1158)

* [DOCS] Align with new TYPO3 documentation standards

- align README.rst, Index.rst, Includes.txt, Settings.cfg
- add genindex.rst, Sitemap.rst
- pose with total and monthly download rate

Each TYPO3 package should show
- current release version
- total download rate
- monthly download rate
in badges.

- remove outdated encoding note
- insert TOCs for large pages
- insert label for every page title
- link terms to official TYPO3 documentation
- link extensions to TER

* [DOCS] Add TS constants to documentation index

* [DOCS] Rename Includes.txt to Includes.rst.txt

.editorconfig

@@ -39,11 +39,13 @@ indent_size = 4
 [*.md]
 indent_style = space
 indent_size = 4
+max_line_length = 80
 
 # ReST-Files
-[*.rst]
+[*.{rst,rst.txt}]
 indent_style = space
 indent_size = 3
+max_line_length = 80
 
 # TypoScript
 [*.typoscript]

.gitignore

@@ -4,3 +4,4 @@ Build/node_modules/*
 composer.lock
 *.cache
 nbproject
+/Documentation-GENERATED-temp/

Documentation/AdministratorManual/Index.rst

@@ -1,25 +1,20 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
-
+.. include:: /Includes.rst.txt
 
 .. _admin-manual:
 
 Administrator manual
 ====================
 
-.. only:: html
-
-   This chapter describes how to manage the extension from a superuser point of view.
+This chapter describes how to manage the extension from a superuser point of
+view.
 
-   For a complete changelog please see the release notes on  `GitHub <https://github.com/benjaminkott/bootstrap_package/releases/>`_.
+For a complete changelog please see the release notes on
+`GitHub <https://github.com/benjaminkott/bootstrap_package/releases/>`_.
 
+**Table of Contents:**
 
 .. toctree::
-   :maxdepth: 5
+   :maxdepth: 1
    :titlesonly:
 
    Migration/6-2-14

Documentation/AdministratorManual/Migration/6-2-11.rst

@@ -1,10 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
-
+.. include:: /Includes.rst.txt
 
 .. _migration_6.2.11:
 
@@ -15,6 +9,13 @@ Upgrade from 6.2.10 to 6.2.11
 This document will only cover **breaking changes**, that could happen while
 overriding the Bootstrap Package.
 
+**Table of Contents:**
+
+.. contents::
+   :backlinks: top
+   :class: compact-list
+   :depth: 1
+   :local:
 
 
 

Documentation/AdministratorManual/Migration/6-2-14.rst

@@ -1,10 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
-
+.. include:: /Includes.rst.txt
 
 .. _migration_6.2.14:
 
@@ -15,6 +9,13 @@ Upgrade from 6.2.13 to 6.2.14
 This document will only cover **breaking changes**, that could happen while
 overriding the Bootstrap Package.
 
+**Table of Contents:**
+
+.. contents::
+   :backlinks: top
+   :class: compact-list
+   :depth: 1
+   :local:
 
 
 

Documentation/Configuration/Extension/Index.rst

@@ -1,20 +1,21 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
+.. _extension-configuration:
 
 =======================
 Extension Configuration
 =======================
 
-Use the extension manager to adjust the Bootstrap Package to your needs.
-
+Use the :ref:`Extension Manager <t3coreapi:extension-manager>` to adjust the
+Bootstrap Package to your needs.
 
 PageTsConfig
 ============
 
 The Bootstrap Package has a lot of PageTsConfig defaults.
-In some cases it can be useful to deactivate some of them if you do not need them.
+In some cases it can be useful to deactivate some of them if you do not need
+them.
+
+.. TODO:
+   All PageTsConfig properties should be listed here - as already done
+   with the sibling chapters "Image Rendering" and "TypoScript".

Documentation/Configuration/ImageRendering/Index.rst

@@ -1,10 +1,6 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
+.. _image-rendering:
 
 ===============
 Image Rendering
@@ -15,6 +11,14 @@ supports multiple variants for various device sizes. Each variant defines the
 **break point**, **width** and the optional **sizes** for high resolution image
 support.
 
+**Table of Contents:**
+
+.. contents::
+   :backlinks: top
+   :class: compact-list
+   :depth: 2
+   :local:
+
 
 
 Image Variants
@@ -129,10 +133,10 @@ for devices with a minimum device pixel ratio from 1.5 and 2.
    }
 
 The data for image rendering is now extended with a sub-set for high-resolution
-variants. If you did not overwrite the default templates, it will just work as 
+variants. If you did not overwrite the default templates, it will just work as
 soon as you add the configuration. If you have overwritten the default
-templates, it will still work as before, but you need to add the new support for 
-high-resolution images yourself. 
+templates, it will still work as before, but you need to add the new support for
+high-resolution images yourself.
 
 Please check the new updated templates and adjust your code if you want this
 support.
@@ -240,11 +244,11 @@ Options for variants:
 +---------------+-----------+-------------------------------------------------+
 | aspectRatio   | float     | Optional, defines the default aspect ratio      |
 |               |           | which will override all previously defined      |
-|               |           | ratios on image level                           | 
+|               |           | ratios on image level                           |
 +---------------+-----------+-------------------------------------------------+
 | sizes         | array     | Optional, defines the available high resolution |
 |               |           | image multiplier for a minimal device pixel     |
-|               |           | ratio per variant                               |  
+|               |           | ratio per variant                               |
 +---------------+-----------+-------------------------------------------------+
 
 

Documentation/Configuration/Index.rst

@@ -1,20 +1,17 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
+.. include:: /Includes.rst.txt
 
-.. include:: ../Includes.txt
+.. _configuration:
 
-
-==============================
+=============
 Configuration
-==============================
+=============
+
+**Table of Contents:**
 
 .. toctree::
-   :maxdepth: 5
+   :maxdepth: 2
    :titlesonly:
-   :glob:
 
    Extension/Index
    ImageRendering/Index
-   TypoScript/Index
+   TypoScript/Index

Documentation/Configuration/TypoScript/Index.rst

@@ -1,23 +1,34 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
+.. index:: ! TypoScript
+.. _typoscript:
 
 ==========
 TypoScript
 ==========
-Bootstrap Package was built to be as adjustable as possible, so nothing is fixed and everything can be overridden with TypoScript constants.
-The constants are grouped in basic and advanced settings. Use the **TYPO3 Constant Editor** in the backend to modify the values.
+
+Bootstrap Package was built to be as adjustable as possible, so nothing is fixed
+and everything can be overridden with TypoScript constants. The constants are
+grouped in basic and advanced settings. Use the :ref:`Constant Editor <t3tsref:constant-editor>`
+in the backend to modify the values.
+
+**Table of Contents:**
+
+.. contents::
+   :backlinks: top
+   :class: compact-list
+   :depth: 2
+   :local:
 
 
 Bootstrap Package: Basic Constants
 ==================================
+
 The basic settings will provide easy to use and understandable options for that are used mainly for styling and appearance.
 
 
+.. index:: TypoScript; page.logo
+
 page.logo
 ---------
 
@@ -47,6 +58,9 @@ page.logo
     }
 
 
+.. TODO: This property seems to be outdated. There is a second "page.meta"
+   further down.
+
 page.meta
 ---------
 
@@ -61,6 +75,8 @@ page.meta
 +-----------------------------------+---------------+-----------------------------------------------------------------------+
 
 
+.. index:: TypoScript; page.theme
+
 page.theme
 ----------
 
@@ -77,6 +93,8 @@ page.theme
 +-----------------------------------+---------------+-----------------------------------------------------------------------+
 
 
+.. index:: TypoScript; page.theme.copyright
+
 page.theme.copyright
 --------------------
 
@@ -90,6 +108,8 @@ page.theme.copyright
 +-----------------------------------+---------------+-----------------------------------------------------------------------+
 
 
+.. index:: TypoScript; page.theme.news
+
 page.theme.news
 ---------------
 
@@ -112,6 +132,8 @@ page.theme.news
 +-----------------------------------+---------------+-----------------------------------------------------------------------+
 
 
+.. index:: TypoScript; page.theme.language
+
 page.theme.language
 -------------------
 
@@ -129,6 +151,8 @@ Bootstrap Package: Advanced Constants
 The advanced settings should be used only if you really know what you are doing.
 
 
+.. index:: TypoScript; page.fluidtemplate
+
 page.fluidtemplate
 ------------------
 
@@ -143,6 +167,8 @@ page.fluidtemplate
 +-----------------------------------+---------------+-----------------------------------------------------------------------+
 
 
+.. index:: TypoScript; page.includePath
+
 page.includePath
 ----------------
 
@@ -157,6 +183,8 @@ page.includePath
 +-----------------------------------+---------------+-----------------------------------------------------------------------+
 
 
+.. index:: TypoScript; page.meta
+
 page.meta
 ---------
 
@@ -175,6 +203,8 @@ page.meta
 +-----------------------------------+---------------+-----------------------------------------------------------------------+
 
 
+.. index:: TypoScript; page.tracking.google
+
 page.tracking.google
 --------------------
 
@@ -187,6 +217,8 @@ page.tracking.google
 +-----------------------------------+---------------+-----------------------------------------------------------------------+
 
 
+.. index:: TypoScript; config
+
 config
 ------
 
@@ -214,6 +246,8 @@ config
 +-----------------------------------+---------------+-----------------------------------------------------------------------+
 
 
+.. index:: TypoScript; plugin.bootstrap_package.settings
+
 plugin.bootstrap_package.settings
 ---------------------------------
 
@@ -226,6 +260,8 @@ plugin.bootstrap_package.settings
 +-----------------------------------+---------------+-----------------------------------------------------------------------+
 
 
+.. index:: TypoScript; plugin.bootstrap_package_contentelements.view
+
 plugin.bootstrap_package_contentelements.view
 ---------------------------------------------