Skip to content

Commit 73eca37

Browse files
authored
Merge pull request #9728 from mendix/ctl-clone-document-dep-mx11
Duplicate #9641 for Mx10
2 parents c38eeb0 + 0b27553 commit 73eca37

24 files changed

+53
-984
lines changed

content/en/docs/refguide10/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](/refguide10/constants/) | Constants are used to define a constant value (for example, to store a URL for a web service). |
5858
| [Datasets](/refguide10/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](/refguide10/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](/refguide10/document-templates/) | **Deprecated in 10.24.0** Document Templates were used to design templates for exporting documents based on application data. |
6060
| [Java Actions](/refguide10/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](/refguide10/regular-expressions/) | A regular expression is used by [validation rules](/refguide10/validation-rules/) on an entity to describe a set of criteria that a string can match. |
6262
| [Rules](/refguide10/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/refguide10/modeling/application-logic/microflows-and-nanoflows/activities/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ These activities can only be used in microflows.
100100

101101
## Document Generation Activities
102102

103+
{{% alert color="warning" %}}
104+
Document generation using Document Templates was deprecated in 10.24.0. See [Document Templates](/refguide10/document-templates/) for alternatives.
105+
{{% /alert %}}
106+
103107
| Graphic | Name | Description |
104108
| --- | --- | --- |
105109
| {{< figure src="/attachments/refguide10/modeling/application-logic/microflows-and-nanoflows/activities/generate-document.png" alt="generate document" link="/refguide10/generate-document/" max-width=60% class="no-border" >}} | [Generate document](/refguide10/generate-document/) (microflows only) | Allows you to create a document of a certain type based on a [template](/refguide10/document-templates/). |

content/en/docs/refguide10/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 10.24.0. See [Document Templates](/refguide10/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](/refguide10/document-templates/).
15+
The **Generate document** microflow activity is used to write a document to a file, based on a [document template](/refguide10/document-templates/).
1616

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

content/en/docs/refguide10/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](/refguide10/navigation-tree/) and the various kinds of [buttons](/refguide10/button-widgets/) have small images (icons) to left of their captions. Images can also be used in the dynamic image widgets in [pages](/refguide10/pages/) and [document templates](/refguide10/document-templates/). Also, [enumeration values](/refguide10/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](/refguide10/navigation-tree/) and the various kinds of [buttons](/refguide10/button-widgets/) have small images (icons) to left of their captions. Images can also be used in the dynamic image widgets in [pages](/refguide10/pages/). Also, [enumeration values](/refguide10/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

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

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,35 @@ weight: 90
55
aliases:
66
- /refguide10/Document+Templates.html
77
- /refguide10/Document+Templates
8+
- /refguide10/creating-your-own-documents/
9+
- /refguide10/data-view-document-template/
10+
- /refguide10/document-template/
11+
- /refguide10/dynamic-image-document-template/
12+
- /refguide10/dynamic-label-document-template/
13+
- /refguide10/footer-document-template/
14+
- /refguide10/header-document-template/
15+
- /refguide10/line-break-document-template/
16+
- /refguide10/page-break-document-template/
17+
- /refguide10/static-image-document-template/
18+
- /refguide10/static-label-document-template/
19+
- /refguide10/style/
20+
- /refguide10/template-grid-document-template/
21+
- /refguide10/title-document-template/
22+
- /refguide10/data-grid-document-template/
23+
- /refguide10/columns-document-template/
24+
- /refguide10/table-document-template/
25+
- /refguide10/row-document-template/
26+
- /refguide10/cell-document-template/
827
#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.
928
---
1029

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. If you wish to use non-deprecated solutions, see the [Alternatives](#alternatives) section below.
32+
{{% /alert %}}
33+
1134
## Introduction
1235

13-
Document Templates are used to model a template required as input for a document export action which can generate all kinds of documents based on application data. They are composed much in the same way as [Pages](/refguide10/pages/).
36+
Document Templates are used to model a template required as input for a document export action which can generate all kinds of documents based on application data. They are composed much in the same way as [Pages](/refguide10/pages/). However, document templates were deprecated in 10.24. If you wish to use non-deprecated solutions, see the [Alternatives](#alternatives) section below.
1437

1538
{{% alert color="warning" %}}
1639
This page describes what document templates are for and what kind of widgets can be placed on them. If you want to see the properties of the document template you can check the documentation for a [document template](/refguide10/document-template/) itself.
@@ -181,3 +204,23 @@ For more information, see [Static Image (Document Template)](/refguide10/static-
181204
A static image inside a table cell.
182205

183206
{{% /alert %}}
207+
208+
## Alternatives {#alternatives}
209+
210+
Document Templates in Mendix allowed the generation of various document types. This section explains the appropriate replacement options for each previously supported document type.
211+
212+
### PDF
213+
214+
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.
215+
216+
### HTML
217+
218+
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.
219+
220+
### Microsoft Word
221+
222+
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).
223+
224+
### Other Formats
225+
226+
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/refguide10/modeling/resources/document-templates/creating-your-own-documents.md

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

0 commit comments

Comments
 (0)