mirror of
https://github.com/inventree/InvenTree.git
synced 2025-11-30 09:20:03 +00:00
786b52d016
* Report merge
* Remove auto-generated file
* Remove pre-commit file
* Revert "Remove pre-commit file"
This reverts commit 00d80bae2a.
* Update API version
* Reduced duplicated logic
* reset pre-commit config
* Added migration files
* Added unit test
* Removed redundant migration
* Updated migration file
* Added a default report template with merge enabled
* Unit test to ensure a single page is generated
* Added docs to support merge feature
* Clean up
* Clean up
* Fixed unresolved link
* Updated API version
* Fixed test report path issue
* Add plugin context for each instance
* merge in master
* Fixed formating
* Added more detailed user guide
* Updated docs
* Added assert to ensure test html output exists
* Updated docs
* Fixed report test path
---------
Co-authored-by: Matthias Mair <code@mjmair.com>
49 lines
2.5 KiB
Markdown
49 lines
2.5 KiB
Markdown
---
|
|
title: Report and LabelGeneration
|
|
---
|
|
|
|
## Custom Reports
|
|
|
|
InvenTree supports a customizable reporting ecosystem, allowing the user to develop document templates that meet their particular needs.
|
|
|
|
PDF files are generated from custom HTML template files which are written by the user.
|
|
|
|
Templates can be used to generate *reports* or *labels* which can be used in a variety of situations to format data in a friendly format for printing, distribution, conformance and testing.
|
|
|
|
In addition to providing the ability for end-users to provide their own reporting templates, some report types offer "built-in" report templates ready for use.
|
|
|
|
### WeasyPrint Templates
|
|
|
|
InvenTree report templates utilize the powerful [WeasyPrint](https://weasyprint.org/) PDF generation engine.
|
|
|
|
!!! info "WeasyPrint"
|
|
WeasyPrint is an extremely powerful and flexible reporting library. Refer to the [WeasyPrint docs](https://doc.courtbouillon.org/weasyprint/stable/) for further information.
|
|
|
|
### Stylesheets
|
|
|
|
Templates are rendered using standard HTML / CSS - if you are familiar with web page layout, you're ready to go!
|
|
|
|
### Template Language
|
|
|
|
Uploaded report template files are passed through the [django template rendering framework]({% include "django.html" %}/topics/templates/), and as such accept the same variable template strings as any other django template file. Different variables are passed to the report template (based on the context of the report) and can be used to customize the contents of the generated PDF.
|
|
|
|
### Variables
|
|
|
|
Each report template is provided a set of *context variables* which can be used when rendering the template.
|
|
|
|
For example, rendering the name of a part (which is available in the particular template context as `part`) is as follows:
|
|
|
|
```html
|
|
{% raw %}
|
|
|
|
<!-- Template variables use {{ double_curly_braces }} -->
|
|
<h2>Part: {{ part.name }}</h3>
|
|
<p><i>
|
|
Description:<br>
|
|
{{ part.description }}
|
|
</p></i>
|
|
{% endraw %}
|
|
```
|
|
#### Rendering a single report vs. multiple report from selection
|
|
Users can select multiple items such as `part`, `stockItem`,...etc to render from a report template. By default, the `merge` attribute of report template is disabled, which means an independent report will be generated for each item in the list of selected items. If `merge` is enabled, all selected items will be available in the `instances` context variable of the report template. Users are free to access them by indexing or in a loop. For more details, visit [context variable](./context_variables.md)
|