mirror of
https://github.com/werkraum-media/events.git
synced 2024-11-24 07:36:09 +01:00
Adjust documentation (#19)
* Use current best practices. * Update list of commands. * Use confval directive to define available settings.
This commit is contained in:
parent
76c1e79ea3
commit
a122f515d8
6 changed files with 52 additions and 33 deletions
|
@ -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``
|
||||||
--------------------------------
|
--------------------------------
|
||||||
|
|
|
@ -4,29 +4,25 @@
|
||||||
Events
|
Events
|
||||||
======
|
======
|
||||||
|
|
||||||
.. only:: html
|
:Extension key:
|
||||||
|
events
|
||||||
|
|
||||||
:Classification:
|
:Package name:
|
||||||
events
|
wrm/events
|
||||||
|
|
||||||
:Description:
|
:Language:
|
||||||
Extension to manage events, that can be imported from Destination Data
|
en
|
||||||
|
|
||||||
:Author:
|
:Author:
|
||||||
Dirk Koritnik
|
Daniel Siepmann
|
||||||
|
|
||||||
:Email:
|
:License:
|
||||||
koritnik@werkraum-media.de
|
This document is published under the
|
||||||
|
`Creative Commons BY-NC-SA 4.0 <https://creativecommons.org/licenses/by-nc-sa/4.0/>`__
|
||||||
|
license.
|
||||||
|
|
||||||
:License:
|
:Rendered:
|
||||||
This document is published under the Open Content License
|
|today|
|
||||||
available from http://www.opencontent.org/opl.shtml
|
|
||||||
|
|
||||||
:Rendered:
|
|
||||||
|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.
|
||||||
|
|
||||||
|
@ -39,11 +35,17 @@ Table of Contents
|
||||||
=================
|
=================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 3
|
:maxdepth: 3
|
||||||
:titlesonly:
|
:titlesonly:
|
||||||
|
|
||||||
Features
|
Features
|
||||||
Commands
|
Commands
|
||||||
Settings
|
Settings
|
||||||
Changelog
|
Changelog
|
||||||
Maintenance
|
Maintenance
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
Sitemap
|
||||||
|
genindex
|
||||||
|
|
|
@ -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
|
||||||
|
|
|
@ -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.
|
||||||
|
|
7
Documentation/Sitemap.rst
Normal file
7
Documentation/Sitemap.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
:template: sitemap.html
|
||||||
|
|
||||||
|
=======
|
||||||
|
Sitemap
|
||||||
|
=======
|
||||||
|
|
||||||
|
.. The sitemap.html template will insert here the page tree automatically.
|
5
Documentation/genindex.rst
Normal file
5
Documentation/genindex.rst
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
=====
|
||||||
|
Index
|
||||||
|
=====
|
||||||
|
|
||||||
|
.. Sphinx will insert here the general index automatically.
|
Loading…
Reference in a new issue