Skip to Content
Icône de Base Comments Templates

Base Comments Templates

by OCA
Free 19.0 — à porter Module Quality check: Verified AGPL-3

Add conditional mako template to any reporton models that inherits comment.template.

Base Comments Templates

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.

Two positions are available for the comments:

  • above document lines (before_lines)
  • below document lines (after_lines)

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)

In existing reports, if you add this line will get the comment template if you created one like

  • <span t-out=”o.get_comment_template(‘position’,company_id=o.company_id, partner_id=o.parnter_id )”/> ( or without any parameter)

This module is the base module for following modules:

  • sale_comment_template
  • purchase_comment_template
  • account_comment_template
  • stock_picking_comment_template

Table of contents

Configuration

Go to Settings > Technical > Reporting > Comment Templates and start designing you comment templates.

This module is the base module for following modules:

  • sale_comment_template
  • purchase_comment_template
  • invoice_comment_template
  • stock_picking_comment_template

Usage

  1. Go to Settings and activate the developer mode.
  2. Go to Settings > Technical > Reporting > Comment Templates.
  3. Create a new record.
  4. Define the Company the template is linked or leave default for all companies.
  5. Define the Partner the template is linked or leave default for all partners.
  6. Define the Model, Domain the template is linked.
  7. Define the Position where the template will be printed:
    • above document lines
    • below document lines

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.

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.

Change the report related to the model from configuration and add a statement like:

<t t-foreach=”o.comment_template_ids.filtered(lambda x: x.position == ‘before_lines’)” t-as=”comment_template_top”>
<div t-out=”o.render_comment(comment_template_top)” />

</t>

<t t-foreach=”o.comment_template_ids.filtered(lambda x: x.position == ‘after_lines’)” t-as=”comment_template_bottom”>
<div t-out=”o.render_comment(comment_template_bottom)” />

</t>

You should always use t-if since the method returns False if no template is found.

If you want to use Qweb templates, or different context, you can specify it just like in mail.render.mixin with parameters:

  • engine: “inline_template”, “qweb” or “qweb_view”,
  • add_context: dict with your own context,
  • post_process: perform a post processing on rendered result

so you could use it :

<t t-foreach=”o.comment_template_ids.filtered(lambda x: x.position == ‘before_lines’)” t-as=”comment_template_top”>
<div t-out=”o.render_comment(comment_template_top, engine=’qweb’, add_context={my dict}, postprocess=True)” />

</t>

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Camptocamp

Contributors

Maintainers

This module is maintained by the OCA.

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 project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

What this app does not do

The publisher has not yet published the list of what the app does not do. This is a store rule: ask support for it before you commit.

Store apps required

None.

Odoo Community modules used

basemail

Apps that complement it

SeriesVersionStatusPublished on
19.019.0.0.0.2 In development 23/09/2026

Listing generated from julien2364/omnifloo-oca-reporting-engine (branch 19.0, commit b9e8c6cdd2d1).

Automatic store check (separate from the publisher's), applied to all apps. Conforme.

CheckResultEffect if absent
Manifeste lisible sans exécution conforme bloquant
Licence reconnue (AGPL-3) conforme bloquant
Aucune dépendance vers Odoo Enterprise conforme bloquant
Aucun import de code Enterprise conforme bloquant
Aucun en-tête de licence Enterprise conforme bloquant
Icône static/description/icon.png conforme déclasse
Description (static/description/index.html ou README) conforme déclasse
Tests automatisés (tests/test_*.py) conforme déclasse
Traduction française (i18n/fr.po) conforme info
Section « Ce que le module ne fait pas » absent info
Titre de 70 caractères au plus (23 actuellement) conforme info
Résumé en français absent info

Reviews from signed-in customers. One rated review per customer; the publisher can reply. Sign in to leave a review.

Publisher
Odoo Community Association (OCA)
Report a problem
https://github.com/OCA/reporting-engine
Omnifloo customers
Support included with your plan: help centre.