[12.0][MIG] report_qweb_element_page_visibility

6 years ago · d4664ad2b2
8 changed files with 610 additions and 15 deletions
--- a/report_qweb_element_page_visibility/README.rst
+++ b/report_qweb_element_page_visibility/README.rst
@ -0,0 +1,104 @@
 ===================================
 Report Qweb Element Page Visibility
 ===================================
 .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! 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%2Freporting--engine-lightgray.png?logo=github
    :target: https://github.com/OCA/reporting-engine/tree/12.0/report_qweb_element_page_visibility
    :alt: OCA/reporting-engine
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/reporting-engine-12-0/reporting-engine-12-0-report_qweb_element_page_visibility
    :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
    :target: https://runbot.odoo-community.org/runbot/143/12.0
    :alt: Try me on Runbot
 |badge1| |badge2| |badge3| |badge4| |badge5| 
 This module allows you to use 4 classes in QWEB reports:
 * not-first-page: shows element in every page but first
 * not-last-page: shows element in every page but last
 * first-page: shows element only on first page
 * last-page: shows element only on last page
 **Table of contents**
 .. contents::
   :local:
 Usage
 =====
 To use this module, you need to:
 In the QWEB ``ir.ui.views`` used by your report,
 you can add an element with css class with any of the classes described above.
 For example if you need to improve invoice report header with
 invoice's number in every page but first, and sale order report header
 with order's name in every page but last, add this code to external_layout_header::
    <t t-if="o._table=='account_invoice'">
        <div class="not-first-page">
            <span t-esc="o.number"/>
        </div>
    </t>
    <t t-if="o._table=='sale_order'">
        <div class="not-last-page">
            <span t-esc="o.name"/>
        </div>
    </t>
 Bug Tracker
 ===========
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/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/reporting-engine/issues/new?body=module:%20report_qweb_element_page_visibility%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.
 Credits
 =======
 Authors
 ~~~~~~~
 * Agile Business Group
 Contributors
 ~~~~~~~~~~~~
 * Nicola Malcontenti <nicola.malcontenti@agilebg.com>
 * Lorenzo Battistini <lorenzo.battistini@agilebg.com>
 * Alessio Gerace <alessio.gerace@agilebg.com>
 * Alex Comba <alex.comba@agilebg.com>
 * Saran Limpajitkutaporn <saranl@ecosoft.co.th>
 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/reporting-engine <https://github.com/OCA/reporting-engine/tree/12.0/report_qweb_element_page_visibility>`_ project on GitHub.
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
--- a/report_qweb_element_page_visibility/init.py
+++ b/report_qweb_element_page_visibility/init.py
@ -1,3 +1,2 @@
 # -*- coding: utf-8 -*-
 # Copyright 2015 Agile Business Group
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
--- a/report_qweb_element_page_visibility/manifest.py
+++ b/report_qweb_element_page_visibility/manifest.py
@ -1,20 +1,19 @@
 # -*- coding: utf-8 -*-
 # Copyright 2015 Agile Business Group
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 {
    'name': 'Report Qweb Element Page Visibility',
    'version': '10.0.1.0.0',
    'version': '12.0.1.0.0',
    'author': 'Agile Business Group, Odoo Community Association (OCA)',
    'category': 'Tools',
    "website": "https://odoo-community.org/",
    "license": "AGPL-3",
    "application": False,
    'website': 'https://github.com/oca/reporting-engine',
    'license': 'AGPL-3',
    'application': False,
    'installable': True,
    'data': [
        'views/layouts.xml',
    ],
    'depends': [
        'report',
        'web',
    ],
 }
--- a/report_qweb_element_page_visibility/readme/CONTRIBUTORS.rst
+++ b/report_qweb_element_page_visibility/readme/CONTRIBUTORS.rst
@ -0,0 +1,5 @@
 * Nicola Malcontenti <nicola.malcontenti@agilebg.com>
 * Lorenzo Battistini <lorenzo.battistini@agilebg.com>
 * Alessio Gerace <alessio.gerace@agilebg.com>
 * Alex Comba <alex.comba@agilebg.com>
 * Saran Limpajitkutaporn <saranl@ecosoft.co.th>
--- a/report_qweb_element_page_visibility/readme/DESCRIPTION.rst
+++ b/report_qweb_element_page_visibility/readme/DESCRIPTION.rst
@ -0,0 +1,6 @@
 This module allows you to use 4 classes in QWEB reports:
 * not-first-page: shows element in every page but first
 * not-last-page: shows element in every page but last
 * first-page: shows element only on first page
 * last-page: shows element only on last page
--- a/report_qweb_element_page_visibility/readme/USAGE.rst
+++ b/report_qweb_element_page_visibility/readme/USAGE.rst
@ -0,0 +1,18 @@
 To use this module, you need to:
 In the QWEB ``ir.ui.views`` used by your report,
 you can add an element with css class with any of the classes described above.
 For example if you need to improve invoice report header with
 invoice's number in every page but first, and sale order report header
 with order's name in every page but last, add this code to external_layout_header::
    <t t-if="o._table=='account_invoice'">
        <div class="not-first-page">
            <span t-esc="o.number"/>
        </div>
    </t>
    <t t-if="o._table=='sale_order'">
        <div class="not-last-page">
            <span t-esc="o.name"/>
        </div>
    </t>
--- a/report_qweb_element_page_visibility/static/description/index.html
+++ b/report_qweb_element_page_visibility/static/description/index.html
@ -0,0 +1,451 @@
 <?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>Report Qweb Element Page Visibility</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="report-qweb-element-page-visibility">
 <h1 class="title">Report Qweb Element Page Visibility</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/reporting-engine/tree/12.0/report_qweb_element_page_visibility"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/reporting-engine-12-0/reporting-engine-12-0-report_qweb_element_page_visibility"><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/143/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
 <p>This module allows you to use 4 classes in QWEB reports:</p>
 <ul class="simple">
 <li>not-first-page: shows element in every page but first</li>
 <li>not-last-page: shows element in every page but last</li>
 <li>first-page: shows element only on first page</li>
 <li>last-page: shows element only on last page</li>
 </ul>
 <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>To use this module, you need to:</p>
 <p>In the QWEB <tt class="docutils literal">ir.ui.views</tt> used by your report,
 you can add an element with css class with any of the classes described above.
 For example if you need to improve invoice report header with
 invoice’s number in every page but first, and sale order report header
 with order’s name in every page but last, add this code to external_layout_header:</p>
 <pre class="literal-block">
 &lt;t t-if=&quot;o._table=='account_invoice'&quot;&gt;
    &lt;div class=&quot;not-first-page&quot;&gt;
        &lt;span t-esc=&quot;o.number&quot;/&gt;
    &lt;/div&gt;
 &lt;/t&gt;
 &lt;t t-if=&quot;o._table=='sale_order'&quot;&gt;
    &lt;div class=&quot;not-last-page&quot;&gt;
        &lt;span t-esc=&quot;o.name&quot;/&gt;
    &lt;/div&gt;
 &lt;/t&gt;
 </pre>
 </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/reporting-engine/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/reporting-engine/issues/new?body=module:%20report_qweb_element_page_visibility%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>
 </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>Agile Business Group</li>
 </ul>
 </div>
 <div class="section" id="contributors">
 <h2><a class="toc-backref" href="#id5">Contributors</a></h2>
 <ul class="simple">
 <li>Nicola Malcontenti &lt;<a class="reference external" href="mailto:nicola.malcontenti&#64;agilebg.com">nicola.malcontenti&#64;agilebg.com</a>&gt;</li>
 <li>Lorenzo Battistini &lt;<a class="reference external" href="mailto:lorenzo.battistini&#64;agilebg.com">lorenzo.battistini&#64;agilebg.com</a>&gt;</li>
 <li>Alessio Gerace &lt;<a class="reference external" href="mailto:alessio.gerace&#64;agilebg.com">alessio.gerace&#64;agilebg.com</a>&gt;</li>
 <li>Alex Comba &lt;<a class="reference external" href="mailto:alex.comba&#64;agilebg.com">alex.comba&#64;agilebg.com</a>&gt;</li>
 <li>Saran Limpajitkutaporn &lt;<a class="reference external" href="mailto:saranl&#64;ecosoft.co.th">saranl&#64;ecosoft.co.th</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/reporting-engine/tree/12.0/report_qweb_element_page_visibility">OCA/reporting-engine</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>
--- a/report_qweb_element_page_visibility/views/layouts.xml
+++ b/report_qweb_element_page_visibility/views/layouts.xml
@ -1,8 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <odoo>
    <template id="minimal_layout" inherit_id="report.minimal_layout">
        <xpath expr="//t[@t-if='subst is True']" position="replace">
    <template id="minimal_layout" inherit_id="web.minimal_layout">
        <xpath expr="//t[@t-if='subst_needed']" position="replace">
            <t t-if="subst is True">
                <script>
                    function subst() {
@ -12,11 +11,25 @@
                            var z = x[i].split('=', 2);
                            vars[z[0]] = unescape(z[1]);
                        }
                        var x=['frompage', 'topage', 'page', 'webpage', 'section', 'subsection', 'subsubsection'];
                        for (var i in x) {
                            var y = document.getElementsByClassName(x[i]);
                            for (var j=0; j&lt;y.length; ++j)
                                y[j].textContent = vars[x[i]];
                        var fromPage = document.getElementsByClassName('page');
                        for(var j = 0; j&lt;fromPage.length; j++)
                            fromPage[j].textContent = vars['sitepage'];
                        var toPage = document.getElementsByClassName('topage');
                        for(var j = 0; j&lt;toPage.length; j++)
                            toPage[j].textContent = vars['sitepages'];
                        var index = vars['webpage'].split('.', 4)[3]
                        var header = document.getElementById('minimal_layout_report_headers');
                        if(header !== null){
                            var companyHeader = header.children[index];
                            header.textContent = '';
                            header.appendChild(companyHeader);
                        }
                        var footer = document.getElementById('minimal_layout_report_footers');
                        if(footer !== null){
                            var companyFooter = footer.children[index];
                            footer.textContent = '';
                            footer.appendChild(companyFooter);
                        }
                        var operations = {
                            'not-first-page': function (elt) {