diff --git a/web_timeline/README.rst b/web_timeline/README.rst index 161a4924..6993ff04 100755 --- a/web_timeline/README.rst +++ b/web_timeline/README.rst @@ -46,162 +46,6 @@ You also need to declare the view in an action window of the involved model. Example: .. code-block:: xml -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - -============= -Timeline view -============= - -Define a new view displaying events in an interactive visualization chart. - -The widget is based on the external library -http://visjs.org/timeline_examples.html - -Configuration -============= - -You need to define a view with the tag as base element. These are -the possible attributes for the tag: - -* date_start (required): it defines the name of the field of type date that - contains the start of the event. -* date_end (optional): it defines the name of the field of type date that - contains the end of the event. The date_end can be equal to the attribute - date_start to display events has 'point' on the Timeline (instantaneous event) -* date_delay (optional): it defines the name of the field of type float/integer - that contain the duration in hours of the event, default = 1 -* default_group_by (required): it defines the name of the field that will be - taken as default group by when accessing the view or when no other group by - is selected. -* zoomKey (optional): Specifies whether the Timeline is only zoomed when an - additional key is down. Available values are '' (does not apply), 'altKey', - 'ctrlKey', or 'metaKey'. Set this option if you want to be able to use the - scroll to navigate vertically on views with a lot of events. -* mode (optional): Specifies the initial visible window. Available values are: - 'day' to display the current day, 'week', 'month' and 'fit'. - Default value is 'fit' to adjust the visible window such that it fits all items -* event_open_popup (optional): when set to true, it allows to edit the events - in a popup. If not (default value), the record is edited changing to form - view. -* colors (optional): it allows to set certain specific colors if the expressed - condition (JS syntax) is met. - -* tooltip (optional): it defines the name of the field of type string for the tooltip content. -You also need to declare the view in an action window of the involved model. - -Example: - -.. code-block:: xml - - - - - project.task - timeline - - - - - - - - kanban,tree,form,calendar,gantt,timeline,graph - - - -Usage -===== - -For accessing the timeline view, you have to click on the button with the clock -icon in the view switcher. The first time you access to it, the timeline window -is zoomed to fit all the current elements, the same as when you perform a -search, filter or group by operation. - -You can use the mouse scroll to zoom in or out in the timeline, and click on -any free area and drag for panning the view in that direction. - -The records of your model will be shown as rectangles whose widths are the -duration of the event according our definition. You can select them clicking -on this rectangle. You can also use Ctrl or Shift keys for adding discrete -or range selections. Selected records are hightlighted with a different color -(but the difference will be more noticeable depending on the background color). -Once selected, you can drag and move the selected records across the timeline. - -When a record is selected, a red cross button appears on the upper left corner -that allows to remove that record. This doesn't work for multiple records -although they were selected. - -Records are grouped in different blocks depending on the group by criteria -selected (if none is specified, then the default group by is applied). -Dragging a record from one block to another change the corresponding field to -the value that represents the block. You can also click on the group name to -edit the involved record directly. - -Double-click on the record to edit it. Double-click in open area to create a -new record with the group and start date linked to the area you clicked in. - - -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/162/10.0 - -Known issues / Roadmap -====================== - -* Implement support for vis.js timeline range item addition (with Ctrl key - pressed). -* Implement a more efficient way of refreshing timeline after a record update. - -Bug Tracker -=========== - -Bugs are tracked on `GitHub Issues -`_. In case of trouble, please -check there if your issue has already been reported. If you spotted it first, -help us smashing it by providing a detailed and welcomed feedback. - -Credits -======= - -Images ------- - -* Odoo Community Association: `Icon `_. - -Contributors ------------- - -* Laurent Mignon -* Adrien Peiffer -* Pedro M. Baeza -* Leonardo Donelli -* Adrien Didenot - -Do not contact contributors directly about support or help with technical issues. - -Maintainer ----------- - -.. image:: https://odoo-community.org/logo.png - :alt: Odoo Community Association - :target: https://odoo-community.org - -This module is maintained by the OCA. - -OCA, or the Odoo Community Association, is a nonprofit organization whose -mission is to support the collaborative development of Odoo features and -promote its widespread use. - -To contribute to this module, please visit https://odoo-community.org. @@ -215,8 +59,8 @@ To contribute to this module, please visit https://odoo-community.org. default_group_by="user_id" event_open_popup="true" zoomKey="ctrlKey" - tooltip="tooltip_model_field" - colors="#ec7063:user_id == false;#2ecb71:kanban_state=='done';"> + colors="#ec7063:user_id == false;#2ecb71:kanban_state=='done';" + tooltip="tooltip_model_field">