From cbfeb4c04db1da1903f845e896c5eab8a23838f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Mon, 14 Mar 2016 23:08:57 +0100 Subject: [PATCH] documenting the activity configuration options --- source/bundles/activity.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/source/bundles/activity.rst b/source/bundles/activity.rst index 65dce71b7..df88df674 100644 --- a/source/bundles/activity.rst +++ b/source/bundles/activity.rst @@ -23,6 +23,29 @@ Entities provided Describe the entities provided. + +Configuration options +********************* + +Those options are available under `chill_activity` key. + +Example of configuration: + +.. code-block:: yaml + + chill_activity: + form: + time_duration: + - { label: '12 minutes', seconds: 720 } + - { label: '30 minutes', seconds: 1800 } + +form.time_duration *array* + The duration which might be suggested when the user create or update an activity. The value must be an array of object, where each object must have a :code:`label` and a :code:`seconds` key. The label provide which is shown to user (the label will be translated, if possible) and the seconds the duration. + + Example: see the example above + + Default value: the values available are 5, 10, 15, 20, 25, 30, 45 minutes, and 1 hour, 1 hour 15, 1 hour 30, 1 hour 45 and 2 hours. + Macros ******