audrius/web
1
0
Fork 1
mirror of https://github.com/OCA/web.git synced 2025-02-22 13:21:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

[BOT] post-merge updates

Browse Source
This commit is contained in:
OCA-git-bot
2024-01-29 16:52:49 +00:00
parent eb8fe1f2e6
commit ccc859547a
5 changed files with 65 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,20 +1,19 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
<title>Overview Dashboard (Tiles)</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
@@ -366,9 +365,11 @@ ul.auto-toc {
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:016842e127bc74b3f446e2ae087f66e14b91670c6e567c09e69b3fc1175667da
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<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><a class="reference external image-reference" 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 image-reference" 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 image-reference" href="https://github.com/OCA/web/tree/16.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 image-reference" href="https://translation.odoo-community.org/projects/web-16-0/web-16-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 image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/web&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module extends the web module to add new dashboard overview system.</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>
<ul class="simple">
@@ -385,68 +386,63 @@ ul.auto-toc {
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id3">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id5">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id6">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li>
<li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="toc-entry-2">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-3">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-4">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="toc-entry-5">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="toc-entry-6">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="toc-entry-7">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="toc-entry-8">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
<p>First, you have to create tile categories.</p>
<ul class="simple">
<li>Go to “Dashboards &gt; Settings &gt; Dashboard Categories”</li>
<li>Click on Create</li>
<li>Set a name, and save.</li>
<li>Go to “Dashboards &gt; Configuration &gt; Overview Settings &gt; Dashboard Categories”</li>
<li>Create categories</li>
</ul>
<p>Odoo menu and action are automatically created.
<p>Odoo menu and action are automatically created in the “Dashboard &gt; Overview” menu
You should refresh your browser to see new menu items.</p>
<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" />
<img alt="https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_category_form.png" src="https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_category_form.png" />
<p>Then you can create tiles.</p>
<ul class="simple">
<li>go to “Dashboards &gt; Settings &gt; Dashboard Tiles”</li>
<li>Go to “Dashboards &gt; Configuration &gt; Overview Settings &gt; Dashboard Items”</li>
<li>create a new tile, set a name, a category and a model.</li>
<li>You can optionally define colors, domain a specific action to use.</li>
<li>You can optionally define colors, domain and a specific action to use.</li>
<li>Setting a user, or a group in “Security” tab will restrict the display of the tile.</li>
</ul>
<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" />
<img alt="https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_tile_form.png" src="https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_tile_form.png" />
<p>You can optionally define a secondary value, for that purpose :</p>
<ul class="simple">
<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>
</ul>
<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" />
<img alt="https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_tile_form_secondary_value.png" src="https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_tile_form_secondary_value.png" />
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id2">Usage</a></h1>
<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
<ul class="simple">
<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>
</ul>
<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" />
<img alt="https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_tile_kanban.png" src="https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_tile_kanban.png" />
<ul class="simple">
<li>By clicking on the item, you’ll navigate to the tree view of the according model.</li>
</ul>
<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>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/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/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" />
<img alt="https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_tile_2_tree_view.png" src="https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_tile_2_tree_view.png" />
</div>
<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="#toc-entry-3">Known issues / Roadmap</a></h1>
<p><strong>Known issues</strong></p>
<ul class="simple">
<li>Can not edit color from dashboard</li>
<li>Original context is ignored.</li>
<li>Original domain and filter are not restored.</li>
<li>To preserve a relative date domain, you have to manually edit the tile’s domain from “Configuration &gt; User Interface &gt; Dashboard Tile”. You can use the same variables available in filters (<tt class="docutils literal">uid</tt>, <tt class="docutils literal">context_today()</tt>, <tt class="docutils literal">current_date</tt>, <tt class="docutils literal">time</tt>, <tt class="docutils literal">datetime</tt>, <cite>relativedelta</cite>).</li>
<li>To preserve a relative date domain, you have to manually edit the tile’s domain from “Configuration &gt; User Interface &gt; Dashboard Tile”. You can use the same variables available in filters (<tt class="docutils literal">uid</tt>, <tt class="docutils literal">context_today()</tt>, <tt class="docutils literal">current_date</tt>, <tt class="docutils literal">relativedelta</tt>).</li>
</ul>
<p><strong>Roadmap</strong></p>
<ul class="simple">
@@ -458,17 +454,17 @@ You should refresh your browser to see new menu items.</p>
</ul>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id4">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h1>
<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.
If you spotted it first, help us smashing it by providing a detailed and welcomed
<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>
If you spotted it first, help us to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_dashboard_tile%0Aversion:%2016.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>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id5">Credits</a></h1>
<h1><a class="toc-backref" href="#toc-entry-5">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id6">Authors</a></h2>
<h2><a class="toc-backref" href="#toc-entry-6">Authors</a></h2>
<ul class="simple">
<li>initOS GmbH &amp; Co. KG</li>
<li>GRAP</li>
@@ -476,7 +472,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id7">Contributors</a></h2>
<h2><a class="toc-backref" href="#toc-entry-7">Contributors</a></h2>
<ul class="simple">
<li>Markus Schneider &lt;markus.schneider at initos.com&gt;</li>
<li>Sylvain Le Gal (<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>)</li>
@@ -484,15 +480,15 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id8">Maintainers</a></h2>
<h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
<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>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><a class="reference external image-reference" 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/OCA/web/tree/16.0/web_dashboard_tile">OCA/web</a> project on GitHub.</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>