TYPO3-Documentation · sarahmccarthy123 · Oct 15, 2024 · Oct 15, 2024 · Oct 17, 2024 · Oct 21, 2024
diff --git a/.editorconfig b/.editorconfig
@@ -1,25 +1,68 @@
-# EditorConfig is awesome: https://EditorConfig.org
-#
-# Use as master: https://github.com/TYPO3-Documentation/T3DocTeam/blob/main/.editorconfig
+# EditorConfig is awesome: http://EditorConfig.org
 
 # top-most EditorConfig file
 root = true
 
-[{*.rst,*.rst.txt}]
+# Unix-style newlines with a newline ending every file
+[*]
 charset = utf-8
 end_of_line = lf
+indent_style = space
+indent_size = 4
 insert_final_newline = true
 trim_trailing_whitespace = true
-indent_style = space
+
+# TS/JS-Files
+[*.{ts,js,mjs}]
+indent_size = 2
+
+# JSON-Files
+[*.json]
+indent_style = tab
+
+# ReST-Files
+[*.{rst,rst.txt}]
 indent_size = 4
 max_line_length = 80
 
-# MD-Files
+# Markdown-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
+
+# YAML-Files
+[*.{yaml,yml}]
+indent_size = 2
+
+# NEON-Files
+[*.neon]
+indent_size = 2
+indent_style = tab
+
+# stylelint
+[.stylelintrc]
+indent_size = 2
+
+# package.json
+[package.json]
+indent_size = 2
+
+# TypoScript
+[*.{typoscript,tsconfig}]
+indent_size = 2
+
+# XLF-Files
+[*.xlf]
+indent_style = tab
+
+# SQL-Files
+[*.sql]
+indent_style = tab
+indent_size = 2
+
+# .htaccess
+[{_.htaccess,.htaccess}]
+indent_style = tab
+
+[Makefile]
+# Use tabs for indentation (Makefiles require tabs)
+indent_style = tab
diff --git a/.github/workflows/apply-precommit.yml b/.github/workflows/apply-precommit.yml
@@ -0,0 +1,71 @@
+name: Check and Fix Whitespace on Schedule
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+  workflow_dispatch:
+
+jobs:
+  lint:
+    if: github.repository_owner == 'TYPO3-documentation'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Install pre-commit
+        run: pip install pre-commit
+
+      - name: Run pre-commit hooks and apply fixes
+        id: pre-commit
+        run: |
+          # Run pre-commit with auto-fix and ignore exit code
+          pre-commit run --all-files --hook-stage=manual --show-diff-on-failure || true
+          # Check if any files were modified
+          git diff --exit-code || echo "FIX_NEEDED=true" >> $GITHUB_ENV
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Check for existing PR
+        if: env.FIX_NEEDED == 'true'
+        id: check_pr
+        run: |
+          EXISTING_PR=$(gh pr list --state open --search "Fix whitespace issues" --json number -q '.[].number')
+          if [[ -n "$EXISTING_PR" ]]; then
+            echo "EXISTING_PR=true" >> $GITHUB_ENV
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create and push changes if needed
+        if: env.FIX_NEEDED == 'true' && env.EXISTING_PR != 'true'
+        id: create_branch
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          # Create a new branch for the changes
+          BRANCH_NAME="fix/whitespace-$(date +'%Y%m%d%H%M%S')"
+          git checkout -b "$BRANCH_NAME"
+          git add .
+          git commit -m "fix: apply whitespace fixes"
+          git push origin "$BRANCH_NAME"
+          echo "branch_name=$BRANCH_NAME" >> $GITHUB_ENV
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Open Pull Request
+        if: env.FIX_NEEDED == 'true' && env.EXISTING_PR != 'true'
+        uses: repo-sync/pull-request@v2
+        with:
+          source_branch: ${{ env.branch_name }}
+          destination_branch: ${{ github.ref_name }}
+          pr_title: "Fix whitespace issues"
+          pr_body: "This PR automatically applies whitespace fixes."
+          token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -35,8 +35,12 @@ jobs:
       - name: Composer validate
         run: Build/Scripts/runTests.sh -p ${{ env.php }} -s composerValidate
 
-      - name: Composer normalize
-        run: Build/Scripts/runTests.sh -p ${{ env.php }} -s composerNormalize -n
+      # Disabled composer-normalize for now because ergebnis/composer-normalize
+      # still hard-depends on localheinz/diff, which conflicts with sebastian/diff
+      # and causes fatal errors in our CI. Re-enable once the upstream dependency
+      # situation is resolved in a newer release.
+      # - name: Composer normalize
+      #   run: Build/Scripts/runTests.sh -p ${{ env.php }} -s composerNormalize -n
 
       - name: CGL
         run: Build/Scripts/runTests.sh -n -p ${{ env.php }} -s cgl -n

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0  # Use the latest version
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
diff --git a/Documentation/About.rst b/Documentation/About.rst
diff --git a/Documentation/AppendixA/Index.rst b/Documentation/AppendixA/Index.rst
@@ -1,9 +1,9 @@
 ..  include:: /Includes.rst.txt
 ..  _appendix-a:
 
-================================
-Appendix A – PHP include scripts
-================================
+==================
+PHP and TypoScript
+==================
 
 ..  _content-object-renderer:
 
@@ -57,6 +57,11 @@ This will stdWrap the content with the properties of `.stdWrap` of the
 TypoScriptFrontendController, TSFE
 ==================================
 
+..  deprecated:: 13.4
+    The class :php:`\TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController`
+    and its global instance :php:`$GLOBALS['TSFE']` have been marked as
+    deprecated. The class will be removed with TYPO3 v14.
+
 You can retrieve the :php:`\TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController`
 via the :ref:`request <t3coreapi:typo3-request>` attribute
 :ref:`frontend.controller <t3coreapi:typo3-request-attribute-frontend-controller>`.

diff --git a/Documentation/CodeSnippets/Config/Menus.php b/Documentation/CodeSnippets/Config/Menus.php
@@ -68,37 +68,11 @@
         'sourceFile' => 'EXT:fluid_styled_content/Resources/Private/Templates/MenuCategorizedPages.html',
         'targetFileName' => 'CodeSnippets/Menu/Template/MenuCategorizedPages.rst.txt',
     ],
-    // special = browse
-    [
-        'action' => 'createCodeSnippet',
-        'caption' => 'EXT:site_package/Configuration/TypoScript/Seo/Setup/RelPrevNextMenu.typoscript',
-        'sourceFile' => 'EXT:site_package/Configuration/TypoScript/Seo/Setup/RelPrevNextMenu.typoscript',
-        'targetFileName' => 'CodeSnippets/Menu/TypoScript/RelPrevNextMenu.rst.txt',
-    ],
     // special = rootline
     [
         'action' => 'createCodeSnippet',
-        'caption' => 'EXT:site_package/Configuration/TypoScript/Menus/Setup/BreadcrumbLib.typoscript',
-        'sourceFile' => 'EXT:site_package/Configuration/TypoScript/Menus/Setup/BreadcrumbLib.typoscript',
-        'targetFileName' => 'CodeSnippets/Menu/TypoScript/BreadcrumbLib.rst.txt',
-    ],
-    [
-        'action' => 'createCodeSnippet',
-        'caption' => 'EXT:site_package/Configuration/TypoScript/Menus/Setup/BreadcrumbDataProcessor.typoscript',
-        'sourceFile' => 'EXT:site_package/Configuration/TypoScript/Menus/Setup/BreadcrumbDataProcessor.typoscript',
-        'targetFileName' => 'CodeSnippets/Menu/TypoScript/BreadcrumbDataProcessor.rst.txt',
-    ],
-    [
-        'action' => 'createCodeSnippet',
-        'caption' => 'EXT:site_package/Resources/Private/Templates/Partials/Navigation/Breadcrumb.html',
-        'sourceFile' => 'EXT:site_package/Resources/Private/Templates/Partials/Navigation/Breadcrumb.html',
+        'caption' => 'EXT:site_package/Resources/Private/PageView/Partials/Navigation/Breadcrumb.html',
+        'sourceFile' => 'EXT:site_package/Resources/Private/PageView/Partials/Navigation/Breadcrumb.html',
         'targetFileName' => 'CodeSnippets/Menu/Template/BreadcrumbDataProcessor.rst.txt',
     ],
-    // special = language
-    [
-        'action' => 'createCodeSnippet',
-        'caption' => 'EXT:site_package/Configuration/TypoScript/Menus/Setup/LanguageMenuLib.typoscript',
-        'sourceFile' => 'EXT:site_package/Configuration/TypoScript/Menus/Setup/LanguageMenuLib.typoscript',
-        'targetFileName' => 'CodeSnippets/Menu/TypoScript/LanguageMenuLib.rst.txt',
-    ],
 ];
diff --git a/Documentation/CodeSnippets/Config/TSconfig.php b/Documentation/CodeSnippets/Config/TSconfig.php
@@ -0,0 +1,21 @@
+<?php
+
+// https=>//github.com/TYPO3-Documentation/t3docs-codesnippets
+// ddev exec vendor/bin/typo3  restructured_api_tools:php_domain public/fileadmin/TYPO3CMS-Reference-TSconfig/Documentation/CodeSnippets/
+
+return [
+    [
+        'action' => 'createCodeSnippet',
+        'sourceFile' => 'EXT:examples/Configuration/TsConfig/Page/Mod/csvExport.tsconfig',
+        'targetFileName' => 'CodeSnippets/PageTSconfig/Mod/CsvExport.rst.txt',
+        'caption' => 'EXT:examples/Configuration/TsConfig/Page/Mod/csvExport.tsconfig',
+        'language' => 'typoscript',
+    ],
+    [
+        'action' => 'createCodeSnippet',
+        'sourceFile' => 'EXT:examples/Configuration/TsConfig/Page/Mod/noExportRecordsLinks.tsconfig',
+        'targetFileName' => 'CodeSnippets/PageTSconfig/Mod/noExportRecordsLinks.rst.txt',
+        'caption' => 'EXT:examples/Configuration/TsConfig/Page/Mod/noExportRecordsLinks.tsconfig',
+        'language' => 'typoscript',
+    ],
+];
diff --git a/Documentation/CodeSnippets/DataProcessing/DataProcessingTemplates.rst.txt b/Documentation/CodeSnippets/DataProcessing/DataProcessingTemplates.rst.txt
@@ -5,8 +5,7 @@
     :caption: EXT:examples/Configuration/TypoScript/DataProcessors/General.typoscript
 
     lib.contentElement {
-       templateRootPaths.200 = EXT:examples/Resources/Private/Templates/ContentElements/
-       partialRootPaths.200 = EXT:examples/Resources/Private/Partials/ContentElements/
-       layoutRootPaths.200 = EXT:examples/Resources/Private/Layout/
+        templateRootPaths.200 = EXT:examples/Resources/Private/Templates/ContentElements/
+        partialRootPaths.200 = EXT:examples/Resources/Private/Partials/ContentElements/
+        layoutRootPaths.200 = EXT:examples/Resources/Private/Layout/
     }
-
diff --git a/Documentation/CodeSnippets/DataProcessing/Template/DataProcCsv.rst.txt b/Documentation/CodeSnippets/DataProcessing/Template/DataProcCsv.rst.txt
@@ -20,4 +20,3 @@
           </f:for>
        </table>
     </html>
-
diff --git a/Documentation/CodeSnippets/DataProcessing/Template/DataProcCustom.rst.txt b/Documentation/CodeSnippets/DataProcessing/Template/DataProcCustom.rst.txt
@@ -18,4 +18,3 @@
        </ul>
 
     </html>
-
diff --git a/Documentation/CodeSnippets/DataProcessing/Template/DataProcDb.rst.txt b/Documentation/CodeSnippets/DataProcessing/Template/DataProcDb.rst.txt
@@ -26,4 +26,3 @@
        </div>
 
     </html>
-
diff --git a/Documentation/CodeSnippets/DataProcessing/Template/DataProcFiles.rst.txt b/Documentation/CodeSnippets/DataProcessing/Template/DataProcFiles.rst.txt
@@ -25,4 +25,3 @@
           </div>
        </div>
     </html>
-
diff --git a/Documentation/CodeSnippets/DataProcessing/Template/DataProcGallery.rst.txt b/Documentation/CodeSnippets/DataProcessing/Template/DataProcGallery.rst.txt
@@ -25,4 +25,3 @@
        </f:for>
 
     </html>
-
diff --git a/Documentation/CodeSnippets/DataProcessing/Template/DataProcLangMenu.rst.txt b/Documentation/CodeSnippets/DataProcessing/Template/DataProcLangMenu.rst.txt
@@ -31,4 +31,3 @@
        </f:if>
 
     </html>
-
diff --git a/Documentation/CodeSnippets/DataProcessing/Template/DataProcMenu.rst.txt b/Documentation/CodeSnippets/DataProcessing/Template/DataProcMenu.rst.txt
@@ -49,4 +49,3 @@
           </f:for>
        </ul>
     </html>
-
diff --git a/Documentation/CodeSnippets/DataProcessing/Template/DataProcSite.rst.txt b/Documentation/CodeSnippets/DataProcessing/Template/DataProcSite.rst.txt
@@ -13,4 +13,3 @@
        <p>Base url: <f:link.page pageUid="{site.rootPageId}">{site.configuration.base}</f:link.page></p>
 
     </html>
-
diff --git a/Documentation/CodeSnippets/DataProcessing/Template/DataProcSiteLanguage.rst.txt b/Documentation/CodeSnippets/DataProcessing/Template/DataProcSiteLanguage.rst.txt
@@ -13,4 +13,3 @@
     <p>language id: {language.languageId}</p>
 
     </html>
-
diff --git a/Documentation/CodeSnippets/DataProcessing/Template/DataProcSplit.rst.txt b/Documentation/CodeSnippets/DataProcessing/Template/DataProcSplit.rst.txt
@@ -15,4 +15,3 @@
        </f:for>
 
     </html>
-
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,4 +13,3 @@
		<p>Base url: <f:link.page pageUid="{site.rootPageId}">{site.configuration.base}</f:link.page></p>

		</html>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,4 +13,3 @@
		<p>language id: {language.languageId}</p>

		</html>