inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-28 05:36:46 +00:00
Code

update report options screenshot

Browse Source
This commit is contained in:
Matthias Mair 2021-11-19 23:14:55 +01:00
parent 938e306a73
commit 330beed1af
4 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/assets/images/report/report.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

BIN
docs/assets/images/report/report_debug_mode.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 19 KiB

BIN
docs/assets/images/report/report_default_page_size.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 19 KiB

12
docs/report/report.md
View File

@ -63,6 +63,10 @@ The django template system allows for conditional rendering, providing condition
A number of global reporting options are available for customizing InvenTree reports:
{% with id="report-options", url="report/report.png", description="Report Options" %}
{% include 'img.html' %}
{% endwith %}
### Enable Reports
By default, the reporting feature is turned off. It must be enabled in the global settings.
@ -72,10 +76,6 @@ By default, the reporting feature is turned off. It must be enabled in the globa
The built-in InvenTree report templates (and any reports which are derived from the built-in templates) use the *Page Size* option to set the page size of the generated reports.
{% with id="report_page_size", url="report/report_default_page_size.png", description="Report Page Size" %}
{% include 'img.html' %}
{% endwith %}
!!! info "Override Page Size"
Custom report templates do not have to make use of the *Page Size* option, although it is made available to the template context.
@ -85,10 +85,6 @@ As templates are rendered directly to a PDF object, it can be difficult to debug
Setting the *Debug Mode* option renders the template as raw HTML instead of PDF, allowing the rendering output to be introspected. This feature allows template designers to understand any issues with the generated HTML (before it is passed to the PDF generation engine).
{% with id="report_debu_mode", url="report/report_debug_mode.png", description="Report Debug Mode" %}
{% include 'img.html' %}
{% endwith %}
!!! warning "HTML Rendering Limitations"
When rendered in debug mode, @page attributes (such as size, etc) will **not** be observed. Additionally, any asset files stored on the InvenTree server will not be rendered. Debug mode is not intended to produce "good looking" documents!