2
0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-27 05:06:43 +00:00
inventree-docs/_includes/reference.html
Oliver ca1e47315d
Pricing refactor (#389)
* Updates for pricing docs

* Add info on pricing caching

* Add some details

* Updated screenshot for BOM pricing

* Update pricing link

* Add missing screenshot in TODO section

* Add a note about the BOM pricing chart
2022-11-14 15:58:08 +11:00

35 lines
1.6 KiB
HTML

Each {{ label }} is uniquely identified by a <strong>Reference</strong> field.
<h4>Reference Pattern</h4>
<p>
The {{ label }} <em>reference</em> field must conform to a (configurable) pattern, allowing users to define a standard for identifying individual orders.<br>
In addition to being used ensure the reference fields conform to a standard format, the reference pattern is also used to automatically generate sequential reference values.
</p>
<p>
The default pattern for the {{ label }} reference pattern is <code>{{ prefix }}{ref:04d}</code>.<br>
This will generate a sequence of reference values like:
<ul>
<li>{{ prefix }}0001</li>
<li>{{ prefix }}0002</li>
<li>{{ prefix }}0003</li>
</ul>
The {{ label }} reference pattern can be configured to generate a different reference sequence as required.
</p>
<p>
The {{ label }} pattern is implemented as follows:
<ul>
<li>The pattern must specify a single <code>{ref}</code> block - this is the <em>required</em> sequential portion of the pattern.</li>
<li>A <code>?</code> character is treated as a wildcard which will match any character.</li>
<li>A <code>#</code> character is treated as a wildcard which will match any number.</li>
<li>Any other characters will be matched literally.</li>
</ul>
</p>
<div class='admonition info'>
<p class='admonition-title'>Reference Formatting</p>
<p>
The reference field pattern uses <a href="https://www.w3schools.com/python/ref_string_format.asp">Python string formatting</a> for value substitution.
</p>
</div>