diff --git a/content/en/docs/refguide/installation/upgrading-from-10-to-11.md b/content/en/docs/refguide/installation/upgrading-from-10-to-11.md index 4b9460e3cd5..de995e77314 100644 --- a/content/en/docs/refguide/installation/upgrading-from-10-to-11.md +++ b/content/en/docs/refguide/installation/upgrading-from-10-to-11.md @@ -27,7 +27,7 @@ Regardless of which major version you are upgrading from, we recommend you upgra 1. Back up your app. 1. Upgrade to the latest patch of Studio Pro. -1. Upgrade widgets, modules, Marketplace components, templates, and connectors. +1. Upgrade widgets, modules, Marketplace components, and connectors. 1. Fix deprecations and test your app. 1. Upgrade app to Mendix 11. @@ -55,7 +55,10 @@ In general, you should not remove and re-import modules unless this is recommend After the upgrade of your marketplace content, take the next steps: -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. +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: + * [Document Templates](/refguide/document-templates/): deprecated in 10.24 + * [Dojo-based Mendix Client](/refguide/mendix-client/): deprecated in 11.0 + * Deprecated Java Version: depending on your Java version you may see errors — to resolve those errors, see [Java Version Migration](/refguide/java-version-migration/) 1. Review the major changes in the sections below. 1. Run your app, test all functionality, and ensure it works without error. 1. Back up or commit your Mendix 10 app so you can return to it if necessary. diff --git a/content/en/docs/refguide/modeling/app-explorer/modules/_index.md b/content/en/docs/refguide/modeling/app-explorer/modules/_index.md index 23790b70714..5aaa2011b4b 100644 --- a/content/en/docs/refguide/modeling/app-explorer/modules/_index.md +++ b/content/en/docs/refguide/modeling/app-explorer/modules/_index.md @@ -56,7 +56,7 @@ There are the following type of modules: | --- | --- | | [Constants](/refguide/constants/) | Constants are used to define a constant value (for example, to store a URL for a web service). | | [Datasets](/refguide/data-sets/) | A dataset can be used for reporting and is defined using either an OQL query or a custom Java action. | -| [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. | +| [Document Templates](/refguide/document-templates/) | **Deprecated in 11.0.0** Document Templates were used to design templates for exporting documents based on application data. | | [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. | | [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. | | [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. | diff --git a/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/_index.md b/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/_index.md index 0eef99318e1..e752dcd994a 100644 --- a/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/_index.md +++ b/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/_index.md @@ -98,7 +98,11 @@ These activities can only be used in microflows. | ---| --- | --- | | {{< 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. | -## Document Generation Activities +## Document Generation Activities (Deprecated) + +{{% alert color="warning" %}} +Document generation using Document Templates was deprecated in 11.0.0. See [Document Templates](/refguide/document-templates/) for alternatives. +{{% /alert %}} | Graphic | Name | Description | | --- | --- | --- | diff --git a/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/generate-document.md b/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/generate-document.md index 89d1f26a88c..d3a502e2e2c 100644 --- a/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/generate-document.md +++ b/content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/generate-document.md @@ -6,13 +6,13 @@ description: "Describes generating documents from a microflow. " #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. --- -{{% alert color="info" %}} -This activity can only be used in microflows. +{{% alert color="warning" %}} +**Document generation** using Document Templates was deprecated in 11.0.0 Please see the documentation of [Document Templates](/refguide/document-templates/) for alternatives. {{% /alert %}} ## Introduction -The **Generate document** activity is used to write a document to a file, based on a [document template](/refguide/document-templates/). +The **Generate document** microflow activity is used to write a document to a file, based on a [document template](/refguide/document-templates/). For more information on which types of documents can be created, see [Document Type](#document-type). diff --git a/content/en/docs/refguide/modeling/images.md b/content/en/docs/refguide/modeling/images.md index cd7c613b36e..01fa59b9860 100644 --- a/content/en/docs/refguide/modeling/images.md +++ b/content/en/docs/refguide/modeling/images.md @@ -8,7 +8,7 @@ description: "Introduces the image functionality in Studio Pro." ## Introduction -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. +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. 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. diff --git a/content/en/docs/refguide/modeling/resources/document-templates.md b/content/en/docs/refguide/modeling/resources/document-templates.md new file mode 100644 index 00000000000..5c7f45c966d --- /dev/null +++ b/content/en/docs/refguide/modeling/resources/document-templates.md @@ -0,0 +1,58 @@ +--- +title: "Document Templates" +url: /refguide/document-templates/ +weight: 90 +aliases: + - /refguide/Document+Templates.html + - /refguide/Document+Templates + - /refguide/creating-your-own-documents/ + - /refguide/data-view-document-template/ + - /refguide/document-template/ + - /refguide/dynamic-image-document-template/ + - /refguide/dynamic-label-document-template/ + - /refguide/footer-document-template/ + - /refguide/header-document-template/ + - /refguide/line-break-document-template/ + - /refguide/page-break-document-template/ + - /refguide/static-image-document-template/ + - /refguide/static-label-document-template/ + - /refguide/style/ + - /refguide/template-grid-document-template/ + - /refguide/title-document-template/ + - /refguide/data-grid-document-template/ + - /refguide/columns-document-template/ + - /refguide/table-document-template/ + - /refguide/row-document-template/ + - /refguide/cell-document-template/ +#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. +--- + +{{% alert color="warning" %}} +The use of **Document Templates** and the **Generate Document** microflow action is deprecated and will be removed in a future version of Mendix. +{{% /alert %}} + +## Introduction + +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. + +To view the documentation of Document Templates, please refer to the [Mendix 10 documentation](/refguide10/document-templates/) instead. + +## Alternatives + +Document Templates in Mendix allowed the generation of various document types. This section explains the appropriate replacement options for each previously supported document type. + +### PDF + +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. + +### HTML + +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. + +### Microsoft Word + +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). + +### Other Formats + +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. diff --git a/content/en/docs/refguide/modeling/resources/document-templates/_index.md b/content/en/docs/refguide/modeling/resources/document-templates/_index.md deleted file mode 100644 index 8e550a23edd..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/_index.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -title: "Document Templates" -url: /refguide/document-templates/ -weight: 90 -aliases: - - /refguide/Document+Templates.html - - /refguide/Document+Templates -#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. ---- - -## Introduction - -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](/refguide/pages/). - -{{% alert color="warning" %}} -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](/refguide/document-template/) itself. -{{% /alert %}} - -The document templates also contain components, also know as *widgets*. Below is a categorized overview of all widgets. The following categories are used: - -* [Core widgets](#core) are central to building document templates in Mendix. These are the widgets that can show a list of entities or a single entity -* [Layout widgets](#layout) are used to structure the layout of your document templates -* [Dynamic data widgets](#dynamic) make it possible to show values of attributes and associations -* [Static data widgets](#static) allow you to work with static data such as a predefined image - -Additionally, in most widgets as well as on the document template itself, a style can be defined. For more information, see [Style](/refguide/style/). - -If you would like to display text in a language with uncommon characters such as Arabic or Thai, make sure you select a font in the style editor that supports these characters. "Tahoma" is such a font. - -## Core Widgets {#core} - -The core widgets are central to building document templates in Mendix. They can show the contents of a single entity or of a list of entities. Every document template designed to show data from the domain model requires one of these components. - -### Data Grid - -The data grid shows a list of objects in a grid. For example, a data grid can show all the orders a customer has placed. - -For more information, see [Data Grid (Document Template)](/refguide/data-grid-document-template/). - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/data-grid-document-template/918138.png" class="no-border" >}} - -A data grid showing a list of orders with a description and the referenced customer name. - -{{% /alert %}} - -### Data View - -The data view is used for showing the contents of exactly one object. If, for example, you want to show details of a single customer you would use a data view to do this. The data view typically contains a table with static labels and dynamic data widgets like a dynamic label. In more complex templates, a data view can contain data grids and other data views for related objects. - -For more information, see [Data View (Document Template)](/refguide/data-view-document-template/). - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/data-view-document-template/918139.png" class="no-border" >}} - -A data view showing order line information. - -{{% /alert %}} - -### Template Grid - -The template grid shows a list of objects in a tile view. For example, a template grid can show a list of products. The template grid has a lot in common with the data grid. The main difference is that the objects are shown in templates (somewhat like a small data view) instead of rows. - -For more information, see [Template Grid (Document Template)](/refguide/template-grid-document-template/). - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918137.png" class="no-border" >}} - -A template grid showing products with name and description. - -{{% /alert %}} - -## Layout Widgets {#layout} - -Layout widgets give structure to a page. They do not show data but provide a layout in which you can place other widgets that do. - -### Table - -Tables can be used to change the layout of the page. They contain a number of rows and columns and the intersection of the two is called a cell. Each cell can contain widgets. Cells can be merged horizontally and vertically before they are filled to allow for asymmetric layouts. -Tables can be used both inside and outside data view or templategrid widgets. - -For more information, see [Table (Document Template)](/refguide/table-document-template/). - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918134.png" class="no-border" >}} - -A table with four rows and three columns. Last row containing a data view with another table. - -{{% /alert %}} - -### Page Break - -When inserting a page break, the current page will be cut off after the break and widgets below the break will be displayed in a new page. - -For more information, see [Page Break (Document Template)](/refguide/page-break-document-template/). - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918135.png" class="no-border" >}} - -A page break - -{{% /alert %}} - -### Line Break - -When inserting a line break, a new line will be inserted at that position. - -For more information, see [Line Break (Document Template)](/refguide/line-break-document-template/). - -## Dynamic Data Widgets {#dynamic} - -Dynamic data widgets are used for showing (dynamic) data. They must be placed inside a data view or template grid because they show attributes or associations of an entity. - -### Dynamic Label - -A dynamic label is used for the same attribute types as a text box in the page editor. It can be used to display a text value. - -For more information, see [Dynamic Label (Document Template)](/refguide/dynamic-label-document-template/). - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918131.png" class="no-border" >}} - -A dynamic label linking to a customer name. - -{{% /alert %}} - -### Dynamic Image - -A dynamic image can be used to show a System.Image. If the image is not available (for example: the image was never saved) it will show the preset default image. It can be deployed inside a data view or templategrid. - -For more information, see [Dynamic Image (Document Template)](/refguide/dynamic-image-document-template/). - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918132.png" class="no-border" >}} - -A dynamic image inside a table cell, showing the preset default image. - -{{% /alert %}} - -## Static Data Widgets {#static} - -These widgets contain static (fixed) data to help create the look of the generated document. - -### Static Label - -A static label shows a line of static text. You can use it to place custom text inside a dataview or template grid or table. - -For more information, see [Static Label (Document Template)](/refguide/static-label-document-template/). - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918130.png" class="no-border" >}} - -A label with text 'Customer name'. - -{{% /alert %}} - -### Title - -A title works much like a static label but can be placed outside a data view, template grid or table. - -For more information, see [Title (Document Template)](/refguide/title-document-template/). - -### Static Image - -A static image shows a predefined image. It can be put either in- or outside a data view or templategrid. - -For more information, see [Static Image (Document Template)](/refguide/static-image-document-template/). - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918133.png" class="no-border" >}} - -A static image inside a table cell. - -{{% /alert %}} diff --git a/content/en/docs/refguide/modeling/resources/document-templates/creating-your-own-documents.md b/content/en/docs/refguide/modeling/resources/document-templates/creating-your-own-documents.md deleted file mode 100644 index 385ac43cdb8..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/creating-your-own-documents.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: "Creating Your Own Documents" -url: /refguide/creating-your-own-documents/ -description: "This documentation will give you insight into creating documents with Mendix." ---- - -## Introduction - -Have you been wondering how to create your own documents with Mendix? This reference will tell you how to do it! - -With Mendix, you can generate documents in different ways. Here, you will learn the fundamentals of generating a document from your own application. - -Before we start, Mendix recommends first reading these pages: - -* [Document Templates](/refguide/document-templates/) -* [Generate Documents](/refguide/generate-document/) - -## Knowing Your Document - -Before you start producing a document with Mendix, it is advisable to make a draft version of the document you want to produce. You can sketch something on a piece of paper or ask your customer to provide you with an example. Either way, it is good to have in mind what you want to achieve. - -Using your desired document, you can choose a strategy for producing it. Mendix offers numerous options for producing documents using the out-of-the-box document template functionality. - -Let’s have a look at how this works with an example. - -## Business Case - -In this application, customers can purchase products. They will do so by creating orders and selecting the products they want to purchase. To be able to present the customer with an overview of their order, a PDF will be created and sent to the customer as an attachment to their confirmation email. The order should show the customer details, the logo of the company, the products with their price, and the total value of the order. - -## Generating a Document with Out-of-the-Box Mendix Functionality - -### Domain Model - -The domain model for this application looks like this: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-02-28_16-37-25.png" class="no-border" >}} - -The **Customer** holds the address information and the preferred communication language. The **Order** owns the date and sum of all the order lines. The **OrderLine** entity has the customer-specific price for a **Product**. Because you want to generate a document, the **OrderDocument** entity has been added. This entity inherits from the **System.FileDocument** entity. - -{{% alert color="info" %}} -Do not use the **System.FileDocument** entity directly, because you have no control over the security of that part from the **System** module. -{{% /alert %}} - -### Microflow - -Now the domain model has been set up, you are ready to create the microflow for your new generate document function. - -Create a new folder to organize all the order document creation related sources: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-02-28_17-02-05.png" class="no-border" >}} - -Now you need a microflow to handle the creation of the document: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-02-28_17-04-03.png" class="no-border" >}} - -The microflow consists of just the default start and endpoint at present: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-02-28_16-30-18.png" class="no-border" >}} - -After creating the microflow, decide what information you would like to use in the document. Let’s start with an order as input. Later on, you can retrieve additional data via the order instance. - -{{% alert color="info" %}} -When you create microflows, it is a best practice to limit the number of input parameters to promote reuse. -{{% /alert %}} - -Here is the input parameter: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-02-28_16-32-33.png" class="no-border" >}} - -In the next step, you will create a new OrderDocument. This object will store the actual document. Set the reference to the **Order** object and the name of the document: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-02-28_16-52-43.png" class="no-border" >}} - -Now you need to have a **Language** object. In our case, the **Customer** is associated with the preferred communication language. In our microflow example, you first retrieve the **Customer** via the **Order**, and then retrieve the **Language** from that **Customer**: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-02-28_16-58-54.png" class="no-border" >}} - -The next step is to use the **Generate document** activity. Within this activity, you can use the available objects and select the document template to create the document. However, the document template does not exist yet, so you need to create it and place it in your folder: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-02-28_17-06-53.png" class="no-border" >}} - -This is the document template configuration: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-03-01_13-03-55.png" class="no-border" >}} - -{{% alert color="info" %}} -Based on the changes you make to the selected template, the arguments will change. -{{% /alert %}} - -The **Generate document** activity has been added: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-03-01_13-06-33.png" class="no-border" >}} - -After you have configured the general settings of the document template, you do not need a separate commit for **NewOrderDocument**. This entity is automatically committed via the document template activity. - -Now that you have set up the **Generate document** configuration, you can configure the template itself. - -{{% alert color="info" %}} -Make sure to set the correct entity access for entities and their attributes used in the document template. Read access is a must for those attributes that are shown in the template. Here is a **Customer** entity that is configured to **Read, Write** for the **User** module role: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-03-01_13-12-28.png" class="no-border" >}} - -{{% /alert %}} - -### Document Template - -In this example, the following document template is available: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-03-01_14-05-07.png" class="no-border" >}} - -In this document template, you start with a data view containing the order details. From this order, you can get the customer information and, from the order lines, the information about the purchased products. - -The data view makes use of tables, table cells, labels, pictures, line breaks, and a template grid to compose the document. - -Now that you have created the document template, you can see that there is an error in the error dock: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-03-01_14-08-48.png" class="no-border" >}} - -To resolve this error, open the **Generate document** activity of the microflow. When the activity is opened, the parameter mapping will be updated and allocated to the mapping parameter. - -Now, your **Generate document** configuration should look like this: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-03-01_14-12-03.png" class="no-border" >}} - -The document template is now configured, and the microflow is ready to be used. If we call this microflow as a sub-microflow, you can add a download activity in the main microflow. This microflow could do the following: - -* Call the sub-microflow to create the document -* Retrieve the created document -* Download the file - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/2018-03-01_14-21-38.png" class="no-border" >}} - -This is the resulting document: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/creating-your-own-documents/15_Result.png" class="no-border" >}} - -In this example, you retrieved the **OrderLine** information via the **Entity (path)** data source. An alternative way of doing this would be to use a microflow that returns objects for the list presentation. If you do this, make sure to add the correct user role (or roles) to the microflows that are being used as data source microflows within the document template. diff --git a/content/en/docs/refguide/modeling/resources/document-templates/data-grid-document-template/_index.md b/content/en/docs/refguide/modeling/resources/document-templates/data-grid-document-template/_index.md deleted file mode 100644 index 095463b039a..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/data-grid-document-template/_index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: "Data Grid (Document Template)" -url: /refguide/data-grid-document-template/ -aliases: - - /refguide/Data+Grid+(document+template).html - - /refguide/data-grid-(document-template).html - - /refguide/Data+Grid+(document+template) - - /refguide/data-grid-(document-template) -#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. ---- - -## Introduction - -The data grid shows a list of objects in a grid. For example, a data grid can show all the orders a customer has placed. - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/data-grid-document-template/918138.png" class="no-border" >}} - -A data grid showing a list of orders with a description and the referenced customer name. - -{{% /alert %}} - -## Components - -### Columns - -See [Columns (document template)](/refguide/columns-document-template/). - -## Appearance Properties - -### Column Weights - -The column weights are percentages separated by semi-colons that determine the widths of the columns. The weights have to add up to 100\. An alternative way of changing the widths of columns is by dragging the separating line between columns. - -{{% alert color="info" %}} -In the screenshot above the column weights are 50;25;25. -{{% /alert %}} - -### Cell Spacing - -Cell spacing specifies the space in between cells - -### Cell Padding - -Cell padding specifies the space between the content of the cell and the cell wall - -### Enable Striping - -With striping enabled you can set the properties of even and uneven data grid rows individually. This way you can create a striping effect by varying color for the 2 different row styles. - -### Style - -See [Style](/refguide/style/) - -## Common Properties - -### Name - -The internal name of the widget. You can use this to give sensible names to widgets. The name property also appears in the generated HTML: the widget DOM element automatically includes the class '`mx-name-{NAME}`', which can be useful for [Selenium testing](/howto/integration/selenium-support/). - -## Data Source Properties - -The data source properties determine which objects will be shown in the data grid. The list of objects in the data grid is constrained by the following mechanisms: - -1. For top-level data grids, the objects passed in the microflow calling the document export action are shown. -2. For nested data grids, if an entity path is used, only the objects reachable by following the path from the containing object are shown. -3. For nested data grids, if a microflow is used, the objects returned by the microflow are shown. - -### Entity (Path) - -The entity (path) property specifies which entity instances will be shown in the data grid. A top-level data grid is always connected to an entity. A nested data grid can either be connected to an entity or to an entity path starting in the entity of the containing data view. The entity path can follow associations irrespective of type and ownership. - -### Microflow - -When a nested data grid is connected to a template, a microflow is needed to retrieve the data. The input parameter of these microflows is always the object of the containing data view and the output is a list of objects of the type of the nested data grid. diff --git a/content/en/docs/refguide/modeling/resources/document-templates/data-grid-document-template/columns-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/data-grid-document-template/columns-document-template.md deleted file mode 100644 index 1d2e7144a00..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/data-grid-document-template/columns-document-template.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "Columns (Document Template)" -url: /refguide/columns-document-template/ -aliases: - - /refguide/columns-(document-template).html - - /refguide/Columns+(document+template).html - - /refguide/columns-(document-template) - - /refguide/Columns+(document+template) -#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. ---- - -## Appearance Properties - -### Caption - -The caption of a column is the text that appears as a header above the rows. This is a translatable text. See [Internationalization](/refguide/translatable-texts/). - -### Enumeration Format (Only for Attributes of the Enumeration Type) - -A column can show its contexts as text (default) or as image. - -| Value | Description | -| --- | --- | -| Text | Show the contents of the connected attribute as a text. | -| Image | Show the image of the enumeration value. | - -### Decimal Precision (Only for Decimal Attributes) - -The precision of a value is defined by the number of digits that is used to express that value. This property indicates the number of decimal places (the number of digits following the decimal point). - -Default: *2* - -### Group Digits (Only for Numeric Attributes) - -For ease of reading, numbers with many digits before the decimal separator may be divided into groups using a delimiter. This property defines whether the end-user will see these groups, or not. - -Default: *False* - -### Date Format (Only for Attributes of Type **Date and time**) - -The date format determines whether the date part, the time part or both are shown. How the date and time parts are formatted depends on the localization of the user using the application. - -These are the possible values: - -* **Date** *(default)* -* **Time** -* **Date and time** -* **Custom** (see below for more details) - -### Custom Date Format (Only for Attributes of Type **Date and time**) - -If you choose **Custom** as the date format (see above), this property determines how the attribute value is formatted. The custom date format is a string that allows for any combination of symbols found in the table below. Any punctuation will be rendered literally. - -{{% snippet file="/static/_includes/refguide/custom-date-format-tokens.md" %}} - -## Data Source Properties - -### Attribute (Path) - -The attribute (path) property specifies the attribute whose value will be displayed in the column. It can be an attribute of the grid entity, or it can be an attribute of an associated entity. The path over which an associated object is accessed is referred to as an attribute path. The path can follow multiple associations of type reference, and at the end (optionally) one of type reference set. If you show a reference set in a column the values will be separated by a comma. diff --git a/content/en/docs/refguide/modeling/resources/document-templates/data-view-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/data-view-document-template.md deleted file mode 100644 index 53a8a9ffe70..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/data-view-document-template.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "Data View (Document Template)" -url: /refguide/data-view-document-template/ -aliases: - - /refguide/Data+View+(document+template).html - - /refguide/data-view-(document-template).html - - /refguide/Data+View+(document+template) - - /refguide/data-view-(document-template) -#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. ---- - -## Introduction - -The data view is used for showing the contents of exactly one object. If, for example, you want to show details of a single orderline this is most easily achieved with a data view. The data view typically contains a table with static labels and dynamic data widgets like a dynamic label. In more complex templates, a data view can contain data grids and other data views for related objects. - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/data-view-document-template/918139.png" class="no-border" >}} - -A data view showing orderline information. - -{{% /alert %}} - -## Common Properties - -{{% snippet file="/static/_includes/refguide/name-property.md" %}} - -## Data Source Properties - -The data source properties determine which objects will be shown in the data grid. The list of objects in the data grid is constrained by the following mechanisms: - -1. For top-level data grids, the objects passed in the microflow calling the document export action are shown. -2. For nested data grids, if an entity path is used, only the objects reachable by following the path from the containing object are shown. -3. For nested data grids, if a microflow is used, the objects returned by the microflow are shown. - -### Entity (Path) - -The entity (path) property specifies of which entity an instance will be shown in the data view. A top-level data view is always connected to an entity. A nested data view can either be connected to an entity or to an entity path starting in the entity of the containing data view. The entity path can follow associations irrespective of type and ownership. - -### Microflow - -When a nested data view is connected to an entity, a microflow is needed to retrieve the data. The input parameter of these microflows is always the object of the containing data view and the output is an object with the entity type of the nested data view. diff --git a/content/en/docs/refguide/modeling/resources/document-templates/document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/document-template.md deleted file mode 100644 index dc713596408..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/document-template.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "Document Template" -url: /refguide/document-template/ ---- - -## Introduction - -This document describes the properties of a document template. If you want to see what document templates are for and what kind of widgets can be placed on them, you can check the [Document Templates](/refguide/document-templates/) overview documentation. - -## Appearance Properties {#appearance-properties} - -### Page Format - -The page format determines the size of the page you are targeting with the document template. Examples are A4 (portrait) and A5 (landscape). You can also choose a Custom page format and use the properties [Page width](#width) and [Page height](#height) below. - -### Page Width (Inch) {#width} - -The width of the page you are targeting with the document template. Automatically set by choosing a page format. If you change it, the page format will be set to 'Custom'. - -### Page Height (Inch) {#height} - -The height of the page you are targeting with the document template. Automatically set by choosing a page format. If you change it, the page format will be set to 'Custom'. - -### Pixels per Inch (PPI) - -The pixel density is used to calculate the size of images based on the pixel value. - -### Margin Left/Right/Top/Bottom (Inch) - -The margins specify the distance between the border of the paper and the contents on all sides. - -### Show Header/Footer on First Page - -Indicates whether the header and/or footer are also shown on the first page. - -{{% alert color="warning" %}} -You must use a page break widget to indicate you're no longer on the first page. This cannot be calculated while generating content. -{{% /alert %}} - -Default: *True.* - -### Enable Header - -Indicates whether the page has a header that is displayed on each page (except optionally the first). - -### Enable Footer - -Indicates whether the page has a footer that is displayed on each page (except optionally the first). - -## Style - -For details, see [Style](/refguide/style/). - -## Common Properties - -### Name - -The name of the document template. You can change the name via the App Explorer. - -### Documentation - -Documentation for the document template. - -## Design Properties - -### Canvas Width - -The canvas width determines the width of the canvas on which you are building the document template in Studio Pro. This property has no effect on the application whatsoever. diff --git a/content/en/docs/refguide/modeling/resources/document-templates/dynamic-image-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/dynamic-image-document-template.md deleted file mode 100644 index e7d6dad15f7..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/dynamic-image-document-template.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "Dynamic Image (Document Template)" -url: /refguide/dynamic-image-document-template/ -aliases: - - /refguide/Dynamic+Image+(document+template).html - - /refguide/dynamic-image-(document-template).html - - /refguide/Dynamic+Image+(document+template) - - /refguide/dynamic-image-(document-template) -#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. ---- - -## Introduction - -A dynamic image can be used to show a System.Image. If the image is not available (for example: the image was never saved) it will show the preset default image. It can be put inside a data view or templategrid. - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918132.png" class="no-border" >}} -A dynamic image inside a table cell, showing the preset default image. - -{{% /alert %}} - -## Appearance Properties - -### Default Image - -The default image is the image that will appear in the document when the dynamic image could not be found (when the entity that specializes the System.Image entity does not contain an actual image.) - -### Use Thumbnail - -Here you can select whether to use the thumbnail in the document or the full image. - -### Width - -The width defines the width of the image in the document. This is set in pixels and using the PPI in the document template this will be recalculated to actual printing size. Either width or height can be set; to prevent distortion of the image it is not possible to set both. - -### Height - -The height defines the height of the image in the document. This is set in pixels and using the PPI in the document template this will be recalculated to actual printing size. Either width or height can be set; to prevent distortion of the image it is not possible to set both. - -## Common Properties - -{{% snippet file="/static/_includes/refguide/name-property.md" %}} diff --git a/content/en/docs/refguide/modeling/resources/document-templates/dynamic-label-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/dynamic-label-document-template.md deleted file mode 100644 index 298c78af703..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/dynamic-label-document-template.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "Dynamic Label (Document Template)" -url: /refguide/dynamic-label-document-template/ -aliases: - - /refguide/Dynamic+label+(document+template).html - - /refguide/dynamic-label-(document-template).html - - /refguide/Dynamic+label+(document+template) - - /refguide/dynamic-label-(document-template) -#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. ---- - -## Introduction - -A dynamic label is used for the same kind of attributes as a text box from the page editor. It can be used to display a text value. - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918131.png" class="no-border" >}} - -A dynamic label linking to a customer name. - -{{% /alert %}} - -## Appearance Properties - -### Style - -For details, see [Style](/refguide/style/). - -### Render XHTML - -If you set the property 'Render XHTML' to true, the attribute connected to this label is assumed to contain XHTML and will be rendered as such. This is useful when you want to incorporate rich text in a document template. This property can only be true for attributes of type String. - -The contents *must* be valid XHTML and cannot contain HTML entities such as `\”`. Such HTML entities will cause rendering errors. HTML entities that are reserved to escape HTML characters are supported (for example `\<`, `\>`, `\'`, and `\&`). For other HTML entities, their unicode equivalents may be used instead (for example, instead of `\”` you can use `\”`). - -Default: *False* - -### Decimal Precision (Only for Decimal Attributes) - -The precision of a value is defined by the number of digits that is used to express that value. This property indicates the number of decimal places (the number of digits following the decimal point) that will be rendered in the widget. - -Default: *2* - -### Group Digits (Only for Numeric Attributes) - -For ease of reading, numbers with many digits in front of the decimal separator may be divided into groups using a delimiter. This property defines whether the end-user will see these groups, or not. - -Default: *False* - -### Date Format (Only for Attributes of Type **Date and time**) - -The date format determines whether the date part, the time part or both are shown. How the date and time parts are formatted depends on the localization of the user using the application. - -These are the possible values: - -* **Date** *(default)* -* **Time** -* **Date and time** -* **Custom** (see below for more details) - -### Custom Date Format (Only for Attributes of Type **Date and time**) - -If you choose **Custom** as the date format (see above), this property determines how the attribute value is formatted. The custom date format is a string that allows for any combination of symbols found in the table below. Any punctuation will be rendered literally. - -{{% snippet file="/static/_includes/refguide/custom-date-format-tokens.md" %}} - -## Common Properties - -{{% snippet file="/static/_includes/refguide/name-property.md" %}} - -## Data Source Properties - -### Attribute (Path) - -The attribute (path) property specifies which attribute will be shown in the dynamic label. diff --git a/content/en/docs/refguide/modeling/resources/document-templates/footer-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/footer-document-template.md deleted file mode 100644 index 8d5b07dbb54..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/footer-document-template.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Footer (Document Template)" -url: /refguide/footer-document-template/ -aliases: - - /refguide/footer-(document-template).html - - /refguide/Footer+(document+template).html - - /refguide/footer-(document-template) - - /refguide/Footer+(document+template) -#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. ---- - -## Introduction - -When enabled, the footer will be inserted at the bottom of every page. Other widgets can be put in the footer. - -For inserting page numbers, see [Static Label](/refguide/static-label-document-template/). - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/footer-document-template/918235.png" class="no-border" >}} - -A footer. - -{{% /alert %}} - -## Appearance - -### BottomMargin - -The amount of space between the bottom of the page and the footer in inches. diff --git a/content/en/docs/refguide/modeling/resources/document-templates/header-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/header-document-template.md deleted file mode 100644 index 62d2202e3a8..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/header-document-template.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Header (Document Template)" -url: /refguide/header-document-template/ -aliases: - - /refguide/header-(document-template).html - - /refguide/Header+(document+template).html - - /refguide/header-(document-template) - - /refguide/Header+(document+template) -#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. ---- - -## Introduction - -When enabled, the header will be inserted at the top of every page. Other widgets can be put in the header. - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/header-document-template/918236.png" class="no-border" >}} - -A header. - -{{% /alert %}} - -For details on enabling the header from the properties of the document template itself, see the [Appearance Properties](/refguide/document-template/#appearance-properties) section of *Document Template*. - -For details on inserting page numbers, see [Static Label](/refguide/static-label-document-template/). - -## Appearance - -### TopMargin - -The amount of space between the top of the page and the header in inches. diff --git a/content/en/docs/refguide/modeling/resources/document-templates/line-break-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/line-break-document-template.md deleted file mode 100644 index 4240c6d9994..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/line-break-document-template.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Line Break (Document Template)" -url: /refguide/line-break-document-template/ -aliases: - - /refguide/Line+Break+(document+template).html - - /refguide/line-break-(document-template).html - - /refguide/Line+Break+(document+template) - - /refguide/line-break-(document-template) -#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. ---- - -## Introduction - -A new line will be started at the insertion of a line break. - -## Common Properties - -{{% snippet file="/static/_includes/refguide/name-property.md" %}} diff --git a/content/en/docs/refguide/modeling/resources/document-templates/page-break-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/page-break-document-template.md deleted file mode 100644 index e13a436f6ba..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/page-break-document-template.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Page Break (Document Template)" -url: /refguide/page-break-document-template/ -aliases: - - /refguide/Page+Break+(document+template).html - - /refguide/page-break-(document-template).html - - /refguide/Page+Break+(document+template) - - /refguide/page-break-(document-template) -#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. ---- - -## Introduction - -When inserting a page break, the current page will be cut off after the break and widgets below the break will be inserted in a new page. - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918135.png" class="no-border" >}} - -A page break. - -{{% /alert %}} - -## Common Properties - -{{% snippet file="/static/_includes/refguide/name-property.md" %}} diff --git a/content/en/docs/refguide/modeling/resources/document-templates/static-image-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/static-image-document-template.md deleted file mode 100644 index b692cb6ce44..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/static-image-document-template.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "Static Image (Document Template)" -url: /refguide/static-image-document-template/ -aliases: - - /refguide/Static+Image+(document+template).html - - /refguide/static-image-(document-template).html - - /refguide/Static+Image+(document+template) - - /refguide/static-image-(document-template) -#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. ---- - -## Introduction - -A static image shows a predefined image. It can be put either inside or outside a data view or template grid. - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918133.png" class="no-border" >}} - -A static image inside a table cell. - -{{% /alert %}} - -## Appearance Properties - -### Image - -This property defines the image that will appear in the document. - -### Width - -The width defines the width of the image in the document. This is set in pixels and using the PPI in the document template this will be recalculated to actual printing size. Either width or height can be set; to prevent distortion of the image it is not possible to set both. - -### Height - -The height defines the height of the image in the document. This is set in pixels and using the PPI in the document template this will be recalculated to actual printing size. Either width or height can be set; to prevent distortion of the image it is not possible to set both. - -## Common Properties - -{{% snippet file="/static/_includes/refguide/name-property.md" %}} diff --git a/content/en/docs/refguide/modeling/resources/document-templates/static-label-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/static-label-document-template.md deleted file mode 100644 index 7c9f5953f3d..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/static-label-document-template.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "Static Label (Document Template)" -url: /refguide/static-label-document-template/ -aliases: - - /refguide/Static+label+(document+template).html - - /refguide/static-label-(document-template).html - - /refguide/Static+label+(document+template) - - /refguide/static-label-(document-template) -#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. ---- - -## Introduction - -A static label shows a line of static text. You can use it to place custom text inside a data view, template grid or table. - -For example, a label with text 'Customer name' will be look like this: - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918130.png" class="no-border" >}} - -If you want to insert the current page number or the total page count in your document, you can use a token inside a static label (and only in a static label). - -For example, static label content `Page [%pageNumber%] of [%totalPageCount%]` will print **Page 2 of 4**. - -## Common Properties - -{{% snippet file="/static/_includes/refguide/name-property.md" %}} - -## Appearance Properties - -### Caption - -This is the value that will be displayed in the document. - -### Style - -For details, see [Style](/refguide/style/). diff --git a/content/en/docs/refguide/modeling/resources/document-templates/style.md b/content/en/docs/refguide/modeling/resources/document-templates/style.md deleted file mode 100644 index 4eb4dbb6956..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/style.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: "Style" -url: /refguide/style/ ---- - -## Introduction - -In most document template widgets and components as well as on the top level document, a style can be defined. This style is designed in Cascading Style Sheets (CSS). However, many of the more common style attributes can be adjusted using the Style Editor. Depending on what type of widget you are styling, you will see different options in the Style Editor. You can also fully customize the style in the tab 'Custom Styles'. - -## Tab Pages - -### Font - -Widgets/Components for which the font tab page is visible: - -* Document template -* Data grid -* Data grid cell -* Dynamic label -* Title -* Static label -* Table - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/style/2018-03-01_14-27-27.png" class="no-border" >}} - -The font tab page in the style editor. - -{{% /alert %}} - -If you'd like to show text in a language with uncommon characters such as Arabic or Thai, make sure you select a font in the style editor that supports these characters. - -### Cell Styling - -Widgets/Components for which the cell styling tab page is visible: - -* Data grid -* Data grid cell -* Title -* Table -* Table cell - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/style/2018-03-01_14-29-13.png" class="no-border" >}} - -The cell styling tab page in the style editor. - -{{% /alert %}} - -### Custom Styles - -The custom styles tab page is always visible for widgets/components that allow styling. - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/style/2018-03-01_14-33-46.png" class="no-border" >}} - -The custom styles tab page in the style editor. - -{{% /alert %}} - -## Custom Fonts for PDF Documents {#custom-fonts} - -You can include custom fonts in your generated documents by simply using a custom style, for example you'd include *font-family: Verdana;* in your style to make the text appear in Verdana font. However, for generating PDF documents, this requires some extra work. The following section teaches you how to do this. - -The PDF generator can be set up to include a custom font by editing a config file for the library responsible for generating the PDF file. You can find this file in your Mendix installation folder in the subfolder /runtime/lib. The file is called fop.xconf. -To make it easier for you to update your Mendix version or to deploy your application it is highly recommended that you do not edit this file directly but instead copy it into your app resources folder. When this file is present in your resources folder, the runtime will automatically access it instead of the default file. - -When you have the fop.xconf file and all the fonts in your resources folder, you can add the font you want to use to the folder. Next, open the fop.xconf file in a text editor. The config file is in XML format. - -To add your own, use the following setup: - -```java - - - - -``` - -The embed-url is where the library can find the font file. The font-triplet-name is the name you would use in your custom css style. - -If you want to use italic or bold versions of the font, you need to specify this as well. For example: - -```java - - - - - - - - - - - -``` - -In the end your setup should look like this: - -* The *fop.xconf* file, your custom font, and the 6 default fonts should be in your app resources folder -* The *fop.xconf* file should include a reference to your custom font - -{{% alert color="warning" %}} -Please note that characters with variant selectors are not supported by our PDF generation library. -{{% /alert %}} diff --git a/content/en/docs/refguide/modeling/resources/document-templates/table-document-template/_index.md b/content/en/docs/refguide/modeling/resources/document-templates/table-document-template/_index.md deleted file mode 100644 index 9f25dc8b503..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/table-document-template/_index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "Table (Document Template)" -url: /refguide/table-document-template/ -aliases: - - /refguide/table-(document-template).html - - /refguide/Table+(document+template.html - - /refguide/table-(document-template) - - /refguide/Table+(document+template -#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. ---- - -## Introduction - -Tables can be used to change the layout of the form. They contain a number of rows and columns and the intersection of the two is called a cell. Each cell can contain widgets. Cells can be merged horizontally and vertically to allow for asymmetric layouts. - -Tables can be used both inside and outside the data view or templategrid widgets. - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918134.png" class="no-border" >}} - -This table has four rows and three columns. The last row contains a data view with another table. - -{{% /alert %}} - -## Components - -### Column - -A column in a table. - -### Row - -A row in a table. See [Row (document template)](/refguide/row-document-template/). - -## Appearance Properties - -### Weights - -The column weights are percentages separated by semi-colons that determine the widths of the columns. The weights have to add up to 100\. An alternative way of changing the widths of columns is by dragging the separating line between columns. - -{{% alert color="info" %}} - -In the screenshot above, the column weights of the enclosing table are `25;25;50`. - -{{% /alert %}} - -### Cell Spacing - -Cell spacing specifies the space in between cells. - -### Cell Padding - -Cell padding specifies the space between the content of the cell and the cell wall. - -### Style - -For details, see [Style](/refguide/style/). - -## Common Properties - -{{% snippet file="/static/_includes/refguide/name-property.md" %}} diff --git a/content/en/docs/refguide/modeling/resources/document-templates/table-document-template/row-document-template/_index.md b/content/en/docs/refguide/modeling/resources/document-templates/table-document-template/row-document-template/_index.md deleted file mode 100644 index 70c352785f8..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/table-document-template/row-document-template/_index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Row (Document Template)" -url: /refguide/row-document-template/ -aliases: - - /refguide/row-(document-template).html - - /refguide/Row+(document+template).html - - /refguide/row-(document-template) - - /refguide/Row+(document+template) -#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. ---- - -## Introduction - -Rows are part of a table. They contain cells which in turn can contain other widgets. - -## Components - -### Cell - -A cell of a row. For more information, see [Cell (Document Template)](/refguide/cell-document-template/). - -## Appearance Properties - -### Condition for Visible - -The condition for visible, as the name suggests, this property allows you to set a condition on which the row is visible to the end-user. These conditions can be enumeration or Boolean attributes of the entity of the data view. diff --git a/content/en/docs/refguide/modeling/resources/document-templates/table-document-template/row-document-template/cell-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/table-document-template/row-document-template/cell-document-template.md deleted file mode 100644 index 749b8ce6fa9..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/table-document-template/row-document-template/cell-document-template.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Cell (Document Template)" -url: /refguide/cell-document-template/ -aliases: - - /refguide/cell-(document-template).html - - /refguide/Cell+(document+template).html - - /refguide/cell-(document-template) - - /refguide/Cell+(document+template) -#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. ---- - -## Introduction - -Cells are part of a table. They can contain other widgets. - -## Appearance Properties - -### Style - -For details, see [Style](/refguide/style/). diff --git a/content/en/docs/refguide/modeling/resources/document-templates/template-grid-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/template-grid-document-template.md deleted file mode 100644 index bebf97b365b..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/template-grid-document-template.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "Template Grid (Document Template)" -url: /refguide/template-grid-document-template/ -aliases: - - /refguide/Template+Grid+(document+template).html - - /refguide/template-grid-(document-template).html - - /refguide/Template+Grid+(document+template) - - /refguide/template-grid-(document-template) -#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. ---- - -## Introduction - -The template grid shows a list of objects in a tile view. For example, a template grid can show a list of products. The template grid has a lot in common with the data grid. The main difference is that the objects are shown in templates (a sort of small data view) instead of rows. - -{{% alert color="info" %}} - -{{< figure src="/attachments/refguide/modeling/resources/document-templates/918137.png" class="no-border" >}} - -A template grid showing products with name, description, and image. - -{{% /alert %}} - -## Appearance Properties - -### Enable Striping - -With striping enabled you can set the contents of even and uneven template grid rows individually. This way you can create a striping effect by varying color for the 2 different row styles. - -### Number of Columns - -This defines the amount of columns the template grid will contain. - -## Common Properties - -{{% snippet file="/static/_includes/refguide/name-property.md" %}} - -## Data Source Properties - -The data source properties determine which objects will be shown in the template grid. The list of objects in the template grid is constrained by the following mechanisms: - -1. For top-level template grids, the objects passed in the microflow calling the document export action are shown. -2. For nested template grids, if an entity path is used, only the objects reachable by following the path from the containing object are shown. -3. For nested template grids, if a microflow is used, the objects returned by the microflow are shown. - -### Entity (Path) - -The entity (path) property specifies from which entity instances will be shown in the template grid. A top-level template grid is always connected to an entity. A nested template grid can either be connected to an entity or to an entity path starting in the entity of the containing data view. The entity path can follow associations irrespective of type and ownership. - -### Microflow - -When a nested template grid is connected to an entity, a microflow is needed to retrieve the data. The input parameter of these microflows is always the object of the containing data view and the output is a list of objects with the type of the nested template grid. diff --git a/content/en/docs/refguide/modeling/resources/document-templates/title-document-template.md b/content/en/docs/refguide/modeling/resources/document-templates/title-document-template.md deleted file mode 100644 index e87f2494932..00000000000 --- a/content/en/docs/refguide/modeling/resources/document-templates/title-document-template.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Title (Document Template)" -url: /refguide/title-document-template/ -aliases: - - /refguide/title-(document-template).html - - /refguide/Title+(document+template).html - - /refguide/title-(document-template) - - /refguide/Title+(document+template) -#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. ---- - -## Introduction - -A title works much like a static label but can be placed outside a data view, templategrid or table. - -## Appearance Properties - -### Caption - -This is the value you wish to display in the document. - -### Style - -For details, see [Style](/refguide/style/). - -## Common Properties - -{{% snippet file="/static/_includes/refguide/name-property.md" %}}