[TASK] Fix #591: Replace Settings.cfg with guides.xml in generated documentation

Replace the Sphinx-based documentation template (Settings.cfg) with the
PHP-renderer-based guides.xml format. Rename Includes.txt to Includes.rst.txt
and update all include paths to use absolute references (/Includes.rst.txt).
Update FileGenerator to render guides.xmlt instead of Settings.cfgt.

Author: PKuhlmay

Classes/Service/FileGenerator.php

@@ -846,15 +846,15 @@ protected function generateDocumentationFiles(): void
             '',
             true,
             5,
-            '.*(rstt|ymlt)'
+            '.*(rstt|ymlt|xmlt)'
         );
         foreach ($docFiles as $docFile) {
             if (is_dir($docFile)) {
                 $this->mkdir_deep(
                     $this->extensionDirectory,
                     'Documentation/' . str_replace($this->getTemplatePath('Documentation/'), '', $docFile)
                 );
-            } elseif (!str_contains($docFile, '.rstt')   && !str_contains($docFile, '.ymlt')) {
+            } elseif (!str_contains($docFile, '.rstt') && !str_contains($docFile, '.ymlt') && !str_contains($docFile, '.xmlt')) {
                 $this->upload_copy_move(
                     $docFile,
                     str_replace(
@@ -867,8 +867,8 @@ protected function generateDocumentationFiles(): void
         }
         $fileContents = $this->renderTemplate('Documentation/Index.rstt', ['extension' => $this->extension]);
         $this->writeFile($this->extensionDirectory . 'Documentation/Index.rst', $fileContents);
-        $fileContents = $this->renderTemplate('Documentation/Settings.cfgt', ['extension' => $this->extension]);
-        $this->writeFile($this->extensionDirectory . 'Documentation/Settings.cfg', $fileContents);
+        $fileContents = $this->renderTemplate('Documentation/guides.xmlt', ['extension' => $this->extension]);
+        $this->writeFile($this->extensionDirectory . 'Documentation/guides.xml', $fileContents);
     }
 
     protected function generateEmptyGitRepository(): void

Resources/Private/CodeTemplates/Extbase/Documentation/ChangeLog/Index.rst

@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _changelog:
 

Resources/Private/CodeTemplates/Extbase/Documentation/Configuration/Index.rst

@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _configuration:
 
@@ -47,4 +47,4 @@ don't hesitate to cross-link to the TypoScript Reference as shown below.
 
 See :ref:`h2document:how-to-document-hyperlinks` for information about how to use cross-references.
 
-See the :file:`Settings.cfg` file for the declaration of cross-linking keys.
+See the :file:`guides.xml` file for the declaration of cross-referencing inventories.

Resources/Private/CodeTemplates/Extbase/Documentation/Developer/Index.rst

@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _developer:
 

Resources/Private/CodeTemplates/Extbase/Documentation/Editor/Index.rst

@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _for-editors:
 

…lates/Extbase/Documentation/Includes.txt …s/Extbase/Documentation/Includes.rst.txtResources/Private/CodeTemplates/Extbase/Documentation/Includes.txt renamed to Resources/Private/CodeTemplates/Extbase/Documentation/Includes.rst.txt Resources/Private/CodeTemplates/Extbase/Documentation/Includes.txt renamed to Resources/Private/CodeTemplates/Extbase/Documentation/Includes.rst.txt

@@ -1,10 +1,4 @@
-.. every .rst file should include Includes.txt
-.. use correct path!
-
-.. include:: Includes.txt
-
-.. Every manual should have a start label for cross-referencing to
-.. start page. Do not remove this!
+.. include:: /Includes.rst.txt
 
 .. _start:
 
@@ -31,29 +25,6 @@
 
 {extension.description}
 
-**TYPO3**
-
-The content of this document is related to TYPO3 CMS,
-a GNU/GPL CMS/Framework available from `typo3.org <https://typo3.org/>`_ .
-
-**Community Documentation**
-
-This documentation is community documentation for the TYPO3 extension {extension.name}
-
-It is maintained as part of this third party extension.
-
-If you find an error or something is missing, please:
-`Report a Problem <https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/issues/new>`__
-
-**Extension Manual**
-
-This documentation is for the TYPO3 extension {extension.extensionKey}.
-
-**For Contributors**
-
-You are welcome to help improve this guide.
-Just click on "Edit me on GitHub" on the top right to submit your change request.
-
 .. toctree::
    :maxdepth: 3
 
@@ -64,4 +35,3 @@ Just click on "Edit me on GitHub" on the top right to submit your change request
    Developer/Index
    KnownProblems/Index
    ChangeLog/Index
-   Sitemap

Resources/Private/CodeTemplates/Extbase/Documentation/Index.rstt

@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _installation:
 

Resources/Private/CodeTemplates/Extbase/Documentation/Installation/Index.rst

@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _introduction:
 
@@ -33,8 +33,8 @@ install and use this extension.
 
 .. important::
 
-   Don't forget to set extension's version number in :file:`Settings.cfg` file,
-   in the :code:`release` property.
+   Don't forget to set the extension's version number in :file:`guides.xml`,
+   in the :code:`release` attribute of the :code:`<project>` element.
    It will be automatically picked up on the cover page by the :code:`|release|` substitution.
 
 .. _screenshots:

Resources/Private/CodeTemplates/Extbase/Documentation/Introduction/Index.rst

@@ -1,4 +1,4 @@
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 .. _known-problems: