events/Documentation/Settings.rst
Daniel Siepmann a122f515d8
Adjust documentation (#19)
* Use current best practices.
* Update list of commands.
* Use confval directive to define available settings.
2023-05-23 11:51:16 +02:00

40 lines
939 B
ReStructuredText

.. _settings:
Settings
========
Frontend
--------
The frontend can be configured via TYPO3 Extbase defaults.
``stdWrap`` is applied to all options.
.. confval:: useMidnight
:type: bool (1 or 0)
:default: 1
| ``0`` will show dates starting from now.
| ``1`` will use midnight of configured start date.
.. confval:: upcoming
:type: bool (1 or 0)
:default: 0
| ``0`` does not alter the behaviour.
| ``1`` turns off the option ``useMidnight``, ``start`` and ``end``.
| Only dates with a start date in the future will be shown.
Import
------
The import can be configured via ``module.tx_events_import`` and offers the following
options:
.. confval:: module.tx_events_import.settings.repeatUntil
Allows to define how long dates should be repeated if ``repeatUntil`` is missing in import data.
The value will be passed to https://www.php.net/manual/en/datetime.modify.php.
No stdWrap is applied.