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.
Site settings¶
When an extension features Settings definitions
for site settings these can be automatically documented by including the settings
definition file. The special syntax PROJECT: can be used to load the file
from the directory of the extension instead of the Documentation folder only.
.. typo3:site-set-settings:: PROJECT:/Configuration/Sets/MySet/settings.definitions.yaml
:name: my-set
:type:
:Label: max=30
:default: max=10
-
website.¶background. color -
- Type
color- Default
"#129845"- Label
- Background color
This will validate the given color string
-
website.¶image. lazy Loading -
- Type
string- Default
"lazy"- Label
- Browser-native image lazy loading
- Enum
- { "lazy": "Lazy", "eager": "Eager", "auto": "Auto" }
Can be "lazy" (browsers could choose to load images later), "eager" (load images right away) or "auto" (browser will determine whether the image should be lazy loaded or not)
-
- Type
string- Default
"a, abbr, acronym, address, article, aside, b, bdo, big, blockquote, br, caption, center, cite, code, col, colgroup, dd, del, dfn, dl, div, dt, em, figure, font, footer, header, h1, h2, h3, h4, h5, h6, hr, i, img, ins, kbd, label, li, link, meta, nav, ol, p, pre, q, s, samp, sdfield, section, small, span, strike, strong, style, sub, sup, table, thead, tbody, tfoot, td, th, tr, title, tt, u, ul, var"- Label
- List of allowed HTML tags when rendering RTE content
The custom parameters :type:, :Label: etc can be used to configure
which aspects of the settings should be shown in the overview table.
A :name: can be used to create a namespace when there are several sets. All
links to the configuration values will be prefixed then.