[DOCS] Backport 12.4, Switch to PHP based documentation rendering (#969)

* [DOCS] Backport 12.4, Switch to PHP based documentation rendering (#968) * Create guides.xml * Remove now outdated Settings.cfg * Remove outdated genindex.rst * Remove outdated screenshots.json * Introduce automatic testing for documentation changes * Introduce make file for easy local rendering (cherry picked from commit 556af29) * [BUGFIX] Fix references (#967) Preparation for switch to PHP-based rendering The guides are more strict in using interlinks then sphinx (cherry picked from commit 19fde0a) * [BUGFIX] Delete Settings
TYPO3-Documentation · Mar 10, 2024 · 7c81e76 · 7c81e76
1 parent 89a3d0c
commit 7c81e76
Show file tree

Hide file tree

Showing 16 changed files with 76 additions and 1,679 deletions.
diff --git a/.github/workflows/test-documentation.yml b/.github/workflows/test-documentation.yml
@@ -0,0 +1,17 @@
+name: test documentation
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    name: documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Test if the documentation will render without warnings
+        run: |
+          mkdir -p Documentation-GENERATED-temp \
+          && docker run --rm --pull always -v $(pwd):/project \
+             ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log
diff --git a/Documentation/ColumnsConfig/Type/File/Properties/Appearance.rst b/Documentation/ColumnsConfig/Type/File/Properties/Appearance.rst
@@ -87,4 +87,4 @@ appearance
     elementBrowserEnabled (boolean)
         Hides or displays the element browser button in inline records
 
-    This property can also be overridden by :ref:`page TSconfig <tceform>`.
+    This property can also be overridden by :ref:`page TSconfig <t3tsconfig:tceform>`.
diff --git a/Documentation/ColumnsConfig/Type/Flex/Index.rst b/Documentation/ColumnsConfig/Type/Flex/Index.rst
@@ -5,7 +5,7 @@
 FlexForm field
 ==============
 
-Renders a :ref:`FlexForm <flexforms>` element. Essentially, this consists in a
+Renders a :ref:`FlexForm <t3coreapi:flexforms>` element. Essentially, this consists in a
 hierarchically organized set of fields which will have their values saved into a
 single field in the database, stored as XML.
 

diff --git a/Documentation/ColumnsConfig/Type/Flex/Properties/DsPointerFieldSearchParent.rst b/Documentation/ColumnsConfig/Type/Flex/Properties/DsPointerFieldSearchParent.rst
@@ -10,10 +10,10 @@ ds\_pointerField\_searchParent
     Beginning with TYPO3 v12 you can migrate to PSR-14 events to manipulate the
     data structure lookup logic:
 
-    *   :ref:`AfterFlexFormDataStructureIdentifierInitializedEvent`
-    *   :ref:`AfterFlexFormDataStructureParsedEvent`
-    *   :ref:`BeforeFlexFormDataStructureIdentifierInitializedEvent`
-    *   :ref:`BeforeFlexFormDataStructureParsedEvent`
+*   :ref:`t3coreapi:AfterFlexFormDataStructureIdentifierInitializedEvent`
+*   :ref:`t3coreapi:AfterFlexFormDataStructureParsedEvent`
+*   :ref:`t3coreapi:BeforeFlexFormDataStructureIdentifierInitializedEvent`
+*   :ref:`t3coreapi:BeforeFlexFormDataStructureParsedEvent`
 
 ..  confval:: ds_pointerField_searchParent
 

diff --git a/...ation/ColumnsConfig/Type/Flex/Properties/DsPointerFieldSearchParentSubField.rst b/...ation/ColumnsConfig/Type/Flex/Properties/DsPointerFieldSearchParentSubField.rst
@@ -10,10 +10,10 @@ ds\_pointerField\_searchParent\_subField
     Beginning with TYPO3 v12 you can migrate to PSR-14 events to manipulate the
     data structure lookup logic:
 
-    *   :ref:`AfterFlexFormDataStructureIdentifierInitializedEvent`
-    *   :ref:`AfterFlexFormDataStructureParsedEvent`
-    *   :ref:`BeforeFlexFormDataStructureIdentifierInitializedEvent`
-    *   :ref:`BeforeFlexFormDataStructureParsedEvent`
+*   :ref:`t3coreapi:AfterFlexFormDataStructureIdentifierInitializedEvent`
+*   :ref:`t3coreapi:AfterFlexFormDataStructureParsedEvent`
+*   :ref:`t3coreapi:BeforeFlexFormDataStructureIdentifierInitializedEvent`
+*   :ref:`t3coreapi:BeforeFlexFormDataStructureParsedEvent`
 
 ..  confval:: ds_pointerField_searchParent_subField
 

diff --git a/Documentation/ColumnsConfig/Type/Flex/Properties/DsTableField.rst b/Documentation/ColumnsConfig/Type/Flex/Properties/DsTableField.rst
@@ -10,10 +10,10 @@ ds\_tableField
     Beginning with TYPO3 v12 you can migrate to PSR-14 events to manipulate the
     data structure lookup logic:
 
-    *   :ref:`AfterFlexFormDataStructureIdentifierInitializedEvent`
-    *   :ref:`AfterFlexFormDataStructureParsedEvent`
-    *   :ref:`BeforeFlexFormDataStructureIdentifierInitializedEvent`
-    *   :ref:`BeforeFlexFormDataStructureParsedEvent`
+*   :ref:`t3coreapi:AfterFlexFormDataStructureIdentifierInitializedEvent`
+*   :ref:`t3coreapi:AfterFlexFormDataStructureParsedEvent`
+*   :ref:`t3coreapi:BeforeFlexFormDataStructureIdentifierInitializedEvent`
+*   :ref:`t3coreapi:BeforeFlexFormDataStructureParsedEvent`
 
 ..  confval:: ds_tableField
 

diff --git a/Documentation/ColumnsConfig/Type/Inline/Examples.rst b/Documentation/ColumnsConfig/Type/Inline/Examples.rst
@@ -133,20 +133,20 @@ type inline** - as it is a container.
          {
              public function render()
              {
-                 $fieldName = $this->data['fieldName'];                
+                 $fieldName = $this->data['fieldName'];
                  $result = $this->initializeResultArray();
 
                   // Add fieldInformation only for this field name
-                  //   this may be changed accordingly                                  
+                  //   this may be changed accordingly
                   if ($fieldName !== 'my_new_field') {
                       return $result;
                   }
-                  
+
                   $text = $GLOBALS['LANG']->sL(
                           'LLL:EXT:my_example/Resources/Private/Language/'
                           . 'locallang_db.xlf:tt_content.fieldInformation.demo'
                   );
-                  
+
                   $result['html'] = $text;
                   return $result;
              }
@@ -198,6 +198,6 @@ type inline** - as it is a container.
 
    *  :ref:`['ctrl']['container'] <ctrl-reference-container>`
    *  How to create custom fieldInformation, fieldControl or fieldWizard in
-      :ref:`FormEngine <FormEngine-Rendering-NodeExpansion>` chapter (TYPO3
+      :ref:`FormEngine <t3coreapi:FormEngine-Rendering-NodeExpansion>` chapter (TYPO3
       Explained)
    *  :ref:`fieldInformation <tca_property_fieldInformation>` property
diff --git a/Documentation/ColumnsConfig/Type/Password/Properties/PasswordPolicy.rst b/Documentation/ColumnsConfig/Type/Password/Properties/PasswordPolicy.rst
@@ -13,7 +13,7 @@ passwordPolicy
     :type: string
     :Scope: Display, Proc.
 
-    This option assigns a :ref:`password policy <password-policies>` to fields
+    This option assigns a :ref:`password policy <t3coreapi:password-policies>` to fields
     of the type `password`. For configured fields, the password policy validator
     will be used in :ref:`DataHandler <t3coreapi:tce-database-basics>` to ensure,
     that the new password complies with the configured password policy.

diff --git a/Documentation/ColumnsConfig/Type/Select/Properties/SelectTreeConfig.rst b/Documentation/ColumnsConfig/Type/Select/Properties/SelectTreeConfig.rst
@@ -34,7 +34,7 @@ treeConfig
       configuration by using the `###SITE:###` syntax.
 
       This property can also be set by page TSconfig, see
-      :ref:`pagetsconfigtceformconfigtreeconfig`
+      :ref:`t3tsconfig:pagetsconfigtceformconfigtreeconfig`
 
       Example:
 

diff --git a/Documentation/Includes.rst.txt b/Documentation/Includes.rst.txt
@@ -1,34 +1 @@
-.. More information about this file:
-   https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
-
-.. ----------
-.. text roles
-.. ----------
-
-.. role:: aspect(emphasis)
-.. role:: bash(code)
-.. role:: html(code)
-.. role:: js(code)
-.. role:: php(code)
-.. role:: rst(code)
-.. role:: sep(strong)
-.. role:: sql(code)
-
-.. role:: tsconfig(code)
-   :class: typoscript
-
-.. role:: typoscript(code)
-.. role:: xml(code)
-   :class: html
-
-.. role:: yaml(code)
-
-.. default-role:: code
-
-.. ---------
-.. highlight
-.. ---------
-
-.. By default, code blocks use PHP syntax highlighting
-
-.. highlight:: php
+..  You can put central messages to display on all pages here
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -50,4 +50,3 @@ This document is the complete reference of the *Table Configuration Array*
    :hidden:
 
    Sitemap
-   genindex
diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg
diff --git a/Documentation/genindex.rst b/Documentation/genindex.rst
diff --git a/Documentation/guides.xml b/Documentation/guides.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<guides xmlns="https://www.phpdoc.org/guides"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd"
+        links-are-relative="true">
+    <extension
+            class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
+            project-home="https://docs.typo3.org/m/typo3/reference-tca/main/en-us/"
+            project-contact="https://typo3.slack.com/archives/C028JEPJL"
+            project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-TCA"
+            project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-TCA/issues"
+            edit-on-github-branch="main"
+            edit-on-github="TYPO3-Documentation/TYPO3CMS-Reference-TCA"
+            typo3-core-preferred="main"
+    />
+    <project title="TCA Reference"
+             release="main (development)"
+             version="main (development)"
+             copyright="since 2012 by the TYPO3 contributors"
+    />
+</guides>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -50,4 +50,3 @@ This document is the complete reference of the Table Configuration Array
		:hidden:

		Sitemap
		genindex