Skip to content

Commit 5c4ca99

Browse files
committed
📝(documentation) Add custom export templates section
... with usage instructions and limitations Signed-off-by: rvveber <[email protected]>
1 parent 2f010cf commit 5c4ca99

File tree

5 files changed

+41
-1
lines changed

5 files changed

+41
-1
lines changed
26.7 KB
Loading
20 KB
Loading
28.9 KB
Loading
26.3 KB
Loading

docs/theming.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,44 @@ THEME_CUSTOMIZATION_FILE_PATH=<path>
8585

8686
### Example of JSON
8787

88-
The json must follow some rules: https://github.com/suitenumerique/docs/blob/main/src/helm/env.d/dev/configuration/theme/demo.json
88+
The json must follow some rules: https://github.com/suitenumerique/docs/blob/main/src/helm/env.d/dev/configuration/theme/demo.json
89+
90+
----
91+
92+
# **Custom Export Templates** 📄
93+
94+
You can define custom export templates to add introductory content, such as headers or titles, to documents before exporting them as PDF, Docx, etc...
95+
96+
Export Templates are managed through the admin interface and can be selected by users during the export process.
97+
98+
### Benefits
99+
100+
This feature offers several advantages:
101+
* **Header customization** 📄: Add custom headers, titles, or branding to exported documents.
102+
* **No code changes required** 🔧: Templates are managed through the admin interface without needing developer intervention.
103+
* **Flexible content** 🌟: Use HTML to create headers that match your organization's style.
104+
105+
### Limitations ⚠️
106+
107+
- Currently, templates are only prepended to the document.
108+
More complex layouts are not supported at this time.
109+
- The `CSS` and `Description` fields are being ignored at this time.
110+
- <b>Due to technical conversion limitations, not all HTML can be converted to the internal format!</b>
111+
112+
### How to Use
113+
114+
1. Create the Template in a new document.
115+
![Build Template in Editor](./assets/export-template-tutorial/build-template-in-editor.png)
116+
2. Copy it as HTML code using the `Copy as HTML` feature:
117+
![Three Dots Copy as HTML](./assets/export-template-tutorial/three-dots-copy-as-html.png)
118+
3. Log in to the admin interface at `/admin` (backend container).
119+
2. Create a new template:
120+
![Admin Create Template Workflow](./assets/export-template-tutorial/admin-create-template-workflow.png)
121+
- **Title**: Enter a descriptive name for the template.
122+
- **Code**: Paste the HTML content from step 2.
123+
- **Public**: Check this box to make the template available in the frontend export modal.
124+
- **Save** the template.
125+
126+
Once saved, users can select the template from the export modal in the frontend during the export process.
127+
![Select Template in Editor](./assets/export-template-tutorial/select-template-in-editor.png)
128+

0 commit comments

Comments
 (0)