From 461664ce0407b38692db4af506d8539a8be24281 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.
Resolves: #103479
Releases: main, 12.4
Change-Id: Id52b3193cf270962f6d728d2dc012b5b1d5c2856
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83585
Tested-by: Lina Wolf <112@linawolf.de>
Tested-by: core-ci <typo3@b13.com>
Reviewed-by: Lina Wolf <112@linawolf.de>
Tested-by: Benni Mack <benni@typo3.org>
Reviewed-by: Benni Mack <benni@typo3.org>
---
.../form/Documentation/Includes.rst.txt | 35 +---------
typo3/sysext/form/Documentation/Index.rst | 1 -
typo3/sysext/form/Documentation/Settings.cfg | 69 -------------------
typo3/sysext/form/Documentation/genindex.rst | 7 --
typo3/sysext/form/Documentation/guides.xml | 6 ++
5 files changed, 7 insertions(+), 111 deletions(-)
delete mode 100644 typo3/sysext/form/Documentation/Settings.cfg
delete mode 100644 typo3/sysext/form/Documentation/genindex.rst
create mode 100644 typo3/sysext/form/Documentation/guides.xml
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 bbfe8b2b43b4..000000000000
--- a/typo3/sysext/form/Documentation/Settings.cfg
+++ /dev/null
@@ -1,69 +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/main/en-us/
-# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/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/main/en-us/
-# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/
-# t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/
-# t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
-# t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/
-# t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/
-# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/
-# t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/
-# t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/
-
-# TYPO3 system extensions
-# ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/main/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/main/en-us/
-# ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/
-# ext_form = https://docs.typo3.org/c/typo3/cms-form/main/en-us/
-# ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/
-# ext_impexp = https://docs.typo3.org/c/typo3/cms-impexp/main/en-us/
-# ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/
-# ext_linkvalidator = https://docs.typo3.org/c/typo3/cms-linkvalidator/main/en-us/
-# ext_lowlevel = https://docs.typo3.org/c/typo3/cms-lowlevel/main/en-us/
-# ext_reactions = https://docs.typo3.org/c/typo3/cms-reactions/main/en-us/
-# ext_recycler = https://docs.typo3.org/c/typo3/cms-recycler/main/en-us/
-# ext_redirects = https://docs.typo3.org/c/typo3/cms-redirects/main/en-us/
-# ext_reports = https://docs.typo3.org/c/typo3/cms-reports/main/en-us/
-# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/
-# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/
-# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/
-# ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/
-
-[extlinks]
-
-t3src = https://github.com/typo3/typo3/blob/main/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
new file mode 100644
index 000000000000..43fc7fedd01d
--- /dev/null
+++ b/typo3/sysext/form/Documentation/guides.xml
@@ -0,0 +1,6 @@
+<?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://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" edit-on-github-branch="main" edit-on-github="typo3/typo3" edit-on-github-directory="typo3/sysext/form/Documentation/" typo3-core-preferred="stable"/>
+ <project title="Form" release="main (development)" version="main (development)" copyright="since 2011 by the TYPO3 contributors"/>
+ <inventory id="t3coreapi" url="https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/"/>
+</guides>
--
GitLab