[Feature] Examples for Table wizard configurations from styleguide (#384

) refs TYPO3-CMS/styleguide#205 Co-authored-by: lina.wolf <lwolf@w-commerce.de>
TYPO3-Documentation · Apr 14, 2021 · 8ed7a7a · 8ed7a7a
1 parent 23c0f45
commit 8ed7a7a
Show file tree

Hide file tree

Showing 27 changed files with 49 additions and 23 deletions.
diff --git a/Documentation/ColumnsConfig/Type/Text/Images/BackendLayout.png b/Documentation/ColumnsConfig/Type/Text/Images/BackendLayout.png
diff --git a/Documentation/ColumnsConfig/Type/Text/Images/RteStyleguide1.png b/Documentation/ColumnsConfig/Type/Text/Images/RteStyleguide1.png
diff --git a/Documentation/ColumnsConfig/Type/Text/Images/SysNote.png b/Documentation/ColumnsConfig/Type/Text/Images/SysNote.png
diff --git a/Documentation/ColumnsConfig/Type/Text/Images/TableTtContentBodytext.png b/Documentation/ColumnsConfig/Type/Text/Images/TableTtContentBodytext.png
diff --git a/Documentation/ColumnsConfig/Type/Text/Properties/TableWizard.rst b/Documentation/ColumnsConfig/Type/Text/Properties/TableWizard.rst
@@ -19,32 +19,23 @@ tableWizard
 
    Note the control button is only displayed after a new record has been saved the first time.
 
-   .. figure:: /ColumnsConfig/Type/Text/Images/TableWizard1.png
-      :alt: The table wizard
-      :class: with-shadow
-
-      The table wizard
+   .. include:: /Includes/Images/Styleguide/RstIncludes/TableWizard.rst.txt
 
    Available options:
 
    xmlOutput
-     (boolean) If set to true, the output from the wizard is XML instead of the TypoScript table configuration code.
-     Default false.
+      (boolean) If set to true, the output from the wizard is XML instead of the
+      TypoScript table configuration code. This variable still needs binding
+      to the wizard parameters. Otherwise only an empty wizard will be rendered.
+      Default false.
 
    numNewRows
      (integer) Setting the number of blank rows that will be added in the bottom of the table when the
      plus-icon is pressed. The default is 5, the range is 1-50.
 
-   Example overriding defaults of a :code:`renderType='textTable'` element:
+Example
+=======
 
-   .. code-block:: php
+Overriding defaults of a :code:`renderType='textTable'` element:
 
-      'bodytext' => [
-         'config' => [
-            'fieldControl' => [
-               'options' => [
-                  'numNewRows' => 3,
-               ],
-            ],
-         ],
-      ],
+.. include:: /Includes/Snippets/Styleguide/RstIncludes/Text21.rst.txt
diff --git a/Documentation/Includes/Images/Core/Frontend/AutomaticScreenshots/CtrlType.png b/Documentation/Includes/Images/Core/Frontend/AutomaticScreenshots/CtrlType.png
diff --git a/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Flex1.png b/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Flex1.png
diff --git a/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Flex2.png b/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Flex2.png
diff --git a/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Input29.png b/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Input29.png
diff --git a/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/SysLanguageUid.png b/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/SysLanguageUid.png
diff --git a/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Text14.png b/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Text14.png
diff --git a/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Text15.png b/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Text15.png
diff --git a/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Text5.png b/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Text5.png
diff --git a/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Text6.png b/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Text6.png
diff --git a/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Text7.png b/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Text7.png
diff --git a/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Text9.png b/Documentation/Includes/Images/Styleguide/AutomaticScreenshots/Text9.png
diff --git a/Documentation/Includes/Images/Styleguide/ManualScreenshots/TableWizard.png b/Documentation/Includes/Images/Styleguide/ManualScreenshots/TableWizard.png
diff --git a/Documentation/Includes/Images/Styleguide/RstIncludes/TableWizard.rst.txt b/Documentation/Includes/Images/Styleguide/RstIncludes/TableWizard.rst.txt
@@ -0,0 +1,7 @@
+.. Manual screenshot:
+
+.. figure:: /Includes/Images/Styleguide/ManualScreenshots/TableWizard.png
+   :alt: The table wizard
+   :class: with-shadow
+
+   The table wizard
diff --git a/Documentation/Includes/Snippets/Styleguide/RstIncludes/FrenchInput1.rst.txt b/Documentation/Includes/Snippets/Styleguide/RstIncludes/FrenchInput1.rst.txt
@@ -0,0 +1,8 @@
+.. Automatic screenshot: Remove this line if you wand to manually change this file
+
+.. literalinclude:: /Includes/Snippets/Styleguide/Sources/tx_styleguide_elements_basic.php
+   :language: php
+   :start-at: start input_1
+   :end-before: end input_1
+   :lines: 2- 
+
diff --git a/Documentation/Includes/Snippets/Styleguide/RstIncludes/Slug1.rst.txt b/Documentation/Includes/Snippets/Styleguide/RstIncludes/Slug1.rst.txt
@@ -4,5 +4,5 @@
    :language: php
    :start-at: start slug_1
    :end-before: end slug_1
-   :lines: 2-
+   :lines: 2- 
 
diff --git a/Documentation/Includes/Snippets/Styleguide/RstIncludes/Slug2.rst.txt b/Documentation/Includes/Snippets/Styleguide/RstIncludes/Slug2.rst.txt
@@ -4,5 +4,5 @@
    :language: php
    :start-at: start slug_2
    :end-before: end slug_2
-   :lines: 2-
+   :lines: 2- 
 
diff --git a/Documentation/Includes/Snippets/Styleguide/RstIncludes/Slug3.rst.txt b/Documentation/Includes/Snippets/Styleguide/RstIncludes/Slug3.rst.txt
@@ -4,5 +4,5 @@
    :language: php
    :start-at: start slug_3
    :end-before: end slug_3
-   :lines: 2-
+   :lines: 2- 
 
diff --git a/Documentation/Includes/Snippets/Styleguide/RstIncludes/Slug4.rst.txt b/Documentation/Includes/Snippets/Styleguide/RstIncludes/Slug4.rst.txt
@@ -4,5 +4,5 @@
    :language: php
    :start-at: start slug_4
    :end-before: end slug_4
-   :lines: 2-
+   :lines: 2- 
 
diff --git a/Documentation/Includes/Snippets/Styleguide/RstIncludes/Slug5.rst.txt b/Documentation/Includes/Snippets/Styleguide/RstIncludes/Slug5.rst.txt
@@ -4,5 +4,5 @@
    :language: php
    :start-at: start slug_5
    :end-before: end slug_5
-   :lines: 2-
+   :lines: 2- 
 
diff --git a/Documentation/Includes/Snippets/Styleguide/RstIncludes/Text21.rst.txt b/Documentation/Includes/Snippets/Styleguide/RstIncludes/Text21.rst.txt
@@ -0,0 +1,8 @@
+.. Automatic screenshot: Remove this line if you wand to manually change this file
+
+.. literalinclude:: /Includes/Snippets/Styleguide/Sources/tx_styleguide_elements_basic.php
+   :language: php
+   :start-at: start text_21
+   :end-before: end text_21
+   :lines: 2- 
+
diff --git a/Documentation/Includes/Snippets/Styleguide/RstIncludes/TranslatedInput1.rst.txt b/Documentation/Includes/Snippets/Styleguide/RstIncludes/TranslatedInput1.rst.txt
@@ -0,0 +1,8 @@
+.. Automatic screenshot: Remove this line if you wand to manually change this file
+
+.. literalinclude:: /Includes/Snippets/Styleguide/Sources/tx_styleguide_elements_basic.php
+   :language: php
+   :start-at: start input_1
+   :end-before: end input_1
+   :lines: 2- 
+
diff --git a/Scripts/GenerateScreenshots/Config.json b/Scripts/GenerateScreenshots/Config.json
@@ -374,6 +374,10 @@
             "text_19",
             {
               "field": "text_20"
+            },
+            {
+              "field": "text_21",
+              "description": "The table wizard"
             }
           ]
         },