<h1 class="title">Project Task Reference Extract</h1> <p>This is a technical module. It has no functional use on its own.</p> <p>It allows to extract a reference to a task from a string.</p> <div class="contents topic" id="table-of-contents"> <p class="topic-title">Table of Contents</p> <ul class="simple"> <li><a class="reference internal" href="#basic-usage" id="id1">Basic Usage</a></li> <li><a class="reference internal" href="#advanced-setup" id="id2">Advanced Setup</a></li> <li><a class="reference internal" href="#contributors" id="id3">Contributors</a></li> </ul> </div> <a name="basic-usage"></a> <h2><a class="toc-backref" href="#id1">Basic Usage</a></h2> <p>The module adds a method <code>_search_references_from_text</code> on <code>project.task</code>.</p> <p>This method takes a string and returns a list of TaskReference (a python class defined in the module).</p> <pre> <code lang="python">from odoo.addons.project_task_reference.reference import TaskReference some_text = &quot;ta#123 Some commit message&quot; reference = env['project.task']._search_references_from_text(some_text)[0] assert isinstance(reference, TaskReference) assert reference.task == env['project.task'].browse(123) assert reference.string == &quot;ta#123&quot; assert reference.normalized_string == &quot;TA#123&quot;</code> </pre> <p>The reference(s) can be located anywhere in the given text.</p> <p>The method is at some point tolerant to variations in the format of the reference inside the given text.</p> <ul class="simple"> <li>It is insensitive to lower case.</li> <li>The <code>#</code> is optional.</li> </ul> <p>Thefore <code>ta123</code> would be recognized.</p> <a name="advanced-setup"></a> <h2><a class="toc-backref" href="#id2">Advanced Setup</a></h2> <p>By default, the system uses the following regex to parse the references:</p> <blockquote> [tT][aA]#?(?P&lt;id&gt;d+)</blockquote> <p>This means that the strings <code>TA#123</code>, <code>ta#123</code>, <code>TA123</code> or <code>ta123</code> will generate a reference that point to the task with ID=123.</p> <p>Then, the following python format is used to render the reference in a normalized form:</p> <blockquote> TA#{id}</blockquote> <p>The reference will always be formatted <code>TA#123</code>.</p> <p>This can be tweeked by defining 2 system parameters:</p> <ul class="simple"> <li><code>project_task_reference.regex</code>: the REGEX used to parse the reference.</li> <li><code>project_task_reference.format</code>: the python format to use for formatting the reference.</li> </ul> <p>For example, let's suppose the format for our links must be: <code>[ST#123]</code>. The system parameters could be as follow:</p> <ul class="simple"> <li><code>project_task_reference.regex</code>: <code>\[?[sS][tT]#?(?P&lt;id&gt;\d+)\]?</code></li> <li><code>project_task_reference.format</code>: <code>[ST#{id}]</code></li> </ul> <p>The regex must contain a parameter <code>(?P&lt;id&gt;\d+)</code> (the database ID of the task).</p> <a name="contributors"></a> <h2><a class="toc-backref" href="#id3">Contributors</a></h2> <ul class="simple"> <li>Numigi (tm) and all its contributors (<a class="reference external" href="https://bit.ly/numigiens">https://bit.ly/numigiens</a>)</li> </ul>