Skip to content

Commit 3f6ff4f

Browse files
authored
Merge pull request #9290 from mendix/lint-docs
[Auto] Lint docs
2 parents 5d1bb8d + 4ce38ae commit 3f6ff4f

File tree

23 files changed

+45
-39
lines changed

23 files changed

+45
-39
lines changed

content/en/docs/apidocs-mxsdk/apidocs/frontend/pluggable-widgets/pluggable-widgets-property-types.md

+1
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,7 @@ When a `dataSource` attribute is specified and configured by the user, it is pas
492492
`<actionVariables>` — Defines variables a widget provides when calling [execute() on an ActionValue](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#execute). The variables are made available in Studio Pro when configuring [Call a Microflow](/refguide/on-click-event/#call-microflow) and [Call a Nanoflow](/refguide/on-click-event/#call-nanoflow) actions.
493493

494494
`<actionVariable>` (required one or more) — Represents a primitive value provided by the widget as an argument when calling `ActionValue.execute()`. The variable is defined by the following attributes:
495+
495496
* `key` (required) — The identifier of the variable used in Studio Pro and the Pluggable Widgets API.
496497
* `type` (required) — The type of the value that the variable represents. Supported types and their corresponding Typescript type are listed in the table below.
497498
* `caption` (required) — A short description of the variable that is displayed in Studio Pro.

content/en/docs/appstore/use-content/platform-supported-content/modules/aws/aws-iot-sitewise.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,4 +103,4 @@ The AWS IoT SiteWise connector contains the following activities:
103103
* `BatchGetAssetPropertyValue` - Get the current value for one or more asset properties.
104104
* `BatchGetAssetPropertyValueHistory` - Get the historical values for one or more asset properties.
105105
* `BatchPutAssetPropertyValue` - Put values for one or more asset properties. It requires a valid `ENUM_Region` parameter and a `BatchPutAssetPropertyValueRequest` object and returns a `BatchPutAssetPropertyValueResponse` object.
106-
* `JA_FindNearestSecond` - The `GetAssetPropertyValueHistory`, `GetAssetPropertyAggregates` and `BatchGetAssetPropertyValueHistory` Amazon Iot SiteWise activities have two attributes call `StartDate` and `EndDate` that can be given to describe the range from which to query historical data. The date and time variable given to these two attributes must be expressed in seconds (millisecond must be 000). For our users to be able to find the nearest second to their chosen time if need be, we have created the `JA_FindNearestSecond` Java action with three different enum variables for the `FindType` parameter.
106+
* `JA_FindNearestSecond` - The `GetAssetPropertyValueHistory`, `GetAssetPropertyAggregates` and `BatchGetAssetPropertyValueHistory` Amazon Iot SiteWise activities have two attributes call `StartDate` and `EndDate` that can be given to describe the range from which to query historical data. The date and time variable given to these two attributes must be expressed in seconds (millisecond must be 000). For our users to be able to find the nearest second to their chosen time if need be, we have created the `JA_FindNearestSecond` Java action with three different enum variables for the `FindType` parameter.

content/en/docs/appstore/use-content/platform-supported-content/modules/database-connector-mx10.md

+1
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,7 @@ To override this setting add below parameter to JDBC URL
307307
```sql
308308
EnableArrow=0
309309
```
310+
310311
For more information, see:
311312

312313
* [Java 21 Support with Databricks](https://community.databricks.com/t5/data-engineering/java-21-support-with-databricks-jdbc-driver/td-p/49297) in Databricks documentation

content/en/docs/appstore/use-content/platform-supported-content/modules/databricks-edc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,4 +124,4 @@ After you have created a table with some entries, you can now be query from your
124124

125125
## Read More
126126

127-
* [External Database Connector: Resolving Apache Arrow dependency issue in Databricks](/appstore/modules/external-database-connector/#apache-arrow-databricks)
127+
* [External Database Connector: Resolving Apache Arrow dependency issue in Databricks](/appstore/modules/external-database-connector/#apache-arrow-databricks)

content/en/docs/howto/front-end/atlas-ui/customize-styling-new.md

+2
Original file line numberDiff line numberDiff line change
@@ -577,9 +577,11 @@ Mendix is able to add the `?638184496048312490` query parameter because of the u
577577
578578
{{% alert color="info" %}}
579579
When the [Mendix React Client](/refguide/mendix-client/react/) is enabled, the line in */deployment/web/index.html* is as follows:
580+
580581
```
581582
<script src="dist/index.js?{{cachebust}}" type="module"></script>
582583
```
584+
583585
{{% /alert %}}
584586
585587
To ensure cache busting keeps working, whenever you need to customize *index.html* or *login.html*, make sure these files are copied according to the recommendations in [Customizing index.html](#custom-web). Whenever cache busting breaks, it is likely that the query parameters have become hard coded (for example `?638184496048312490`) instead of dynamic (for example `?{{cachebust}}`) due to copying */deployment/web/index.html* instead of the correct filename */deployment/web/index-example.html*.

content/en/docs/refguide/installation/install.md

+1
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ The prerequisites are the following:
7171
| [2.37.1](https://github.com/git-for-windows/git/releases/tag/v2.37.1.windows.1) | [2.41.0](https://github.com/git-for-windows/git/releases/tag/v2.41.0.windows.3) | [2.43.0](https://github.com/git-for-windows/git/releases/tag/v2.43.0.windows.1)|[2.48.1](https://github.com/git-for-windows/git/releases/download/v2.48.1.windows.1/Git-2.48.1-64-bit.exe)|
7272

7373
{{% alert color="warning" %}} Mendix recommends installing Git for all versions of Studio Pro to ensure optimal performance and full feature availability.
74+
7475
* Studio Pro versions below 10.21.0 can work without Git, but some operations may experience reduced performance, and advanced features—such as [rebase](/refguide/merge-algorithm/#rebase)—will not be available.
7576
* Starting from Studio Pro 10.21.0, Git version 2.48.1 or above is required. This version is automatically installed during Studio Pro installation. However, for [non-administrative installation](#offline) you must install Git manually.{{% /alert %}}
7677

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

-1
Original file line numberDiff line numberDiff line change
@@ -478,4 +478,3 @@ When enabled, the names that Studio Pro suggests in microflows will start with a
478478
### Activity Default Colors
479479

480480
This table allows you to select a default color for each microflow activity type that is available in your app. The selected color will be used as the background color for all microflow activities of that type in your app. It is possible to override this default value for individual activities in the microflow editor. If you change the default color for an activity type, and there are activities of that type present in the app that have an individual background color specified, a dialog will be shown that allows you to apply the new default color to these activities as well.
481-

content/en/docs/refguide/modeling/pages/common-widget-properties.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -414,9 +414,9 @@ The visibility of the billing address depends whether the customer checks that t
414414

415415
When selected, this shows the widget while a provided [expression](/refguide/expressions/) evaluates to true. The expression may use the variables listed in the expression editor, including:
416416

417-
- `$currentObject`, representing the object of the closest enclosing data container.
418-
- The objects of any enclosing data container, available under the name of the widget that exposes them (for example `$dataView1`).
419-
- [Parameters](/refguide/page-properties/#parameters) and [variables](/refguide/page-properties/#variables) defined on the page or snippet.
417+
* `$currentObject`, representing the object of the closest enclosing data container.
418+
* The objects of any enclosing data container, available under the name of the widget that exposes them (for example `$dataView1`).
419+
* [Parameters](/refguide/page-properties/#parameters) and [variables](/refguide/page-properties/#variables) defined on the page or snippet.
420420

421421
For example, you might want a button to only be visible if a condition is met. Assume the object has an attribute called `myAttribute`, and you want the button to be visible only if `myAttribute` actually has a value stored. To achieve this goal put this expression into the field: `$currentObject/myAttribute != empty`.
422422

content/en/docs/refguide/modeling/pages/input-widgets/_index.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ description: "Widgets which can be added to pages to view and edit attributes of
1010
Input elements show data to the end-user and, optionally, allow them to edit the data.
1111

1212
In order to function, input elements need to be linked to a value, either a variable inside a page or snippet or an attribute of an entity. As such, they must be placed within a data context:
13+
1314
* A [data container](/refguide/data-widgets/) widget containing an object
1415
* A snippet containing one or more [parameters](/refguide/page-properties/#parameters)
1516
* A page or a snippet containing one or more [variables](/refguide/page-properties/#variables)

content/en/docs/refguide/modeling/pages/input-widgets/check-box.md

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ A **Check box** widget is used to display and, optionally, allow the end-user to
1212
{{% alert color="info" %}}In native mobile applications, the checkbox widget can be rendered as either a switch (default) or a checkbox. If checkbox, it displays a tick if the value is true and remains empty if it is false. If switch, it displays a track with right-positioned thumb button if the value is true and a left-positioned thumb button if it is false.{{% /alert %}}
1313

1414
A checkbox must be placed within a data context to display or edit the intended value:
15+
1516
* A [data container](/refguide/data-widgets/) widget containing an object
1617
* A snippet containing one or more [parameters](/refguide/page-properties/#parameters)
1718
* A page or a snippet containing one or more [variables](/refguide/page-properties/#variables)

content/en/docs/refguide/modeling/pages/input-widgets/date-picker.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ weight: 60
1010
A **date picker** is used to display and, optionally, allow the end-user to edit the value of an attribute or a variable of [data type](/refguide/data-types/) *Date and Time*. It uses the values set in the **Languages** tab of **App Settings** to display a correctly localized value to the end-user, using the **Language** object associated with the end-user.
1111

1212
A date picker must be placed within a data context to display or edit the intended value:
13+
1314
* A [data container](/refguide/data-widgets/) widget containing an object
1415
* A snippet containing one or more [parameters](/refguide/page-properties/#parameters)
1516
* A page or a snippet containing one or more [variables](/refguide/page-properties/#variables)
@@ -149,4 +150,4 @@ This differs from the [On change](#on-change) property in that the event will al
149150

150151
* [Data View](/refguide/data-view/)
151152
* [Attributes](/refguide/attributes/)
152-
* [Variables](/refguide/page-properties/#variables)
153+
* [Variables](/refguide/page-properties/#variables)

content/en/docs/refguide/modeling/pages/input-widgets/drop-down.md

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ For more information on converting a drop-down widget into its more modern combo
1919
A **drop-down** is used to display and, optionally, allow the end-user to edit the value of an attribute or variable of [data type](/refguide/data-types/) *enumeration*.
2020

2121
A drop-down must be placed within a data context to display or edit the intended value:
22+
2223
* A [data container](/refguide/data-widgets/) widget containing an object
2324
* A snippet containing one or more [parameters](/refguide/page-properties/#parameters)
2425
* A page or a snippet containing one or more [variables](/refguide/page-properties/#variables)

content/en/docs/refguide/modeling/pages/input-widgets/radio-buttons.md

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ When the page is displayed to the end-user, all the possible values are listed,
1616
{{< figure src="/attachments/refguide/modeling/pages/input-widgets/radio-buttons/radio-buttons-displayed.png" class="no-border" >}}
1717

1818
A radio button must be placed within a data context to display or edit the intended value:
19+
1920
* A [data container](/refguide/data-widgets/) widget containing an object
2021
* A snippet containing one or more [parameters](/refguide/page-properties/#parameters)
2122
* A page or a snippet containing one or more [variables](/refguide/page-properties/#variables)

content/en/docs/refguide/modeling/pages/input-widgets/text-area.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ weight: 20
1010
A **text area** is used to display and, optionally, allow the end-user to edit the value of an attribute or variable of [data type](/refguide/data-types/) *String*. It differs from a [text box](/refguide/text-box/) In that the value can be displayed over several lines.
1111

1212
A text area must be placed within a data context to display or edit the intended value:
13+
1314
* A [data container](/refguide/data-widgets/) widget containing an object
1415
* A snippet containing one or more [parameters](/refguide/page-properties/#parameters)
1516
* A page or a snippet containing one or more [variables](/refguide/page-properties/#variables)
@@ -204,4 +205,4 @@ With **While user is entering data**, users now can adjust one more property cal
204205

205206
* [Data view](/refguide/data-view/)
206207
* [Attributes](/refguide/attributes/)
207-
* [Variables](/refguide/page-properties/#variables)
208+
* [Variables](/refguide/page-properties/#variables)

content/en/docs/refguide/modeling/pages/input-widgets/text-box.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ A text box is used to display and, optionally, allow the end-user to edit the va
1818
* String
1919

2020
A text box must be placed within a data context to display or edit the intended value:
21+
2122
* A [data container](/refguide/data-widgets/) widget containing an object
2223
* A snippet containing one or more [parameters](/refguide/page-properties/#parameters)
2324
* A page or a snippet containing one or more [variables](/refguide/page-properties/#variables)
@@ -230,4 +231,4 @@ The formatting section applies only to the way that numeric attributes or variab
230231
* [Data Types](/refguide/data-types/)
231232
* [Data View](/refguide/data-view/)
232233
* [Attributes](/refguide/attributes/)
233-
* [Variables](/refguide/page-properties/#variables)
234+
* [Variables](/refguide/page-properties/#variables)

content/en/docs/refguide/modeling/pages/page/_index.md

-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,6 @@ To delete an element from a page, select this element and press <kbd>Delete</kbd
132132

133133
The top bar of the Page Editor features both the **Parameters** and **Variables** buttons. These allow you to change the parameters or variables for a page. Both buttons display the current number of parameters or variables in their caption. Additionally, the tooltip of the parameters button will list all parameters and their type, while the tooltip of the variables button lists each variable and its type.
134134

135-
136135
For more information about page parameters and variables, see the [Data](/refguide/page-properties/#data) section in *Page Properties*.
137136

138137
## Page Editor Modes {#page-editor-modes}

content/en/docs/refguide/modeling/security/security-overview.md

-2
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ The **Security Overview** summarizes the app's security for a selected user role
2626
3. Optionally, select a module in the sidebar of the overview.
2727
Selecting a module filters the content in the **Entity access**, **Page access**, **Microflow access**, and **Nanoflow access** tabs. The list of modules does not show the System module or any protected modules.
2828

29-
30-
3129
## Security Overview Contents
3230

3331
The **Security Overview** page has the following tabs:

content/en/docs/refguide/version-control/on-premises-git.md

-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ Studio Pro can use Windows Authentication for Git service providers that support
5555

5656
You can enable Windows Authentication in [Git Preferences settings](/refguide/preferences-dialog/#enable-windows-authentication).
5757

58-
5958
## Setting Up the Environment
6059

6160
This section describes how to configure a Git versioned app in Studio Pro. You need a Git server and an initially unversioned Mendix app.

content/en/docs/releasenotes/mobile/mendix-native-mobile-builder.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -647,4 +647,4 @@ The Mendix Native Mobile Builder supports background updates. That means it need
647647
#### Known Issues
648648

649649
* A known issue affects all versions of Native Mobile Builder below [1.0.135](#10135). Specifically, there is a known issue with the signing certificate. Because the update fails at the certificate step, the Native Mobile Builder gets stuck on its loading screen. See the link below for instructions on how to implement a first-time workaround:
650-
* Fixed in [1.0.135](#ki-certificate-signing)
650+
* Fixed in [1.0.135](#ki-certificate-signing)

content/en/docs/releasenotes/mobile/native-template/nt-studio-pro-10-parent/nt-13-rn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For more information on cookie encryption, see [Encrypting Session Cookies](/ref
2929
* **react-native-image-picker:** 7.2.3
3030
* **@react-native-community/netinfo:** 11.4.1
3131

32-
- We changed the bottom sheet library to **@gorhom/bottom-sheet**
32+
* We changed the bottom sheet library to **@gorhom/bottom-sheet**
3333

3434
### Upgrade Instructions {#upgrade-instructions}
3535

content/en/docs/releasenotes/sdk/metamodel/metamodel-10/metamodel-10.21.md

-1
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,3 @@ weight: 79
107107
#### Outcome (Element)
108108

109109
* We introduced the `persistentId` property.
110-

0 commit comments

Comments
 (0)