Move Includes.txt to Includes.rst.txt (#153)

Introduce GenIndex
TYPO3-Documentation · Dec 26, 2020 · 9486b10 · 9486b10
1 parent a56b7c0
commit 9486b10
Show file tree

Hide file tree

Showing 23 changed files with 79 additions and 64 deletions.
diff --git a/Documentation/GenIndex.rst b/Documentation/GenIndex.rst
@@ -0,0 +1,13 @@
+.. include:: /Includes.rst.txt
+
+.. _index:
+
+=====
+Index
+=====
+
+*Note:* This index page has just entered the scene. I will develop gradually.
+
+.. 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
diff --git a/Documentation/Includes.txt → Documentation/Includes.rst.txt b/Documentation/Includes.txt → Documentation/Includes.rst.txt
@@ -1,4 +1,4 @@
-.. This is 'Includes.txt'. It is included at the very top of each and
+.. This is 'Includes.rst.txt'. It is included at the very top of each and
    every ReST source file in THIS documentation project (= manual).
 
 .. role:: aspect (emphasis)

diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -1,4 +1,4 @@
-.. include:: Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _start:
 
@@ -74,5 +74,6 @@ Alternatively you can `file an issue
    UsingSetting/Index
    PageTsconfig/Index
    UserTsconfig/Index
+   GenIndex
    Sitemap
 
diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _introduction:
 
@@ -25,6 +25,7 @@ The rest of the document is a reference: A document to look-up and find properti
 This document is especially important for integrators who want to make life as easy as possible
 for their dear backend users.
 
+.. index:: ! TSconfig
 .. _about-tsconfig:
 
 About TSconfig

diff --git a/Documentation/PageTsconfig/Index.rst b/Documentation/PageTsconfig/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _pagetsconfig:
 .. _pagetoplevelobjects:

diff --git a/Documentation/PageTsconfig/Mod.rst b/Documentation/PageTsconfig/Mod.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _pagemod:
 

diff --git a/Documentation/PageTsconfig/Options.rst b/Documentation/PageTsconfig/Options.rst
@@ -1,43 +1,43 @@
-.. include:: ../Includes.txt
-
-.. _pageoptions:
-
-=======
-options
-=======
-
-Various options for the page affecting the core at various points.
-
-
-.. _pagebackendlayout:
-
-backendLayout
-=============
-
-exclude
--------
-
-:aspect:`Datatype`
-    list of identifiers / uids
-
-:aspect:`Description`
-    Exclude a list of backend layouts form being selectable when assigning a backend layout
-    to a page record.
-
-    Use the uid/identifier of the record in the default data provider.
-
-:aspect:`Example`
-    .. figure:: ../Images/BackendLayoutID.png
-        :alt: Two backend layout records shown in list module
-
-        Two backend layout records shown in list module
-
-    .. code-block:: typoscript
-
-        # Exclude two backend layouts from drop down selector
-        options.backendLayout.exclude = 1,2
-
-    .. figure:: ../Images/BackendLayoutsExcluded.png
-        :alt: Drop down without backend layouts
-
-        Drop down without backend layouts
+.. include:: /Includes.rst.txt
+
+.. _pageoptions:
+
+=======
+options
+=======
+
+Various options for the page affecting the core at various points.
+
+
+.. _pagebackendlayout:
+
+backendLayout
+=============
+
+exclude
+-------
+
+:aspect:`Datatype`
+    list of identifiers / uids
+
+:aspect:`Description`
+    Exclude a list of backend layouts form being selectable when assigning a backend layout
+    to a page record.
+
+    Use the uid/identifier of the record in the default data provider.
+
+:aspect:`Example`
+    .. figure:: ../Images/BackendLayoutID.png
+        :alt: Two backend layout records shown in list module
+
+        Two backend layout records shown in list module
+
+    .. code-block:: typoscript
+
+        # Exclude two backend layouts from drop down selector
+        options.backendLayout.exclude = 1,2
+
+    .. figure:: ../Images/BackendLayoutsExcluded.png
+        :alt: Drop down without backend layouts
+
+        Drop down without backend layouts
diff --git a/Documentation/PageTsconfig/Rte.rst b/Documentation/PageTsconfig/Rte.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _pageTsRte:
 

diff --git a/Documentation/PageTsconfig/TcaDefaults.rst b/Documentation/PageTsconfig/TcaDefaults.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _pageTsTcaDefaults:
 

diff --git a/Documentation/PageTsconfig/TceForm.rst b/Documentation/PageTsconfig/TceForm.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _tceform:
 .. _pagetceformconfobj:

diff --git a/Documentation/PageTsconfig/TceMain.rst b/Documentation/PageTsconfig/TceMain.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _pagetcemain:
 .. _pagetcemain-properties:

diff --git a/Documentation/PageTsconfig/Tx.rst b/Documentation/PageTsconfig/Tx.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 ====
 tx_*

diff --git a/Documentation/Targets.rst b/Documentation/Targets.rst
@@ -1,6 +1,6 @@
 :orphan:
 
-.. include:: /Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _linktargets:
 

diff --git a/Documentation/UserTsconfig/AdmPanel.rst b/Documentation/UserTsconfig/AdmPanel.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _useradmpanel:
 

diff --git a/Documentation/UserTsconfig/Auth.rst b/Documentation/UserTsconfig/Auth.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 ====
 auth

diff --git a/Documentation/UserTsconfig/Index.rst b/Documentation/UserTsconfig/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _usertsconfig:
 .. _usertoplevelobjects:

diff --git a/Documentation/UserTsconfig/Options.rst b/Documentation/UserTsconfig/Options.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _useroptions:
 

diff --git a/Documentation/UserTsconfig/Page.rst b/Documentation/UserTsconfig/Page.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 ====
 page

diff --git a/Documentation/UserTsconfig/Permissions.rst b/Documentation/UserTsconfig/Permissions.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _userTsConfigPermissions:
 

diff --git a/Documentation/UserTsconfig/Setup.rst b/Documentation/UserTsconfig/Setup.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _usersetup:
 

diff --git a/Documentation/UserTsconfig/TcaDefaults.rst b/Documentation/UserTsconfig/TcaDefaults.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. highlight:: php
 .. _userTsTcaDefaults:

diff --git a/Documentation/UserTsconfig/Tx.rst b/Documentation/UserTsconfig/Tx.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 ====
 tx_*

diff --git a/Documentation/UsingSetting/Index.rst b/Documentation/UsingSetting/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _typoscript-syntax-using-setting: