Skip to content

Commit af776d8

Browse files
authored
Merge pull request #9984 from mendix/qt-review
Review Resources docs
2 parents 80be3e9 + 01f54fc commit af776d8

13 files changed

Lines changed: 114 additions & 115 deletions

File tree

content/en/docs/refguide/modeling/resources/_index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To add a resource document, do the following:
1818

1919
1. In the [App Explorer](/refguide/app-explorer/), right-click the module or a folder you want to add a resource to and select **Add other**:
2020

21-
{{< figure src="/attachments/refguide/modeling/resources/app-explorer-resources.png" class="no-border" >}}
21+
{{< figure src="/attachments/refguide/modeling/resources/add-resources.png" class="no-border" >}}
2222

2323
2. In the **Resources** category, select the document you would like to add to your app.
2424

@@ -28,18 +28,19 @@ The **Resources** category contain various document types that can be used in di
2828

2929
| Element | Is used in | Description |
3030
| ------------------ | -------------------------------------- | ------------------------------------------------------------ |
31+
| [Dataset](/refguide/data-sets/) | Pages | Datasets define the data shown in reports widgets. |
3132
| [Java action](/refguide/java-actions/) | Microflows | Java actions can extend the functionality of your application. They can be called from microflows. |
3233
| [JavaScript action](/refguide/javascript-actions/) | Nanoflow | JavaScript actions can extend the functionality of your application. They can be called from nanoflows. |
34+
| [Task queue](/refguide/task-queue/) | Microflows and Java actions | A Task queue allows you to run microflows or Java actions asynchronously while controlling the number of tasks that are active. |
3335
| [Rule](/refguide/rules/) | Microflows | Rules contain the application logic that should result in an enumeration or a Boolean. They are used in decisions in microflows. |
3436
| [Enumeration](/refguide/enumerations/) | Domain model | Enumerations are used to define attributes of an enumeration type. |
35-
| [Dataset](/refguide/data-sets/) | Pages | Datasets define the data shown in reports widgets. |
3637
| [Constant](/refguide/constants/) | Microflow expressions and Consumed web services | Constants are used to define configuration values. |
3738
| [Regular expression](/refguide/regular-expressions/) | Domain model | Regular expressions are used in validation rules to define criteria that a string should match to pass the validation. They cannot be used in other places which require regular expressions (for example, the *isMatch()* function). |
3839
| [Scheduled event](/refguide/scheduled-events/) | Microflows | Scheduled events let the runtime execute a microflow at a specific moment in time. |
39-
| [Document template](/refguide/document-templates/) | Microflows | Document template is used to format the document in a client and to download or print it. |
40+
| [Document template](/refguide/document-templates/)(deprecated) | Microflows | Document template is used to format the document in a client and to download or print it. |
4041

4142
## Read More
4243

4344
* [Microflows](/refguide/microflows/)
44-
* [Domain Model]
45+
* [Data in the Domain Model](/refguide/domain-model/)
4546
* [Pages](/refguide/pages/)

content/en/docs/refguide/modeling/resources/constants.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
title: "Constants"
33
url: /refguide/constants/
4-
weight: 60
4+
weight: 70
55
#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.
66
---
77

88
## Introduction
99

1010
Constants are used to define configuration values. These can differ per environment.
1111

12-
When running the application on a licensed Mendix Cloud environment, SAP BTP, or Mendix on Kubernetes you can configure the constant values for each environment separately using the [Model Options](/developerportal/deploy/environments-details/#model-options) tab of the **Environment Details** page to set your constants.
12+
When running the application on a licensed Mendix Cloud environment, SAP BTP, or Mendix on Kubernetes, you can configure the constant values for each environment separately using the [Model Options](/developerportal/deploy/environments-details/#model-options) tab of the **Environment Details** page to set your constants.
1313

14-
For other cloud environments for example, Siemens [Insights Hub](/partners/siemens/mindsphere/)the constants can be accessed as **Environment Variables** in, for instance, Cloud Foundry. The constant is exposed with the name **module** + **.** + **constant** (for example, `mymodule.myconstant`).
14+
For other cloud environments (for example, Siemens [Insights Hub](/partners/siemens/mindsphere/)), the constants can be accessed as **Environment Variables** in, for instance, Cloud Foundry. The constant is exposed with the name *module* + *.* + *constant* (for example, `mymodule.myconstant`).
1515

1616
When running the application locally or in a Free App environment, the values defined in Studio Pro are used.
1717

@@ -47,7 +47,7 @@ This property is only available for add-on and solution modules. For more inform
4747

4848
### Documentation
4949

50-
This field is for documentation purposes only: end-users will never see it, and it does not influence the behavior of your application
50+
This field is for documentation purposes only. End-users will never see it, and it does not influence the behavior of your application.
5151

5252
## Type Properties
5353

@@ -71,7 +71,7 @@ This property defines whether the constant is accessible from client-side expres
7171
| No *(default)* | The constant will not be sent to the client and will be only accessible from [microflow](/refguide/microflows/) expressions |
7272

7373
{{% alert color="warning" %}}
74-
When a constant is exposed to the client, Mendix Runtime sends its value to the client so that in addition to microflow expressions, it will also be accessible from nanoflows and page expressions. This means that you should not use sensitive data or secrets such as passwords when a constant is exposed to the client.
74+
When a constant is exposed to the client, the Mendix Runtime sends its value to the client so that in addition to microflow expressions, it will also be accessible from nanoflows and page expressions. This means you should not use sensitive data or secrets such as passwords when a constant is exposed to the client.
7575

7676
For a web app, changes to a constant's values are reflected when the end-user refreshes the browser or restarts the app. For an offline-first PWA or native application, the app stores the constants' values for offline use. The app updates the constant's values in the following cases:
7777

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: "Document Templates"
2+
title: "Document Templates (Deprecated)"
33
url: /refguide/document-templates/
4-
weight: 90
4+
weight: 100
55
aliases:
66
- /refguide/Document+Templates.html
77
- /refguide/Document+Templates
@@ -55,4 +55,4 @@ Generating Microsoft Word documents is no longer supported by Mendix. However, t
5555

5656
### Other Formats
5757

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.
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 recommend exploring whether supported formats like PDF or HTML can meet your current needs.

content/en/docs/refguide/modeling/resources/enumerations.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Enumerations"
33
url: /refguide/enumerations/
4-
weight: 40
4+
weight: 60
55
aliases:
66
- /refguide/enumeration-values.html
77
- /refguide/enumeration-values
@@ -13,49 +13,47 @@ aliases:
1313

1414
An enumeration defines a list of predefined values. Enumerations are used for the enumeration attribute type. For example, the status of an order can be *Open*, *Closed*, or *In Progress*. So, the enumeration for the order status will consist of three values: *Open*, *Closed*, and *In_Progress*.
1515

16-
An enumeration consists of one or more [enumeration values](/refguide/enumerations/#enum-properties). Each value represents one option. An attribute of the enumeration type can also represent an uninitialized state: for example, if you do not assign any status to an order, the order status will be *empty*.
16+
An enumeration consists of one or more [enumeration values](/refguide/enumerations/#enum-properties). Each value represents one option. An attribute of the enumeration type can also represent an uninitialized state. For example, if you do not assign any status to an order, the order status will be *empty*.
1717

1818
## Enumeration Properties {#enum-properties}
1919

2020
An enumeration has the following properties:
2121

22-
* **Name**The name of the enumeration.
23-
* **Documentation** - This can be used to explain to other developers about the enumeration. End-users cannot see this documentation.
24-
* **Export level**Allows you to define access level to this document on the consumer (customer) side when developing an add-on module or a solution.
22+
* **Name**the name of the enumeration
23+
* **Documentation** - can be used to share information about the enumeration to other developers; end-users cannot see this documentation
24+
* **Export level**allows you to define access level to this document on the consumer (customer) side when developing an add-on module or a solution
2525

2626
{{% alert color="info" %}}This property is only available for add-on and solution modules. For more information on types of modules, see the [Module Types](/refguide/modules/#module-types) section in *Modules*.{{% /alert %}}
2727

2828
**Export level** has the following values:
2929

30-
* **Hidden** *(default)*The document/element content is hidden from a consumer.
31-
* **Usable**Consumers can use the enumeration in their apps.
30+
* **Hidden** *(default)*the document/element content is hidden from a consumer
31+
* **Usable**consumers can use the enumeration in their apps
3232

3333
* **Enumeration values** – An enumeration has one or more enumeration values. Each value represents one of the options. For more information on enumeration values and their properties, see the [Enumeration Value Properties](#enum-value-properties) section.
3434

3535
The following properties are only available when the enumeration is an external enumeration that is part of a [consumed Odata service](/refguide/consumed-odata-service/):
3636

37-
* **From service** - This property shows the source of the enumeration and allows you to **Detach** the enumeration from the source if the source has been deleted.
38-
* **Original name** - The original name of the enumeration from the source.
37+
* **From service** - shows the source of the enumeration and allows you to detach the enumeration from the source if the source has been deleted
38+
* **Original name** - the original name of the enumeration from the source
3939

4040
### Enumeration Value Properties {#enum-value-properties}
4141

42-
Enumeration value properties are described below:
43-
4442
#### Caption
4543

46-
This is the caption of an enumeration value is the text that the end-user sees for this enumeration value.
44+
The caption of an enumeration value is the text the end-user sees for this enumeration value.
4745

4846
The caption can be changed and can contain any character. For example, *In Progress* is a valid caption even though it contains a space.
4947

5048
This is a translatable text. For more information, see [Language Menu](/refguide/translatable-texts/).
5149

5250
#### Name {#name}
5351

54-
This is the name of an enumeration value. It is a technical name of the value which is used to refer to the enumeration value in your app.
52+
This is the name of an enumeration value. It is a technical name of the value that is used to refer to the enumeration value in your app.
5553

5654
The name of an enumeration value must be a technical name, starting with a letter and only containing letters, digits, and underscores.
5755

58-
<details><summary>It cannot be a reserved word (click to see a list of reserved words)</summary>
56+
<details><summary>The name cannot be a reserved word (click to see a list of reserved words)</summary>
5957

6058
* `_`
6159
* `abstract`
@@ -137,26 +135,26 @@ The name of an enumeration value is also used for storing the enumeration value
137135

138136
This is an image selected for an enumeration value to be displayed in a data grid column.
139137

140-
To use the image in a data grid, set the enumeration format of the column to *Image*. For more information on data grid columns, see [Grid Columns](/refguide/columns/).
138+
To use the image in a data grid, set the enumeration format of the column to **Image**. For more information on data grid columns, see [Grid Columns](/refguide/columns/).
141139

142140
## Creating an Enumeration
143141

144142
To create a new enumeration, do the following:
145143

146-
1. In the [App Explorer](/refguide/app-explorer/), right-click the module or a folder you want to add enumeration to and in the list of actions, select **Add other** > **Enumeration**.
147-
2. In the **Add Enumeration** dialog box, fill out the name of the enumeration.
144+
1. In the [App Explorer](/refguide/app-explorer/), right-click the module or a folder you want to add enumeration to and select **Add other** > **Enumeration**.
145+
2. In the **Add Enumeration** dialog box, add the name of the enumeration.
148146
3. In the **Enumeration** dialog box, click **New** to create enumeration values:
149147

150-
1. Fill out **Name** and **Caption** for an enumeration value. You can set **Image** for it if necessary. For more information on enumeration properties, see the [Enumeration Properties](#enum-properties) section. <br />
148+
1. Add **Name** and **Caption** for the enumeration value. You can set **Image** for it, if necessary.
151149

152150
{{< figure src="/attachments/refguide/modeling/resources/enumerations/add-enum-value.png" class="no-border" >}}
153151

154-
1. Click **OK** to save the enumeration value.
152+
2. Click **OK** to save the enumeration value.
155153

156154
4. Repeat step 3 for every enumeration value that you want to create.
157155
5. Click **OK** to save the enumeration.
158156

159-
You have added a new enumeration to your app. You can use the same enumeration for different attributes of the enumeration type in your app.
157+
You can use the same enumeration for different attributes of the enumeration type in your app.
160158

161159
## Read More
162160

content/en/docs/refguide/modeling/resources/java-actions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: "Java Actions"
33
url: /refguide/java-actions/
4-
weight: 10
4+
weight: 20
55
description: "Describes using Java Actions to extend the functionality of your Mendix app."
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

99
## Introduction
1010

11-
With Java actions you can extend the functionality of your application in situations where it would be hard to implement this functionality in microflows. You can call a Java action from a microflow using the [Call Java action](/refguide/call-java-action/).
11+
With Java actions you can extend the functionality of your application in situations where it would be hard to implement this functionality in microflows. You can call a Java action from a microflow using the [Call Java action](/refguide/call-java-action/) activity.
1212

1313
{{% alert color="info" %}}
1414
Each Java action defined in Studio Pro corresponds to a file *{name of Java action}.java* in the subdirectory *javasource/{module name}/actions* of the app directory.

content/en/docs/refguide/modeling/resources/javascript-actions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "JavaScript Actions"
33
url: /refguide/javascript-actions/
4-
weight: 20
4+
weight: 30
55
description: "This reference guide details the ways JavaScript Actions can extend the functionality of your Mendix app."
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
---
@@ -26,7 +26,7 @@ To learn how to create, configure, and use a JavaScript action, see these [Build
2626

2727
## General Settings
2828

29-
After double-clicking a JavaScript action in your **App Explorer** you will see the JavaScript action's settings:
29+
Double-click the JavaScript action in your **App Explorer** to open the action's settings:
3030

3131
{{< figure src="/attachments/refguide/modeling/resources/javascript-actions/javascript-action-settings-no-para.png" alt="javascript settings" width="600" class="no-border" >}}
3232

content/en/docs/refguide/modeling/resources/regular-expressions.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Regular Expressions"
33
url: /refguide/regular-expressions/
4-
weight: 70
4+
weight: 80
55
#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.
66
---
77

@@ -33,9 +33,9 @@ Here are two post code examples: **3072AP** and **7500 AH**.
3333
These are the criteria:
3434

3535
* The first character is a digit in the range 1 to 9
36-
* The second, third and fourth characters are digits in the range 0 to 9
36+
* The second, third, and fourth characters are digits in the range 0 to 9
3737
* The last two characters are letters, as expressed by the last two subexpression [A-Za-z], which indicate that the last two characters should be in the range A-Z or the range a-z
38-
* Between the digits and the letters there can be a space, as expressed by the subexpression which consists of a space and a question mark; the question mark indicates that the space is optional
38+
* There can be a space between the digits and the letters, as expressed by the subexpression which consists of a space and a question mark; the question mark indicates that the space is optional
3939
{{% /alert %}}
4040

4141
The following sections give a summary of regular expressions that can be used in Mendix. This description also applies to regular expression strings used in functions such as *isMatch()*.
@@ -52,7 +52,7 @@ A regular expression can contain the following types of subexpressions:
5252

5353
{{% alert color="info" %}}These forms can be mixed: `[abcx-z]` matches "*a*", "*b*", "*c*", "*x*", "*y*", or "*z*", and is equivalent to `[a-cx-z]`. The `-` character is treated as a literal character if it is the last or the first character within the brackets, or if it is escaped with a backslash.{{% /alert %}}
5454

55-
* `[^ ]` – matches a single character that is NOT contained within the brackets, for example:
55+
* `[^ ]` – matches a single character that is not contained within the brackets, for example:
5656
* `[^abc]` matches any character other than "a", "b", or "c"
5757
* `[^a-z]` matches any single character that is not a lowercase letter from "a" to "z"
5858

@@ -68,10 +68,10 @@ A regular expression can contain the following types of subexpressions:
6868
* A literal character – this is a character that does not have a special meaning in the regular expression language and it matches itself; this is effectively any character except `\[](){}^-$?*+|.`, for example:
6969
* The *`space`* in the Dutch post code example is a literal character that just matches itself
7070

71-
{{% alert color="info" %}}If you need to match one of the characters which is not a literal, prefix it with a backslash.{{% /alert %}}
71+
{{% alert color="info" %}}If you need to match one of the characters that is not a literal, prefix it with a backslash.{{% /alert %}}
7272

7373
* `\w` – a word: a letter, digit, or underscore; `\w` is an abbreviation for `[A-Za-z0-9_]`
74-
* `\d` – a digit" an abbreviation for `[0-9]`
74+
* `\d` – a digit; an abbreviation for `[0-9]`
7575

7676
### Quantifiers
7777

@@ -81,10 +81,10 @@ The following quantifiers can be used:
8181

8282
| Quantifier | Description |
8383
| --- | --- |
84-
| ? | The preceding sub-expression should occur not or once. |
85-
| * | The preceding sub-expression occurs any number of times. |
86-
| + | The preceding sub-expression should occur once or more. |
87-
| | No quantifier means that the preceding sub-expression should occur exactly once. |
84+
| ? | The preceding subexpression should occur not or once. |
85+
| * | The preceding subexpression occurs any number of times. |
86+
| + | The preceding subexpression should occur once or more. |
87+
| | No quantifier means that the preceding subexpression should occur exactly once. |
8888

8989
## Read More
9090

0 commit comments

Comments
 (0)