Techsystech
/
web
mirror of https://github.com/OCA/web.git
3
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

[UPD] README.rst

pull/2325/head
OCA-git-bot 2021-11-26 13:39:44 +00:00 committed by Sylvain LE GAL
parent 8c76207d82
commit 5a3ee93464
2 changed files with 55 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
web_dashboard_tile/README.rst
View File

@ -13,11 +13,17 @@ Overview Dashboard (Tiles)
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3 :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-legalsylvain%2Fweb-lightgray.png?logo=github .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
:target: https://github.com/legalsylvain/web/tree/12.0-mig-web_dashboard_tile/web_dashboard_tile :target: https://github.com/OCA/web/tree/12.0/web_dashboard_tile
:alt: legalsylvain/web :alt: OCA/web
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/web-12-0/web-12-0-web_dashboard_tile
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/162/12.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge1| |badge2| |badge3| |badge4| |badge5|
Adds a dashboard where you can configure tiles from any view and add them as short cut. Adds a dashboard where you can configure tiles from any view and add them as short cut.
@ -55,7 +61,7 @@ First, you have to create tile categories.
Odoo menu and action are automatically created. Odoo menu and action are automatically created.
You should refresh your browser to see new menu items. You should refresh your browser to see new menu items.
.. image:: https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_category_form.png .. image:: https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_category_form.png
Then you can create tiles. Then you can create tiles.
@ -67,15 +73,15 @@ Then you can create tiles.
* Setting a user, or a group in "Security" tab will restrict the display of the tile. * Setting a user, or a group in "Security" tab will restrict the display of the tile.
.. image:: https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_form.png .. image:: https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_tile_form.png
You can optionanaly define a secondary value, for that purpose : You can optionally define a secondary value, for that purpose :
* Select a field, a function to apply. * Select a field, a function to apply.
* You can define a specific format. (``.format()`` python syntax) * You can define a specific format. (``.format()`` python syntax)
.. image:: https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_form_secondary_value.png .. image:: https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_tile_form_secondary_value.png
Usage Usage
@ -85,20 +91,19 @@ Usage
* The tile configured is displayed with the up to date count and average values of the selected domain. * The tile configured is displayed with the up to date count and average values of the selected domain.
.. image:: https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_kanban.png .. image:: https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_tile_kanban.png
* By clicking on the item, you'll navigate to the tree view of the according model. * By clicking on the item, you'll navigate to the tree view of the according model.
.. image:: https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_2_tree_view.png .. image:: https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_tile_2_tree_view.png
**Note** **Note**
When you are in a tree view, with a domain, you can save it in the favorite menu, but the configuration is limited. When you are in a tree view, with a domain, you can save it in the favorite menu, but the configuration is limited.
.. image:: https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/favorite_menu_create_tile.png .. image:: https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/favorite_menu_create_tile.png
.. image:: https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/favorite_menu_create_tile_result.png
.. image:: https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/favorite_menu_create_tile_result.png
Known issues / Roadmap Known issues / Roadmap
====================== ======================
@ -122,10 +127,10 @@ Known issues / Roadmap
Bug Tracker Bug Tracker
=========== ===========
Bugs are tracked on `GitHub Issues <https://github.com/legalsylvain/web/issues>`_. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
In case of trouble, please check there if your issue has already been reported. 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 If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/legalsylvain/web/issues/new?body=module:%20web_dashboard_tile%0Aversion:%2012.0-mig-web_dashboard_tile%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. `feedback <https://github.com/OCA/web/issues/new?body=module:%20web_dashboard_tile%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues. Do not contact contributors directly about support or help with technical issues.
@ -137,6 +142,7 @@ Authors
* initOS GmbH & Co. KG * initOS GmbH & Co. KG
* GRAP * GRAP
* Iván Todorovich <ivan.todorovich@gmail.com>
Contributors Contributors
~~~~~~~~~~~~ ~~~~~~~~~~~~
@ -148,14 +154,24 @@ Contributors
Maintainers Maintainers
~~~~~~~~~~~ ~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
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.
.. |maintainer-legalsylvain| image:: https://github.com/legalsylvain.png?size=40px .. |maintainer-legalsylvain| image:: https://github.com/legalsylvain.png?size=40px
:target: https://github.com/legalsylvain :target: https://github.com/legalsylvain
:alt: legalsylvain :alt: legalsylvain
Current maintainer: Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|maintainer-legalsylvain| |maintainer-legalsylvain|
This module is part of the `legalsylvain/web <https://github.com/legalsylvain/web/tree/12.0-mig-web_dashboard_tile/web_dashboard_tile>`_ project on GitHub. This module is part of the `OCA/web <https://github.com/OCA/web/tree/12.0/web_dashboard_tile>`_ project on GitHub.
You are welcome to contribute. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

36
web_dashboard_tile/static/description/index.html
View File

@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" /> <meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
<title>Overview Dashboard (Tiles)</title> <title>Overview Dashboard (Tiles)</title>
<style type="text/css"> <style type="text/css">
@ -367,7 +367,7 @@ ul.auto-toc {
!! This file is generated by oca-gen-addon-readme !! !! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !! !! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/legalsylvain/web/tree/12.0-mig-web_dashboard_tile/web_dashboard_tile"><img alt="legalsylvain/web" src="https://img.shields.io/badge/github-legalsylvain%2Fweb-lightgray.png?logo=github" /></a></p> <p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/web/tree/12.0/web_dashboard_tile"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-12-0/web-12-0-web_dashboard_tile"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/162/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>Adds a dashboard where you can configure tiles from any view and add them as short cut.</p> <p>Adds a dashboard where you can configure tiles from any view and add them as short cut.</p>
<p>By default, the tile displays items count of a given model restricted to a given domain.</p> <p>By default, the tile displays items count of a given model restricted to a given domain.</p>
<p>Optionally, the tile can display the result of a function on a field.</p> <p>Optionally, the tile can display the result of a function on a field.</p>
@ -407,7 +407,7 @@ ul.auto-toc {
</ul> </ul>
<p>Odoo menu and action are automatically created. <p>Odoo menu and action are automatically created.
You should refresh your browser to see new menu items.</p> You should refresh your browser to see new menu items.</p>
<img alt="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_category_form.png" src="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_category_form.png" /> <img alt="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_category_form.png" src="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_category_form.png" />
<p>Then you can create tiles.</p> <p>Then you can create tiles.</p>
<ul class="simple"> <ul class="simple">
<li>go to “Dashboards &gt; Settings &gt; Dashboard Tiles”</li> <li>go to “Dashboards &gt; Settings &gt; Dashboard Tiles”</li>
@ -415,13 +415,13 @@ You should refresh your browser to see new menu items.</p>
<li>You can optionally define colors, domain a specific action to use.</li> <li>You can optionally define colors, domain a specific action to use.</li>
<li>Setting a user, or a group in “Security” tab will restrict the display of the tile.</li> <li>Setting a user, or a group in “Security” tab will restrict the display of the tile.</li>
</ul> </ul>
<img alt="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_form.png" src="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_form.png" /> <img alt="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_tile_form.png" src="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_tile_form.png" />
<p>You can optionanaly define a secondary value, for that purpose :</p> <p>You can optionally define a secondary value, for that purpose :</p>
<ul class="simple"> <ul class="simple">
<li>Select a field, a function to apply.</li> <li>Select a field, a function to apply.</li>
<li>You can define a specific format. (<tt class="docutils literal">.format()</tt> python syntax)</li> <li>You can define a specific format. (<tt class="docutils literal">.format()</tt> python syntax)</li>
</ul> </ul>
<img alt="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_form_secondary_value.png" src="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_form_secondary_value.png" /> <img alt="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_tile_form_secondary_value.png" src="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_tile_form_secondary_value.png" />
</div> </div>
<div class="section" id="usage"> <div class="section" id="usage">
<h1><a class="toc-backref" href="#id2">Usage</a></h1> <h1><a class="toc-backref" href="#id2">Usage</a></h1>
@ -429,15 +429,15 @@ You should refresh your browser to see new menu items.</p>
<li>Go to “Dashboard &gt; Overview” and select a category</li> <li>Go to “Dashboard &gt; Overview” and select a category</li>
<li>The tile configured is displayed with the up to date count and average values of the selected domain.</li> <li>The tile configured is displayed with the up to date count and average values of the selected domain.</li>
</ul> </ul>
<img alt="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_kanban.png" src="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_kanban.png" /> <img alt="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_tile_kanban.png" src="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_tile_kanban.png" />
<ul class="simple"> <ul class="simple">
<li>By clicking on the item, you’ll navigate to the tree view of the according model.</li> <li>By clicking on the item, you’ll navigate to the tree view of the according model.</li>
</ul> </ul>
<img alt="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_2_tree_view.png" src="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_2_tree_view.png" /> <img alt="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_tile_2_tree_view.png" src="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/tile_tile_2_tree_view.png" />
<p><strong>Note</strong></p> <p><strong>Note</strong></p>
<p>When you are in a tree view, with a domain, you can save it in the favorite menu, but the configuration is limited.</p> <p>When you are in a tree view, with a domain, you can save it in the favorite menu, but the configuration is limited.</p>
<img alt="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/favorite_menu_create_tile.png" src="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/favorite_menu_create_tile.png" /> <img alt="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/favorite_menu_create_tile.png" src="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/favorite_menu_create_tile.png" />
<img alt="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/favorite_menu_create_tile_result.png" src="https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/favorite_menu_create_tile_result.png" /> <img alt="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/favorite_menu_create_tile_result.png" src="https://raw.githubusercontent.com/OCA/web/12.0/web_dashboard_tile/static/description/favorite_menu_create_tile_result.png" />
</div> </div>
<div class="section" id="known-issues-roadmap"> <div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h1> <h1><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h1>
@ -459,10 +459,10 @@ You should refresh your browser to see new menu items.</p>
</div> </div>
<div class="section" id="bug-tracker"> <div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id4">Bug Tracker</a></h1> <h1><a class="toc-backref" href="#id4">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/legalsylvain/web/issues">GitHub Issues</a>. <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/web/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported. 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 If you spotted it first, help us smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/legalsylvain/web/issues/new?body=module:%20web_dashboard_tile%0Aversion:%2012.0-mig-web_dashboard_tile%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_dashboard_tile%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p> <p>Do not contact contributors directly about support or help with technical issues.</p>
</div> </div>
<div class="section" id="credits"> <div class="section" id="credits">
@ -472,6 +472,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<ul class="simple"> <ul class="simple">
<li>initOS GmbH &amp; Co. KG</li> <li>initOS GmbH &amp; Co. KG</li>
<li>GRAP</li> <li>GRAP</li>
<li>Iván Todorovich &lt;<a class="reference external" href="mailto:ivan.todorovich&#64;gmail.com">ivan.todorovich&#64;gmail.com</a>&gt;</li>
</ul> </ul>
</div> </div>
<div class="section" id="contributors"> <div class="section" id="contributors">
@ -484,10 +485,15 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
</div> </div>
<div class="section" id="maintainers"> <div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id8">Maintainers</a></h2> <h2><a class="toc-backref" href="#id8">Maintainers</a></h2>
<p>Current maintainer:</p> <p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>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.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external" href="https://github.com/legalsylvain"><img alt="legalsylvain" src="https://github.com/legalsylvain.png?size=40px" /></a></p> <p><a class="reference external" href="https://github.com/legalsylvain"><img alt="legalsylvain" src="https://github.com/legalsylvain.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/legalsylvain/web/tree/12.0-mig-web_dashboard_tile/web_dashboard_tile">legalsylvain/web</a> project on GitHub.</p> <p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/12.0/web_dashboard_tile">OCA/web</a> project on GitHub.</p>
<p>You are welcome to contribute.</p> <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div> </div>
</div> </div>
</div> </div>