Browse Source

[ADD] - add web_filter_description module

Add description to filters
pull/930/head
Bejaoui Souheil 6 years ago
committed by sbejaoui
parent
commit
920c2a84e2
  1. 89
      web_filter_description/README.rst
  2. 4
      web_filter_description/__init__.py
  3. 16
      web_filter_description/__manifest__.py
  4. 3
      web_filter_description/models/__init__.py
  5. 24
      web_filter_description/models/ir_filters.py
  6. 1
      web_filter_description/readme/CONTRIBUTORS.rst
  7. 1
      web_filter_description/readme/DESCRIPTION.rst
  8. 12
      web_filter_description/readme/USAGE.rst
  9. BIN
      web_filter_description/static/description/icon.png
  10. 431
      web_filter_description/static/description/index.html
  11. BIN
      web_filter_description/static/description/screenshot_1.png
  12. BIN
      web_filter_description/static/description/screenshot_2.png
  13. 47
      web_filter_description/static/src/js/web_filter_description.js
  14. 17
      web_filter_description/static/src/xml/web_filter_description.xml
  15. 1
      web_filter_description/tests/__init__.py
  16. 28
      web_filter_description/tests/test_ir_filters.py
  17. 12
      web_filter_description/views/assets.xml
  18. 17
      web_filter_description/views/ir_filters.xml

89
web_filter_description/README.rst

