inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-10-31 12:55:37 +00:00
Code Activity

Reference (#433)

Browse Source 
* Adds page documenting reference strings

* Cleanup existing reference field documentation
This commit is contained in:
Oliver
2023-02-02 09:48:48 +11:00
committed by GitHub
parent b8370aaea1
commit 1f2598b748
6 changed files with 54 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
_includes/reference.html
View File

@@ -1,35 +0,0 @@
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>