Skip to content

Commit 9d3149a

Browse files
authored
Merge pull request #9641 from jdiehl/patch-90
Deprecate Document Templates
2 parents 3e27e1b + a2d9eed commit 9d3149a

26 files changed

+73
-1169
lines changed

content/en/docs/refguide/installation/upgrading-from-10-to-11.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Regardless of which major version you are upgrading from, we recommend you upgra
2727

2828
1. Back up your app.
2929
1. Upgrade to the latest patch of Studio Pro.
30-
1. Upgrade widgets, modules, Marketplace components, templates, and connectors.
30+
1. Upgrade widgets, modules, Marketplace components, and connectors.
3131
1. Fix deprecations and test your app.
3232
1. Upgrade app to Mendix 11.
3333

@@ -55,7 +55,10 @@ In general, you should not remove and re-import modules unless this is recommend
5555

5656
After the upgrade of your marketplace content, take the next steps:
5757

58-
1. Fix any deprecation warnings you see in development in Studio Pro, as well as in the Mendix Runtime using your console and browser console.
58+
1. Fix any deprecation warnings you see in development in Studio Pro, as well as in the Mendix Runtime using your console and browser console. These deprecations could include, but are not limited to, the following:
59+
* [Document Templates](/refguide/document-templates/): deprecated in 10.24
60+
* [Dojo-based Mendix Client](/refguide/mendix-client/): deprecated in 11.0
61+
* Deprecated Java Version: depending on your Java version you may see errors — to resolve those errors, see [Java Version Migration](/refguide/java-version-migration/)
5962
1. Review the major changes in the sections below.
6063
1. Run your app, test all functionality, and ensure it works without error.
6164
1. Back up or commit your Mendix 10 app so you can return to it if necessary.

content/en/docs/refguide/modeling/app-explorer/modules/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ There are the following type of modules:
5656
| --- | --- |
5757
| [Constants](/refguide/constants/) | Constants are used to define a constant value (for example, to store a URL for a web service). |
5858
| [Datasets](/refguide/data-sets/) | A dataset can be used for reporting and is defined using either an OQL query or a custom Java action. |
59-
| [Document Templates](/refguide/document-templates/) | Document templates are used to model a template needed as input for a document export action that can generate all kinds of documents based on application data. They are composed much in the same way as forms. |
59+
| [Document Templates](/refguide/document-templates/) | **Deprecated in 11.0.0** Document Templates were used to design templates for exporting documents based on application data. |
6060
| [Java Actions](/refguide/java-actions/) | With Java actions, you can extend the functionality of your application in situations where it would be hard to implement the functionality in microflows. You can call a Java action from a microflow. |
6161
| [Regular Expressions](/refguide/regular-expressions/) | A regular expression is used by [validation rules](/refguide/validation-rules/) on an entity to describe a set of criteria that a string can match. |
6262
| [Rules](/refguide/rules/) | A rule defines a set of criteria. With a certain input, the rule will result in a Boolean or enumeration, depending on the criteria met. It can be called from a decision to determine the direction the microflow should go once a decision is reached. |

content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/_index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,11 @@ These activities can only be used in microflows.
9898
| ---| --- | --- |
9999
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/activities/log-message.png" alt="log message" link="/refguide/log-message/" max-width=60% class="no-border" >}} | [Log message](/refguide/log-message/) | Allows you to create messages that appear in the log of your Mendix application. |
100100

101-
## Document Generation Activities
101+
## Document Generation Activities (Deprecated)
102+
103+
{{% alert color="warning" %}}
104+
Document generation using Document Templates was deprecated in 11.0.0. See [Document Templates](/refguide/document-templates/) for alternatives.
105+
{{% /alert %}}
102106

103107
| Graphic | Name | Description |
104108
| --- | --- | --- |

content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/generate-document.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ description: "Describes generating documents from a microflow. "
66
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
77
---
88

9-
{{% alert color="info" %}}
10-
This activity can only be used in microflows.
9+
{{% alert color="warning" %}}
10+
**Document generation** using Document Templates was deprecated in 11.0.0 Please see the documentation of [Document Templates](/refguide/document-templates/) for alternatives.
1111
{{% /alert %}}
1212

1313
## Introduction
1414

15-
The **Generate document** activity is used to write a document to a file, based on a [document template](/refguide/document-templates/).
15+
The **Generate document** microflow activity is used to write a document to a file, based on a [document template](/refguide/document-templates/).
1616

1717
For more information on which types of documents can be created, see [Document Type](#document-type).
1818

content/en/docs/refguide/modeling/images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: "Introduces the image functionality in Studio Pro."
88

99
## Introduction
1010

11-
Images can be used to brighten up your application. [Navigation items](/refguide/navigation-tree/) and the various kinds of [buttons](/refguide/button-widgets/) have small images (icons) to left of their captions. Images can also be used in the dynamic image widgets in [pages](/refguide/pages/) and [document templates](/refguide/document-templates/). Also, [enumeration values](/refguide/enumerations/#enum-value-properties) can have images that can then be shown in data grid columns.
11+
Images can be used to brighten up your application. [Navigation items](/refguide/navigation-tree/) and the various kinds of [buttons](/refguide/button-widgets/) have small images (icons) to left of their captions. Images can also be used in the dynamic image widgets in [pages](/refguide/pages/). Also, [enumeration values](/refguide/enumerations/#enum-value-properties) can have images that can then be shown in data grid columns.
1212

1313
The **System** module contains some images that are used by the standard components. If you place a data view on a page, the **Save** and **Cancel** buttons will have images from the **System** module on them. You can always use different images if you like. The same holds for images on the control bar buttons of the data grid.
1414

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: "Document Templates"
3+
url: /refguide/document-templates/
4+
weight: 90
5+
aliases:
6+
- /refguide/Document+Templates.html
7+
- /refguide/Document+Templates
8+
- /refguide/creating-your-own-documents/
9+
- /refguide/data-view-document-template/
10+
- /refguide/document-template/
11+
- /refguide/dynamic-image-document-template/
12+
- /refguide/dynamic-label-document-template/
13+
- /refguide/footer-document-template/
14+
- /refguide/header-document-template/
15+
- /refguide/line-break-document-template/
16+
- /refguide/page-break-document-template/
17+
- /refguide/static-image-document-template/
18+
- /refguide/static-label-document-template/
19+
- /refguide/style/
20+
- /refguide/template-grid-document-template/
21+
- /refguide/title-document-template/
22+
- /refguide/data-grid-document-template/
23+
- /refguide/columns-document-template/
24+
- /refguide/table-document-template/
25+
- /refguide/row-document-template/
26+
- /refguide/cell-document-template/
27+
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
28+
---
29+
30+
{{% alert color="warning" %}}
31+
The use of **Document Templates** and the **Generate Document** microflow action is deprecated and will be removed in a future version of Mendix.
32+
{{% /alert %}}
33+
34+
## Introduction
35+
36+
Document Templates, previously used to design templates for exporting documents based on application data in Mendix, along with the **Generate Document** microflow action, are now deprecated and will be removed in a future Mendix release. This guide outlines the recommended alternatives for document generation.
37+
38+
To view the documentation of Document Templates, please refer to the [Mendix 10 documentation](/refguide10/document-templates/) instead.
39+
40+
## Alternatives
41+
42+
Document Templates in Mendix allowed the generation of various document types. This section explains the appropriate replacement options for each previously supported document type.
43+
44+
### PDF
45+
46+
To generate PDF documents, use the [PDF Document Generation](/appstore/modules/document-generation/) capability, which allows you to define PDFs based on standard Mendix pages. This approach offers significantly greater flexibility and control over the layout and design of your PDF documents compared to the deprecated Document Templates.
47+
48+
### HTML
49+
50+
To generate HTML documents, create the HTML manually and use the token replacement capabilities of the [Mx Model Reflection](/appstore/modules/model-reflection/#token-configuration) module to insert application data. Open source tools such as [MJML](https://mjml.io/) can assist in designing visually appealing HTML, especially for email templates.
51+
52+
### Microsoft Word
53+
54+
Generating Microsoft Word documents is no longer supported by Mendix. However, there are several alternative solutions available — both free and paid — maintained by Mendix partners and the community that support Word document generation. These can be found in the [Mendix Marketplace](https://marketplace.mendix.com/link/search/word).
55+
56+
### Other Formats
57+
58+
Other formats, including Rich Text Format (.rtf) and OpenDocument Text (.odt), are no longer supported by Mendix and do not have official alternatives. We understand this may impact certain use cases, and we recommend exploring whether supported formats like PDF or HTML can meet your current needs.

content/en/docs/refguide/modeling/resources/document-templates/_index.md

Lines changed: 0 additions & 183 deletions
This file was deleted.

0 commit comments

Comments
 (0)