From 8c19c5dadf9f0f313bf54e9d48de10f554eaac0b Mon Sep 17 00:00:00 2001 From: Simon Praetorius Date: Thu, 4 Jul 2024 12:31:51 +0200 Subject: [PATCH] Update FluidViewHelper.rst (#436) --- Documentation/Maintainers/FluidViewHelper.rst | 58 +++---------------- 1 file changed, 7 insertions(+), 51 deletions(-) diff --git a/Documentation/Maintainers/FluidViewHelper.rst b/Documentation/Maintainers/FluidViewHelper.rst index 399dabe1..2ab9fc15 100644 --- a/Documentation/Maintainers/FluidViewHelper.rst +++ b/Documentation/Maintainers/FluidViewHelper.rst @@ -19,60 +19,16 @@ to the TYPO3 Core, follow the :ref:`TYPO3 Contribution Guide - Core Development `. -.. _fluid-viewhelper-reference-generation-schema: - -The Fluid ViewHelper schema generator -===================================== - -The PHP files defining the ViewHelpers are transferred into :file:`schema.xsd` -files. The package `fluid-schema-generator `__ -is responsible for this step, automatically executed via triggered GitHub actions. If information is missing in the -:file:`schema.xsd`, adjustments need to be made in the PHP files. :file:`schema.xsd` files are considered "read-only" due to their auto-generated nature. The information from the -:file:`schema.xsd` files can, if configured through plugins, also used by IDEs for context sensitive help in -editors etc. - -You can generate the :file:`schema.xsd` files yourself for local testing, like this: - -.. code-block:: bash - - git clone git@github.com:typo3/typo3.git core - cd core - composer require -o -n --no-progress typo3/fluid-schema-generator - mkdir -p ../schemas/typo3fluid/fluid/latest - ./bin/generateschema TYPO3Fluid\\\Fluid > ../schemas/typo3fluid/fluid/latest/schema.xsd - mkdir -p ../schemas/typo3/core/latest - ./bin/generateschema TYPO3\\\CMS\\\Core > ../schemas/typo3/core/latest/schema.xsd - mkdir -p ../schemas/typo3/fluid/latest - ./bin/generateschema TYPO3\\\CMS\\\Fluid > ../schemas/typo3/fluid/latest/schema.xsd - mkdir -p ../schemas/typo3/backend/latest - ./bin/generateschema TYPO3\\\CMS\\\Backend > ../schemas/typo3/backend/latest/schema.xsd - -The composer step will automatically require the Fluid Rendering Engine in the version -used by the Core version you fetched via GIT (by default, `main`). - .. _fluid-viewhelper-reference-generation-rst: -Generation of the reStructuredText files -========================================= - -The :abbr:`rst (reStructuredText)` files get generated from the -:file:`schema.xsd` files (See section -:ref:`fluid-viewhelper-reference-generation-schema`) with the help of the -following tool: -`Fluid ViewHelper Documentation Generator `. - -Please note that the TYPO3 Core initially uses `reStructuredText` formatting -inside the phpDoc comments already, and this is passed on to the :file:`schema.xsd` -files with exactly that formatting. -IDEs may want to interpret these schemas with expected HTML or MarkDown syntax, -so you may see raw `reStructuredText` output in this case. -The generated Documentation for `docs.typo3.org` takes care of -transforming the generated :file:`.rst` files to HTML, by utilizing the -https://github.com/TYPO3-Documentation/render-guides project. - +Generation of the reStructuredText files and JSON files +======================================================= -If any of the ViewHelper source code documentation is only contained in the :file:`schema.xsd` files but -not the generated standalone :file:`.rst` files, a bug in that generator may exist and needs adressing. +The `Fluid ViewHelper Documentation Generator ` +is responsible for creating both a directory structure of :abbr:`rst (reStructuredText)` files and +a json file for each documented Fluid namespace. The Fluid namespaces to be documented are configured +in JSON files in this repository, which also support combining multiple namespaces into one +(because `f:*` in TYPO3 combines both `EXT:fluid` and Fluid Standalone ViewHelpers). .. _fluid-viewhelper-reference-generation-html: