2021-03-23 19:14:27 +00:00
<?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/" / >
< title > Base Comments Templates< / 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 = "base-comments-templates" >
< h1 class = "title" > Base Comments Templates< / 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/14.0/base_comment_template" > < 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-14-0/reporting-engine-14-0-base_comment_template" > < 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/14.0" > < img alt = "Try me on Runbot" src = "https://img.shields.io/badge/runbot-Try%20me-875A7B.png" / > < / a > < / p >
2021-05-26 11:32:35 +00:00
< p > Add a new mixin class to define templates of comments to print on documents.
The comment templates can be defined like make templates, so you can use variables from linked models.< / p >
< p > Two positions are available for the comments:< / p >
< ul class = "simple" >
< li > above document lines (before_lines)< / li >
< li > below document lines (after_lines)< / li >
< / ul >
< p > The template are general, and can be attached to any Model and based on some domain defined in the template.
You can define one default template per Model and domain, which can be overwritten for any company and partners.
It has a priority field (smaller number = higher priority)< / p >
< p > In existing reports, if you add this line will get the comment template if you created one like< / p >
< ul class = "simple" >
< li > < span t-raw=”o.get_comment_template(‘ ’ > ( or without any parameter)< / li >
< / ul >
2021-03-23 19:14:27 +00:00
< p > This module is the base module for following modules:< / p >
< ul class = "simple" >
< li > sale_comment_template< / li >
< li > purchase_comment_template< / li >
< li > invoice_comment_template< / li >
< li > stock_picking_comment_template< / li >
< / ul >
< p > < strong > Table of contents< / strong > < / p >
< div class = "contents local topic" id = "contents" >
< ul class = "simple" >
2021-05-26 11:32:35 +00:00
< 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 = "#bug-tracker" id = "id3" > Bug Tracker< / a > < / li >
< li > < a class = "reference internal" href = "#credits" id = "id4" > Credits< / a > < ul >
< li > < a class = "reference internal" href = "#authors" id = "id5" > Authors< / a > < / li >
< li > < a class = "reference internal" href = "#contributors" id = "id6" > Contributors< / a > < / li >
< li > < a class = "reference internal" href = "#maintainers" id = "id7" > Maintainers< / a > < / li >
2021-03-23 19:14:27 +00:00
< / ul >
< / li >
< / ul >
< / div >
2021-05-26 11:32:35 +00:00
< div class = "section" id = "configuration" >
< h1 > < a class = "toc-backref" href = "#id1" > Configuration< / a > < / h1 >
< p > Go to < em > Settings > Technical > Reporting > Comment Templates< / em > and start designing you comment templates.< / p >
< p > This module is the base module for following modules:< / p >
< ul class = "simple" >
< li > sale_comment_template< / li >
< li > purchase_comment_template< / li >
< li > invoice_comment_template< / li >
< li > stock_picking_comment_template< / li >
< / ul >
< / div >
< div class = "section" id = "usage" >
< h1 > < a class = "toc-backref" href = "#id2" > Usage< / a > < / h1 >
< ol class = "arabic simple" >
< li > Go to < em > Settings< / em > and activate the developer mode.< / li >
< li > Go to < em > Settings > Technical > Reporting > Comment Templates< / em > .< / li >
< li > Create a new record.< / li >
< li > Define the Company the template is linked or leave default for all companies.< / li >
< li > Define the Partner the template is linked or leave default for all partners.< / li >
< li > Define the Model, Domain the template is linked.< / li >
< li > Define the Position where the template will be printed:< ul >
< li > above document lines< / li >
< li > below document lines< / li >
< / ul >
< / li >
< / ol >
< p > You should have at least one template with Default field set, if you choose a Partner the template is deselected as a Default one.
If you create a new template with the same configuration (Model, Domain, Position) and set it as Default, the previous one will be deselected as a default one.< / p >
< p > The template is a html field which will be rendered just like a mail template, so you can use variables like ${object}, ${user}, ${ctx} to add dynamic content.< / p >
< p > Change the report related to the model from configuration and add a statement like:< / p >
2022-06-29 18:39:47 +00:00
< dl class = "docutils" >
< dt > < t t-foreach=”o.comment_template_ids.filtered(lambda x: x.position == ‘ ’ > < / dt >
< dd > < div t-raw=”o.render_comment(comment_template_top)” /> < / dd >
< / dl >
< p > < /t> < / p >
< dl class = "docutils" >
< dt > < t t-foreach=”o.comment_template_ids.filtered(lambda x: x.position == ‘ ’ > < / dt >
< dd > < div t-raw=”o.render_comment(comment_template_bottom)” /> < / dd >
< / dl >
< p > < /t> < / p >
2021-05-26 11:32:35 +00:00
< p > You should always use t-if since the method returns False if no template is found.< / p >
2022-06-29 18:39:47 +00:00
< p > If you want to use Qweb templates, or different context, you can specify it just like in
mail.render.mixin with parameters:< / p >
< ul class = "simple" >
< li > engine: “jinja” or “qweb”,< / li >
< li > add_context: dict with your own context,< / li >
< li > post_process: perform a post processing on rendered result< / li >
< / ul >
< p > so you could use it :< / p >
< dl class = "docutils" >
< dt > < t t-foreach=”o.comment_template_ids.filtered(lambda x: x.position == ‘ ’ > < / dt >
< dd > < div t-raw=”o.render_comment(comment_template_top, engine=’ ’ > < / dd >
< / dl >
< p > < /t> < / p >
2021-05-26 11:32:35 +00:00
< / div >
2021-03-23 19:14:27 +00:00
< div class = "section" id = "bug-tracker" >
2021-05-26 11:32:35 +00:00
< h1 > < a class = "toc-backref" href = "#id3" > Bug Tracker< / a > < / h1 >
2021-03-23 19:14:27 +00:00
< 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:%20base_comment_template%0Aversion:%2014.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" >
2021-05-26 11:32:35 +00:00
< h1 > < a class = "toc-backref" href = "#id4" > Credits< / a > < / h1 >
2021-03-23 19:14:27 +00:00
< div class = "section" id = "authors" >
2021-05-26 11:32:35 +00:00
< h2 > < a class = "toc-backref" href = "#id5" > Authors< / a > < / h2 >
2021-03-23 19:14:27 +00:00
< ul class = "simple" >
< li > Camptocamp< / li >
< / ul >
< / div >
< div class = "section" id = "contributors" >
2021-05-26 11:32:35 +00:00
< h2 > < a class = "toc-backref" href = "#id6" > Contributors< / a > < / h2 >
2021-03-23 19:14:27 +00:00
< ul class = "simple" >
< li > Xavier Jimenez < < a class = "reference external" href = "mailto:xavier.jimenez@qubiq.es" > xavier.jimenez@ qubiq.es< / a > > < / li >
< li > Nicolas Bessi < < a class = "reference external" href = "mailto:nicolas.bessi@camptocamp.com" > nicolas.bessi@ camptocamp.com< / a > > < / li >
< li > Yannick Vaucher < < a class = "reference external" href = "mailto:yannick.vaucher@camptocamp.com" > yannick.vaucher@ camptocamp.com< / a > > < / li >
< li > Guewen Baconnier < < a class = "reference external" href = "mailto:guewen.baconnier@camptocamp.com" > guewen.baconnier@ camptocamp.com< / a > > < / li >
< li > Simone Rubino < < a class = "reference external" href = "mailto:simone.rubino@agilebg.com" > simone.rubino@ agilebg.com< / a > > < / li >
< li > < a class = "reference external" href = "https://www.dynapps.be" > DynApps< / a > :< ul >
< li > Raf Ven < < a class = "reference external" href = "mailto:raf.ven@dynapps.be" > raf.ven@ dynapps.be< / a > > < / li >
< / ul >
< / li >
< li > < a class = "reference external" href = "https://www.druidoo.io" > Druidoo< / a > :< ul >
< li > Iván Todorovich < < a class = "reference external" href = "mailto:ivan.todorovich@druidoo.io" > ivan.todorovich@ druidoo.io< / a > > < / li >
< / ul >
< / li >
< li > Pierre Verkest < < a class = "reference external" href = "mailto:pierreverkest84@gmail.com" > pierreverkest84@ gmail.com< / a > > < / li >
2021-05-26 11:32:35 +00:00
< li > < a class = "reference external" href = "https://www.nexterp.ro" > NextERP Romania< / a > :< ul >
< li > Fekete Mihai < < a class = "reference external" href = "mailto:feketemihai@nexterp.ro" > feketemihai@ nexterp.ro< / a > > < / li >
< / ul >
< / li >
< li > < a class = "reference external" href = "https://www.tecnativa.com" > Tecnativa< / a > :< ul >
< li > Carlos Roca< / li >
< li > Víctor Martínez< / li >
< / ul >
< / li >
2021-03-23 19:14:27 +00:00
< / ul >
< / div >
< div class = "section" id = "maintainers" >
2021-05-26 11:32:35 +00:00
< h2 > < a class = "toc-backref" href = "#id7" > Maintainers< / a > < / h2 >
2021-03-23 19:14:27 +00:00
< 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/14.0/base_comment_template" > 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 >
