Browse Source

Update README

pull/405/head
Iván Todorovich 8 years ago
parent
commit
1346b74e1f
  1. 43
      web_dashboard_tile/README.rst

43
web_dashboard_tile/README.rst

@ -1,17 +1,17 @@
Add Tiles to Dashboard
======================
Dashboard Tiles
===============
module to give you a dashboard where you can configure tile from any view
Adds a dashboard where you can configure tiles from any view
and add them as short cut.
* Tile can be:
* displayed only for a user;
* global for all users (In that case, some tiles will be hidden if
the current user doesn't have access to the given model);
* The tile displays items count of a given model restricted to a given domain;
* Optionnaly, the tile can display the result of a function of a field;
* Function is one of sum/avg/min/max/median;
* Field must be integer or float;
* Displayed only for a user.
* Global for all users (In that case, some tiles will be hidden if
the current user doesn't have access to the given model).
* The tile displays items count of a given model restricted to a given domain.
* Optionally, the tile can display the result of a function of a field
* Function is one of sum/avg/min/max/median.
* Field must be integer or float.
Usage
=====
@ -24,17 +24,18 @@ Usage
.. image:: ./static/src/img/screenshot_action_click.png
Kown issues/limits
==================
* can not edit tile from dashboard (color, sequence, function, ...);
* context are ignored;
* combine domain of menue and filter so can not restore origin filter;
possible future improvments
===========================
* add icons;
* support client side action (like inbox);
* restore original Domain + Filter when an action is set.
Known issues
============
* Can not edit tile from dashboard (color, sequence, function, ...).
* Original context is ignored.
* Original domain and filter are not restored.
* To preserve a relative date domain, you have to manually edit the tile's domain from `Configuration > User Interface > Dashboard Tile`. You can use the same variables available in filters (`uid`, `context_today()`, `current_date`, `time`, `datetime`, `relativedelta`).
Roadmap
=======
* Add icons.
* Support client side action (like inbox).
* Restore original Domain + Filter when an action is set.
Bug Tracker
===========

Loading…
Cancel
Save