mirror of
https://github.com/inventree/inventree-docs.git
synced 2025-08-19 18:35:50 +00:00
_includes
docs
admin
assets
build
buy
extend
javascripts
part
report
labels.md
order.md
pack.md
report.md
test.md
start
stock
stylesheets
webfonts
contribute.md
index.md
.gitignore
LICENSE
README.md
mkdocs.yml
readthedocs.yml
requirements.txt
58 lines
1.7 KiB
Markdown
58 lines
1.7 KiB
Markdown
---
|
|
title: Custom Labels
|
|
---
|
|
|
|
## Custom Labels
|
|
|
|
InvenTree supports printing of custom template-based labels, using the [blabel](https://github.com/Edinburgh-Genome-Foundry/blabel) plugin for Python.
|
|
|
|
Custom labels can be generated using simple HTML templates, with support for QR-codes, and conditional formatting using the Jinja template engine.
|
|
|
|
!!! info "Documentation"
|
|
Refer to the blabel documentation for further information
|
|
|
|
### Creating Labels
|
|
|
|
!!! missing "TODO"
|
|
This section requires further work
|
|
|
|
### Stylesheet
|
|
|
|
!!! missing "TODO"
|
|
This section requires further work
|
|
|
|
### Context Data
|
|
|
|
Each label template is supplied with *context data* (variables) which can be used to display information based on the context in which the label is printed.
|
|
|
|
!!! missing "TODO"
|
|
This section requires further work
|
|
|
|
### QR Codes
|
|
|
|
!!! missing "TODO"
|
|
This section requires further work
|
|
|
|
### Conditional Formatting
|
|
|
|
!!! missing "TODO"
|
|
This section requires further work
|
|
|
|
## Stock Labels
|
|
|
|
!!! missing "TODO"
|
|
This section requires further work
|
|
|
|
### Context Data
|
|
|
|
In addition to the global label context data, the following variables are made available to the StockItem label template:
|
|
|
|
* item - *The StockItem object itself*
|
|
* part - *The Part object which is referenced by the StockItem object*
|
|
* name - *The `name` field of the Part object*
|
|
* ipn - *The `IPN` field of the Part object*
|
|
* quantity - *The `quantity` field of the StockItem object*
|
|
* serial - *The `serial` field of the StockItem object*
|
|
* uid - *The `uid` field of the StockItem object*
|
|
* qrcode - *JSON data representing the StockItem object, useful for rendering to a QR code*
|
|
* tests - *Dict object of TestResult data associated with the StockItem* |