diff --git a/Documentation/Reference/FileStructure.rst b/Documentation/Reference/FileStructure.rst index 3149eb0..5d297dd 100644 --- a/Documentation/Reference/FileStructure.rst +++ b/Documentation/Reference/FileStructure.rst @@ -171,6 +171,9 @@ that: Maintainers/Index +.. include:: _FileStructure/_Includes.rst.txt + :show-buttons: + .. index:: File structure; Documentation/Sitemap.rst, Sitemap.rst .. _sitemap-rst: diff --git a/Documentation/Reference/_FileStructure/_Includes.rst.txt b/Documentation/Reference/_FileStructure/_Includes.rst.txt new file mode 100644 index 0000000..f071fe8 --- /dev/null +++ b/Documentation/Reference/_FileStructure/_Includes.rst.txt @@ -0,0 +1,30 @@ +.. _includes-rst-txt: + +Optional: :file:`Documentation/Includes.rst.txt` +------------------------------------------------ + +The :file:`Includes.rst.txt` is optional for Extension documentation. We use +it by convention in all official documentation. + +By default it only contains a comment: + +.. code-block:: rst + :caption: Documentation/Includes.rst.txt + + .. You can put central messages to display on all pages here + +In the official documentation we use it to mark outdated and eLTS versions: + +.. code-block:: rst + :caption: Documentation/Includes.rst.txt + + .. You can put central messages to display on all pages here + + .. attention:: + TYPO3 v10 has reached end-of-life as of April 30th 2023 and + is no longer being maintained. [...] + +Before :ref:`migration ` to the new rendering it also contained +configuration settings. All those have been moved to the +:ref:`guides.xml ` or have been replaced by defaults in our theme +implementation.