NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[FIX] developer: adapt markup documentation

Browse Source 
On how to combine Markup and translations
Note that this does not work before 17.0

closes odoo/documentation#6189

Related: odoo/odoo#139316
Related: odoo/enterprise#49379
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
This commit is contained in:
Martin Trigaux 2023-10-20 13:55:38 +02:00
parent ae05fe478d
commit ff23483846
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
content/developer/reference/backend/security.rst
View File

@ -418,9 +418,9 @@ the content (text).
Markup('&lt;R&amp;D&gt; <br/> <p>Hello</p>') Markup('&lt;R&amp;D&gt; <br/> <p>Hello</p>')
>>> escape("<R&D>") >>> escape("<R&D>")
Markup('&lt;R&amp;D&gt;') Markup('&lt;R&amp;D&gt;')
>>> escape(_("List of Tasks on project %s: %s")) % ( >>> _("List of Tasks on project %s: %s",
... project.name, ... project.name,
... Markup("<ul>%s</ul>") % Markup().join([Markup("<li>%s</li>") % t.name for t in project.task_ids]) ... Markup("<ul>%s</ul>") % Markup().join(Markup("<li>%s</li>") % t.name for t in project.task_ids)
... ) ... )
Markup('Liste de tâches pour le projet &lt;R&amp;D&gt;: <ul><li>First &lt;R&amp;D&gt; task</li></ul>') Markup('Liste de tâches pour le projet &lt;R&amp;D&gt;: <ul><li>First &lt;R&amp;D&gt; task</li></ul>')
@ -434,6 +434,22 @@ the content (text).
>>> Markup(f"<p>Foo {self.bar}</p>") # bad, bar is inserted before escaping >>> Markup(f"<p>Foo {self.bar}</p>") # bad, bar is inserted before escaping
>>> Markup("<p>Foo {bar}</p>").format(bar=self.bar) # good, sorry no fstring >>> Markup("<p>Foo {bar}</p>").format(bar=self.bar) # good, sorry no fstring
When working with translations, it is especially important to separate the HTML
from the text. The translation methods accepts a :class:`~markupsafe.Markup`
parameters and will escape the translation if it gets receives at least one.
.. code-block:: pycon
>>> Markup("<p>%s</p>") % _("Hello <R&D>")
Markup('<p>Bonjour &lt;R&amp;D&gt;</p>')
>>> _("Order %s has been confirmed", Markup("<a>%s</a>") % order.name)
Markup('Order <a>SO42</a> has been confirmed')
>>> _("Message received from %(name)s <%(email)s>",
... name=self.name,
... email=Markup("<a href='mailto:%s'>%s</a>") % (self.email, self.email)
Markup('Message received from Georges &lt;<a href=mailto:george@abitbol.example>george@abitbol.example</a>&gt;')
Escaping vs Sanitizing Escaping vs Sanitizing
---------------------- ----------------------