From 90fd24b2d36f0922483aceebc83c2a236b9ddf2b Mon Sep 17 00:00:00 2001 From: Martin Trigaux Date: Wed, 10 Feb 2016 07:40:21 +0100 Subject: [PATCH] [FIX] doc: gantt documentation Tutorial was using gantt view from 8.0 Add documentation in reference section on new attributes --- doc/howtos/backend.rst | 10 +++++----- doc/reference/views.rst | 36 +++++++++++++++++++++++++----------- 2 files changed, 30 insertions(+), 16 deletions(-) diff --git a/doc/howtos/backend.rst b/doc/howtos/backend.rst index 0b29d8ec0ae..0c61cc56fcb 100644 --- a/doc/howtos/backend.rst +++ b/doc/howtos/backend.rst @@ -1128,11 +1128,11 @@ their root element is ````. .. code-block:: xml - - - - - + .. exercise:: Gantt charts diff --git a/doc/reference/views.rst b/doc/reference/views.rst index 871b275cd39..d775759222e 100644 --- a/doc/reference/views.rst +++ b/doc/reference/views.rst @@ -1013,26 +1013,40 @@ take the following attributes: and the end date will be set to the start date ``date_delay`` name of the field providing the duration of the event -``progress`` - name of a field providing the completion percentage for the record's event, - between 0 and 100 +``duration_unit`` + one of ``minute``, ``hour`` (default), ``day``, ``week``, ``month``, ``year`` + ``default_group_by`` name of a field to group tasks by -``fold_last_level`` - If a value is set, the last grouping level is folded -``round_dnd_dates`` - enables rounding the task's start and end dates to the nearest scale marks +``type`` + ``gantt`` classic gantt view (default) + + ``consolidate`` values of the first children are consolidated in the gantt's task + + ``planning`` children are displayed in the gantt's task ``consolidation`` field name to display consolidation value in record cell ``consolidation_max`` dictionary with the "group by" field as key and the maximum consolidation value that can be reached before displaying the cell in red + (e.g. ``{"user_id": 100}``) + + .. warning:: + The dictionnary definition must use double-quotes, ``{'user_id': 100}`` is + not a valid value +``consolidation_label`` + string to display next to the consolidation value, if not specified, the label + of the consolidation field will be used +``fold_last_level`` + If a value is set, the last grouping level is folded +``round_dnd_dates`` + enables rounding the task's start and end dates to the nearest scale marks + +.. ``progress`` + name of a field providing the completion percentage for the record's event, + between 0 and 100 .. consolidation_exclude .. consolidation_color -.. ``type`` - ``gantt`` classic gantt view (default) - ``consolidate`` values of the first children are consolidated in the gantt's task - ``planning`` children are displayed in the gantt's task .. _reference/views/diagram: