From b8cd7bebbe88bbd8c18dd258e197b25cff783d01 Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Sun, 10 Mar 2024 11:29:51 +0100 Subject: [PATCH 1/3] [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 556af2919341c3d1b2ae3b9f74e933e4a1b94983) --- .github/workflows/test-documentation.yml | 17 + Documentation/Includes.rst.txt | 35 +- Documentation/Index.rst | 1 - Documentation/genindex.rst | 7 - Documentation/guides.xml | 21 + Documentation/screenshots.json | 1545 ---------------------- Makefile | 16 + 7 files changed, 55 insertions(+), 1587 deletions(-) create mode 100644 .github/workflows/test-documentation.yml 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/.github/workflows/test-documentation.yml b/.github/workflows/test-documentation.yml new file mode 100644 index 00000000..79ac662e --- /dev/null +++ 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/Includes.rst.txt b/Documentation/Includes.rst.txt index 469841d3..b5b5ca98 100644 --- 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 index 98fe68cb..9d072b49 100644 --- 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/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..b3b1f051 --- /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 dfc8ab64..00000000 --- a/Documentation/screenshots.json +++ /dev/null @@ -1,1545 +0,0 @@ -{ - "suites": { - "Examples": { - "screenshots": [ - [ - {"action": "setScreenshotsImagePath", "path": "Images/AutomaticScreenshots"}, - {"action": "createScreenshotsRstFile", "create": true}, - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - { - "action": "goToRecord", - "table": "tt_content", - "uid": {"action": "getUidByField", "table": "tt_content", "field": "header", "value": "Advanced FlexForm in plugin"} - }, - { - "action": "click", - "link": "Plugin" - }, - { - "action": "makeScreenshotOfElement", - "selector": ".module-body", - "fileName": "PluginFlexFormConfigurationCheck", - "captionText": "Checking the TCA configuration for the newly added Flexform" - }, - { - "action": "goToRecord", - "table": "fe_users", - "uid": {"action": "getUidByField", "table": "fe_users", "field": "username", "value": "example_user"} - }, - { - "action": "click", - "link": "Extended" - }, - { - "action": "makeScreenshotOfElement", - "selector": ".module-body", - "fileName": "ExtendingTcaFeUsers", - "altText": "New fields for fe\\_users table", - "captionText": "New fields for fe\\_users table" - } - ] - ] - }, - "Introduction": { - "screenshots": { - "actionsIdentifierImageManipulation": [ - {"action": "resizeWindow", "width": 1024,"height": 768}, - {"action": "see", "text": "Page"}, - {"action": "click", "link": "Page"}, - {"action": "openPageTreePath", "path": ["Congratulations"]}, - {"action": "switchToContentFrame"}, - {"action": "waitForText", "text": "Congratulations", "timeout": 5}, - {"action": "click", "link": "div#element-tt_content-223 a[href*=edit]"}, - {"action": "waitForText", "text": "Edit Page Content \"Deliver business value\" on page \"Congratulations\"", "timeout": 5}, - {"action": "click", "link": "Images"}, - {"action": "click", "link": "//div[@id=\"data-1-tt_content-223-image_records\"]/div[1]//button[contains(@class, \"form-irre-header-button\")]"}, - {"action": "wait", "timeout": 0.5}, - {"action": "resizeToFullPage"}, - { - "action": "makeScreenshotOfElement", - "selector": "//div[@id=\"data-1-tt_content-223-image_records\"]/div[1]//div[contains(@class, \"form-group\")][contains(., \"Image manipulation\")]", - "fileName": "ImageManipulationButton" - }, - {"action": "click", "link": "//div[@id=\"data-1-tt_content-223-image_records\"]/div[1]//button[contains(@class, \"form-irre-header-button\")]"}, - {"action": "resizeWindow", "width": 1024,"height": 768} - ], - "be_groups": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - { - "action": "setNavigationDefaultTable", - "table": "be_groups" - }, - { - "action": "makeScreenshotOfField", - "uid": 1, - "fields": "file_mountpoints", - "fileName": "FileMountpoints" - } - ], - "tt_content": [ - { - "action": "resizeWindow", - "width": 1024, - "height": 640 - }, - { - "action": "setNavigationDefaultTable", - "table": "tt_content" - }, - {"action": "amOnPage", "page": "/typo3/module/web/list?id=80&table=tt_content"}, - {"action": "switchToContentFrame"}, - { - "action": "makeScreenshotOfElement", - "fileName": "TtContent", - "selector": ".recordlist", - "altText": "Control section of tt_content" - }, - { - "action": "goToRecord", - "uid": { - "action": "getUidByField", - "table": "tt_content", - "field": "header", - "value": "Playground" - } - }, - - { - "action": "click", - "link": ".form-select" - }, - { - "action": "wait", - "timeout": 0.1 - }, - { - "action": "makeScreenshotOfElement", - "fileName": "CtrlType", - "altText": "The type selector of a content elements" - }, - - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tt_content", - "field": "header", - "value": "Deliver business value" - } - }, - { - "action": "makeScreenshotOfField", - "fields": "hidden", - "fileName": "TtContentHidden" - }, - { - "action": "goToField", - "fields": "image" - }, - { - "action": "click", - "link": ".panel-heading button.form-irre-header-button" - }, - {"action": "waitForText", "text": "Alternative Text"}, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "Image" - }, - {"action": "cropScreenshot", "fileName": "Image", "position": "right-top", "height": 400, "width": 640}, - { - "action": "click", - "link": ".panel-heading button.form-irre-header-button" - } - ] - } - }, - "Styleguide": { - "screenshots": { - "options": [ - {"action": "setScreenshotsImagePath", "path": "Images/AutomaticScreenshots"}, - {"action": "createScreenshotsRstFile", "create": true} - ], - "inline_fal": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_inline_fal" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_inline_fal", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "resizeWindow", - "width": 640, - "height": 2048 - }, - { - "action": "goToField", - "fields": "inline_1" - }, - { - "action": "click", - "link": ".form-irre-header-button" - }, - { - "action": "wait", - "timeout": 0.1 - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "InlineFalInline1" - } - ], - "overview": [ - {"action": "amOnPage", "page": "/typo3/main"}, - {"action": "resizeWindow", "width": 1220,"height": 440}, - {"action": "see", "text": "List"}, - {"action": "click", "link": "List"}, - {"action": "openPageTreePath", "path": ["styleguide TCA demo", "elements basic"]}, - {"action": "switchToContentFrame"}, - {"action": "waitForText", "text": "elements basic", "timeout": 5}, - { - "action": "click", - "link": "#recordlist-tx_styleguide_elements_basic a[data-bs-original-title=\"Edit record\"]" - }, - {"action": "waitForText", "text": "Edit Form engine elements", "timeout": 5}, - {"action": "makeScreenshotOfWindow", "fileName": "StyleguideViewExample"}, - {"action": "switchToMainFrame"}, - {"action": "click", "link": "#typo3-cms-backend-backend-toolbaritems-helptoolbaritem a"}, - {"action": "waitForText", "text": "Help", "timeout": 5}, - {"action": "see", "text": "Styleguide"}, - {"action": "click", "link": "Styleguide"}, - {"action": "switchToContentFrame"}, - {"action": "waitForText", "text": "TYPO3 CMS Backend Styleguide", "timeout": 5}, - {"action": "click", "link": "TCA / Records"}, - {"action": "waitForText", "text": "TCA test records", "timeout": 5}, - {"action": "switchToMainFrame"}, - {"action": "click", "link": "#typo3-cms-backend-backend-toolbaritems-helptoolbaritem a"}, - {"action": "makeScreenshotOfWindow", "fileName": "StyleguideCreateTCA"} - ], - "input_basic": [ - {"comment": "************************************"}, - {"comment": "Screenshots from table tx_styleguide_elements_basic"}, - {"comment": "************************************"}, - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_elements_basic" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_basic", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfField", - "fields": "sys_language_uid", - "fileName": "SysLanguageUid" - }, - { - "action": "goToField", - "fields": "input_1" - }, - { - "action": "drawBox", - "selector": ".formengine-field-item-description" - }, - { - "action": "makeScreenshotOfElement", - "fileName": "Label" - }, - { - "action": "makeScreenshotOfField", - "fields": "input_28", - "fileName": "Input28" - }, - { - "action": "makeScreenshotOfField", - "fields": "input_30", - "fileName": "Input30" - }, - { - "action": "makeScreenshotOfField", - "fields": "input_33", - "fileName": "Input33" - } - ], - "none_basic": [ - {"comment": "************************************"}, - {"comment": "Screenshots from table tx_styleguide_elements_basic"}, - {"comment": "************************************"}, - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_elements_basic" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_basic", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfField", - "fields": "none_1", - "fileName": "None1" - } - ], - "radio_basic": [ - {"comment": "************************************"}, - {"comment": "Screenshots from table tx_styleguide_elements_basic"}, - {"comment": "************************************"}, - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_elements_basic" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_basic", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfField", - "fields": "radio_1", - "fileName": "Radio1" - } - ], - "checkbox_basic": [ - {"comment": "************************************"}, - {"comment": "Screenshots from table tx_styleguide_elements_basic"}, - {"comment": "************************************"}, - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_elements_basic" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_basic", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfField", - "fields": "checkbox_2", - "fileName": "Checkbox2" - }, - { - "action": "makeScreenshotOfField", - "fields": "checkbox_3", - "fileName": "Checkbox3" - }, - { - "action": "makeScreenshotOfField", - "fields": "checkbox_7", - "fileName": "Checkbox7" - }, - { - "action": "makeScreenshotOfField", - "fields": "checkbox_8", - "fileName": "Checkbox8" - }, - { - "action": "makeScreenshotOfField", - "fields": "checkbox_12", - "fileName": "Checkbox12" - }, - { - "action": "makeScreenshotOfField", - "fields": "checkbox_16", - "fileName": "Checkbox16" - }, - { - "action": "makeScreenshotOfField", - "fields": "checkbox_17", - "fileName": "Checkbox17" - }, - { - "action": "makeScreenshotOfField", - "fields": "checkbox_18", - "fileName": "Checkbox18" - }, - { - "action": "makeScreenshotOfField", - "fields": "checkbox_19", - "fileName": "Checkbox19" - }, - { - "action": "makeScreenshotOfField", - "fields": "checkbox_21", - "fileName": "Checkbox21" - } - ], - "text_basic": [ - {"comment": "************************************"}, - {"comment": "Screenshots from table tx_styleguide_elements_basic"}, - {"comment": "************************************"}, - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_elements_basic" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_basic", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfField", - "fields": "text_4", - "fileName": "Text4" - }, - { - "action": "makeScreenshotOfField", - "fields": "text_5", - "fileName": "Text5" - }, - { - "action": "makeScreenshotOfField", - "fields": "text_6", - "fileName": "Text6" - }, - { - "action": "makeScreenshotOfField", - "fields": "text_7", - "fileName": "Text7" - }, - { - "action": "makeScreenshotOfField", - "fields": "text_9", - "fileName": "Text9" - }, - { - "action": "makeScreenshotOfField", - "fields": "text_11", - "fileName": "Text11" - }, - { - "action": "makeScreenshotOfField", - "fields": "text_14", - "fileName": "Text14" - }, - { - "action": "makeScreenshotOfField", - "fields": "text_15", - "fileName": "Text15" - }, - { - "action": "makeScreenshotOfField", - "fields": "text_17", - "fileName": "Text17", - "captionText": "The table wizard allows to edit the code-like configuration of the tables with a visual editor." - }, - { - "action": "makeScreenshotOfField", - "fields": "text_19", - "fileName": "Text19" - }, - { - "action": "makeScreenshotOfField", - "fields": "text_20", - "fileName": "Text20" - } - ], - "basic_translation": [ - {"comment": "************************************"}, - {"comment": "Screenshots from table tx_styleguide_elements_basic translation "}, - {"comment": "************************************"}, - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_elements_basic" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_basic", - "field": "sys_language_uid", - "value": { - "action": "getUidByField", - "table": "sys_language", - "field": "title", - "value": "styleguide demo language german" - } - } - }, - { - "action": "makeScreenshotOfField", - "fields": "text_2", - "fileName": "TranslatedText2" - } - ], - "select": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_elements_select" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_select", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfField", - "fields": "select_checkbox_1", - "fileName": "SelectCheckbox1" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_checkbox_2", - "fileName": "SelectCheckbox2" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_checkbox_3", - "fileName": "SelectCheckbox3" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_checkbox_5", - "fileName": "SelectCheckbox5" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_checkbox_7", - "fileName": "SelectCheckbox7" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_multiplesidebyside_1", - "fileName": "SelectMultiplesidebyside1" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_multiplesidebyside_2", - "fileName": "SelectMultiplesidebyside2" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_multiplesidebyside_5", - "fileName": "SelectMultiplesidebyside5" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_multiplesidebyside_6", - "fileName": "SelectMultiplesidebyside6" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_multiplesidebyside_8", - "fileName": "SelectMultiplesidebyside8" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_multiplesidebyside_10", - "fileName": "SelectMultiplesidebyside10" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_1", - "fileName": "SelectSingle1" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_3", - "fileName": "SelectSingle3" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_4", - "fileName": "SelectSingle4" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_7", - "fileName": "SelectSingle7" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_10", - "fileName": "SelectSingle10" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_12", - "fileName": "SelectSingle12" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_15", - "fileName": "SelectSingle15" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_16", - "fileName": "SelectSingle16" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_17", - "fileName": "SelectSingle17" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_18", - "fileName": "SelectSingle18" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_19", - "fileName": "SelectSingle19" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_20", - "fileName": "SelectSingle20" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_singlebox_1", - "fileName": "SelectSinglebox1" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_singlebox_3", - "fileName": "SelectSinglebox3" - }, - { - "action": "goToField", - "fields": "select_tree_1" - }, - { - "action": "wait", - "timeout": 1 - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "SelectTree1" - }, - { - "action": "goToField", - "fields": "select_tree_2" - }, - { - "action": "wait", - "timeout": 1 - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "SelectTree2" - }, - { - "action": "goToField", - "fields": "select_tree_6" - }, - { - "action": "wait", - "timeout": 1 - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "SelectTree6" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_requestUpdate_1", - "fileName": "SelectRequestupdate1" - } - ], - "select_translation": [ - {"comment": "************************************"}, - {"comment": "Screenshots from table tx_styleguide_elements_select translation "}, - {"comment": "************************************"}, - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_elements_select" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_select", - "field": "sys_language_uid", - "value": { - "action": "getUidByField", - "table": "sys_language", - "field": "title", - "value": "styleguide demo language german" - } - } - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_8", - "fileName": "TranslatedSelectSingle8" - }, - { - "action": "makeScreenshotOfField", - "fields": "select_single_13", - "fileName": "TranslatedSelectSingle13" - } - ], - "rte": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_elements_rte" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_rte", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfField", - "fields": "rte_1", - "fileName": "Rte1" - }, - {"action": "cropScreenshot", "fileName": "Rte1", "position": "right-top", "height": 300, "width": 640}, - { - "action": "makeScreenshotOfField", - "fields": "rte_2", - "fileName": "Rte2" - }, - {"action": "cropScreenshot", "fileName": "Rte2", "position": "right-top", "height": 300, "width": 640}, - { - "action": "makeScreenshotOfField", - "fields": "rte_3", - "fileName": "Rte3" - }, - {"action": "cropScreenshot", "fileName": "Rte3", "position": "right-top", "height": 300, "width": 640}, - { - "action": "makeScreenshotOfField", - "fields": "rte_4", - "fileName": "Rte4" - }, - {"action": "cropScreenshot", "fileName": "Rte4", "position": "right-top", "height": 300, "width": 640}, - { - "action": "makeScreenshotOfField", - "fields": "rte_5", - "fileName": "Rte5" - }, - {"action": "cropScreenshot", "fileName": "Rte5", "position": "right-top", "height": 350, "width": 640} - ], - "t3editor": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_elements_t3editor" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_t3editor", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfField", - "fields": "t3editor_1", - "fileName": "T3editor1" - } - ], - "flex": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_flex" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_flex", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfField", - "fields": "flex_1", - "fileName": "Flex1", - "altText": "A field with a simple, one-field flex form" - }, - { - "action": "makeScreenshotOfField", - "fields": "flex_2", - "fileName": "Flex2", - "altText": "A flex form with two sheets and descriptions" - }, - { - "action": "makeScreenshotOfField", - "fields": "flex_file_1", - "fileName": "FlexFile1", - "altText": "A field with a simple, one-field flex form" - } - ], - "slugs": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_elements_slugs" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_slugs", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfField", - "fields": "slug_1", - "fileName": "Slug1" - }, - { - "action": "makeScreenshotOfField", - "fields": "slug_2", - "fileName": "Slug2" - }, - { - "action": "makeScreenshotOfField", - "fields": "slug_3", - "fileName": "Slug3" - }, - { - "action": "makeScreenshotOfField", - "fields": "slug_4", - "fileName": "Slug4" - }, - { - "action": "makeScreenshotOfField", - "fields": "slug_5", - "fileName": "Slug5" - } - ], - "elements_group": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_elements_group" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_elements_group", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfField", - "fields": "group_db_1", - "fileName": "GroupDb1" - }, - { - "action": "makeScreenshotOfField", - "fields": "group_db_3", - "fileName": "GroupDb3" - }, - { - "action": "makeScreenshotOfField", - "fields": "group_db_8", - "fileName": "GroupDb8" - }, - { - "action": "makeScreenshotOfField", - "fields": "group_db_10", - "fileName": "GroupDb10" - }, - { - "action": "makeScreenshotOfField", - "fields": "group_db_11", - "fileName": "GroupDb11" - }, - { - "action": "makeScreenshotOfField", - "fields": "group_folder_1", - "fileName": "GroupFolder1" - } - ], - "inline_1n": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_inline_1n" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_inline_1n", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "goToField", - "fields": "inline_1" - }, - { - "action": "click", - "link": ".form-irre-header-button" - }, - { - "action": "wait", - "timeout": 0.1 - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "Inline1nInline1" - } - ], - "inline_1n1n": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_inline_1n1n" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_inline_1n1n", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "goToField", - "fields": "inline_1" - }, - { - "action": "click", - "link": ".form-irre-header-button" - }, - { - "action": "wait", - "timeout": 0.1 - }, - { - "action": "click", - "link": ".form-irre-object .panel-collapse .form-irre-header-button" - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "Inline1n1nInline1" - } - ], - "inline_mm": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_inline_mm" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_inline_mm", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "InlineMmChildParents", - "captionText": "An inline field with MM relation defined in the opposite table" - }, - { - "action": "goToField", - "fields": "inline_1" - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "InlineMmInline1", - "altText": "An inline field with MM relation" - } - ], - "inline_mm_child": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_inline_mm_child" - } - ], - "inline_mn": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_inline_mn" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_inline_mn", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "goToField", - "fields": "inline_1" - }, - { - "action": "click", - "link": ".form-irre-header-button" - }, - { - "action": "wait", - "timeout": 0.1 - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "InlineMnInline1" - } - ], - "inline_mn_child": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_inline_mn_child" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_inline_mn_child", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "goToField", - "fields": "parents" - }, - { - "action": "click", - "link": ".form-irre-header-button" - }, - { - "action": "wait", - "timeout": 0.1 - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "InlineMnChildParents" - } - ], - "inline_mnsymmetric_branches": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_inline_mnsymmetric" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_inline_mnsymmetric", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "goToField", - "fields": "branches" - }, - { - "action": "click", - "link": ".form-irre-header-button" - }, - { - "action": "wait", - "timeout": 0.1 - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "InlineMnSymmetricBranches" - } - ], - "inline_mnsymmetric_input": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_inline_mnsymmetric" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_inline_mnsymmetric", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "goToField", - "fields": "branches" - }, - { - "action": "click", - "link": ".form-irre-header-button" - }, - { - "action": "wait", - "timeout": 1 - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "InlineMnSymmetric11Branches" - } - ], - "inline_usecombination": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_inline_usecombination" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_inline_usecombination", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "goToField", - "fields": "inline_1" - }, - { - "action": "click", - "link": ".form-irre-header-button" - }, - { - "action": "wait", - "timeout": 0.1 - }, - { - "action": "makeScreenshotOfElement", - "selector": ".form-section", - "fileName": "InlineUsecombinationcInline1" - } - ], - "type": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_type" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_type", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfField", - "fields": "record_type", - "fileName": "RecordType" - }, - { - "action": "goToRecord" - }, - { - "action": "makeScreenshotOfElement", - "selector": ".t3js-module-body", - "fileName": "CtrlTypeWithChangedFields" - }, - { - "action": "selectOption", - "select": "select[name=\"data[tx_styleguide_type][1][record_type]\"]", - "option": "0" - }, - {"action": "waitForModalDialogInMainFrame"}, - { - "action": "makeScreenshotOfElement", - "fileName": "CtrlTypeChangeModal" - }, - {"action": "click", "link": "OK"}, - {"action": "wait", "timeout": 0.3}, - { - "action": "makeScreenshotOfElement", - "selector": ".t3js-module-body", - "fileName": "CtrlType0" - }, - { - "action": "selectOption", - "select": "select[name=\"data[tx_styleguide_type][1][record_type]\"]", - "option": "withColumnsOverrides" - }, - {"action": "waitForModalDialogInMainFrame"}, - {"action": "click", "link": "OK"}, - {"action": "wait", "timeout": 1}, - { - "action": "makeScreenshotOfElement", - "selector": ".t3js-module-body", - "fileName": "CtrlTypeWithOverriddenColumns" - }, - - { - "action": "makeScreenshotOfField", - "fields": "record_type", - "fileName": "RecordType" - } - ], - "typeforeign": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_typeforeign" - }, - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_typeforeign", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfRecord", - "fileName": "CtrlTypeForeign", - "selector": ".typo3-TCEforms", - "altText": "The type of the record is fetched from the record specified in field `foreign_table`" - }, - { - "action": "makeScreenshotOfField", - "fields": "foreign_table", - "fileName": "TypeForeignForeignTable" - } - ], - "ctrl_common": [ - { - "action": "resizeWindow", - "width": 640, - "height": 640 - }, - - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_ctrl_common" - }, - { - "action": "setNavigationDefaultUid", - "uid": 1 - }, - { - "action": "makeScreenshotOfField", - "fields": "sys_language_uid", - "fileName": "SysLanguageUid", - "altText": "A typical sys_language_uid field" - }, - { - "action": "makeScreenshotOfRecord", - "fileName": "CtrlDescriptionColumn", - "selector": "#EditDocumentController", - "altText": "Record information shown editing an example record" - }, - { - "action": "goToRecord" - }, - { - "action": "waitForText", - "text": "Access", - "timeout": 5 - }, - { - "action": "click", - "link": "Access" - }, - { - "action": "wait", - "timeout": 0.1 - }, - { - "action": "makeScreenshotOfElement", - "selector": "[role=\"tabpanel\"]", - "fileName": "CtrlEnableFields", - "altText": "Record information shown editing an example record" - }, - {"action": "amOnPage", "page": "/typo3/module/web/list?id=7&table=tx_styleguide_ctrl_common"}, - - { - "action": "resizeWindow", - "width": 1024, - "height": 640 - }, - {"action": "switchToMainFrame"}, - { - "action": "click", - "link": "Hide Navigation" - }, - {"action": "switchToContentFrame"}, - { - "action": "makeScreenshotOfElement", - "fileName": "TxStyleguideCtrlCommon", - "selector": ".recordlist", - "altText": "A common example of the control section" - }, - {"action": "switchToMainFrame"}, - { - "action": "click", - "link": "Show Navigation" - } - ], - "ctrl_minimal": [ - { - "action": "resizeWindow", - "width": 1024, - "height": 640 - }, - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_ctrl_minimal" - }, - { - "action": "setNavigationDefaultUid", - "uid": 1 - }, - {"action": "amOnPage", "page": "/typo3/module/web/list?id=12&table=tx_styleguide_ctrl_minimal"}, - - {"action": "switchToContentFrame"}, - { - "action": "makeScreenshotOfElement", - "fileName": "TxStyleguideCtrlMinimal", - "selector": ".recordlist", - "altText": "A minimal example of the control section" - } - ], - "palettes": [ - { - "action": "resizeWindow", - "width": 640, - "height": 1024 - }, - { - "action": "setNavigationDefaultTable", - "table": "tx_styleguide_palette" - }, - - { - "action": "setNavigationDefaultUid", - "uid": { - "action": "getUidByField", - "table": "tx_styleguide_typeforeign", - "field": "sys_language_uid", - "value": 0 - } - }, - { - "action": "makeScreenshotOfRecord", - "fileName": "Palette", - "selector": ".typo3-TCEforms", - "captionText": "Examples of different palettes in the extension styleguide" - }, - { - "action": "makeScreenshotOfRecord", - "fileName": "PaletteDescription", - "selector": "//*[contains(@class, 'form-section') and contains(., 'palette_1')]", - "captionText": "A palette with a description" - } - ] - } - } - } -} diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..77dab54f --- /dev/null +++ b/Makefile @@ -0,0 +1,16 @@ +.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 documentation (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: test-docs +test-docs: ## Test the documentation rendering + mkdir -p Documentation-GENERATED-temp + + docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log From b6ffb3f8c37e7b50228452bc17353fd1aa090b9f Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Sun, 10 Mar 2024 10:52:43 +0100 Subject: [PATCH 2/3] [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 19fde0ab11cdd0a7eb1de279a2cfc9bee2d50f63) --- .../ColumnsConfig/Type/File/Properties/Appearance.rst | 2 +- Documentation/ColumnsConfig/Type/Flex/Index.rst | 2 +- .../Flex/Properties/DsPointerFieldSearchParent.rst | 8 ++++---- .../Properties/DsPointerFieldSearchParentSubField.rst | 8 ++++---- .../Type/Flex/Properties/DsTableField.rst | 8 ++++---- Documentation/ColumnsConfig/Type/Inline/Examples.rst | 10 +++++----- .../Type/Password/Properties/PasswordPolicy.rst | 2 +- .../Type/Select/Properties/SelectTreeConfig.rst | 2 +- 8 files changed, 21 insertions(+), 21 deletions(-) diff --git a/Documentation/ColumnsConfig/Type/File/Properties/Appearance.rst b/Documentation/ColumnsConfig/Type/File/Properties/Appearance.rst index 98c84654..cd30a516 100644 --- 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 `. + This property can also be overridden by :ref:`page TSconfig `. diff --git a/Documentation/ColumnsConfig/Type/Flex/Index.rst b/Documentation/ColumnsConfig/Type/Flex/Index.rst index 336e0126..843be0c1 100644 --- a/Documentation/ColumnsConfig/Type/Flex/Index.rst +++ b/Documentation/ColumnsConfig/Type/Flex/Index.rst @@ -5,7 +5,7 @@ FlexForm field ============== -Renders a :ref:`FlexForm ` element. Essentially, this consists in a +Renders a :ref:`FlexForm ` 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 index cc9b174b..6a246c6c 100644 --- 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/Documentation/ColumnsConfig/Type/Flex/Properties/DsPointerFieldSearchParentSubField.rst b/Documentation/ColumnsConfig/Type/Flex/Properties/DsPointerFieldSearchParentSubField.rst index 1eb8c122..61ee79aa 100644 --- a/Documentation/ColumnsConfig/Type/Flex/Properties/DsPointerFieldSearchParentSubField.rst +++ b/Documentation/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 index 5dd67272..ca0ff1b6 100644 --- 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 index 286c750f..901416fd 100644 --- 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'] ` * How to create custom fieldInformation, fieldControl or fieldWizard in - :ref:`FormEngine ` chapter (TYPO3 + :ref:`FormEngine ` chapter (TYPO3 Explained) * :ref:`fieldInformation ` property diff --git a/Documentation/ColumnsConfig/Type/Password/Properties/PasswordPolicy.rst b/Documentation/ColumnsConfig/Type/Password/Properties/PasswordPolicy.rst index 64ce65fa..f0ba4c68 100644 --- 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 ` to fields + This option assigns a :ref:`password policy ` to fields of the type `password`. For configured fields, the password policy validator will be used in :ref:`DataHandler ` 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 index 33531825..e9c334c6 100644 --- 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: From 542b8c12b02914ae1d181d8107304871ffb33bb6 Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Sun, 10 Mar 2024 12:14:51 +0100 Subject: [PATCH 3/3] [BUGFIX] Delete Settings --- Documentation/Settings.cfg | 71 -------------------------------------- 1 file changed, 71 deletions(-) delete mode 100644 Documentation/Settings.cfg diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg deleted file mode 100644 index 18b9b5c2..00000000 --- a/Documentation/Settings.cfg +++ /dev/null @@ -1,71 +0,0 @@ -# More information about this file: -# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg - -[general] - -project = TCA Reference -version = 12.4 -release = 12.4 -copyright = since 2012 by the TYPO3 contributors - -[html_theme_options] - -# "Edit on GitHub" button -github_repository = TYPO3-Documentation/TYPO3CMS-Reference-TCA -github_branch = 12.4 - -# Footer links -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 -project_discussions = - -use_opensearch = - -[intersphinx_mapping] - -# Official TYPO3 manuals -h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ -# t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/ -t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/12.4/en-us/ -# t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/main/en-us/ -# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/12.4/en-us/ -# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/12.4/en-us/ -# t3home = https://docs.typo3.org/ -# t3install = https://docs.typo3.org/m/typo3/guide-installation/12.4/en-us/ -# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/12.4/en-us/ -# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/12.4/en-us/ -# t3tca = https://docs.typo3.org/m/typo3/reference-tca/12.4/en-us/ -t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/12.4/en-us/ -t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/12.4/en-us/ -t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/12.4/en-us/ -# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/12.4/en-us/ -# t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/12.4/en-us/ -# t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/12.4/en-us/ - -# TYPO3 system extensions -# ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/12.4/en-us/ -ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/ -# ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/12.4/en-us/ -# ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/12.4/en-us/ -# ext_form = https://docs.typo3.org/c/typo3/cms-form/12.4/en-us/ -# ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/12.4/en-us/ -# ext_impexp = https://docs.typo3.org/c/typo3/cms-impexp/12.4/en-us/ -# ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/12.4/en-us/ -# ext_linkvalidator = https://docs.typo3.org/c/typo3/cms-linkvalidator/12.4/en-us/ -# ext_lowlevel = https://docs.typo3.org/c/typo3/cms-lowlevel/12.4/en-us/ -# ext_reactions = https://docs.typo3.org/c/typo3/cms-reactions/12.4/en-us/ -# ext_recycler = https://docs.typo3.org/c/typo3/cms-recycler/12.4/en-us/ -# ext_redirects = https://docs.typo3.org/c/typo3/cms-redirects/12.4/en-us/ -# ext_reports = https://docs.typo3.org/c/typo3/cms-reports/12.4/en-us/ -# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/12.4/en-us/ -# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/12.4/en-us/ -# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/12.4/en-us/ -ext_t3editor = https://docs.typo3.org/c/typo3/cms-t3editor/12.4/en-us/ -ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/12.4/en-us/ - -[extlinks] - -t3ext = https://extensions.typo3.org/extension/%s | EXT: -t3src = https://github.com/typo3/typo3/blob/main/typo3/sysext/%s | EXT: