{"componentChunkName":"component---smooth-doc-smooth-doc-src-templates-doc-js","path":"/docs/report-templates/report-templates-overview/","result":{"data":{"mdx":{"fields":{"pageType":"doc","title":"Report Templates Overview","editLink":""},"body":"var _excluded = [\"components\"];\nfunction _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }\nfunction _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var s = Object.getOwnPropertySymbols(e); for (r = 0; r < s.length; r++) o = s[r], t.includes(o) || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }\nfunction _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (e.includes(n)) continue; t[n] = r[n]; } return t; }\n/* @jsxRuntime classic */\n/* @jsx mdx */\n\nvar _frontmatter = {\n \"title\": \"Report Templates Overview\",\n \"description\": \"working with figures\",\n \"section\": \"Report Templates\",\n \"order\": 32\n};\nvar layoutProps = {\n _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n var components = _ref.components,\n props = _objectWithoutProperties(_ref, _excluded);\n return mdx(MDXLayout, _extends({}, layoutProps, props, {\n components: components,\n mdxType: \"MDXLayout\"\n }), mdx(\"h1\", {\n \"id\": \"report-templates-overview\"\n }, mdx(\"a\", {\n parentName: \"h1\",\n \"href\": \"#report-templates-overview\",\n \"aria-label\": \"report templates overview permalink\",\n \"className\": \"anchor\"\n }, mdx(\"svg\", {\n parentName: \"a\",\n \"aria-hidden\": \"true\",\n \"focusable\": \"false\",\n \"height\": \"16\",\n \"version\": \"1.1\",\n \"viewBox\": \"0 0 16 16\",\n \"width\": \"16\"\n }, mdx(\"path\", {\n parentName: \"svg\",\n \"fillRule\": \"evenodd\",\n \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n }))), \"Report Templates Overview\"), mdx(\"h5\", {\n \"id\": \"add-on\"\n }, mdx(\"a\", {\n parentName: \"h5\",\n \"href\": \"#add-on\",\n \"aria-label\": \"add on permalink\",\n \"className\": \"anchor\"\n }, mdx(\"svg\", {\n parentName: \"a\",\n \"aria-hidden\": \"true\",\n \"focusable\": \"false\",\n \"height\": \"16\",\n \"version\": \"1.1\",\n \"viewBox\": \"0 0 16 16\",\n \"width\": \"16\"\n }, mdx(\"path\", {\n parentName: \"svg\",\n \"fillRule\": \"evenodd\",\n \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n }))), \"[add-on]\"), mdx(\"p\", null, \"Report templates may be used to generate standardized \", mdx(\"abbr\", {\n parentName: \"p\",\n \"title\": \"Portable Document Format\"\n }, \"PDF\"), \" outputs for summarizing the information in a folder. Reports may include the signature of the user that generated them and are automatically saved in the folder where they are generated. Report templates provide a convenient mechanism for archiving and/or sharing study information in standard formats. Different report templates can be used for different studies, depending on the need.\"), mdx(\"div\", {\n className: \"info\"\n }, \"The Report templates add-on is required to create reports.\"), mdx(\"h2\", {\n \"id\": \"developing-templates\"\n }, mdx(\"a\", {\n parentName: \"h2\",\n \"href\": \"#developing-templates\",\n \"aria-label\": \"developing templates permalink\",\n \"className\": \"anchor\"\n }, mdx(\"svg\", {\n parentName: \"a\",\n \"aria-hidden\": \"true\",\n \"focusable\": \"false\",\n \"height\": \"16\",\n \"version\": \"1.1\",\n \"viewBox\": \"0 0 16 16\",\n \"width\": \"16\"\n }, mdx(\"path\", {\n parentName: \"svg\",\n \"fillRule\": \"evenodd\",\n \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n }))), \"Developing Templates\"), mdx(\"p\", null, \"Developing templates requires understanding of \", mdx(\"abbr\", {\n parentName: \"p\",\n \"title\": \"HyperText Markup Language\"\n }, \"HTML\"), \" and \", mdx(\"abbr\", {\n parentName: \"p\",\n \"title\": \"Cascading Style Sheets\"\n }, \"CSS\"), \". If you don\\u2019t have the required expertise and are not willing to experiment, contact our support team for information on how we may be able to support you.\"), mdx(\"p\", null, \"The style and layout of the data in a template can be fully customized with standard \", mdx(\"abbr\", {\n parentName: \"p\",\n \"title\": \"HyperText Markup Language\"\n }, \"HTML\"), \" and \", mdx(\"abbr\", {\n parentName: \"p\",\n \"title\": \"Cascading Style Sheets\"\n }, \"CSS\"), \", similar to how web pages are formatted. Additionally, placeholders can be used to represent metadata, snapshots, image thumbnails, hyperlinks, as well as other static data (e.g., text and images) throughout the template. During report generation, these placeholders are populated with data from the folder in which the report is generated. The output of the reporting engine is a \", mdx(\"abbr\", {\n parentName: \"p\",\n \"title\": \"Portable Document Format\"\n }, \"PDF\"), \" that has been formatted and populated according to the template that has been used.\"), mdx(\"p\", null, \"To better understand the features of the templating language, start by reviewing our \", mdx(\"a\", {\n parentName: \"p\",\n \"href\": \"/flow/manual/latest/docs/report-templates/jinja2-quick-reference/\"\n }, \"Jinja2 Quick Reference\"), \" and \", mdx(\"a\", {\n parentName: \"p\",\n \"href\": \"/flow/manual/latest/docs/report-templates/placeholder-reference/\"\n }, \"Placeholder Reference\"), \". For comprehensive information about the templating language, refer to the \", mdx(\"a\", {\n parentName: \"p\",\n \"href\": \"https://jinja.palletsprojects.com/en/3.0.x/templates/\"\n }, \"Jinja2 documentation\"), \".\"), mdx(\"h3\", {\n \"id\": \"a-basic-template\"\n }, mdx(\"a\", {\n parentName: \"h3\",\n \"href\": \"#a-basic-template\",\n \"aria-label\": \"a basic template permalink\",\n \"className\": \"anchor\"\n }, mdx(\"svg\", {\n parentName: \"a\",\n \"aria-hidden\": \"true\",\n \"focusable\": \"false\",\n \"height\": \"16\",\n \"version\": \"1.1\",\n \"viewBox\": \"0 0 16 16\",\n \"width\": \"16\"\n }, mdx(\"path\", {\n parentName: \"svg\",\n \"fillRule\": \"evenodd\",\n \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n }))), \"A Basic Template\"), mdx(\"p\", null, \"The following example demonstrates a trivial example of a template that outputs the list of images in a folder. To learn more about the syntax and possibilities, see the following pages for more details: \", mdx(\"a\", {\n parentName: \"p\",\n \"href\": \"/flow/manual/latest/docs/report-templates/jinja2-quick-reference/\"\n }, \"Jinja2 Quick Reference\"), \", \", mdx(\"a\", {\n parentName: \"p\",\n \"href\": \"/flow/manual/latest/docs/report-templates/placeholder-reference/\"\n }, \"Placeholder Reference\"), \" and \", mdx(\"a\", {\n parentName: \"p\",\n \"href\": \"/flow/manual/latest/docs/report-templates/auxiliary-information/\"\n }, \"Auxiliary Information\"), \".\"), mdx(\"pre\", null, mdx(\"code\", {\n parentName: \"pre\"\n }, \"{# Section for report title #}\\n{% block title %}\\n {# Set the title of your PDF document in this block (text only) #}\\n{% endblock %}\\n\\n{# Section for report body #}\\n{% block body %}\\n
\\n

Basic Report Template

\\n\\n

Set the content of your report within the \\\"body\\\" block.

\\n

Use variables passed to the template like this:

\\n

The name of the folder is {{ folder.name }}.

\\n\\n

List of Images

\\n \\n\\n

If the report is signed, the signer's signature and name will appear here:

\\n {% if report_signed_by %}\\n
\\n \\n

Signed by {{ report_signed_by.name }} at {{ report_signed_at }}

\\n
\\n {% endif %}\\n
\\n{% endblock %}\\n\")));\n}\n;\nMDXContent.isMDXComponent = true;","tableOfContents":{"items":[{"url":"#report-templates-overview","title":"Report Templates Overview","items":[{"items":[{"items":[{"items":[{"url":"#add-on","title":"add-on"}]}]}]},{"url":"#developing-templates","title":"Developing Templates","items":[{"url":"#a-basic-template","title":"A Basic Template"}]}]}]}}},"pageContext":{"id":"a2bc75c3-a32b-585c-9498-0609377b8c83"}},"staticQueryHashes":["1086510573","1106176283","1122327541","2140385554","2719290676","3597609067","4027383558"]}