diff --git a/Documentation/Reference/GuidesXml.rst b/Documentation/Reference/GuidesXml.rst index b00d0687..f6cac058 100644 --- a/Documentation/Reference/GuidesXml.rst +++ b/Documentation/Reference/GuidesXml.rst @@ -50,6 +50,13 @@ And follow the interactive question. The following settings can be relevant for TYPO3 themed documentation: + .. note:: + The schema accepts a :xml:`theme` attribute on :xml:``, + but TYPO3 documentation does not need it: the theme is loaded by + the :xml:`` tag. A + :xml:`` **child element** is invalid and aborts rendering + with `Invalid type for path guides.theme`. + .. _settings-guides-default-code-language: .. confval:: default-code-language @@ -137,6 +144,9 @@ And follow the interactive question. + The :xml:`url` should end with a trailing slash (:xml:`.../en-us/`) — + without it, resolving the inventory can fail. + .. _settings-guides-project: @@ -242,6 +252,12 @@ And follow the interactive question. The class attribute is mandatory, it references the extension that is used to render the documentation with the TYPO3 documentation theme. + .. note:: + If the :xml:`class` attribute (or the whole :xml:`` + tag) is missing, the documentation renders with the default + phpDocumentor layout instead of the TYPO3 theme. No error is + raised — the output just looks wrong. + .. _settings-guides-github-workflow: .. confval:: edit-on-github-*