Skip to content

Commit

Permalink
[IMP] base_comment_template: update readme files
Browse files Browse the repository at this point in the history
Change deprecated t-raw to t-out.
Rename invoice_comment_template to account_comment_template
  • Loading branch information
alan196 committed May 3, 2024
1 parent 618d24f commit 66b64bc
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
10 changes: 5 additions & 5 deletions base_comment_template/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ 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-raw="o.get_comment_template('position',company_id=o.company_id, partner_id=o.parnter_id )"/> ( or without any parameter)
* <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
* invoice_comment_template
* account_comment_template
* stock_picking_comment_template

**Table of contents**
Expand Down Expand Up @@ -91,13 +91,13 @@ The template is a html field which will be rendered just like a mail template, s
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-raw="o.render_comment(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-raw="o.render_comment(comment_template_bottom)" />
<div t-out="o.render_comment(comment_template_bottom)" />

</t>

Expand All @@ -113,7 +113,7 @@ mail.render.mixin with parameters:
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-raw="o.render_comment(comment_template_top, engine='qweb', add_context={my dict}, postprocess=True)" />
<div t-out="o.render_comment(comment_template_top, engine='qweb', add_context={my dict}, postprocess=True)" />

</t>

Expand Down
4 changes: 2 additions & 2 deletions base_comment_template/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ 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-raw="o.get_comment_template('position',company_id=o.company_id, partner_id=o.parnter_id )"/> ( or without any parameter)
* <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
* invoice_comment_template
* account_comment_template
* stock_picking_comment_template
6 changes: 3 additions & 3 deletions base_comment_template/readme/USAGE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ The template is a html field which will be rendered just like a mail template, s
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-raw="o.render_comment(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-raw="o.render_comment(comment_template_bottom)" />
<div t-out="o.render_comment(comment_template_bottom)" />

</t>

Expand All @@ -39,6 +39,6 @@ mail.render.mixin with parameters:
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-raw="o.render_comment(comment_template_top, engine='qweb', add_context={my dict}, postprocess=True)" />
<div t-out="o.render_comment(comment_template_top, engine='qweb', add_context={my dict}, postprocess=True)" />

</t>
10 changes: 5 additions & 5 deletions base_comment_template/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -381,13 +381,13 @@ <h1 class="title">Base Comments Templates</h1>
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>&lt;span t-raw=”o.get_comment_template(‘position’,company_id=o.company_id, partner_id=o.parnter_id )”/&gt; ( or without any parameter)</li>
<li>&lt;span t-out=”o.get_comment_template(‘position’,company_id=o.company_id, partner_id=o.parnter_id )”/&gt; ( or without any parameter)</li>
</ul>
<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>account_comment_template</li>
<li>stock_picking_comment_template</li>
</ul>
<p><strong>Table of contents</strong></p>
Expand Down Expand Up @@ -436,12 +436,12 @@ <h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
<p>Change the report related to the model from configuration and add a statement like:</p>
<dl class="docutils">
<dt>&lt;t t-foreach=”o.comment_template_ids.filtered(lambda x: x.position == ‘before_lines’)” t-as=”comment_template_top”&gt;</dt>
<dd>&lt;div t-raw=”o.render_comment(comment_template_top)” /&gt;</dd>
<dd>&lt;div t-out=”o.render_comment(comment_template_top)” /&gt;</dd>
</dl>
<p>&lt;/t&gt;</p>
<dl class="docutils">
<dt>&lt;t t-foreach=”o.comment_template_ids.filtered(lambda x: x.position == ‘after_lines’)” t-as=”comment_template_bottom”&gt;</dt>
<dd>&lt;div t-raw=”o.render_comment(comment_template_bottom)” /&gt;</dd>
<dd>&lt;div t-out=”o.render_comment(comment_template_bottom)” /&gt;</dd>
</dl>
<p>&lt;/t&gt;</p>
<p>You should always use t-if since the method returns False if no template is found.</p>
Expand All @@ -455,7 +455,7 @@ <h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
<p>so you could use it :</p>
<dl class="docutils">
<dt>&lt;t t-foreach=”o.comment_template_ids.filtered(lambda x: x.position == ‘before_lines’)” t-as=”comment_template_top”&gt;</dt>
<dd>&lt;div t-raw=”o.render_comment(comment_template_top, engine=’qweb’, add_context={my dict}, postprocess=True)” /&gt;</dd>
<dd>&lt;div t-out=”o.render_comment(comment_template_top, engine=’qweb’, add_context={my dict}, postprocess=True)” /&gt;</dd>
</dl>
<p>&lt;/t&gt;</p>
</div>
Expand Down

0 comments on commit 66b64bc

Please sign in to comment.