Note
This version of the guide covers the new PHP-based rendering of Documentation with the TYPO3 Documentation theme.
If the project you are looking at has a file Documentation/guides.xml it is using the new rendering.
Otherwise, consider to migrate the Documentation or head over to the legacy version of this guide: How to document, Sphinx based.
Fluid ViewHelper reference generation¶
The Fluid ViewHelper Reference gets automatically updated by changes to the according ViewHelper classes in the TYPO3 Core and the package Fluid Rendering Engine.
The generated documentation specifically depends on the phpDoc-style inline
comments on top of the ViewHelper classes as well as the configured arguments in their
php:initializeArguments() method.
Changes in wording or arguments thus need to be made inside the relevant files of these two repositories. For contributions to the TYPO3 Core, follow the TYPO3 Contribution Guide - Core Development.
Generation of the reStructuredText files and JSON files¶
The Fluid ViewHelper Documentation Generator <https://github.com/TYPO3-Documentation/fluid-documentation-generator>
is responsible for creating both a directory structure of rst 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).
Rendering the ViewHelper reference to HTML¶
The rst files generated in step
Generation of the reStructuredText files and JSON files will be saved by the
GitHub action into
the repository Fluid ViewHelper Reference <https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-ViewHelper>.
In this repository all files not overridden by the
Fluid ViewHelper Documentation Generator <https://github.com/TYPO3-Documentation/fluid-documentation-generator>
are maintained, Including the start page Index.rst and the
guides.xml. This repository is then rendered by
the standard rendering process.
GitHub action "Fluid ViewHelper Documentation"¶
All processes described above are combined for automatic execution as a GitHub action in the repository t3docs-ci-deploy. It is triggered automatically once a day, or can be executed manually through the GitHub UI by the TYPO3 Documentation team.
Maintainers needs to occasionally watch for failed or stuck Workflow runs.