From 37528a7c8044d17aa9d3ab2673a16a61b4aadc46 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 10 Mar 2024 10:51:13 +0100 Subject: [PATCH] [TASK] Backport 11.5 Switch to PHP-based rendering (#441) * [TASK] Backport 11.5 Switch to PHP-based rendering * [TASK] Backport 111.5 Switch to PHP-based rendering --- Documentation/Index.rst | 1 - Documentation/PageTsconfig/Rte.rst | 3 +- Documentation/PageTsconfig/TceMain.rst | 2 +- Documentation/genindex.rst | 7 --- Documentation/guides.xml | 21 +++++++ Documentation/screenshots.json | 85 -------------------------- Makefile | 29 +++++++++ 7 files changed, 53 insertions(+), 95 deletions(-) delete mode 100644 Documentation/genindex.rst create mode 100644 Documentation/guides.xml delete mode 100644 Documentation/screenshots.json create mode 100644 Makefile diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 8ba30bcd..8f22b4f4 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -53,4 +53,3 @@ Explained. :hidden: Sitemap - genindex diff --git a/Documentation/PageTsconfig/Rte.rst b/Documentation/PageTsconfig/Rte.rst index 224f56fd..2f0e334b 100644 --- a/Documentation/PageTsconfig/Rte.rst +++ b/Documentation/PageTsconfig/Rte.rst @@ -386,7 +386,8 @@ configuration of the transformations. For instance you may disable the mapping b :code:`-` and :code:`-` tags which is done by the `ts_transform` transformation. Notice how many properties relate to specific transformations only! Also notice that the meta-transformations -`ts_css` imply other transformations :ref:`as explained in the overview `. +`ts_css` imply other transformations. + This means that options limited to `ts_transform` will also work for `ts_css` of course. diff --git a/Documentation/PageTsconfig/TceMain.rst b/Documentation/PageTsconfig/TceMain.rst index 0d34d8f5..766081ac 100644 --- a/Documentation/PageTsconfig/TceMain.rst +++ b/Documentation/PageTsconfig/TceMain.rst @@ -213,7 +213,7 @@ linkHandler title in the linkbrowser. It then saves the link in the format `t3://record?identifier=my_content&uid=123`. To render the link in the frontend you need to define the same key in the TypoScript setup - :ref:`config.recordLinks `. + `config.recordLinks`. .. tip:: For a complete example see also the :ref:`Record link tutorial diff --git a/Documentation/genindex.rst b/Documentation/genindex.rst deleted file mode 100644 index 806ec56a..00000000 --- a/Documentation/genindex.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. include:: /Includes.rst.txt - -===== -Index -===== - -.. Sphinx will insert here the general index automatically. diff --git a/Documentation/guides.xml b/Documentation/guides.xml new file mode 100644 index 00000000..e72a0052 --- /dev/null +++ b/Documentation/guides.xml @@ -0,0 +1,21 @@ + + + + + diff --git a/Documentation/screenshots.json b/Documentation/screenshots.json deleted file mode 100644 index 1596a2a3..00000000 --- a/Documentation/screenshots.json +++ /dev/null @@ -1,85 +0,0 @@ -{ - "suites": { - "Styleguide": { - "screenshots": { - "_default": [ - {"action": "resizeWindow", "width": 1024,"height": 768}, - {"action": "setScreenshotsImagePath","path": "Images/AutomaticScreenshots"}, - {"action": "setScreenshotsRstPath","path": "Images/AutomaticScreenshots"}, - {"action": "setCodeSnippetsSourcePath","path": "typo3conf/ext/styleguide"}, - {"action": "setCodeSnippetsTargetPath", "path": "CodeSnippets"} - ], - "fields": [ - {"include": "_default"}, - { - "action": "goToField", - "table": "tx_styleguide_elements_basic", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_basic", - "field": "sys_language_uid", - "value": 0 - }, - "fields": "input_1" - }, - {"action": "switchToMainFrame"}, - {"action": "click", "link": "button.t3js-topbar-button-modulemenu"}, - {"action": "switchToContentFrame"}, - { - "action": "makeScreenshotOfElement", - "selector": ".typo3-TCEforms", - "fileName": "Input1" - }, - {"action": "switchToMainFrame"}, - {"action": "click", "link": "button.t3js-topbar-button-modulemenu"} - ] - } - }, - "Examples": { - "screenshots": { - "_default": [ - {"action": "resizeWindow", "width": 1024,"height": 768}, - {"action": "setScreenshotsImagePath","path": "Images/AutomaticScreenshots"}, - {"action": "setScreenshotsRstPath","path": "Images/AutomaticScreenshots"}, - {"action": "setCodeSnippetsSourcePath","path": "typo3conf/ext/examples"}, - {"action": "setCodeSnippetsTargetPath", "path": "CodeSnippets"} - ], - "fileListExport": [ - {"include": "_default"}, - {"action": "resizeWindow", "width": 1024,"height": 480}, - {"action": "see", "text": "List"}, - {"action": "click", "link": "List"}, - {"action": "openPageTreePath", "path": ["Root page", "TSconfig Reference", "with ExportRecordsLinks"]}, - {"action": "switchToMainFrame"}, - {"action": "click", "link": "button.t3js-topbar-button-modulemenu"}, - { - "action": "makeScreenshotOfContentFrame", - "fileName": "WebList/WithExportButtons", - "captionText": "The list module with export buttons after activating the single-table mode" - }, - {"action": "switchToContentFrame"}, - {"action": "click", "link": "//button[contains(.,'Download')]"}, - {"action": "waitForModalDialogInMainFrame"}, - { - "action": "makeScreenshotOfElement", - "fileName": "WebList/ExportDialog" - }, - {"action": "click", "link": "Cancel"}, - {"action": "switchToMainFrame"}, - {"action": "openPageTreePath", "path": ["Root page", "TSconfig Reference", "no ExportRecordsLinks"]}, - {"action": "switchToContentFrame"}, - { - "action": "makeScreenshotOfContentFrame", - "fileName": "WebList/NoExportButtons", - "captionText": "The list module without export buttons after activating the single-table mode" - }, - {"action": "switchToMainFrame"}, - {"action": "click", "link": "button.t3js-topbar-button-modulemenu"}, - {"action": "setCodeSnippetsTargetPath", "path": "CodeSnippets/PageTSconfig/Mod"}, - {"action": "createCodeSnippet", "sourceFile": "Configuration/TSconfig/Page/Mod/csvExport.tsconfig", "targetFileName": "CsvExport", "language": "typoscript"}, - {"action": "createCodeSnippet", "sourceFile": "Configuration/TSconfig/Page/Mod/noExportRecordsLinks.tsconfig", "targetFileName": "noExportRecordsLinks", "language": "typoscript"} - ] - } - } - } -} \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..1196ff05 --- /dev/null +++ b/Makefile @@ -0,0 +1,29 @@ +.PHONY: help +help: ## Displays this list of targets with descriptions + @echo "The following commands are available:\n" + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' + +.PHONY: docs +docs: ## Generate projects docs (from "Documentation" directory) + mkdir -p Documentation-GENERATED-temp + + docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation + +.PHONY: codesnippets +codesnippets: ## Regenerate automatic code snippets + .Build/vendor/bin/typo3 codesnippet:create Documentation/CodeSnippets/ + +.PHONY: test +test: test-lint test-cgl test-docs ## Runs all test suites + +.PHONY: test-lint +test-lint: ## Lint PHP includes + Build/Scripts/runTests.sh -s lint + +.PHONY: test-cgl +test-cgl: ## Test coding guidelines to PHP includes + Build/Scripts/runTests.sh -n -s cgl + +.PHONY: fix-cgl +fix-cgl: ## Apply coding guidelines to PHP includes + Build/Scripts/runTests.sh -s cgl