Adjust documentation (#19)

* Use current best practices.
* Update list of commands.
* Use confval directive to define available settings.
This commit is contained in:
Daniel Siepmann 2023-05-23 11:51:16 +02:00 committed by GitHub
parent 76c1e79ea3
commit a122f515d8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 52 additions and 33 deletions

View file

@ -16,8 +16,11 @@ Access built in help:
# Get detailed help of command # Get detailed help of command
./vendor/bin/typo3 help events:destinationdataimport ./vendor/bin/typo3 help events:destinationdataimport
``events:destinationdataimport`` ``events:destinationdataimportviaconfiguration``
-------------------------------- ------------------------------------------------
``events:destinationdataimportviaallconfigurations``
----------------------------------------------------
``events:removeAll`` ``events:removeAll``
-------------------------------- --------------------------------

View file

@ -4,30 +4,26 @@
Events Events
====== ======
.. only:: html :Extension key:
:Classification:
events events
:Description: :Package name:
Extension to manage events, that can be imported from Destination Data wrm/events
:Language:
en
:Author: :Author:
Dirk Koritnik Daniel Siepmann
:Email:
koritnik@werkraum-media.de
:License: :License:
This document is published under the Open Content License This document is published under the
available from http://www.opencontent.org/opl.shtml `Creative Commons BY-NC-SA 4.0 <https://creativecommons.org/licenses/by-nc-sa/4.0/>`__
license.
:Rendered: :Rendered:
|today| |today|
The content of this document is related to TYPO3,
a GNU/GPL CMS/Framework available from `www.typo3.org <http://www.typo3.org/>`_.
A basic events extension. A basic events extension.
This is shared as is. It is developed and used by the agency for some years already. This is shared as is. It is developed and used by the agency for some years already.
@ -47,3 +43,9 @@ Table of Contents
Settings Settings
Changelog Changelog
Maintenance Maintenance
.. toctree::
:hidden:
Sitemap
genindex

View file

@ -1,6 +1,6 @@
[general] [general]
project = Events Extension project = Events Extension
copyright = since 2019 by Dirk Koritnik copyright = since 2019 by Dirk Koritnik and Daniel Siepmann
[html_theme_options] [html_theme_options]
github_branch = main github_branch = main

View file

@ -10,16 +10,18 @@ The frontend can be configured via TYPO3 Extbase defaults.
``stdWrap`` is applied to all options. ``stdWrap`` is applied to all options.
.. option:: settings.useMidnight .. confval:: useMidnight
Can be set to ``1`` (default) or ``0``. :type: bool (1 or 0)
:default: 1
| ``0`` will show dates starting from now. | ``0`` will show dates starting from now.
| ``1`` will use midnight of configured start date. | ``1`` will use midnight of configured start date.
.. option:: settings.upcoming .. confval:: upcoming
Can be set to ``0`` (default) or ``1``. :type: bool (1 or 0)
:default: 0
| ``0`` does not alter the behaviour. | ``0`` does not alter the behaviour.
| ``1`` turns off the option ``useMidnight``, ``start`` and ``end``. | ``1`` turns off the option ``useMidnight``, ``start`` and ``end``.
@ -31,7 +33,7 @@ Import
The import can be configured via ``module.tx_events_import`` and offers the following The import can be configured via ``module.tx_events_import`` and offers the following
options: options:
.. option:: module.tx_events_import.settings.repeatUntil .. confval:: module.tx_events_import.settings.repeatUntil
Allows to define how long dates should be repeated if ``repeatUntil`` is missing in import data. 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. The value will be passed to https://www.php.net/manual/en/datetime.modify.php.

View file

@ -0,0 +1,7 @@
:template: sitemap.html
=======
Sitemap
=======
.. The sitemap.html template will insert here the page tree automatically.

View file

@ -0,0 +1,5 @@
=====
Index
=====
.. Sphinx will insert here the general index automatically.