Merge pull request #7 from alexander-nitsche/task-update-docs

[TASK] Align with new TYPO3 documentation standards
FriendsOfTYPO3 · Apr 21, 2022 · 49dd829 · 49dd829
2 parents 03bd498 + 59fd4a0
commit 49dd829
Show file tree

Hide file tree

Showing 82 changed files with 327 additions and 198 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,20 @@
+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
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+/Documentation-GENERATED-temp/
diff --git a/Documentation/.gitignore b/Documentation/.gitignore
diff --git a/Documentation/Administration/DefaultNewRecord/Index.rst b/Documentation/Administration/DefaultNewRecord/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _default-new-record:

diff --git a/Documentation/Administration/Index.rst b/Documentation/Administration/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _administration:
@@ -8,7 +8,7 @@ Administration
 ==============
 
 Upon installation, the extension will set default properties in the page
-TSconfig in the variable :ts:`mod.wizards`.
+TSconfig in the variable :typoscript:`mod.wizards`.
 
 These properties may be modified for any particular page, BE user or BE
 user group and are described below.

diff --git a/...mentation/Administration/WizardSettings/DefaultsReference/ElementsTab/Index.rst b/...mentation/Administration/WizardSettings/DefaultsReference/ElementsTab/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _wizard-settings-defaults-elements-tab:
@@ -27,7 +27,7 @@ doing so, the element will be added at the end of the form.
 showAccordions
 ==============
 
-(:ts:`mod.wizards.form.defaults.tabs.elements.showAccordions`)
+(:typoscript:`mod.wizards.form.defaults.tabs.elements.showAccordions`)
 
 :aspect:`Property:`
     showAccordions
@@ -50,7 +50,7 @@ showAccordions
 showButtons
 ===========
 
-(:ts:`mod.wizards.form.defaults.tabs.elements.accordions.[NameOfAccordion].showButtons`)
+(:typoscript:`mod.wizards.form.defaults.tabs.elements.accordions.[NameOfAccordion].showButtons`)
 
 :aspect:`Property:`
     showButtons

diff --git a/Documentation/Administration/WizardSettings/DefaultsReference/FormTab/Index.rst b/Documentation/Administration/WizardSettings/DefaultsReference/FormTab/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _wizard-settings-defaults-form-tab:
@@ -23,7 +23,7 @@ of the form or the prefix as well as the post-processor configuration.
 showAccordions
 ==============
 
-(:ts:`mod.wizards.form.defaults.tabs.form.showAccordions`)
+(:typoscript:`mod.wizards.form.defaults.tabs.form.showAccordions`)
 
 :aspect:`Property:`
     showAccordions
@@ -64,7 +64,7 @@ showProperties
     expected and has to be fixed in a coming version of TYPO3. There is
     a workaround which is shown below.
 
-(:ts:`mod.wizards.form.defaults.tabs.form.accordions.attributes.showProperties`)
+(:typoscript:`mod.wizards.form.defaults.tabs.form.accordions.attributes.showProperties`)
 
 :aspect:`Property:`
     showProperties
@@ -81,7 +81,7 @@ showProperties
 
 Since the above shown configuration is not working, the following workaround can
 be applied. To configure the attribute accordion of the form element, address the
-object directly via :ts:`mod.wizards.form.elements.form.accordions.attributes.showProperties`.
+object directly via :typoscript:`mod.wizards.form.elements.form.accordions.attributes.showProperties`.
 
 
 .. _wizard-settings-defaults-form-postprocessor:
@@ -95,7 +95,7 @@ Post-processors accordion
 showPostProcessors
 ------------------
 
-(:ts:`mod.wizards.form.defaults.tabs.form.accordions.postProcessor.showPostProcessors`)
+(:typoscript:`mod.wizards.form.defaults.tabs.form.accordions.postProcessor.showPostProcessors`)
 
 :aspect:`Property:`
     showPostProcessors
@@ -118,7 +118,7 @@ showPostProcessors
 postProcessors.[post-processor].showProperties
 ----------------------------------------------
 
-(:ts:`mod.wizards.form.defaults.tabs.form.accordions.postProcessor.postProcessors.[post-processor].showProperties`)
+(:typoscript:`mod.wizards.form.defaults.tabs.form.accordions.postProcessor.postProcessors.[post-processor].showProperties`)
 
 :aspect:`Property:`
     postProcessors.[post-processor].showProperties
@@ -129,7 +129,7 @@ postProcessors.[post-processor].showProperties
 :aspect:`Description:`
     Configuration for the post-processors individually.
 
-    The syntax is :ts:`postProcessors.[name of the post-processor].showProperties`.
+    The syntax is :typoscript:`postProcessors.[name of the post-processor].showProperties`.
 
 :aspect:`Default:`
     The following element properties are available:

diff --git a/Documentation/Administration/WizardSettings/DefaultsReference/Index.rst b/Documentation/Administration/WizardSettings/DefaultsReference/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _wizard-settings-defaults:

diff --git a/Documentation/Administration/WizardSettings/DefaultsReference/OptionsTab/Index.rst b/Documentation/Administration/WizardSettings/DefaultsReference/OptionsTab/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _wizard-settings-defaults-options-tab:
@@ -31,7 +31,7 @@ showAccordions
     showAccordions
 
 :aspect:`TypoScript Path:`
-    :ts:`mod.wizards.form.defaults.tabs.options.showAccordions`
+    :typoscript:`mod.wizards.form.defaults.tabs.options.showAccordions`
 
 :aspect:`Data type:`
     string
@@ -86,7 +86,7 @@ showProperties
     showProperties
 
 :aspect:`TypoScript Path:`
-    :ts:`mod.wizards.form.defaults.tabs.options.accordions.label.showProperties`
+    :typoscript:`mod.wizards.form.defaults.tabs.options.accordions.label.showProperties`
 
 :aspect:`Data type:`
     string
@@ -116,7 +116,7 @@ showProperties
     showProperties
 
 :aspect:`TypoScript Path:`
-    :ts:`mod.wizards.form.defaults.tabs.options.accordions.attributes.showProperties`
+    :typoscript:`mod.wizards.form.defaults.tabs.options.accordions.attributes.showProperties`
 
 :aspect:`Data type:`
     string
@@ -153,7 +153,7 @@ showRules
     showRules
 
 :aspect:`TypoScript Path:`
-    :ts:`mod.wizards.form.defaults.tabs.options.accordions.validation.showRules`
+    :typoscript:`mod.wizards.form.defaults.tabs.options.accordions.validation.showRules`
 
 :aspect:`Data type:`
     string
@@ -177,14 +177,14 @@ rules.[rule].showProperties
     rules.[rule].showProperties
 
 :aspect:`TypoScript Path:`
-    :ts:`mod.wizards.form.defaults.tabs.options.accordions.validation.rules.[rule].showProperties`
+    :typoscript:`mod.wizards.form.defaults.tabs.options.accordions.validation.rules.[rule].showProperties`
 
 :aspect:`Data type:`
     [array of objects]
 
 :aspect:`Description:`
     For each rule one can define which properties should appear.
-    The syntax is :ts:`rules.[name of the rule].showProperties`.
+    The syntax is :typoscript:`rules.[name of the rule].showProperties`.
 
 :aspect:`Default:`
     The following element properties are available:
@@ -230,7 +230,7 @@ showFilters
     showFilters
 
 :aspect:`TypoScript Path:`
-    :ts:`mod.wizards.form.defaults.tabs.options.accordions.filtering.showFilters`
+    :typoscript:`mod.wizards.form.defaults.tabs.options.accordions.filtering.showFilters`
 
 :aspect:`Data type:`
     string
@@ -255,7 +255,7 @@ filters.[filter].showProperties
     filters.[filter].showProperties
 
 :aspect:`TypoScript Path:`
-    :ts:`mod.wizards.form.defaults.tabs.options.accordions.filtering.filters.[filter].showProperties`
+    :typoscript:`mod.wizards.form.defaults.tabs.options.accordions.filtering.filters.[filter].showProperties`
 
 :aspect:`Data type:`
     string
@@ -265,7 +265,7 @@ filters.[filter].showProperties
     configuration. Only the filters which are mentioned below can be
     configured.
 
-    The syntax is :ts:`filters.[name of the filter].showProperties`.
+    The syntax is :typoscript:`filters.[name of the filter].showProperties`.
 
 :aspect:`Default:`
     The following element properties are available:

diff --git a/Documentation/Administration/WizardSettings/DefaultsReference/ShowTabs/Index.rst b/Documentation/Administration/WizardSettings/DefaultsReference/ShowTabs/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _wizard-settings-defaults-showtabs:
@@ -7,7 +7,7 @@
 showTabs
 ========
 
-(:ts:`mod.wizards.form.defaults.showTabs`)
+(:typoscript:`mod.wizards.form.defaults.showTabs`)
 
 The configuration "showTabs" defines the outermost tabs on the left
 side of the form wizard.
@@ -33,7 +33,7 @@ side of the form wizard.
 tabs
 ====
 
-(:ts:`mod.wizards.form.defaults.tabs`)
+(:typoscript:`mod.wizards.form.defaults.tabs`)
 
 Each of the 3 tabs can be further customized.
 

diff --git a/Documentation/Administration/WizardSettings/ElementsReference/Index.rst b/Documentation/Administration/WizardSettings/ElementsReference/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _wizard-settings-elements:
@@ -22,8 +22,8 @@ Overriding element settings
 
 It is possible to override the default option tab settings for each
 element individually. This is done by using the same configuration as
-in :ts:`mod.wizards.form.defaults.tabs.options`, but using this
-configuration in :ts:`mod.wizards.form.elements.[elementName]`.
+in :typoscript:`mod.wizards.form.defaults.tabs.options`, but using this
+configuration in :typoscript:`mod.wizards.form.elements.[elementName]`.
 
 The example below will hide all the accordions within the option tab for
 a text field (TEXTLINE element), except the filters:

diff --git a/Documentation/Administration/WizardSettings/Index.rst b/Documentation/Administration/WizardSettings/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _wizard-settings:

diff --git a/Documentation/Configuration/Filters/Alphabetic/Index.rst b/Documentation/Configuration/Filters/Alphabetic/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-filters-alphabetic:

diff --git a/Documentation/Configuration/Filters/Alphanumeric/Index.rst b/Documentation/Configuration/Filters/Alphanumeric/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-filters-alphanumeric:

diff --git a/Documentation/Configuration/Filters/Currency/Index.rst b/Documentation/Configuration/Filters/Currency/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-filters-currency:

diff --git a/Documentation/Configuration/Filters/Digit/Index.rst b/Documentation/Configuration/Filters/Digit/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-filters-digit:

diff --git a/Documentation/Configuration/Filters/Index.rst b/Documentation/Configuration/Filters/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-filters:

diff --git a/Documentation/Configuration/Filters/Integer/Index.rst b/Documentation/Configuration/Filters/Integer/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-filters-integer:

diff --git a/Documentation/Configuration/Filters/Lowercase/Index.rst b/Documentation/Configuration/Filters/Lowercase/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-filters-lowercase:

diff --git a/Documentation/Configuration/Filters/Regexp/Index.rst b/Documentation/Configuration/Filters/Regexp/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-filters-regexp:

diff --git a/Documentation/Configuration/Filters/Stripnewlines/Index.rst b/Documentation/Configuration/Filters/Stripnewlines/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-filters-stripnewlines:

diff --git a/Documentation/Configuration/Filters/Titlecase/Index.rst b/Documentation/Configuration/Filters/Titlecase/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-filters-titlecase:

diff --git a/Documentation/Configuration/Filters/Trim/Index.rst b/Documentation/Configuration/Filters/Trim/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-filters-trim:

diff --git a/Documentation/Configuration/Filters/Uppercase/Index.rst b/Documentation/Configuration/Filters/Uppercase/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-filters-uppercase:

diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _configuration:

diff --git a/Documentation/Configuration/Layout/Index.rst b/Documentation/Configuration/Layout/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _reference-layout:

diff --git a/Documentation/Configuration/Layout/LayoutObjectSpecific/Index.rst b/Documentation/Configuration/Layout/LayoutObjectSpecific/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _change-layout-individual-form:

diff --git a/Documentation/Configuration/Layout/LayoutViewSpecific/Index.rst b/Documentation/Configuration/Layout/LayoutViewSpecific/Index.rst
@@ -1,4 +1,4 @@
-.. include:: ../../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _change-layout-specific-view:
@@ -112,7 +112,7 @@ the following code could be applied.
 Properties and defaults
 =======================
 
-If the integrator does not define any :ts:`.layout` setting the default
+If the integrator does not define any :typoscript:`.layout` setting the default
 layout defined in the PHP classes will be used.
 
 The following list shows all available elements within all the different