diff --git a/docs/assets/images/report/report.png b/docs/assets/images/report/report.png new file mode 100644 index 0000000..9bf1da6 Binary files /dev/null and b/docs/assets/images/report/report.png differ diff --git a/docs/assets/images/report/report_debug_mode.png b/docs/assets/images/report/report_debug_mode.png deleted file mode 100644 index 86d2f0f..0000000 Binary files a/docs/assets/images/report/report_debug_mode.png and /dev/null differ diff --git a/docs/assets/images/report/report_default_page_size.png b/docs/assets/images/report/report_default_page_size.png deleted file mode 100644 index 7feb76c..0000000 Binary files a/docs/assets/images/report/report_default_page_size.png and /dev/null differ diff --git a/docs/demo.md b/docs/demo.md index a44dbc4..cdf9902 100644 --- a/docs/demo.md +++ b/docs/demo.md @@ -26,7 +26,8 @@ The InvenTree demo database resets to a known state once per day. - Database records are reset to the latest state of the [demo dataset](https://github.com/inventree/demo-dataset) - InvenTree software is kept up to date with the latest `inventree:master` available via docker -During the update period, the demo server may be inaccessible for a few minutes. +!!! warning "Server Down" + During the update period, the demo server may be inaccessible for a few minutes. ## Demo Dataset diff --git a/docs/report/report.md b/docs/report/report.md index a0cce35..e2a996b 100644 --- a/docs/report/report.md +++ b/docs/report/report.md @@ -63,14 +63,19 @@ 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. + + ### Default Page Size 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. @@ -80,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!