From 194cc1271929405f2b3a9f90b95354465c69d540 Mon Sep 17 00:00:00 2001 From: Lina Wolf <112@linawolf.de> Date: Mon, 25 Mar 2024 08:09:40 +0100 Subject: [PATCH] [DOCS] Switch form documentation to PHP-based rendering A backport to 11.5 is not possible due to too many issues in the Docs that cannot be backported automatically. Change-Id: I32e957ec8b41059e8eb8ddfd17f80f08c3ea454d Resolves: #103479 Releases: main, 12.4 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83543 Tested-by: core-ci Reviewed-by: Lina Wolf <112@linawolf.de> Tested-by: Lina Wolf <112@linawolf.de> --- .../form/Documentation/Includes.rst.txt | 35 +--------- typo3/sysext/form/Documentation/Index.rst | 1 - typo3/sysext/form/Documentation/Settings.cfg | 70 ------------------- typo3/sysext/form/Documentation/genindex.rst | 7 -- typo3/sysext/form/Documentation/guides.xml | 22 +++++- 5 files changed, 20 insertions(+), 115 deletions(-) delete mode 100644 typo3/sysext/form/Documentation/Settings.cfg delete mode 100644 typo3/sysext/form/Documentation/genindex.rst diff --git a/typo3/sysext/form/Documentation/Includes.rst.txt b/typo3/sysext/form/Documentation/Includes.rst.txt index af7f7005ee32..236250747b4d 100644 --- a/typo3/sysext/form/Documentation/Includes.rst.txt +++ b/typo3/sysext/form/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/typo3/sysext/form/Documentation/Index.rst b/typo3/sysext/form/Documentation/Index.rst index 6032575fb492..e562ac31a8d1 100644 --- a/typo3/sysext/form/Documentation/Index.rst +++ b/typo3/sysext/form/Documentation/Index.rst @@ -53,4 +53,3 @@ integrators and developers alike to create all kinds of forms. :hidden: Sitemap - genindex diff --git a/typo3/sysext/form/Documentation/Settings.cfg b/typo3/sysext/form/Documentation/Settings.cfg deleted file mode 100644 index 54f118da20cf..000000000000 --- a/typo3/sysext/form/Documentation/Settings.cfg +++ /dev/null @@ -1,70 +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 = Form -version = main (development) -release = main (development) -copyright = since 2011 by the TYPO3 contributors - -[html_theme_options] - -# "Edit on GitHub" button -github_repository = typo3/typo3 -github_branch = main -path_to_documentation_dir = typo3/sysext/form/Documentation/ - -# Footer links -project_home = https://extensions.typo3.org/extension/form/ -project_contact = https://typo3.slack.com/archives/C025BQLFA -project_repository = https://github.com/typo3/typo3 -project_issues = https://forge.typo3.org/projects/typo3cms-core/issues -project_discussions = - -use_opensearch = - -[intersphinx_mapping] - -# Official TYPO3 manuals -# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ -# t3content = https://docs.typo3.org/m/typo3/guide-contentandmarketing/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/ -# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/12.4/en-us/ -# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/ -# t3home = https://docs.typo3.org/ -# 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/12.4/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] - -t3src = https://github.com/typo3/typo3/blob/12.4/typo3/sysext/%s | EXT: diff --git a/typo3/sysext/form/Documentation/genindex.rst b/typo3/sysext/form/Documentation/genindex.rst deleted file mode 100644 index 806ec56a77c4..000000000000 --- a/typo3/sysext/form/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/typo3/sysext/form/Documentation/guides.xml b/typo3/sysext/form/Documentation/guides.xml index b5acce4488c1..43b556949c42 100644 --- a/typo3/sysext/form/Documentation/guides.xml +++ b/typo3/sysext/form/Documentation/guides.xml @@ -1,5 +1,21 @@ - - - + + +