@ -0,0 +1,89 @@
==========================
Add Description to filters
==========================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
:target: https://github.com/OCA/web/tree/10.0/web_filter_description
:alt: OCA/web
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/web-10-0/web-10-0-web_filter_description
: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/10.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
Add description for your custom filters
**Table of contents**
.. contents::
:local:
Usage
=====
When you create a custom filter you can add a description to it.
.. figure:: https://raw.githubusercontent.com/OCA/web/10.0/web_filter_description/static/description/screenshot_1.png
:scale: 80 %
:alt: Add a description
The description will be shown as tooltip after.
.. figure:: https://raw.githubusercontent.com/OCA/web/10.0/web_filter_description/static/description/screenshot_2.png
:scale: 80 %
:alt: Show the description
Bug Tracker
===========
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.
If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_filter_description%0Aversion:%2010.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.
Credits
=======
Authors
~~~~~~~
* Bejaoui Souheil
Contributors
~~~~~~~~~~~~
* Bejaoui Souheil <bejaoui_souheil@hotmail.fr>
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.
This module is part of the `OCA/web <https://github.com/OCA/web/tree/10.0/web_filter_description>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

4
web_filter_description/__init__.py

@ -0,0 +1,4 @@
# -*- coding: utf-8 -*-
from . import models
from . import tests

16
web_filter_description/__manifest__.py

@ -0,0 +1,16 @@
# -*- coding: utf-8 -*-
# Copyright 2018 Bejaoui Souheil <souheil_bejaoui@hotmail.fr>
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
{
"name": "Add Description to filters",
"version": "10.0.1.0.0",
"author": "Bejaoui Souheil, Odoo Community Association (OCA)",
"license": "AGPL-3",
'website': "https://github.com/OCA/web",
"summary": "Add description to filters",
"category": "Tools",
"depends": ['web'],
"data": ["views/assets.xml", "views/ir_filters.xml"],
'qweb': ["static/src/xml/web_filter_description.xml"],
"installable": True,
}

3
web_filter_description/models/__init__.py

@ -0,0 +1,3 @@
# -*- coding: utf-8 -*-
from . import ir_filters

24
web_filter_description/models/ir_filters.py

@ -0,0 +1,24 @@
# -*- coding: utf-8 -*-
# Copyright 2018 Bejaoui Souheil <souheil_bejaoui@hotmail.fr>
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from odoo import fields, models, api
class IrFilters(models.Model):
_inherit = 'ir.filters'
description = fields.Text(string="Description", required=False)
@api.model
def get_filters(self, model, action_id=None):
res = super(IrFilters, self).get_filters(model, action_id)
ids = map(lambda f: f['id'], res)
# Browse filters that are in res
filters = self.browse(ids)
for i, res_filter in enumerate(res):
# Add the field 'description' to the result
res[i]['description'] = filters.filtered(
lambda f: f.id == res_filter['id']
).description
return res

1
web_filter_description/readme/CONTRIBUTORS.rst

@ -0,0 +1 @@
* Bejaoui Souheil <bejaoui_souheil@hotmail.fr>

1
web_filter_description/readme/DESCRIPTION.rst

@ -0,0 +1 @@
Add description for your custom filters

12
web_filter_description/readme/USAGE.rst

@ -0,0 +1,12 @@
When you create a custom filter you can add a description to it.
.. figure:: static/description/screenshot_1.png
:scale: 80 %
:alt: Add a description
The description will be shown as tooltip after.
.. figure:: static/description/screenshot_2.png
:scale: 80 %
:alt: Show the description

BIN
web_filter_description/static/description/icon.png

After

Width: 128  |  Height: 128  |  Size: 9.2 KiB

431
web_filter_description/static/description/index.html

@ -0,0 +1,431 @@
<?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.14: http://docutils.sourceforge.net/" />
<title>Add Description to filters</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z 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
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="add-description-to-filters">
<h1 class="title">Add Description to filters</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! 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/OCA/web/tree/10.0/web_filter_description"><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-10-0/web-10-0-web_filter_description"><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/10.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>Add description for your custom filters</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id1">Usage</a></h1>
<p>When you create a custom filter you can add a description to it.</p>
<div class="figure">
<img alt="Add a description" src="https://raw.githubusercontent.com/OCA/web/10.0/web_filter_description/static/description/screenshot_1.png" />
</div>
<p>The description will be shown as tooltip after.</p>
<div class="figure">
<img alt="Show the description" src="https://raw.githubusercontent.com/OCA/web/10.0/web_filter_description/static/description/screenshot_2.png" />
</div>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id2">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_filter_description%0Aversion:%2010.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="#id3">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
<ul class="simple">
<li>Bejaoui Souheil</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
<ul class="simple">
<li>Bejaoui Souheil &lt;<a class="reference external" href="mailto:bejaoui_souheil&#64;hotmail.fr">bejaoui_souheil&#64;hotmail.fr</a>&gt;</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id6">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>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/10.0/web_filter_description">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>
</div>
</body>
</html>

BIN
web_filter_description/static/description/screenshot_1.png

After

Width: 837  |  Height: 368  |  Size: 54 KiB

BIN
web_filter_description/static/description/screenshot_2.png

After

Width: 844  |  Height: 290  |  Size: 49 KiB

47
web_filter_description/static/src/js/web_filter_description.js

@ -0,0 +1,47 @@
/* *
Copyright 2018 Bejaoui Souheil <souheil_bejaoui@hotmail.fr>
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
*/
odoo.define('web_filter_description.web_filter_description', function(require) {
"use strict";
var session = require('web.session');
var data_manager = require('web.data_manager');
var FavoriteMenu = require('web.FavoriteMenu');
FavoriteMenu.include({
start: function() {
this.$save_name = this.$('.o_save_name');
this.$textarea = this.$save_name.find('textarea');
return this._super();
},
save_favorite: function() {
var self = this,
filter_name = this.$inputs[0].value,
description = this.$textarea[0].value,
shared_filter = this.$inputs[2].checked;
return $.when(this._super()).then(function() {
var filter_key = self.key_for({
name: filter_name,
user_id: shared_filter ? false : session.uid,
model_id: self.target_model,
action_id: self.action_id,
});
var filter = self.filters[filter_key];
if (filter) {
filter.description = description;
return data_manager.create_filter(filter);
}
});
},
append_filter: function(filter) {
var self = this,
filter_name = filter.name,
filter_description = filter.description,
filter_key = self.key_for(filter);
$.when(this._super(filter)).then(function() {
self.$filters[filter_key].prop('title', filter_description ? filter_description : filter_name);
});
},
});
});

17
web_filter_description/static/src/xml/web_filter_description.xml

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--Copyright 2018 Bejaoui Souheil <souheil_bejaoui@hotmail.fr>
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).-->
<templates id="template" xml:space="preserve">
<t t-extend="SearchView.FavoriteMenu">
<t t-jquery="li.o_save_name:eq(0)" t-operation="after">
<li class="o_save_name">
<div>
<label for="description">Description</label>
<textarea name="description"></textarea>
</div>
</li>
</t>
</t>
</templates>

1
web_filter_description/tests/__init__.py

@ -0,0 +1 @@
from . import test_ir_filters

28
web_filter_description/tests/test_ir_filters.py

@ -0,0 +1,28 @@
# -*- coding: utf-8 -*-
# Copyright 2018 Bejaoui Souheil <souheil_bejaoui@hotmail.fr>
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from odoo.tests.common import TransactionCase
class TestIrFilters(TransactionCase):
def setUp(self):
super(TestIrFilters, self).setUp()
self.filter_object = self.env['ir.filters'].create(
{
'name': 'custom filter',
'model_id': 'ir.module.module',
'domain': '[]',
'user_id': False,
'description': 'custom filter description',
}
)
def test_create_filter_with_description(self):
res = self.env['ir.filters'].get_filters(model='ir.module.module')
if res:
self.assertIn('description', res[0].keys())
self.assertIn(
'custom filter description',
list(map(lambda f: f['description'], res)),
)

12
web_filter_description/views/assets.xml

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--Copyright 2018 Bejaoui Souheil <souheil_bejaoui@hotmail.fr>
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).-->
<odoo>
<template id="assets_backend" name="web_filter_description"
inherit_id="web.assets_backend">
<xpath expr="." position="inside">
<script type="text/javascript"
src="/web_filter_description/static/src/js/web_filter_description.js"/>
</xpath>
</template>
</odoo>

17
web_filter_description/views/ir_filters.xml

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<!--Copyright 2018 Bejaoui Souheil <souheil_bejaoui@hotmail.fr>
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).-->
<odoo>
<record id="ir_filters_view_form" model="ir.ui.view">
<field name="name">ir.filters.form</field>
<field name="model">ir.filters</field>
<field name="inherit_id" ref="base.ir_filters_view_form"/>
<field name="arch" type="xml">
<xpath expr="//field[@name='sort']" position="after">
<field name="description"/>
</xpath>
</field>
</record>
</odoo>
Loading…
Cancel
Save