From 5557e10b42c586ea92de63ea2ba7ce7a05ce2d48 Mon Sep 17 00:00:00 2001 From: Quinn Tracy <142489060+quinntracy@users.noreply.github.com> Date: Tue, 5 May 2026 14:21:32 +0200 Subject: [PATCH 1/8] Review Menu index --- .../en/docs/refguide/modeling/menus/_index.md | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/content/en/docs/refguide/modeling/menus/_index.md b/content/en/docs/refguide/modeling/menus/_index.md index a6e03868397..6f8fa900569 100644 --- a/content/en/docs/refguide/modeling/menus/_index.md +++ b/content/en/docs/refguide/modeling/menus/_index.md @@ -7,55 +7,55 @@ weight: 20 ## Introduction -The top-bar of Studio Pro contains the following menus: +The top bar of Studio Pro contains the following menus: {{< figure src="/attachments/refguide/modeling/menus/menu-bar.png" alt="Menu-bar" class="no-border" >}} -* [Global Navigation Menu](#global-navigation-menu) – allows you to navigate to other parts of the platform +* [Global Navigation Menu](#global-navigation-menu) – navigates to other parts of the platform * [File](#file) – allows you to manage documents and apps * [Edit](#edit) – allows you to perform editing functions such as search or copy within Studio Pro * [View](#view) – allows you to choose how Studio Pro and dockable panes within Studio Pro are displayed * [App](#app) – contains app-wide settings -* [Run](#run) – contains actions for deploying and monitoring your app -* [Version Control](#version-control) – contains setting for version control +* [Run](#run) – contains actions for deploying and monitoring your app +* [Version Control](#version-control) – contains settings for version control * [Language](#language) – contains language and translation settings -* [Help](#help) – allows you to view documentation, the [Mendix Community](https://community.mendix.com/p/questions), open log file directory, or view information on the current information of Studio Pro +* [Help](#help) – allows you to view documentation, the [Mendix Community](https://community.mendix.com/p/questions), and the log file directory, or displays information about the current version of Studio Pro ## Global Navigation Menu {#global-navigation-menu} -The **Global Navigation Menu** menu is located at the upper left of Studio Pro and is represented as a nine-dots icon. It contains links to various parts of the platform that will open in a new browser window. For more information, see [Global Navigation](/portal/global-navigation/). +The **Global Navigation Menu** is located at the upper left of Studio Pro and is represented as a nine-dot icon. It contains links to various parts of the platform that open in a new browser window. For more information, see [Global Navigation](/portal/global-navigation/). ## File Menu {#file} -Via the **File** menu you can manage documents and apps. For more information on the **File** menu, see [File Menu](/refguide/file-menu/). +Use the **File** menu to manage documents and apps. For more information, see [File Menu](/refguide/file-menu/). ## Edit Menu {#edit} -The **Edit** menu allows you to perform editing functions, such as cut/copy/paste. You can also set [preferences](/refguide/preferences-dialog/) via this menu. For more information on the **Edit** menu, see [Edit Menu](/refguide/edit-menu/). +The **Edit** menu allows you to perform editing functions, such as cut, copy, and paste. You can also set [preferences](/refguide/preferences-dialog/). For more information, see [Edit Menu](/refguide/edit-menu/). ## View Menu {#view} -The **View** menu allows you to view dockable panes, to enable the full screen mode, and reset the project layout. For more information on the **View** menu and its items, see [View Menu](/refguide/view-menu/). +The **View** menu allows you to view dockable panes, enable full screen mode, and reset the project layout. For more information, see [View Menu](/refguide/view-menu/). ## App Menu {#app} -In the **App** menu, you can view and/or manipulate settings that are connected to your app and deployment. For more information on the **App** menu, see [App Menu](/refguide/app-menu/). +In the **App** menu, you can view and manipulate settings that are connected to your app and deployment. For more information, see [App Menu](/refguide/app-menu/). ## Run Menu {#run} -The **Run** menu contains actions for deploying and monitoring your app, such as **Publish**, **Run Locally**, or **Debugger**. For more information on the **Run** menu, see [Run Menu](/refguide/run-menu/). +The **Run** menu contains actions for deploying and monitoring your app, such as **Publish**, **Run Locally**, and **Debugger**. For more information, see [Run Menu](/refguide/run-menu/). ## Version Control Menu {#version-control} -In the **Version Control** menu, you can view and/or manipulate settings on the version control. For more information on the **Version Control** menu, see [Version Control Menu](/refguide/version-control-menu/). +In the **Version Control** menu, you can view and manipulate version control settings. For more information, see [Version Control Menu](/refguide/version-control-menu/). ## Language Menu {#language} -In the **Language** menu, you can add alternative languages to your app so that end-users can see the app in their preferred language. You can also make batch changes to identical texts, even if you are only working in one language. For more information on the **Language** menu, see [Language Menu](/refguide/translatable-texts/). +In the **Language** menu, you can add alternative languages to your app so that end-users can see the app in their preferred language. You can also make batch changes to identical texts, even if you are only working in one language. For more information, see [Language Menu](/refguide/translatable-texts/). ## Help Menu {#help} -In the **Help** menu, you can ask questions and find answers to common problems you may experience while using Studio Pro. For more information on the **Help** menu, see [Help Menu](/refguide/help-menu/). +In the **Help** menu, you can ask questions and find answers to common problems you may experience while using Studio Pro. For more information, see [Help Menu](/refguide/help-menu/). ## Read More From 394aa2c22c4cd728d4fab3313348741aa7209c92 Mon Sep 17 00:00:00 2001 From: Quinn Tracy <142489060+quinntracy@users.noreply.github.com> Date: Tue, 5 May 2026 14:30:45 +0200 Subject: [PATCH 2/8] Review App Menu --- .../modeling/menus/app-menu/_index.md | 29 +++++++++---------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/content/en/docs/refguide/modeling/menus/app-menu/_index.md b/content/en/docs/refguide/modeling/menus/app-menu/_index.md index 4fc781f4bdc..125213853a5 100644 --- a/content/en/docs/refguide/modeling/menus/app-menu/_index.md +++ b/content/en/docs/refguide/modeling/menus/app-menu/_index.md @@ -7,13 +7,13 @@ weight: 30 ## Introduction -In the **App** menu, you can view and/or manipulate settings that are connected to your app and deployment. For example, you can create a deployment package. +In the **App** menu, you can view and modify settings related to your app and deployment. For example, you can create a deployment package. {{< figure src="/attachments/refguide/modeling/menus/app-menu/app-menu.png" alt="App Menu" class="no-border" >}} ## Tools -Under **App** > **Tools**, you can find settings on updating widgets, button icons, and layouts, checking widgets, and converting your classes to **Design** properties. +Under **App** > **Tools**, you can find settings for updating widgets, button icons, and layouts; checking widgets; and converting your classes to **Design** properties. ### Batch Update Button Icons {#batch-update-button-icons} @@ -29,7 +29,7 @@ The **Check Widgets** option checks that the widgets you have implemented in the ### Update Widgets {#update-widgets} -The **Update Widgets** option presents the current versions of the widgets you are using in your app, what the latest versions of the widgets are, and an update option +The **Update Widgets** option shows the current versions of the widgets you are using in your app, the latest available versions, and an update option. ### Convert Classes to Design Properties @@ -37,11 +37,11 @@ The **Convert classes to design properties** option allows you to convert classe ### Generate Bill of Materials {#generate-bill-of-materials} -The **Generate Bill of Materials** option allows you to generate a bill of materials for the current project. See [SBOM Generation](/refguide/sbom-generation/) for more information. +The **Generate Bill of Materials** option allows you to generate a Software Bill of Materials (SBOM) for the current app. For more information, see [SBOM Generation](/refguide/sbom-generation/). ## Synchronize App Directory {#synchronize} -The **Synchronize App Directory** option creates folders inside the app directory (resources, widgets, theme, etc.), if necessary. It also reads the widget packages that are currently inside the widgets folders. For example, if you add widgets to the widgets folder, you needs to synchronize the app directory for them to appear in the **Toolbox**. +The **Synchronize App Directory** option creates folders inside the app directory (resources, widgets, theme, and so on) if necessary. It also reads the widget packages that are currently inside the widgets folders. For example, if you add widgets to the widgets folder, you need to synchronize the app directory for them to appear in the **Toolbox**. Shortcut key: F4 @@ -61,15 +61,15 @@ The **Deploy for Eclipse** option deploys the app to the deployment directory. T Shortcut key: F6 -For more information on how write Java actions from Eclipse, see [Using Eclipse](/refguide/using-eclipse/). +For more information on how to write Java actions from Eclipse, see [Using Eclipse](/refguide/using-eclipse/). ## Create Deployment Package{#create-package} -The **Create Deployment Package** option creates a Mendix Deployment Archive package (*.mda*) that contains all necessary files to run the app. This can be used if you want to deploy your app on a Windows server or on a custom Mendix Cloud. +The **Create Deployment Package** option creates a Mendix Deployment Archive package (*.mda*) that contains all necessary files to run the app. Use this option if you want to deploy your app on a Windows server or on a custom Mendix Cloud. Shortcut key: F7 -For more information on settings displayed on the Create Deployment Package dialog box, see [Create Deployment Package](/refguide/create-deployment-package-dialog/). +For more information on the settings displayed in the Create Deployment Package dialog box, see [Create Deployment Package](/refguide/create-deployment-package-dialog/). ## Clean Deployment Directory {#clean-deployment-directory} @@ -89,22 +89,21 @@ For more information on using this option, see [Deploy to the Cloud](/refguide/d ## Build Native Mobile App -If you have an app with a [native profile](/refguide/navigation/#native-phone), this option launches the [Mendix Native Mobile Builder](/releasenotes/mobile/mendix-native-mobile-builder/). This wizard will guide you through the required steps for configuring and publishing your app. +If you have an app with a [native profile](/refguide/navigation/#native-phone), this option launches the [Mendix Native Mobile Builder](/releasenotes/mobile/mendix-native-mobile-builder/). This wizard guides you through the required steps for configuring and publishing your app. -For the first step in your native mobile journey, see [Build a Mendix Native App Locally -](/refguide/mobile/distributing-mobile-apps/building-native-apps/native-build-locally/). +For the first step in your native mobile journey, see [Build a Mendix Native App Locally](/refguide/mobile/distributing-mobile-apps/building-native-apps/native-build-locally/). ## Synchronize Dependencies -Dependency synchronization is automatically triggered to run in the background whenever changes are made to a specific dependency. It also occurs when you open your app in Studio Pro. +Dependency synchronization automatically runs in the background whenever you make changes to a specific dependency. It also runs when you open your app in Studio Pro. -You can trigger manual synchronization by opening the **App** menu and selecting **Synchronize Dependencies**. +You can trigger manual synchronization by opening the **App** menu and selecting **Synchronize Dependencies**. -For more information, see the [Dependency Sychronization](/refguide/managed-dependencies/#dependency-synchronization) section of *Managed Dependencies*. +For more information, see the [Dependency Synchronization](/refguide/managed-dependencies/#dependency-synchronization) section of *Managed Dependencies*. ## Show Security Overview -The **Show Security Overview** option opens the [Security Overview](/refguide/security-overview/), where you can view a unified overview of your app's security. +The **Show Security Overview** option opens the [Security Overview](/refguide/security-overview/), which displays a unified overview of your app's security. ## Read More From d7ce1fa44b3721c29428510417aa4f2bd471eadb Mon Sep 17 00:00:00 2001 From: Quinn Tracy <142489060+quinntracy@users.noreply.github.com> Date: Tue, 5 May 2026 15:30:51 +0200 Subject: [PATCH 3/8] Review Edit docs --- .../modeling/menus/edit-menu/_index.md | 18 ++--- .../menus/edit-menu/find-and-find-advanced.md | 44 ++++++------ .../modeling/menus/edit-menu/go-to-option.md | 14 ++-- .../menus/edit-menu/preferences-dialog.md | 72 +++++++++---------- 4 files changed, 74 insertions(+), 74 deletions(-) diff --git a/content/en/docs/refguide/modeling/menus/edit-menu/_index.md b/content/en/docs/refguide/modeling/menus/edit-menu/_index.md index b4aff14bcbf..92f324e4597 100644 --- a/content/en/docs/refguide/modeling/menus/edit-menu/_index.md +++ b/content/en/docs/refguide/modeling/menus/edit-menu/_index.md @@ -7,7 +7,7 @@ weight: 10 ## Introduction -Via the **Edit** menu you can perform various actions, such cut/copy/paste or search where a particular document is used. You can also open the [Preferences](/refguide/preferences-dialog/) dialog that contains user-specific settings. +You can use the **Edit** menu to perform various actions, such as cut, copy, and paste, or search where a particular document is used. You can also open the [Preferences](/refguide/preferences-dialog/) dialog box that contains user-specific settings. {{< figure src="/attachments/refguide/modeling/menus/edit-menu/edit-menu.png" alt="Edit Menu" class="no-border" width="300" >}} @@ -19,20 +19,20 @@ The **Edit** menu items are described in the table below: | ------------------------------------------------------------ | ------------------------------------------------------------ | | **Undo** (Ctrl + Z) | Undoes the last action in a document tab. Undo and redo actions are unlimited. | | **Redo** (Ctrl + Y) | Redoes the last action that was undone in a document tab. | -| **Cut** (Ctrl + X) | Copies the selected element to the clipboard and delete it. | +| **Cut** (Ctrl + X) | Copies the selected element to the clipboard and deletes it. | | **Copy** (Ctrl + C) | Copies the selected element to the clipboard. | | **Paste** (Ctrl + V) | Pastes the contents of the clipboard in the current editor. | | **Delete** (Delete) | Deletes the selected element. | -| **Find** (Ctrl + F) | Searches the model for text. The following texts are searched: all texts that appear in the end-user interface (for example captions of labels or buttons); names and documentation of documents; entity, association, and attribute names and documentation; access rule documentation; page widget names; captions and documentation of microflow objects; and names of items in microflows. | +| **Find** (Ctrl + F) | Searches the model for text. The following texts are searched: all texts that appear in the end-user interface (for example, captions of labels or buttons); names and documentation of documents; entity, association, and attribute names and documentation; access rule documentation; page widget names; captions and documentation of microflow objects; and names of items in microflows. | | **Find Advanced** (Ctrl + Shift + F) | Opens a dialog box that allows for advanced search operations. Examples are searching for any document type and searching for unused documents. | | **Find Usages** (Ctrl + Alt + F) | Opens the **Find Results** pane and displays usages of the selected object. | | **Go to** (Ctrl + G) | Quickly navigates to any document or domain model element in the app by typing a few letters and pressing Enter. | -| **Next Find Result** (F3) | Highlights the next find result in the **Find Results** pane and open it in an editor. | -| **Previous Find Result** (Shift + F3) | Highlights the previous find result in the **Find Results** pane and open it in an editor. | -| **Back** (Ctrl + -) | Move backward through your editing history to show the documents you have recently worked on. | -| **Forward** (Ctrl + Shift + -) | Move forward through your editing history to show the documents you have recently worked on. | -| **Next Error** (F8) | Highlights the next error in the **Error List** pane and open it in an editor. | -| **Previous Error** (Shift + F8) | Highlights the previous error result in the **Error List** pane and open it in an editor. | +| **Next Find Result** (F3) | Highlights the next find result in the **Find Results** pane and opens it in an editor. | +| **Previous Find Result** (Shift + F3) | Highlights the previous find result in the **Find Results** pane and opens it in an editor. | +| **Back** (Ctrl + -) | Moves backward through your editing history to show the documents you have recently worked on. | +| **Forward** (Ctrl + Shift + -) | Moves forward through your editing history to show the documents you have recently worked on. | +| **Next Error** (F8) | Highlights the next error in the **Error List** pane and opens it in an editor. | +| **Previous Error** (Shift + F8) | Highlights the previous error result in the **Error List** pane and opens it in an editor. | | **Preferences** | Opens the **Preferences** dialog box, where you can set your general, model, and advanced editing preferences. For more information on the **Preferences** dialog box, see [Preferences](/refguide/preferences-dialog/). | ## Read More diff --git a/content/en/docs/refguide/modeling/menus/edit-menu/find-and-find-advanced.md b/content/en/docs/refguide/modeling/menus/edit-menu/find-and-find-advanced.md index 9e05f53eb63..0a599c0be2c 100644 --- a/content/en/docs/refguide/modeling/menus/edit-menu/find-and-find-advanced.md +++ b/content/en/docs/refguide/modeling/menus/edit-menu/find-and-find-advanced.md @@ -7,16 +7,16 @@ weight: 10 ## Introduction -You can search for changes or usages of different elements, documents, XPaths, changes to various elements, in your app. You do it via **Find**, **Find Advanced**, and **Find Usages** options under the **Edit** menu. +You can search for changes or usages of different elements, documents, and XPaths in your app. You can do this with the **Find**, **Find Advanced**, and **Find Usages** options under the **Edit** menu. {{< figure src="/attachments/refguide/modeling/menus/edit-menu/find-and-find-advanced/find-options.png" alt="Find Options" >}} ## Find Option -You can find various elements in your app via the **Find** option. For example, you would like to find elements in the domain model, page editor, and microflow editor where the word "Employee" is used: pages, entities, associations, expressions with it, etc. Do the following: +You can find various elements in your app with the **Find** option. For example, to find elements in the domain model, page editor, and microflow editor where the word "Employee" is used (such as pages, entities, associations, and expressions), do the following: -1. Click **Edit** > **Find** in the top-bar or press Ctrl + F. -2. In the **Find** dialog box, leave **Match case** and **Match the whole word** unselected. This way you will search for all instances of the word "Employee" including such instances as "employee", Employees", or "Department_Employee": +1. Click **Edit** > **Find** in the top bar or press Ctrl + F. +2. In the **Find** dialog box, leave **Match case** and **Match the whole word** unselected. This way you will search for all instances of the word "Employee" including such instances as "employee", "Employees", or "Department_Employee": {{< figure src="/attachments/refguide/modeling/menus/edit-menu/find-and-find-advanced/find.png" alt="Find" >}} @@ -26,14 +26,14 @@ You can see search results in the **Find Results** pane: ## Find Advanced Option {#find-advanced} -With the **Find Advanced** option you can set advanced criteria and find specific elements in your app, such as all [object activities](#find-object-activities), or [unused elements](#find-unused-elements). +With the **Find Advanced** option, you can set advanced criteria and find specific elements in your app, such as all [object activities](#find-object-activities) or [unused elements](#find-unused-elements). ### Finding Object Activities {#find-object-activities} You can search for microflows that have object activities in them. Do the following: -1. Click **Edit** > **Find** **Advanced** in the top-bar or press Ctrl + Shift + F. - The **Find Advanced** dialog box will open: +1. Click **Edit** > **Find Advanced** in the top bar or press Ctrl + Shift + F. + The **Find Advanced** dialog box opens: {{< figure src="/attachments/refguide/modeling/menus/edit-menu/find-and-find-advanced/find-advanced-dialog-box.png" class="no-border" width="400" >}} 2. In the **Search for** option, select **Actions in microflows, nanoflows, and rules**: {{< figure src="/attachments/refguide/modeling/menus/edit-menu/find-and-find-advanced/search-for-microflow-actions.png" class="no-border" width="400" >}} @@ -43,7 +43,7 @@ You can see search results in the **Find Results** pane. ### Finding Unused Elements {#find-unused-elements} -While you develop your app, it might occur that specific functionality (for example, pages or microflows) is not applicable anymore in the final version of your application. To keep your app clear and easy to maintain, it is advised to clean any unused items up. +While you develop your app, specific functionality (for example, pages or microflows) might not be applicable anymore in the final version of your application. To keep your app clear and easy to maintain, clean up any unused items. To find the unused items, do the following: @@ -54,9 +54,9 @@ To find the unused items, do the following: 3. Click **Find**. -The results will show up in the **Find Results** pane. To filter the results click the **Show all** button in the upper-right corner of the pane. +The results show up in the **Find Results** pane. To filter the results, click the **Show all** button in the upper-right corner of the pane. -Note that deleting any unused items might result in more unused items. For example, if you delete an unused page, a microflow which is only used on that page will become an unused item itself. If you are cleaning up your app regularly refresh the unused items list. +Deleting any unused items might result in more unused items. For example, if you delete an unused page, a microflow that is only used on that page will become an unused item itself. If you are cleaning up your app, regularly refresh the unused items list. {{% alert color="info" %}} Modules downloaded from the Marketplace might contain a lot of unused items. If you remove those items and the module is updated later, those items will be back in your model, so it is advised that you do not remove any unused items from an Marketplace module.' @@ -68,31 +68,35 @@ Any objects which are excluded from the app will not show up in the unused items ### Marking Unused Objects as Used -Some pages and microflows are only used from Java code and will be listed as an unused item because Studio Pro cannot look into Java source code. To prevent anyone from removing these objects you can mark the page or microflow as used. Do the following: +Some pages and microflows are only used from Java code and will be listed as an unused item because Studio Pro cannot look into Java source code. To prevent anyone from removing these objects, you can mark the page or microflow as used. Do the following: -1. Open the page or microflow which needs to be marked as used. -2. Open the **Edit** menu and select **Properties**, then change the **Mark as used** property from **No** to **Yes**. +1. Open the page or microflow that needs to be marked as used. +2. Open the **Edit** menu and select **Properties**. +3. Change the **Mark as used** property from **No** to **Yes**. ## Find Usages Option {#find-usages} -The **Find Usages** option allows you to find where a certain element is used, for example, to find all buttons that open a certain page. +The **Find Usages** option finds where a certain element is used, for example, all buttons that open a certain page. {{% alert color="info" %}} -This option only finds places where the selected entity/attribute is selected itself. This means that it will not find instances where the entity/attribute is derived implicitly (for example, by following an association). +This option only finds places where the selected entity or attribute is directly selected. It does not find instances where the entity or attribute is derived implicitly, such as by following an association. {{% /alert %}} To find where a certain element is used, do the following: -1. Open the document which contains the element. For example, open the domain model. -2. Select an element (for example, an entity) and click **Edit** > **Find usages** in the top-bar or right-click an element and select **Find usages**: +1. Open the document that contains the element, such as the domain model. +2. Select an element, such as an entity. +3. Click **Edit** > **Find usages** in the top bar, or right-click the element. +4. Select **Find usages**: {{< figure src="/attachments/refguide/modeling/menus/edit-menu/find-and-find-advanced/find-usages.png" alt="Find Usages" width="350" class="no-border" width="300" >}} -Studio Pro shows all usages of this entity in the **Find Results** pane. +Studio Pro shows all usages of the entity in the **Find Results** pane. + {{< figure src="/attachments/refguide/modeling/menus/edit-menu/find-and-find-advanced/found-usages.png" alt="Find Results Pane" class="no-border" >}} -Double-click an item in the **Find Results** pane to open the corresponding document. +Double-click an item in the **Find Results** pane to open the corresponding document. -Click **Lock results** in the **Find Results** pane. Now if you click **Find Usages**, the results will be shown in a second **Find Results** pane. This allows you to keep several search results. +Click **Lock results** in the **Find Results** pane to keep the current results. The next time you click **Find Usages**, the results display in a second **Find Results** pane. This allows you to keep several search results. ## Read More diff --git a/content/en/docs/refguide/modeling/menus/edit-menu/go-to-option.md b/content/en/docs/refguide/modeling/menus/edit-menu/go-to-option.md index 5213aee7dc2..6616d9d9e15 100644 --- a/content/en/docs/refguide/modeling/menus/edit-menu/go-to-option.md +++ b/content/en/docs/refguide/modeling/menus/edit-menu/go-to-option.md @@ -7,33 +7,33 @@ weight: 40 ## Introduction -In Studio Pro editors, such as navigation, page, or microflow editor, you can access a handy menu by right-clicking items. A **Go to** option is commonly used to find your way in an app. It allows you to navigate from one element to another: for example, to navigate to the target of a button or to the source of a data grid. +In Studio Pro editors, such as the navigation, page, or microflow editor, you can access a handy menu by right-clicking items. The **Go to** option is commonly used to find your way in an app. It allows you to navigate from one element to another, for example, to navigate to the target of a button or to the source of a data grid. ## The Go to Option The examples of using the **Go to** option are described below: -* **Opening a target of a menu item** – in **App** > **Navigation**, you can right-click a menu item and select **Go to target**. Studio Pro will open the corresponding target of the menu item,for example, a page. +* **Opening a target of a menu item** – in **App** > **Navigation**, you can right-click a menu item and select **Go to target**. Studio Pro opens the corresponding target of the menu item, for example, a page. {{< figure src="/attachments/refguide/modeling/menus/edit-menu/go-to-option/go-to-target.png" alt="Go to Target" class="no-border" width="600" >}} -* **Opening a data source of an element** – on pages, you can navigate to the data source of a widget. For example, you can right-click a button in the data grid and select **Go to microflow**. Mendix Studio Pro will open the corresponding microflow: +* **Opening a data source of an element** – on pages, you can navigate to the data source of a widget. For example, you can right-click a button in the data grid and select **Go to microflow**. Mendix Studio Pro opens the corresponding microflow: {{< figure src="/attachments/refguide/modeling/menus/edit-menu/go-to-option/go-to-microflow.png" alt="Go to Microflow" class="no-border" width="500" >}} -* **Opening an entity from a microflow** – you can navigate to an entity in the domain model if you right-click an activity in the microflow and select **Go to entity**. Mendix Studio Pro will open the corresponding domain model: +* **Opening an entity from a microflow** – you can navigate to an entity in the domain model if you right-click an activity in the microflow and select **Go to entity**. Mendix Studio Pro opens the corresponding domain model: {{< figure src="/attachments/refguide/modeling/menus/edit-menu/go-to-option/go-to-entity.png" alt="Go to Entity" class="no-border" width="400" >}} ## The Go to Dialog {#go-to-dialog} -The **Go to** dialog can be accessed by both the **Edit** menu or by using the Ctrl + G shortcut. The dialog allows quick navigation to any document or domain model element in the app by typing a few letters and pressing Enter. +The **Go to** dialog box can be accessed by both the **Edit** menu or by using the Ctrl + G shortcut. The dialog box allows quick navigation to any document or domain model element in the app by typing a few letters and pressing Enter. {{< figure src="/attachments/refguide/modeling/menus/edit-menu/go-to-option/go-to-dialog.png" alt="Go to Dialog" width="400" >}} -The typed letters or term are cached, so if the dialog is closed and reopened, the input is not lost. +The typed letters or term are cached, so if the dialog box is closed and reopened, the input is not lost. -This dialog also supports a filter option. The filter selection is saved upon both closing and reopening the dialog, and over different user sessions. This means the filter selection is saved even if you close and reopen Studio Pro. +This dialog box also supports a filter option. The filter selection is saved when you close and reopen the dialog box, and it persists over different user sessions. This means the filter selection is saved even if you close and reopen Studio Pro. ## Read More diff --git a/content/en/docs/refguide/modeling/menus/edit-menu/preferences-dialog.md b/content/en/docs/refguide/modeling/menus/edit-menu/preferences-dialog.md index 09dee7867ec..600b7b7cc61 100644 --- a/content/en/docs/refguide/modeling/menus/edit-menu/preferences-dialog.md +++ b/content/en/docs/refguide/modeling/menus/edit-menu/preferences-dialog.md @@ -6,7 +6,7 @@ weight: 50 ## Introduction -The **Preferences** option in the menu opens a dialog box where you can set user-specific preferences which apply to the whole of Studio Pro: +The **Preferences** option in the menu opens a dialog box where you can set user-specific preferences that apply to the whole of Studio Pro: {{< figure src="/attachments/refguide/modeling/menus/edit-menu/preferences-dialog/preferences.png" alt="Preferences" width="600" class="no-border" >}} @@ -16,7 +16,7 @@ The **Preferences** option in the menu opens a dialog box where you can set user When enabled, this option automatically saves your changes on various actions, such as running and deploying your app, executing version control operations (for example, committing, merging, or reverting), closing files or apps, exporting modules, or exiting Studio Pro. -Additionally, you have the option to enable autosave for any of these actions when you have unsaved changes. In such cases a dialogue box is opened, where you can choose to save or discard your changes. You can speed this process up by checking the **Do not ask me again** checkbox, which prevents further prompts and enables the autosave functionality. +Additionally, you have the option to enable autosave for any of these actions when you have unsaved changes. In such cases, a dialog box opens, where you can choose to save or discard your changes. You can speed up this process by checking the **Do not ask me again** checkbox, which prevents further prompts and enables the autosave functionality. ### Interface {#interface} @@ -40,7 +40,7 @@ For more information about the styling editor, see the [Using the Styling Editor #### Auto-Check Delay -The **Auto-check delay** is the number of milliseconds that Studio Pro waits after a change, before starting the consistency checks. Increase this setting for large apps if Studio Pro responses slowly after changes. +The **Auto-check delay** is the number of milliseconds that Studio Pro waits after a change before starting the consistency checks. Increase this setting for large apps if Studio Pro responds slowly after changes. #### Highlight Shown Errors and Warnings in the Editor @@ -60,9 +60,7 @@ In the **Deployment** tab you can configure various settings related to applicat ### JDK {#jdk} -Here the directories of the Java Development Kit (JDK) for each supported Java version can be selected. -These JDKs are used when you locally deploy an application. -Usually, the correct directories are located automatically. +Here you can select the directories of the Java Development Kit (JDK) for each supported Java version. These JDKs are used when you locally deploy an application. Usually, the correct directories are located automatically. A JDK is necessary to run Mendix applications, because the Mendix Runtime runs on the Java Virtual Machine (JVM). @@ -70,7 +68,7 @@ A JDK is necessary to run Mendix applications, because the Mendix Runtime runs o #### Enable Run Optimizations -Enable this setting to increase the speed at which a running application is updated after changes have been made in Studio Pro. If only pages, layouts, or snippets have been changed, then an entire restart of the application is skipped to decrease deployment time. Also, no Java compilation is performed when no relevant files have changed. +Enable this setting to increase the speed at which a running application is updated after changes have been made in Studio Pro. If only pages, layouts, or snippets have been changed, an entire restart of the application is skipped to decrease deployment time. Also, no Java compilation is performed when no relevant files have changed. #### Optimize Bundle {#bundle} @@ -100,9 +98,9 @@ Enabling this option allows you to specify which repositories should be used by #### Repositories -This option becomes available if **Use custom repositiories** is set to **Yes**. +This option becomes available if **Use custom repositories** is set to **Yes**. -You can specify which repositories to use for Gradle. The content of this field should be specified using Groovy syntax and is what is inside the `repositories { }` section in a Gradle build file. By default, this field contains: `mavenCentral()` and `gradlePluginPortal()`. +You can specify which repositories to use for Gradle. The content of this field should be specified using Groovy syntax and is what is inside the `repositories { }` section in a Gradle build file. By default, this field contains `mavenCentral()` and `gradlePluginPortal()`. ## Maia Tab @@ -112,15 +110,13 @@ You can specify which repositories to use for Gradle. The content of this field In Studio Pro 11.7 and below, the **Generative AI** section contains the following settings: -The **Generative AI** section contains the following settings: - -* **Enable Start with Maia** – When enabled, you can use the **Start with Maia** starting point in Studio Pro to help you create an app. For more information on how to use this feature, see [Start with Maia](/refguide/start-with-maia/). It is enabled by default. -* **Enable Maia Explain** – When enabled, you can use it to explain a microflow or a nanoflow in the logic editors. For more information on how to use this feature, see [Maia Explain](/refguide/maia-explain/). It is enabled by default. -* **Enable Maia for Domain Model** – when enabled, you can use it to generate a new domain model or to explain and improve an existing one. For more information on how to use this feature, see [Maia for Domain Model](/refguide/maia-for-domain-model/). It is enabled by default. -* **Enable Maia for OQL Generation**– when enabled, you can use it to generate and manage OQL (Object Query Language) queries through an intuitive interface. For more information on how to use this feature, see [Maia for OQL](/refguide/maia-for-oql/). It is disabled by default. -* **Enable Maia for Pages** – when enabled, you can use it to generate a new page or to explain and improve an existing one. For more information on how to use this feature, see [Maia for Pages](/refguide/maia-for-pages/). It is disabled by default. -* **Enable Maia for Workflows** – when enabled, you can use it to generate workflows by adding and configuring activities. For more information on how to use this feature, see [Maia for Workflows](/refguide/maia-for-workflows/). It is disabled by default. -* **Enable translation generator** – when enabled, you can use it to translate your model into different languages through the **Batch translate** option under the **Language** menu, or to translate [system texts](/refguide/system-texts/) for you. For more information, see [Translation Generator](/refguide/translation-generator/). It is disabled by default. +* **Enable Start with Maia** – when enabled, you can use the **Start with Maia** starting point in Studio Pro to help you create an app. For more information on how to use this feature, see [Start with Maia](/refguide/start-with-maia/). It is enabled by default. +* **Enable Maia Explain** – when enabled, you can use it to explain a microflow or a nanoflow in the logic editors. For more information, see [Maia Explain](/refguide/maia-explain/). It is enabled by default. +* **Enable Maia for Domain Model** – when enabled, you can use it to generate a new domain model or to explain and improve an existing one. For more information, see [Maia for Domain Model](/refguide/maia-for-domain-model/). It is enabled by default. +* **Enable Maia for OQL Generation** – when enabled, you can use it to generate and manage OQL (Object Query Language) queries through an intuitive interface. For more information, see [Maia for OQL](/refguide/maia-for-oql/). It is disabled by default. +* **Enable Maia for Pages** – when enabled, you can use it to generate a new page or to explain and improve an existing one. For more information, see [Maia for Pages](/refguide/maia-for-pages/). It is disabled by default. +* **Enable Maia for Workflows** – when enabled, you can use it to generate workflows by adding and configuring activities. For more information, see [Maia for Workflows](/refguide/maia-for-workflows/). It is disabled by default. +* **Enable translation generator** – when enabled, you can use it to translate your model into different languages through the **Batch translate** option under the **Language** menu or to translate [system texts](/refguide/system-texts/). For more information, see [Translation Generator](/refguide/translation-generator/). It is disabled by default. ### In-Editor Recommender @@ -142,7 +138,7 @@ The **Best Practice Recommender** section contains the following settings: * **Enable MCP Server** - When enabled, you can use the [Studio Pro MCP Server](/refguide/studio-pro-mcp-server/), which enables you to leverage Maia's capabilities directly from external clients, including AI coding assistants, agents, and other MCP-based LLM tools. It is disabled by default. - **Port** (Default: 7782) - With this setting, you can configure the port of the server. + **Port** (Default: 7782) - You can configure the port of the server with this setting. ## Model Tab @@ -160,7 +156,7 @@ This setting defines the default response to the question whether to automatical This is the path and name of the program that is used to view the details of file changes in the [commit dialog box](/refguide/commit-dialog/). -For example, you can see how to set up file comparison for Visual Studio Code below: +For example, this is how to set up file comparison for Visual Studio Code: ```text {path to VS Code}/Code.exe --wait --diff "{0}" "{1}" @@ -189,7 +185,7 @@ This setting allows users to specify a path for Git installation in their system #### Enable Private Version Control with Git {#enable-with-Git} -Select this option when you want to work on an app that is not stored in [Mendix Team Server](/developerportal/repository/team-server/), but in a private Git server, which you have access to. This allows you to specify the location of the app on the Git server when opening, downloading, or uploading the app. With this setting you also need to specify [name and email](#name) that will be used to identify your commits with Git. +Select this option when you want to work on an app that is not stored in [Mendix Team Server](/developerportal/repository/team-server/), but in a private Git server that you have access to. This allows you to specify the location of the app on the Git server when opening, downloading, or uploading the app. With this setting, you also need to specify [name and email](#name) that will be used to identify your commits with Git. #### Name and Email {#name} @@ -219,7 +215,7 @@ Select a [Clone type](/refguide/clone-type/) to use for future clone operations, #### Combine Local and Remote Changes -When [combining changes](/refguide/merge-algorithm/), for example when doing a Git pull, the user can choose between **Rebase** and **Merge** as the default action. This preference can be overridden for each merge which contains conflicts. +When [combining changes](/refguide/merge-algorithm/), for example when doing a Git pull, the user can choose between **Rebase** and **Merge** as the default action. This preference can be overridden for each merge that contains conflicts. #### Git Version Warning @@ -237,7 +233,7 @@ The number of minutes to wait after a fetch has started before performing anothe #### Enable Automatic Repository Optimization {#optimization} -Select **Enable automatic repository optimization** to run Git repository optimization automatically on a regular basis. This helps you maintain the storage structure providing benefits from both performance and repository size perspectives. +Select **Enable automatic repository optimization** to run Git repository optimization automatically on a regular basis. This helps you maintain the storage structure, providing benefits from both performance and repository size perspectives. #### Number of Commits @@ -247,7 +243,7 @@ This option is available when the [Enable automatic repository optimization](#op ### Theme {#studio-pro-theme} -This option allows user to choose between Studio Pro themes: **Auto (System theme)**, **Light**, or **Dark**. The default is **Auto (System theme)**, which detects the theme set in the operating system and uses an appropriate theme for Studio Pro (**Light** or **Dark**). Changing this option requires a restart of Studio Pro to take effect. +This option allows you to choose between Studio Pro themes: **Auto (System theme)**, **Light**, or **Dark**. The default is **Auto (System theme)**, which detects the theme set in the operating system and uses an appropriate theme for Studio Pro (**Light** or **Dark**). Changing this option requires a restart of Studio Pro to take effect. ### Default Page Editor {#default-page-editor} @@ -271,39 +267,39 @@ This setting allows you to move forward and backward through your editing histor ### Dialogs {#dialogs} -When a pop-up dialog is resized, Studio Pro will remember the new size and use it when the same dialog is opened again. This option allows you to disable this behavior and always show the dialogs at their default size. +When a pop-up dialog box is resized, Studio Pro will remember the new size and use it when the same dialog box is opened again. This option allows you to disable this behavior and always show the dialog boxes at their default size. ## Advanced Tab ### Rendering Settings {#rendering} -Hardware and driver issues may cause performance problems when running Studio Pro. These issues can appear in form of dialog boxes opening and closing much more slowly than expected, and general slowness of the UI. If case the hardware problems cannot be solved, it is possible to mitigate these issues by turning the **Enable software rendering mode** setting on. This option is available for Native UI and Web Content. For Web Content, you can select **Auto**, which enables software rendering mode automatically when running on Parallels or another virtual machine. +Hardware and driver issues may cause performance problems when running Studio Pro. These issues can appear in the form of dialog boxes opening and closing much more slowly than expected and general slowness of the UI. If the hardware problems cannot be solved, you can mitigate these issues by turning the **Enable software rendering mode** setting on. This option is available for Native UI and Web Content. For Web Content, you can select **Auto**, which enables software rendering mode automatically when running on Parallels or another virtual machine. Enabling this setting requires a restart of Studio Pro to take effect. Running the application with this setting on may increase the CPU usage. ### Proxy Server -Sometimes the computer running Studio Pro cannot access the internet directly, but has to connect to a proxy server that requires authentication. If this is the case, then these settings can be used to specify the user name and password to connect to the proxy server. +Sometimes the computer running Studio Pro cannot access the internet directly but has to connect to a proxy server that requires authentication. If this is the case, you can use these settings to specify the user name and password to connect to the proxy server. ### Usage Data {#usage-data} -When the **Send Studio Pro usage data to Mendix** setting is enabled, Studio Pro sends usage data to Mendix that allows Mendix to identify issues and improve the user experience. The usage data does not contain sensitive information. It is possible to disable this feature, but it may affect the behavior of some features, prevent Mendix from identifying issues reported by the user, or affect tracking issues that are not reported yet. This setting is machine-specific and changing this feature does not affect any existing installed version. +When the **Send Studio Pro usage data to Mendix** setting is enabled, Studio Pro sends usage data to Mendix that allows Mendix to identify issues and improve the user experience. The usage data does not contain sensitive information. You can disable this feature, but it may affect the behavior of some features, prevent Mendix from identifying issues reported by the user, or affect tracking issues that are not reported yet. This setting is machine-specific, and changing this feature does not affect any existing installed version. ### XPath {#visual-builder} -**Visual Builder** is the default way to construct XPath constraints, but you can change the default by clearing **Enable the XPath Builder as the default XPath constraint editor**. +**Visual Builder** is the default way to construct XPath constraints. To change the default, clear **Enable the XPath Builder as the default XPath constraint editor**. ### Feedback Survey -When the **Show feedback survey periodically** setting is enabled, Studio Pro will periodically display a feedback survey to gather input on your experience. This helps Mendix improve the product based on user feedback. For more information, see [Feedback Survey](/refguide/feedback-survey/). +When **Show feedback survey periodically** is enabled, Studio Pro periodically displays a feedback survey to gather input on your experience. This helps Mendix improve the product based on user feedback. For more information, see [Feedback Survey](/refguide/feedback-survey/). ### Antivirus Exclusion -When the **Do not show antivirus exclusion notifications** setting is enabled, Studio Pro will not display notifications related to antivirus exclusions. For more information, see [Antivirus Exclusion](/refguide/antivirus-exclusion/). +When **Do not show antivirus exclusion notifications** is enabled, Studio Pro does not display notifications related to antivirus exclusions. For more information, see [Antivirus Exclusion](/refguide/antivirus-exclusion/). -### Extension Development +### Extension Development -When **Extension Development** mode is enabled, you can start Studio Pro without using the extensibility feature flag, which allows you to develop extensions for Studio Pro. You must restart Studio Pro to use this feature. +When **Extension Development** mode is enabled, you can start Studio Pro without using the extensibility feature flag. This allows you to develop extensions for Studio Pro. You must restart Studio Pro to use this feature. ## New Features Tab {#new-features} @@ -313,7 +309,7 @@ Select this option to use the modernized version of the App Explorer. You must r ### Console -Select this option to use the modernized (web) Runtime console. You must restart Studio Pro to use this feature. +Select this option to use the modernized (web) Runtime console. You must restart Studio Pro to use this feature. ### Errors Pane @@ -329,7 +325,7 @@ You can publish data as a GraphQL service. When you enable this feature, you can ### JavaScript Action Editor -Select this option to use the modernized version of the JavaScript action Editor. You must close all open JavaScript actions to use this feature. +Select this option to use the modernized version of the JavaScript action editor. You must close all open JavaScript actions to use this feature. ### Mapping Editor @@ -339,13 +335,13 @@ This setting allows you to set the beta version as the default editor. This option allows you to use the web version of the system texts editor. It is enabled by default. -If Translation Generator is also enabled, you can use it in this editor as well. For more information, see the [Generating Translation for System Texts](/refguide/translation-generator/#translate-system-text) section in *Translation Generator*. +If Translation Generator is also enabled, you can use it in this editor. For more information, see the [Generating Translation for System Texts](/refguide/translation-generator/#translate-system-text) section in *Translation Generator*. ### Workflow -In Studio Pro 11.8, select the **Enable workflow event sub-processes (beta)** option to allow adding [event sub-processes](/refguide/workflow-event-sub-processes/) to your workflow in the workflow editor. +In Studio Pro 11.8, select **Enable workflow event sub-processes (beta)** to allow adding [event sub-processes](/refguide/workflow-event-sub-processes/) to your workflow in the workflow editor. -In Studio Pro 11.9 and above, this option is removed. Workflow event sub-processes are in general availability and are enabled by default. +In Studio Pro 11.9 and above, this option is removed. Workflow event sub-processes are in general availability and enabled by default. ## Read More From 903e98de9ab28d6a177755cb66e8d58eaae2f808 Mon Sep 17 00:00:00 2001 From: Quinn Tracy <142489060+quinntracy@users.noreply.github.com> Date: Tue, 5 May 2026 17:28:22 +0200 Subject: [PATCH 4/8] Review File menu docs --- .../modeling/menus/file-menu/_index.md | 28 ++++++++-------- .../file-menu/export-app-package-dialog.md | 33 +++++++++---------- .../file-menu/import-app-package-dialog.md | 22 ++++++------- .../modeling/menus/file-menu/new-app.md | 22 ++++++------- .../menus/file-menu/open-app-dialog.md | 26 +++++++-------- 5 files changed, 64 insertions(+), 67 deletions(-) diff --git a/content/en/docs/refguide/modeling/menus/file-menu/_index.md b/content/en/docs/refguide/modeling/menus/file-menu/_index.md index 8ed10ead363..e64d929e073 100644 --- a/content/en/docs/refguide/modeling/menus/file-menu/_index.md +++ b/content/en/docs/refguide/modeling/menus/file-menu/_index.md @@ -1,7 +1,7 @@ --- title: "File Menu" url: /refguide/file-menu/ -description: "Describes the File Menu in Studio Pro." +description: "Describes the File menu in Studio Pro and its options for managing documents and apps." weight: 5 --- @@ -17,20 +17,20 @@ The **File** menu items are described in the table below: | Menu Item | Description | Shortcut Key | | -------------------------- | ------------------------------------------------------------ | ------------------------------------------------- | -| **New Document** | Creates a new document within the app currently open. You can choose the name, location, and type of document. For more information on types of documents, see [Modules](/refguide/modules/). | Ctrl + N | -| **New App** | Creates a new single-developer app. A single-developer app is simply a file (with the extension *.mpr*) that is stored in the local file system. For more information, see [New App](/refguide/new-app/). | Ctrl + Shift + N | -| **Open App** | Opens an existing single-developer app (*.mpr*) or app package (*.mpk*). See **New App** above for information on single-developer apps. For more information, see [Open App](/refguide/open-app-dialog/). | Ctrl + Shift + O | +| **New Document** | Creates a new document within the currently open app. You can choose the name, location, and type of document. For more information on document types, see [Modules](/refguide/modules/). | Ctrl + N | +| **New App** | Creates a new single-developer app. A single-developer app is a file (with the extension *.mpr*) stored in the local file system. For more information, see [New App](/refguide/new-app/). | Ctrl + Shift + N | +| **Open App** | Opens an existing single-developer app (*.mpr*) or app package (*.mpk*). See **New App** for information on single-developer apps. For more information, see [Open App](/refguide/open-app-dialog/). | Ctrl + Shift + O | | **Recent Apps** | Shows a list of recently opened apps for quick opening. | | -| **Save** | Saves the changes in the currently active document tab. | Ctrl + S | -| **Save All** | Saves the changes in all documents that are open. | Ctrl + Shift + S | -| **Close** | Closes the current document. You will be asked to save or discard changes when needed. | Ctrl + W | -| **Close All** | Closes all document tabs. You will be asked to save or discard changes when needed. | Ctrl + Shift + W | -| **Close App** | Closes the currently open App and returns to the home page. | | -| **Export as Image** | Exports the current document as an image in the *.png* format. The following document types can be exported as images: domain models, workflows, microflows, nanoflows, rules, and document templates. | | -| **Upgrade app to split MPR format (v2)** | Converts the file storage format of the current branch. The [MPRv2 storage format](/refguide/troubleshoot-repository-size/#mpr-format) results in reduced repository growth to ensure good performance over time. | | -| **Export App Package** | Exports the current app to a package (*.mpk*) file. This is useful for example when you want to give someone the entire app, or when you need to provide a test app when submitting a ticket. For more information, see [Export App Package](/refguide/export-app-package-dialog/). | | -| **Import App Package** | Imports a package that was created with the **Export App Package** menu item. For more information, see [Import App Package](/refguide/import-app-package-dialog/). | | -| **Exit** | Closes Studio Pro | | +| **Save** | Saves changes in the currently active document tab. | Ctrl + S | +| **Save All** | Saves changes in all open documents. | Ctrl + Shift + S | +| **Close** | Closes the current document. If there are unsaved changes, you are asked to save or discard them. | Ctrl + W | +| **Close All** | Closes all document tabs. If there are unsaved changes, you are asked to save or discard them. | Ctrl + Shift + W | +| **Close App** | Closes the currently open app and returns to the home page. | | +| **Export as Image** | Exports the current document as an image in *.png* format. The following document types can be exported as images: domain models, workflows, microflows, nanoflows, rules, and document templates. | | +| **Upgrade app to split MPR format (v2)** | Converts the file storage format of the current branch. The [MPRv2 storage format](/refguide/troubleshoot-repository-size/#mpr-format) reduces repository growth to ensure good performance over time. | | +| **Export App Package** | Exports the current app to a package (*.mpk*) file. This is useful when you want to give someone the entire app or when you need to provide a test app when submitting a ticket. For more information, see [Export App Package](/refguide/export-app-package-dialog/). | | +| **Import App Package** | Imports a package created with the **Export App Package** menu item. For more information, see [Import App Package](/refguide/import-app-package-dialog/). | | +| **Exit** | Closes Studio Pro. | | ## Read More diff --git a/content/en/docs/refguide/modeling/menus/file-menu/export-app-package-dialog.md b/content/en/docs/refguide/modeling/menus/file-menu/export-app-package-dialog.md index 0d6ab04de4a..3a6f525c27f 100644 --- a/content/en/docs/refguide/modeling/menus/file-menu/export-app-package-dialog.md +++ b/content/en/docs/refguide/modeling/menus/file-menu/export-app-package-dialog.md @@ -9,39 +9,39 @@ aliases: ## Introduction -You can export an app package (*.mpk*) from Mendix Studio Pro for backup purposes or to share it with other Mendix developers. This is useful if you want to give someone the entire app, or if you need to provide a test app when submitting a ticket. +You can export an app package (*.mpk*) from Studio Pro for backup purposes or to share it with other developers. This is useful when you want to give someone the entire app or when you need to provide a test app when submitting a ticket. -App packages can be imported again into a new app using the [Import App Package](/refguide/import-app-package-dialog/). +You can import app packages into a new app using the [Import App Package](/refguide/import-app-package-dialog/) feature. To export the package, open the **File** menu > **Export App Package** and select the relevant options in the **Export App Package** dialog box: {{< figure src="/attachments/refguide/modeling/menus/file-menu/export-app-package-dialog/export-app-package.png" alt="Export App Package Dialog Window" class="no-border" >}} -For more information on what options you can select, see the sections below. +The sections below describe the available options. ## Package Type -Alternatively, you can export your app as an [Adaptable Solution](/appstore/creating-content/sol-adapt/). To be able to do it when exporting, open the **App settings** > **Solution** tab and set **Enable solution adaptation** to **Yes**. For more information on this setting, see the [Solution Tab](/refguide/solution-tab/) section in *App Settings*. +You can also export your app as an [Adaptable Solution](/appstore/creating-content/sol-adapt/). To do this, open the **App settings** > **Solution** tab and set **Enable solution adaptation** to **Yes**. For more information on this setting, see the [Solution Tab](/refguide/solution-tab/) section in *App Settings*. -You can now choose to export your app as the **Solution** or **Source Package**. +You can then choose to export your app as **Solution** or **Source Package**. {{< figure src="/attachments/refguide/modeling/menus/file-menu/export-app-package-dialog/export-app-package-types.png" alt="Export App Package Dialog Window with Different Package Types" class="no-border" >}} ### Solution Package {{% alert color="info" %}} -You can only see the **Solution** and **Source Package** settings when you have access to publishing add-on modules and solutions. The access can be gained through the [Mendix Partner Program](/appstore/partner-program/). +You can only see the **Solution** and **Source Package** settings when you have access to publishing add-on modules and solutions. You can gain this access through the [Mendix Partner Program](/appstore/partner-program/). {{% /alert %}} -Choose this type of package if you develop your app as a solution and it has certain documents/elements hidden from consumers. Your app will be exported as a *.mxsolution* file; add-on and solution modules will be converted to the *.mxmodule* format during export. For more information on add-on and solution modules, see [Configuring Add-on and Solution Modules for Publishing](/refguide/configure-add-on-and-solution-modules/). +Choose this package type if you develop your app as a solution and it has certain documents or elements hidden from consumers. Your app is exported as a *.mxsolution* file; add-on and solution modules are converted to the *.mxmodule* format during export. For more information on add-on and solution modules, see [Configuring Add-on and Solution Modules for Publishing](/refguide/configure-add-on-and-solution-modules/). ### Source Package {{% alert color="info" %}} -You can only see the **Solution** and **Source Package** settings when you have access to publishing add-on modules and solutions. The access can be gained through the [Mendix Partner Program](/appstore/partner-program/). +You can only see the **Solution** and **Source Package** settings when you have access to publishing add-on modules and solutions. You can gain this access through the [Mendix Partner Program](/appstore/partner-program/). {{% /alert %}} -A source package is used to distribute your app in the source format (i.e. all content is distributed with source code, which allows documents/elements to be changed on the consumer side). Your app is exported in the *.mpk* format. +A source package is used to distribute your app in the source format (that is, all content is distributed with source code, which allows documents and elements to be changed on the consumer side). Your app is exported in *.mpk* format. ## Destination @@ -49,16 +49,13 @@ You can specify the folder to export the package to. The default location is a f ## Export Data -Mendix app packages can be exported to a Mendix package file (*.mpk*). You can choose to export the built-in deployment database and uploaded files as well, or export with no data. You can choose one of the following options: +App packages can be exported to a package file (*.mpk*). You can choose to export the built-in deployment database and uploaded files or export with no data. Choose one of the following options: -* **No data** – the package will be exported without data. -* **Existing snapshot** – this option will include the existing database snapshot in the export app package - - {{% alert color="info" %}}This option is only available when a snapshot has already been created. If necessary, you can create a snapshot via **Version Control** > **Add Snapshot of Data**.{{% /alert %}} - -* **New snapshot from current database** – will create a new snapshot from the database and include it in the export - - {{% alert color="info" %}}This option is available after you run the app locally at least once, because a local database will be created when running the app for the first time.{{% /alert %}} +* **No data** – the package is exported without data. +* **Existing snapshot** – this option includes the existing database snapshot in the exported app package. +{{% alert color="info" %}}This option is only available when a snapshot has already been created. If necessary, you can create a snapshot via **Version Control** > **Add Snapshot of Data**.{{% /alert %}} +* **New snapshot from current database** – creates a new snapshot from the database and includes it in the export. +{{% alert color="info" %}}This option is available after you run the app locally at least once, because a local database is created when running the app for the first time.{{% /alert %}} ## Read More diff --git a/content/en/docs/refguide/modeling/menus/file-menu/import-app-package-dialog.md b/content/en/docs/refguide/modeling/menus/file-menu/import-app-package-dialog.md index 3eefec61460..4e2ca0d63fe 100644 --- a/content/en/docs/refguide/modeling/menus/file-menu/import-app-package-dialog.md +++ b/content/en/docs/refguide/modeling/menus/file-menu/import-app-package-dialog.md @@ -2,23 +2,23 @@ title: "Import App Package" url: /refguide/import-app-package-dialog/ weight: 40 -description: "Describes the Import App Package process and Import App Package dialog box." +description: "Describes how to import an app package and the options in the Import App Package dialog box." aliases: - /refguide/import-project-package-dialog/ --- ## Introduction -To create a new app from a Mendix app package (*.mpk*) file, you need to import an app package. The new app can either be stored in a version control server or locally on disk. +To create a new app from an app package (*.mpk*) file, import the app package. You can store the new app in a version control server or locally on disk. To import an app package, do the following: -1. Select the **File** menu in the top bar > **Import App Package** -2. Browse to the *.mpk* file you would like to import. -3. Select the relevant options in the **Import App Package** dialog box and click **OK**. For more information on what options you can select, see the sections below. +1. Select the **File** menu in the top bar > **Import App Package**. +2. Browse to the *.mpk* file you want to import. +3. Select the relevant options in the **Import App Package** dialog box and click **OK**. The sections below describe the available options. {{< figure src="/attachments/refguide/modeling/menus/file-menu/import-app-package-dialog/import-app-package.png" alt="Import App Package Dialog Window" class="no-border" width="600" >}} -App packages can be created using [Export App Package](/refguide/export-app-package-dialog/). +You can create app packages using [Export App Package](/refguide/export-app-package-dialog/). ## Where Should We Store Your App? @@ -26,11 +26,11 @@ Use this setting to select the location where you want to store your app. This c ### Mendix Team Server {#team-server} -When uploading the app to the Team Server, you can choose between creating a new repository, or uploading to an existing one. +When uploading the app to the Team Server, you can choose between creating a new repository or uploading to an existing one. #### New Mendix Team Server -If you select to store your app in a new Mendix Team Server, a new Team Server app will be created. You need to enter the name for the new Team Server app and repository in the **App name** field. +If you select to store your app in a new Team Server, a new Team Server app is created. Enter the name for the new Team Server app and repository in the **App name** field. #### Existing Mendix Team Server @@ -41,18 +41,18 @@ For more information about the Mendix Team Server, see [Team Server](/developerp ### Private Server {#private-server} {{% alert color="info" %}} -The **Private server** option is only available when support for other Git servers is enabled: **Edit** >**Preferences** > **Version Control** > **Enable private version control with Git**. +The **Private server** option is only available when support for other Git servers is enabled: **Edit** > **Preferences** > **Version Control** > **Enable private version control with Git**. {{% /alert %}} In the **App repository address** field, enter the address of the repository you want to upload your app to. ### Locally on Disk {#local} -Select this option if you don't need to upload the new app to a version control server. In this case it will only be stored on the local disk of the computer that's running Studio Pro. +Select this option if you do not need to upload the new app to a version control server. In this case, the app is only stored on the local disk of the computer running Studio Pro. ## App Directory -Use this field to choose the directory where the app files of the app will be stored. If the version control is enabled, the suggested name ends with *-main* to indicate this will be the main development line of the app. +Use this field to choose the directory where the app files are stored. If version control is enabled, the suggested name ends with *-main* to indicate this is the main development line of the app. ## Read More diff --git a/content/en/docs/refguide/modeling/menus/file-menu/new-app.md b/content/en/docs/refguide/modeling/menus/file-menu/new-app.md index 7f9fa82ef64..f44b408e82f 100644 --- a/content/en/docs/refguide/modeling/menus/file-menu/new-app.md +++ b/content/en/docs/refguide/modeling/menus/file-menu/new-app.md @@ -2,7 +2,7 @@ title: "New App" url: /refguide/new-app/ weight: 10 -description: "This document describes the New App flow and the App Settings dialog box." +description: "Describes how to create a new app in Studio Pro and configure the App Settings dialog box." aliases: - /refguide/app-settings-dialog.html - /refguide/app-settings-dialog @@ -12,15 +12,15 @@ aliases: ## Introduction -You can create a new app in Mendix Studio Pro. +You can create a new app in Studio Pro. -To create a new app, follow the steps below: +To create a new app, follow these steps: 1. Do one of the following: 1. Open the **File** menu in the top bar > **New App**. 2. Click **Create New App** on the Studio Pro landing page. -2. In **My Apps** tab, select a starting point (an app template). +2. In the **My Apps** tab, select a starting point (an app template). 3. Click **Use this app**. 4. In the **App Settings** dialog box, select the settings for your app and click **Create app**. For more information on app settings, see the [App Settings](#app-settings) section. @@ -28,31 +28,31 @@ The new app is created and opened. ## App Settings {#app-settings} -When creating a new app, the **App Settings** dialog box is opened where you can specify an app name, whether or not to enable the online services provided by the Mendix Platform, the default language, and the location on disk where the app files for your app are stored: +When creating a new app, the **App Settings** dialog box opens. Use it to specify an app name, whether to enable the online services provided by the Mendix Platform, the default language, and the location on disk where the app files are stored: {{< figure src="/attachments/refguide/modeling/menus/file-menu/new-app/app-settings-dialog.png" alt="App Settings" class="no-border" >}} ### App Name -The name of your new app. This name is used as the name of the app directory and file on disk. If you enable the online services for this app, the name is also used for the Team Server repository and a corresponding app in **My Apps**. +The name of your new app. This name is used as the name of the app directory and file on disk. If you enable online services for this app, the name is also used for the Team Server repository and a corresponding app in **My Apps**. ### Enable Online Services -The Mendix Platform offers online services such as [version control](/refguide/version-control/) and [cloud deployment](/deployment/). When enabled, this will create an app in [Apps](https://sprintr.home.mendix.com/) in the Mendix Portal and a corresponding version control repository. +The Mendix Platform offers online services such as [version control](/refguide/version-control/) and [cloud deployment](/deployment/). When enabled, this creates an app in [Apps](https://sprintr.home.mendix.com/) in the Mendix Portal and a corresponding version control repository. -If you choose *No*, you will create an app that is only stored on your local disk. At a later point you can still decide to upload this local app to a version control server and enjoy the benefits of version control. +If you choose *No*, you create an app that is only stored on your local disk. You can still upload this local app to a version control server later. ### Default Language -The default language is the language of the user interface of your app. Choose the language that you will initially use in your forms and other user interface elements. You can always add additional languages to your app later. +The default language is the language of the user interface of your app. Choose the language that you use initially in your forms and other user interface elements. You can add additional languages to your app later. ### App Directory Specify the directory in which the files for your app are stored. -If you enable the online services for the new app, you will see that the suffix *-main* has been added to the directory name automatically. It is used to indicate that the directory contains the main branch line of your app. While working on your app, you can create new branches and download them to other directories. For more information on the branch line management, see [Branch Line Manager](/refguide/branch-line-manager-dialog/). +If you enable online services for the new app, the suffix *-main* is added to the directory name automatically. This indicates that the directory contains the main branch line of your app. While working on your app, you can create new branches and download them to other directories. For more information on branch line management, see [Branch Line Manager](/refguide/branch-line-manager-dialog/). -The default directory in which new apps are stored can be changed in the [Preferences](/refguide/preferences-dialog/#default-directory) dialog box. +You can change the default directory in which new apps are stored in the [Preferences](/refguide/preferences-dialog/#default-directory) dialog box. ## Read More diff --git a/content/en/docs/refguide/modeling/menus/file-menu/open-app-dialog.md b/content/en/docs/refguide/modeling/menus/file-menu/open-app-dialog.md index 4a9ec707699..712f79ab1aa 100644 --- a/content/en/docs/refguide/modeling/menus/file-menu/open-app-dialog.md +++ b/content/en/docs/refguide/modeling/menus/file-menu/open-app-dialog.md @@ -2,7 +2,7 @@ title: "Open App" url: /refguide/open-app-dialog/ weight: 20 -description: "Describes the Open App flow and the Open App dialog box" +description: "Describes how to open an app in Studio Pro using the Open App dialog box." aliases: - /refguide/open-project-dialog.html - /refguide/open-project-dialog @@ -16,31 +16,31 @@ To open an app in Mendix Studio Pro, do one of the following: * Select **File** > **Open App** * Click **Open App** on the Studio Pro landing page -The **Open App** dialog box will open, where you can [select an app](#select-app) from your apps, [open an app locally](#open-locally),[open an app from a private Git repository](#open-private) or [import an app package](#import-app): +The **Open App** dialog box opens. You can [select an app](#select-app) from your apps, [open an app locally](#open-locally), [open an app from a private Git repository](#open-private), or [import an app package](#import-app): -{{< figure src="/attachments/refguide/modeling/menus/file-menu/open-app-dialog/open-app.png" alt="Open App" class="no-border" width="700" >}} +{{< figure src="/attachments/refguide/modeling/menus/file-menu/open-app-dialog/open-app.png" alt="Open App dialog box" class="no-border" width="700" >}} -Apps can be located on the Team Server, on another Git server, or on the local disk. When opening an app from the Team Server or another Git server, Studio Pro will check whether you have already downloaded this app. If so, it will simply open it. If not, the app will be downloaded from the version control server first. +Apps can be located on the Team Server, on another Git server, or on the local disk. When you open an app from the Team Server or another Git server, Studio Pro checks whether you have already downloaded it. If so, Studio Pro opens it. If not, Studio Pro downloads the app from the version control server first. ## Opening an App ### Selecting an App {#select-app} -You can select an app from the list of your apps. Once you have selected an app, you can either choose a [branch line](/refguide/version-control/glossary/#branches) that you would like to open or click **Open in Studio Pro** and the branch that is indicated in the **Current Branch** column will open: +You can select an app from the list of your apps. After you select an app, you can choose a [branch line](/refguide/version-control/glossary/#branches) to open or click **Open in Studio Pro**. When you click **Open in Studio Pro**, Studio Pro opens the branch indicated in the **Current Branch** column. -{{< figure src="/attachments/refguide/modeling/menus/file-menu/open-app-dialog/select-app.png" class="no-border" width="700" >}} +{{< figure src="/attachments/refguide/modeling/menus/file-menu/open-app-dialog/select-app.png" alt="Select App screen showing list of apps with current branch column" class="no-border" width="700" >}} -### Opening App Locally {#open-locally} +### Opening an App Locally {#open-locally} -For opening an app you already have on disk, click **Open App Locally** in the left sidebar and point to the app file. +To open an app you already have on disk, click **Open App Locally** in the left sidebar and point to the app file. ### Opening a Private App {#open-private} -For opening an app you already have in a [Git On-Premises Version Control Server](/refguide/on-premises-git/), click **Open Private App** in the left sidebar. You will need to enter the **App repository address**, credentials for the repository, choose the **Development line** (branch) and indicate where you want to store it on the disk. +To open an app you already have in a [Git On-Premises Version Control Server](/refguide/on-premises-git/), click **Open Private App** in the left sidebar. Enter the **App repository address**, credentials for the repository, choose the **Development line** (branch), and indicate where you want to store it on the disk. -### Importing App Package {#import-app} +### Importing an App Package {#import-app} -You can also import an app package and open it. Click **Import App Package** in the left sidebar. For more information on how to import an app package, see [Import App Package](/refguide/import-app-package-dialog/). +You can also import an app package and open it. Click **Import App Package** in the left sidebar. For more information, see [Import App Package](/refguide/import-app-package-dialog/). ### Preferences @@ -51,9 +51,9 @@ Clicking **Preferences** opens a dialog box with a subset of the preferences you * Rendering * [Clone type](/refguide/preferences-dialog/#clone) -### Open Studio Pro +### Opening Studio Pro -Open the full Studio Pro IDE directly by clicking **Open Studio Pro** without selecting or creating an app. This gives you immediate access to development tools such as the Log Directory and the **Preferences** dialog. +You can open the full Studio Pro IDE directly by clicking **Open Studio Pro** without selecting or creating an app. This gives you immediate access to development tools such as the Log Directory and the **Preferences** dialog box. ## Read More From fbbc28f4e22cd77b53e6d4e0becc977999007c57 Mon Sep 17 00:00:00 2001 From: Quinn Tracy <142489060+quinntracy@users.noreply.github.com> Date: Wed, 6 May 2026 13:40:25 +0200 Subject: [PATCH 5/8] Review File menu doc --- .../solving-load-and-import-errors.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/content/en/docs/refguide/modeling/menus/file-menu/solving-load-and-import-errors.md b/content/en/docs/refguide/modeling/menus/file-menu/solving-load-and-import-errors.md index 57083a02fee..0e2e4dd1600 100644 --- a/content/en/docs/refguide/modeling/menus/file-menu/solving-load-and-import-errors.md +++ b/content/en/docs/refguide/modeling/menus/file-menu/solving-load-and-import-errors.md @@ -2,7 +2,7 @@ title: "Solve Load and Import Errors" url: /refguide/solving-load-and-import-errors/ weight: 11 -description: "Describes how to solve problems that may occur when opening an app." +description: "Describes how to solve load and import errors that occur when opening an app in Studio Pro." aliases: - /howto/solving-load-and-import-errors.html/ - /howto/solving-load-and-import-errors/ @@ -12,49 +12,49 @@ aliases: ## Introduction -This how-to will help you to solve problems that may occur when opening an app in Mendix Studio Pro. +This document describes how to solve problems that can occur when opening an app in Studio Pro. -One possible cause of errors that prevent loading is the usage of the [Mendix Model SDK](/apidocs-mxsdk/mxsdk/) for creating or editing the app. With the Mendix Model SDK it's possible to edit your app in such a way that its format becomes invalid, and in the process preventing Studio Pro from opening it. When this happens the following message is shown: +One possible cause of errors that prevent loading is using the [Mendix Model SDK](/apidocs-mxsdk/mxsdk/) to create or edit the app. The Mendix Model SDK can edit your app so its format becomes invalid, which prevents Studio Pro from opening it. When this happens, the following message appears: -{{< figure src="/attachments/refguide/modeling/menus/file-menu/solving-load-and-import-errors/18580055.png" class="no-border" >}} +{{< figure src="/attachments/refguide/modeling/menus/file-menu/solving-load-and-import-errors/18580055.png" alt="" class="no-border" >}} -Read on to find out how to determine the origin of these errors, and possible ways to solve them. +This document explains how to determine the origin of these errors and possible ways to solve them. ## Determining the Actual Problems -Click the **Details >>** button to show the actual errors that occurred while loading your app: +Click **Details** to show the actual errors that occurred while loading your app: -{{< figure src="/attachments/refguide/modeling/menus/file-menu/solving-load-and-import-errors/18580052.png" class="no-border" >}} +{{< figure src="/attachments/refguide/modeling/menus/file-menu/solving-load-and-import-errors/18580052.png" alt="" class="no-border" >}} These detailed messages tell you the following: -* The module and document in which the error occurred (for example, the domain model of the module 'Transportation'). -* The model element that caused the error (for example, the entity 'Vehicle'). -* What the actual problem is (for example, there's an index that doesn't contain any attributes, which is not permitted). +* The module and document where the error occurred (for example, the domain model of the module *Transportation*) +* The model element that caused the error (for example, the entity *Vehicle*) +* What the actual problem is (for example, an index that does not contain any attributes, which is not permitted) ## Determining the Origin of Your App -Before trying to solve the problems, it is useful to discover the origin of the app, because the errors may be introduced by someone else. Go through the following possibilities: +Before trying to solve the problems, discover the origin of the app because someone else may have introduced the errors. Go through the following possibilities: ### Is This a Team Server App? -If your app is a [Team Server](/developerportal/repository/team-server/) app, and you just did a [download or update](/refguide/using-version-control-in-studio-pro/) from the server, the problem may have been added in a revision that was recently committed to the Team Server. You can check who made the most recent commit on the [Team Server](/developerportal/repository/team-server/) page of your app in [Apps](https://sprintr.home.mendix.com). +If your app is a [Team Server](/developerportal/repository/team-server/) app and you just did a [download or update](/refguide/using-version-control-in-studio-pro/) from the server, the problem may have been added in a revision that was recently committed to the Team Server. You can check who made the most recent commit on the [Team Server](/developerportal/repository/team-server/) page of your app in [Apps](https://sprintr.home.mendix.com). If the latest change on your branch line was committed by someone other than yourself, please inform the person about the problem. ### Did You Obtain the Model from Someone Else? -If you received the model from someone else, for example as an app package (.mpk) file, then it is possible they created the model with the Mendix Model SDK. Please inform the person about the problem and ask them for a solution. +If you received the model from someone else (for example, as an app package (*.mpk*) file), they may have created the model with the Mendix Model SDK. Inform them about the problem and ask them for a solution. ### Did You Create the App Yourself? -If you created or edited the app yourself, you will want to read the next section of this how-to to find out what you can do to solve the problem. +If you created or edited the app yourself, read the next section to find out how to solve the problem. ## Solving the Problems -The problems described in this how-to can't be solved by editing the app in Mendix Studio Pro, because the app's file format is invalid in a way that prevents Studio Pro from reading it. This also means the problems are probably not caused by working on the app with Studio Pro. +The problems described in this document cannot be solved by editing the app in Studio Pro, because the app file format is invalid in a way that prevents Studio Pro from reading it. This also means the problems were probably not caused by working on the app with Studio Pro. -The most likely cause for these kinds of errors is a faulty script that was run on the Mendix Model SDK and, if this is the case, means you will also need to use the SDK to fix the problems. If you created or edited the model yourself using the Mendix Model SDK, you will probably know what to do to solve the problems by carefully reading the messages in the error dialog, and locating the relevant part of you SDK code, after which you can change your SDK script to make the app valid again. Be sure to check the [Mendix Model SDK documentation](/apidocs-mxsdk/mxsdk/) if you need information about constructing or altering models with SDK scripts. +The most likely cause for these kinds of errors is a faulty script that was run on the Mendix Model SDK. If this is the case, you need to use the SDK to fix the problems. If you created or edited the model yourself using the Mendix Model SDK, carefully read the messages in the error dialog and locate the relevant part of your SDK code. Then change your SDK script to make the app valid again. For information about constructing or altering models with SDK scripts, see the [Mendix Model SDK documentation](/apidocs-mxsdk/mxsdk/). ## Read More From 211925b11a6e34caa5980aafeb88edd61195da1b Mon Sep 17 00:00:00 2001 From: Quinn Tracy <142489060+quinntracy@users.noreply.github.com> Date: Wed, 6 May 2026 14:44:43 +0200 Subject: [PATCH 6/8] Review Help menu docs --- .../modeling/menus/help-menu/_index.md | 10 ++-- .../menus/help-menu/feedback-survey.md | 14 +++--- .../menus/help-menu/performance-logging.md | 48 +++++++++---------- .../modeling/menus/help-menu/profiling.md | 22 ++++----- 4 files changed, 47 insertions(+), 47 deletions(-) diff --git a/content/en/docs/refguide/modeling/menus/help-menu/_index.md b/content/en/docs/refguide/modeling/menus/help-menu/_index.md index c47b9a7db27..821bf423a62 100644 --- a/content/en/docs/refguide/modeling/menus/help-menu/_index.md +++ b/content/en/docs/refguide/modeling/menus/help-menu/_index.md @@ -1,12 +1,12 @@ --- title: "Help Menu" url: /refguide/help-menu/ -description: "Describes the Help Menu in Studio-Pro." +description: "Describes the Help menu in Studio Pro." --- ## Introduction -In the **Help** menu, you can ask questions and find answers to common problems you may experience while using Studio Pro. +The **Help** menu provides access to documentation, community support, and diagnostic tools for troubleshooting issues in Studio Pro. {{< figure src="/attachments/refguide/modeling/menus/help-menu/help-menu.png" alt="Help Menu" class="no-border" width="300" >}} @@ -21,6 +21,6 @@ The **Help** menu items are described in the table below: | **Ask a Question** | Opens the Mendix Community in the default web browser. | | **Submit Feedback...** | Opens the [Help us improve](/refguide/feedback-survey/) dialog to gather input on your experience using Mendix Studio Pro. | | **Support Tools** | Provides tools that can be used to share with Mendix Support, especially when you encounter issues with performance or high memory consumption. Support tools include the following:
| -| **Open Log File Directory** | Opens the log files written by Studio Pro that can be used to see what might be the reason something went wrong in Studio Pro. Studio Pro retains these logs for the last 30 days, with files organized from the most recent to the oldest. Log files can also be used to share with Mendix Support when you submit a ticket. | -| **Welcome** | Opens the **Welcome** page, which shows information about the version of Studio Pro being used, and links to release notes, Mendix platform blogs, and Maia Learn and Maia Chat. | -| **About Mendix Studio Pro** | Shows information about the current version of Mendix Studio Pro. | +| **Open Log File Directory** | Opens the log files written by Studio Pro. Studio Pro retains these logs for the last 30 days, with files organized from most recent to oldest. You can use log files to diagnose issues or share them with Mendix Support when you submit a ticket. | +| **Welcome** | Opens the **Welcome** page, which displays information about the current Studio Pro version and includes links to release notes, Mendix platform blogs, Maia Learn, and Maia Chat. | +| **About Mendix Studio Pro** | Displays information about the current version of Mendix Studio Pro. | diff --git a/content/en/docs/refguide/modeling/menus/help-menu/feedback-survey.md b/content/en/docs/refguide/modeling/menus/help-menu/feedback-survey.md index caa6185dfe0..cab1a8abdbf 100644 --- a/content/en/docs/refguide/modeling/menus/help-menu/feedback-survey.md +++ b/content/en/docs/refguide/modeling/menus/help-menu/feedback-survey.md @@ -1,35 +1,35 @@ --- title: "Feedback Survey" url: /refguide/feedback-survey/ -description: "Describes how to provide feedback on your experience using Studio Pro." +description: "Describes how you can provide feedback on your experience with Studio Pro." --- ## Introduction -The **Help us improve** dialog box allows you to provide feedback on your experience with Studio Pro. Your feedback helps the Mendix team understand user needs and improve the product. +Use the **Help us improve** dialog box to provide feedback on your experience with Studio Pro. Your feedback helps the Mendix team understand user needs and improve the product. {{< figure src="/attachments/refguide/modeling/menus/help-menu/feedback-survey/feedback-survey.png" class="no-border" >}} ## Feedback Survey Overview -The **Help us improve** dialog box opens periodically for you to provide feedback. You can rate your experience on a scale from -2 to 2, with -2 being the lowest score and 2 being the highest score. +The **Help us improve** dialog box opens periodically. You can rate your experience on a scale from -2 (lowest) to 2 (highest). ### Disabling the Feedback Survey -To disable the dialog box from opening, follow the steps below: +To disable the dialog box from opening, do the following: 1. Open the **Edit** menu. -2. Click **Preferences** > **Advanced** > **Feedback Survey**. +2. Click **Preferences** > **Advanced** > **Feedback Survey**. 3. Set **Show feedback survey periodically** to **No**. {{< figure src="/attachments/refguide/modeling/menus/help-menu/feedback-survey/disable-feedback-survey.png" class="no-border" >}} ### Submitting Feedback Manually -The dialog box can be opened manually by clicking **Help** > **Submit Feedback**: +To open the dialog box manually, click **Help** > **Submit Feedback**. {{< figure src="/attachments/refguide/modeling/menus/help-menu/feedback-survey/submit-feedback.png" class="no-border" >}} ### Send Feedback Button -The **Send Feedback** button is disabled until a score is selected. Once you choose a score, the button is enabled, allowing you to submit your feedback. You can provide justification for your score, but this is optional. +The **Send Feedback** button is disabled until you select a score. You can optionally provide justification for your score. diff --git a/content/en/docs/refguide/modeling/menus/help-menu/performance-logging.md b/content/en/docs/refguide/modeling/menus/help-menu/performance-logging.md index 431f843d302..c99164c5795 100644 --- a/content/en/docs/refguide/modeling/menus/help-menu/performance-logging.md +++ b/content/en/docs/refguide/modeling/menus/help-menu/performance-logging.md @@ -1,16 +1,16 @@ --- title: "Performance Logging" url: /refguide/performance-logging/ -description: "Describes how to enable, view and compare performance metrics to key functionalities in Studio Pro." +description: "Describes how to enable, view, and compare performance metrics for key functionalities in Studio Pro." --- ## Introduction -Studio Pro can log performance measurements to key functionalities (such as opening and closing microflow editors and moving items around in the App Explorer) that can help identify performance degradations. +Studio Pro can log performance measurements for key functionalities (such as opening and closing microflow editors and moving items in the App Explorer). These measurements help identify performance degradations. -The performance logging feature can be reached by clicking **Help** > **Support Tools** > **Performance logging**: +To access the performance logging feature, click **Help** > **Support Tools** > **Performance logging**: -{{< figure src="/attachments/refguide/modeling/menus/help-menu/performance-logging/performance-logging-menu.png" class="no-border" >}} +{{< figure src="/attachments/refguide/modeling/menus/help-menu/performance-logging/performance-logging-menu.png" alt="" class="no-border" >}} This tool enables you to do the following: @@ -21,50 +21,50 @@ This tool enables you to do the following: ## Enable Performance Logging -Check **Enable performance logging** to turn on performance logging. +Select **Enable performance logging** to turn on performance logging. -* If it is checked, performance logging is enabled and measurements are being logged -* If it is unchecked, performance logging is disabled +* If selected, performance logging is enabled and measurements are logged +* If cleared, performance logging is disabled ## Start a New Session of Performance Logging {#new-session} When you click **Start new session**, you will see the following dialog: -{{< figure src="/attachments/refguide/modeling/menus/help-menu/performance-logging/naming-new-session.png" class="no-border" width="650" >}} +{{< figure src="/attachments/refguide/modeling/menus/help-menu/performance-logging/naming-new-session.png" alt="" class="no-border" width="650" >}} You can specify a name for the new performance logging session that can be used later when comparing performance measurements: -{{< figure src="/attachments/refguide/modeling/menus/help-menu/performance-logging/compare-measurements.png" class="no-border" width="750" >}} +{{< figure src="/attachments/refguide/modeling/menus/help-menu/performance-logging/compare-measurements.png" alt="" class="no-border" width="750" >}} ## View Performance Measurements When you click **Show measurements**, you will see the following dialog: -{{< figure src="/attachments/refguide/modeling/menus/help-menu/performance-logging/view-measurements.png" class="no-border" width="700" >}} +{{< figure src="/attachments/refguide/modeling/menus/help-menu/performance-logging/view-measurements.png" alt="" class="no-border" width="700" >}} -The **Measurement Source** field allows you to choose the source for the performance measurements you want to view: a previously created logging session or a log file where the measurements were logged. +The **Measurement Source** field lets you choose the source for the performance measurements you want to view: a previously created logging session or a log file where the measurements were logged. -The dialog displays the data grid with the measurements: +The dialog displays a data grid with the following measurements: -* **ID** – displays a unique ID for the measurement that is being logged -* **Category** – displays the category of the measurement, which are split to categories (such as measurements related to documents and UI) -* **Description** – displays a description for the measurement that is being logged -* **Duration** – displays the execution time (in milliseconds) of the currently logged operation +* **ID** – a unique ID for the measurement that is being logged +* **Category** – the category of the measurement (such as measurements related to documents and UI) +* **Description** – a description of the measurement that is being logged +* **Duration** – the execution time (in milliseconds) of the currently logged operation -The **Generate Report** button in the bottom-right corner allows you to view the results in text editor documents (such as Notepad). +The **Generate Report** button in the lower-right corner lets you view the results in text editor documents (such as Notepad). ## Compare Performance Measurements When you click **Compare measurements**, you will see the following dialog: -{{< figure src="/attachments/refguide/modeling/menus/help-menu/performance-logging/compare-measurements-dialog.png" class="no-border" >}} +{{< figure src="/attachments/refguide/modeling/menus/help-menu/performance-logging/compare-measurements-dialog.png" alt="" class="no-border" >}} -This allows you to compare between two different performance measurements sources (for example, the installed version and log file). +This lets you compare two different performance measurement sources (for example, the installed version and log file). -The rows in the grid are colored according to the following indication: +The rows in the grid are colored according to the following indicators: -* Gray – there is no change in the execution time -* Green – there was an improvement in the execution time -* Red – there was a degradation in the execution time +* Gray – no change in execution time +* Green – improvement in execution time +* Red – degradation in execution time -The **Generate Report** at the bottom-right corner allows you to view the results in text editor documents. +The **Generate Report** button in the lower-right corner lets you view the results in text editor documents. diff --git a/content/en/docs/refguide/modeling/menus/help-menu/profiling.md b/content/en/docs/refguide/modeling/menus/help-menu/profiling.md index c70612d7e9a..e0a903fcc6c 100644 --- a/content/en/docs/refguide/modeling/menus/help-menu/profiling.md +++ b/content/en/docs/refguide/modeling/menus/help-menu/profiling.md @@ -1,7 +1,7 @@ --- title: "Profiling" url: /refguide/profiling/ -description: "Describes how to run a performance profiler session on the local machine from within Studio-Pro." +description: "Describes how to run a performance profiler session on the local machine from within Studio Pro." --- ## Introduction @@ -12,30 +12,30 @@ These features are not yet supported on native macOS machines. The **Profiling** section of the **Help** menu > **Support Tools** allows you to run a performance profiler session and to capture a memory snapshot: -{{< figure src="/attachments/refguide/modeling/menus/help-menu/profiling/profiling-menu.png" class="no-border" width="500" >}} +{{< figure src="/attachments/refguide/modeling/menus/help-menu/profiling/profiling-menu.png" alt="Profiling menu options in Studio Pro" class="no-border" width="500" >}} ### Run a Performance Profiler Session (Start Profiling/Stop Profiling) -To investigate performance issues that are reproduced on your local machine, you can run a performance profiler session from within Studio Pro without installing the actual profiler on your machine. This session generates a report written to disk, which you can then send to the Mendix Support teams. Mendix developers will load this report on their machines to investigate the performance issues you experienced locally. +To investigate performance issues on your local machine, you can run a performance profiler session from within Studio Pro without installing a separate profiler. The session generates a report written to disk, which you can send to Mendix Support. Mendix developers load this report to investigate the performance issues you experienced. -When you click **Start profiling**, you are presented with a dialog box that asks you to choose a location on the local disk to save the performance reports to. Choose a local spot on your disk and avoid selecting a network drive. +When you click **Start profiling**, a dialog box prompts you to choose a location on the local disk to save the performance reports. Choose a local directory and avoid selecting a network drive. -Then, perform the operations that lead to a degrading performance or slowness. +Then, perform the operations that cause slow performance. -When you are done, click **Profiling** > **Stop profiling**. Zip all the files you can find in the directory that are opened (the directory you chose when clicking **Start profiling**), then send the archive to Mendix Support. +When you are done, click **Profiling** > **Stop profiling**. Zip all the files in the directory that opens (the directory you chose when clicking **Start profiling**), and then send the archive to Mendix Support. {{% alert color="info" %}} -Profiling can be started at any time (when you start to see performance issues) and does not need to start immediately after running Studio Pro. +You can start profiling at any time, not just immediately after running Studio Pro. Start profiling when you see performance issues. {{% /alert %}} ### Capture Memory Snapshot -You can capture a snapshot of memory consumed by Studio Pro. The snapshot is written to disk, which you can then send to the Mendix Support teams. Mendix developers will load this snapshot on their machines to investigate the issues related to memory consumption. +You can capture a snapshot of memory consumed by Studio Pro. The snapshot is written to disk, which you can send to Mendix Support. Mendix developers load this snapshot to investigate issues related to memory consumption. -When you click **Profiling** > **Capture Memory Snapshot**, you see a dialog box that asks you to choose a location on the local disk to save the memory snapshot to. Avoid selecting a network drive. +When you click **Profiling** > **Capture Memory Snapshot**, a dialog box prompts you to choose a location on the local disk to save the memory snapshot. Avoid selecting a network drive. -When the operation is complete, zip the file from the directory that are opened (the directory you chose when clicking **Capture Memory Snapshot**), then send the archive to Mendix Support. +When the operation completes, zip the file from the directory that opens (the directory you chose when clicking **Capture Memory Snapshot**), and then send the archive to Mendix Support. {{% alert color="info" %}} -The **Capture Memory Snapshot** menu is not available when a performance profiler session is in progress. Stop the running session to capture memory snapshot. +The **Capture Memory Snapshot** menu is not available when a performance profiler session is in progress. Stop the running session to capture a memory snapshot. {{% /alert %}} From 60716216f5371db7187712029d8078b5613a35f7 Mon Sep 17 00:00:00 2001 From: Quinn Tracy <142489060+quinntracy@users.noreply.github.com> Date: Wed, 6 May 2026 16:19:55 +0200 Subject: [PATCH 7/8] Review Run menu --- .../modeling/menus/run-menu/_index.md | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/content/en/docs/refguide/modeling/menus/run-menu/_index.md b/content/en/docs/refguide/modeling/menus/run-menu/_index.md index 268c1a7b102..677d4af29a2 100644 --- a/content/en/docs/refguide/modeling/menus/run-menu/_index.md +++ b/content/en/docs/refguide/modeling/menus/run-menu/_index.md @@ -7,28 +7,28 @@ weight: 35 ## Introduction -The **Run** menu allows you to deploy and monitor your app: +Use the **Run** menu to deploy and monitor your app: {{< figure src="/attachments/refguide/modeling/menus/run-menu/run-menu.png" alt="Run Menu" class="no-border" width="400" >}} -## Menu Items Overview +## Menu Items -The **Run** menu items are described in the table below: +The following table describes the **Run** menu items: | Menu Item | Description | Shortcut Key | | --- | --- | --- | -| **Run Locally** | Runs the app locally so you can view the app. | F5 | +| **Run Locally** | Runs the app locally so you can view it. | F5 | | **Stop** | Stops the currently running app. | Shift + F5 | -| **Configuration** | Sets the configuration level (**Default**). | | -| **Default Log Level** | Allows setting the default log level before running the app locally. The options are **Trace**, **Debug**, **Info** (default), **Warning**, **Error**, **Critical**. | | -| **Publish** | Deploys the app to cloud. The **Console** pane is activated and this shows the output of the server that runs the app. | | -|**Run on Cloud Foundry (⚠ deprecated)** | Opens the **Edit Cloud Foundry Settings** dialog box so you can run your app on Cloud Foundry. | | -| **Edit Cloud Foundry Settings (⚠ deprecated)** | Opens the **Edit Cloud Foundry Settings** dialog box so you can edit your Cloud Foundry settings. For more information on this dialog box, see [Edit Cloud Foundry Settings](/refguide/edit-cloud-foundry-settings-dialog/). | | -| **Debug** | Allows you to connect the [Debugger](/refguide/view-menu/#debugger). | | -| **Responsive Web** | Shows the web client for the currently running app in the browser. | F9 | -| **Tablet Web** | Shows the tablet mobile client for the currently running app in the browser. | Ctrl + Shift + F9 | -| **Phone Web** | Shows the mobile client for the currently running app in the browser. | Ctrl + F9 | -| **View on your device** | Provides a link to allow you to view the app. | | +| **Configuration** | Sets the configuration level to **Default**. | | +| **Default Log Level** | Sets the default log level before running the app locally. Options are **Trace**, **Debug**, **Info** (default), **Warning**, **Error**, and **Critical**. | | +| **Publish** | Deploys the app to the cloud. The **Console** pane opens and shows the output of the server that runs the app. | | +| **Run on Cloud Foundry (⚠ deprecated)** | Opens the **Edit Cloud Foundry Settings** dialog box so you can run your app on Cloud Foundry. | | +| **Edit Cloud Foundry Settings (⚠ deprecated)** | Opens the **Edit Cloud Foundry Settings** dialog box so you can edit your Cloud Foundry settings. For more information, see [Edit Cloud Foundry Settings](/refguide/edit-cloud-foundry-settings-dialog/). | | +| **Debug** | Connects the [Debugger](/refguide/view-menu/#debugger). | | +| **Responsive Web** | Opens the web client for the currently running app in the browser. | F9 | +| **Tablet Web** | Opens the tablet mobile client for the currently running app in the browser. | Ctrl + Shift + F9 | +| **Phone Web** | Opens the mobile client for the currently running app in the browser. | Ctrl + F9 | +| **View on your device** | Provides a link to view the app on your device. | | ## Read More From 9c28a8321ff831fb886f64665ed81a666cd8364d Mon Sep 17 00:00:00 2001 From: Quinn Tracy <142489060+quinntracy@users.noreply.github.com> Date: Wed, 6 May 2026 16:56:02 +0200 Subject: [PATCH 8/8] Review Language menu docs --- .../menus/translatable-texts/_index.md | 54 +++++++-------- .../advanced-translations-export.md | 12 ++-- .../advanced-translations-import.md | 20 +++--- .../menus/translatable-texts/batch-replace.md | 66 +++++++++---------- 4 files changed, 76 insertions(+), 76 deletions(-) diff --git a/content/en/docs/refguide/modeling/menus/translatable-texts/_index.md b/content/en/docs/refguide/modeling/menus/translatable-texts/_index.md index 82f246d9e9d..e4ec146e6e8 100644 --- a/content/en/docs/refguide/modeling/menus/translatable-texts/_index.md +++ b/content/en/docs/refguide/modeling/menus/translatable-texts/_index.md @@ -7,7 +7,7 @@ weight: 50 ## Introduction -Mendix is designed so that it is easy to present the same information to users who have different language requirements. To support this, all texts that are presented to the end-user can be translated to different languages. +Mendix makes it easy to present the same information to users who have different language requirements. All text presented to end users can be translated to different languages. These *translatable texts* include the following: @@ -30,15 +30,15 @@ When you have multiple languages set up in your app, you can choose a language t * using the drop-down in the lower-right corner of Studio Pro's main window * using the Ctrl + L or Ctrl + Shift + L keyboard shortcut combinations, which cycle through the configured languages -When working in a language which is not the default, you can identify texts that have not been translated yet. These show the text in the default language between angle brackets. For example, ``. You can replace the text with the appropriate translation, and it will be replaced for the currently selected language. +When working in a language that is not the default, you can identify texts that have not been translated yet. These show the text in the default language between angle brackets. For example, ``. When you replace the text with the appropriate translation, it updates for the currently selected language. If you edit your app to add new widgets while not in the default language, any new translatable texts for those widgets will be added to the current language. The text in the default language will either be left blank or will have the placeholder text for the widget. All untranslated texts will be displayed in the default language when you run the application. -English (US) and Dutch translations are added by default even if you do not use these languages in your app. When you add a new element (for example, a button), it will get an English and Dutch translation in the system, but you will not see it until you add those languages. You may want to delete all English and Dutch translations if you do not plan to have your app in these languages. Before deleting English (US), make sure you have another default language set up. For more information on how to delete translations, see the [Delete](/refguide/language-operations/#delete) section in *Language Operations*. +English (US) and Dutch translations are added by default even if you do not use these languages in your app. When you add a new element (for example, a button), it gets an English and Dutch translation in the system, but you will not see it until you add those languages. You may want to delete all English and Dutch translations if you do not plan to have your app in these languages. Before deleting English (US), make sure you have another default language set up. For more information on how to delete translations, see the [Delete](/refguide/language-operations/#delete) section in *Language Operations*. -If you plan to export your module/app as an add-on/solution, the best practice is to remove default Dutch translations to avoid confusion for your customers in case they plan to translate their app to Dutch. For more information, see the [Exporting Add-on Modules and Solutions](/refguide/configure-add-on-and-solution-modules/#export) section in *Configuring Add-on and Solution Modules for Publishing*. +If you plan to export your module or app as an add-on or solution, the best practice is to remove default Dutch translations to avoid confusion for your customers in case they plan to translate their app to Dutch. For more information, see the [Exporting Add-on Modules and Solutions](/refguide/configure-add-on-and-solution-modules/#export) section in *Configuring Add-on and Solution Modules for Publishing*. {{% alert color="info" %}} If there is no text in the default language, the end-user will see `[no translation]`. If you want the text to be blank, set the default language text to be a space rather than empty. @@ -50,43 +50,43 @@ The **Language** menu allows you to manage additional languages and translations {{< figure src="/attachments/refguide/modeling/menus/translatable-texts/language-menu.png" alt="Language Menu" class="no-border" >}} -### Menu Items Overview +### Menu Items -The **Language** menu items are described in the table below: +The following table describes the **Language** menu items: | Menu Item | Description | Shortcut Key | |-------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| --- | -| **Current Language** | Choose the current language from one of the languages set up in **Language Settings…**. | *None* | -| **Select Previous Language** | Choose the previous language in the list of languages chosen in **Language Settings…**. | Ctrl + Shift + L | -| **Select Next Language** | Choose the next language in the list of languages chosen in **Language Settings…**. | Ctrl + L | -| [Language Settings…](/refguide/language-settings/) | Choose which languages are supported by the app and configure date and time settings. | *None* | -| [Batch Replace…](/refguide/batch-replace/) | Change all occurrences of chosen translatable texts in the current language where they are identical. | *None* | -| [Batch Translate…](/refguide/batch-translate/) | Add and edit translations from a selected source language to a selected target language | *None* | -| [Language Operations…](/refguide/language-operations/) | Manipulate (for example, copy) translations between languages. | *None* | -| [Advanced Translations Import](/refguide/advanced-translations-import/) | Import translations from Excel or PO files. | *None* | -| [Advanced Translations Export](/refguide/advanced-translations-export/) | Export translations as Excel or PO files. | *None* | +| **Current Language** | Chooses the current language from one of the languages set up in **Language Settings…**. | *None* | +| **Select Previous Language** | Chooses the previous language in the list of languages from **Language Settings…**. | Ctrl + Shift + L | +| **Select Next Language** | Chooses the next language in the list of languages from **Language Settings…**. | Ctrl + L | +| [Language Settings…](/refguide/language-settings/) | Chooses which languages the app supports and configures date and time settings. | *None* | +| [Batch Replace…](/refguide/batch-replace/) | Changes all occurrences of chosen translatable texts in the current language where they are identical. | *None* | +| [Batch Translate…](/refguide/batch-translate/) | Adds and edits translations from a selected source language to a selected target language. | *None* | +| [Language Operations…](/refguide/language-operations/) | Manipulates (for example, copies) translations between languages. | *None* | +| [Advanced Translations Import](/refguide/advanced-translations-import/) | Imports translations from Excel or PO files. | *None* | +| [Advanced Translations Export](/refguide/advanced-translations-export/) | Exports translations as Excel or PO files. | *None* | ## Setting the End-User's Language -The language which is displayed to the end-user is determined by the **Language** object which is associated with the **User** object for the current end-user via the association **User_Language**. +The language displayed to the end-user is determined by the **Language** object associated with the **User** object for the current end-user via the association **User_Language**. If the associated language is not one of those set in the app, then the end-user will see pages in the default language. -If the end-user is not associated with a language, for example they are an anonymous user, the language used depends on the user's browser or operating system settings. If the language requested is not present up in the app, then the app's default language will be used. The requested language will be as follows: +If the end-user is not associated with a language (for example, they are an anonymous user), the language used depends on the user's browser or operating system settings. If the requested language is not present in the app, then the app's default language is used. The requested language is as follows: -* for web apps – the first language which matches a language set in the app based on the browser's preferred order of languages -* for mobile apps – the operating system language +* For web apps – the first language that matches a language set in the app based on the browser's preferred order of languages. +* For mobile apps – the operating system language. {{< figure src="/attachments/refguide/modeling/menus/translatable-texts/user-language-domain-model.png" alt="System Domain Model for User and Language" class="no-border" width="750" >}} -If you allow end-users to change their display language within the app, the changes will not be applied immediately. This is because the translatable texts for the app are already set to the end-users original language. +If you allow end-users to change their display language within the app, the changes are not applied immediately. This is because the translatable texts for the app are already set to the end-user's original language. There are two options to ensure that the language is changed: -1. Ask the end-user to do something manually - * sign out and sign in again - * use their browser's refresh command -2. Force Mendix to reload the page – for example by doing the following: +1. Ask the end-user to do something manually: + * Sign out and sign in again + * Use their browser's refresh command +2. Force Mendix to reload the page, for example, by doing the following: 1. Add the platform supported widget [HTML / JavaScript Snippet](https://marketplace.mendix.com/link/component/56/) to your app. 2. Create a pop-up page. 3. Place the HTMLSnippet widget on the pop-up page. @@ -95,15 +95,15 @@ There are two options to ensure that the language is changed: {{< figure src="/attachments/refguide/modeling/menus/translatable-texts/reload-with-state.png" alt="System Domain Model for User and Language" class="no-border" width="600" >}} - {{% alert color="warning" %}}When reloading the page, the language change must be made for the `$currentUser` object of entity type `User`. It will not change the language immediately if you use an association to a specialization of the `User` entity, such as `Administration.Account`.{{% /alert %}} + {{% alert color="warning" %}}When reloading the page, the language change must be made for the `$currentUser` object of entity type `User`. The language will not change immediately if you use an association to a specialization of the `User` entity, such as `Administration.Account`.{{% /alert %}} {{% alert color="info" %}} -The above only applies to pages *within* your Mendix application (meaning, pages that are created in Studio Pro). The labels for static pages (such as the *index.html* and *login.html* pages in the **theme** folder of your app) are generated when you create a deployment package using the default language of your app. The labels on those pages will not change for different users, they will always be the same. +The above only applies to pages *within* your Mendix application (meaning pages that are created in Studio Pro). The labels for static pages (such as the *index.html* and *login.html* pages in the **theme** folder of your app) are generated when you create a deployment package using the default language of your app. The labels on those pages will not change for different users; they will always be the same. {{% /alert %}} ## Read More -* [Translating Your App Content](/refguide/translate-your-app-content/) – a worked example of adding a translation +* [Translating Your App Content](/refguide/translate-your-app-content/) – a worked example of adding a translation * [Using Translatable Validation Messages](/refguide/translatable-validation-messages/) * [Change language by clicking a link](https://community.mendix.com/link/questions/91821) – explanations and ideas in the Mendix Community for refreshing the page when the language is changed * [Anonymous User Journey](https://community.mendix.com/link/questions/91676) – a discussion in the Mendix Community about switching languages for anonymous end-users diff --git a/content/en/docs/refguide/modeling/menus/translatable-texts/advanced-translations-export.md b/content/en/docs/refguide/modeling/menus/translatable-texts/advanced-translations-export.md index bfc55f99db0..513756bdd7b 100644 --- a/content/en/docs/refguide/modeling/menus/translatable-texts/advanced-translations-export.md +++ b/content/en/docs/refguide/modeling/menus/translatable-texts/advanced-translations-export.md @@ -6,20 +6,20 @@ weight: 60 ## Introduction -**Advanced Translations Export** allows you to export translations to Microsoft Excel (*.xlsx*) or PO (*.po*) format files. +Use **Advanced Translations Export** to export translations to Microsoft Excel (*.xlsx*) or PO (*.po*) format files. ## Using Advanced Translations Export -To export languages, from the top-bar menu, select **Language > Advanced Translations Export** and choose one of the following options: +To export languages, from the top bar menu, select **Language > Advanced Translations Export** and choose one of the following options: -* **As Excel (.xlsx) file** – export translations to a Microsoft Excel (*.xlsx*) format file -* **As PO (.po) files** – export translations to PO (*.po*) format files +* **As Excel (.xlsx) file** – exports translations to a Microsoft Excel (*.xlsx*) format file +* **As PO (.po) files** – exports translations to PO (*.po*) format files {{< figure src="/attachments/refguide/modeling/menus/translatable-texts/advanced-translations-export.png" alt="Advanced Translations Export" >}} When you select an option, a directory selector appears. Select the directory containing the files you want to export. -A pop-up will appear confirming the start of the export. +A pop-up appears confirming the start of the export. ### Export as Excel @@ -43,7 +43,7 @@ The formats of the Excel file for **Advanced Translations Export** and [Advanced ### Export as PO -Click **As PO (`*.po*`) files** and select a directory for the export. Studio Pro will create a subdirectory named in the format `Export_{app-name}_Po_{time-stamp}`. The translations will be saved as PO (`*.po*`) format files. The files will be named in the format `{app-name}-{language}.po` (e.g. *App-en_US.po*). +Click **As PO (`*.po*`) files** and select a directory for the export. Studio Pro creates a subdirectory named in the format `Export_{app-name}_Po_{time-stamp}`. The translations are saved as PO (`*.po*`) format files. The files are named in the format `{app-name}-{language}.po` (for example, *App-en_US.po*). {{% alert color="warning" %}} The formats of the PO files for **Advanced Translations Export** and [Advanced Translations Import](/refguide/advanced-translations-import/) are similar. diff --git a/content/en/docs/refguide/modeling/menus/translatable-texts/advanced-translations-import.md b/content/en/docs/refguide/modeling/menus/translatable-texts/advanced-translations-import.md index d51ab7edf80..1dcf7d8320f 100644 --- a/content/en/docs/refguide/modeling/menus/translatable-texts/advanced-translations-import.md +++ b/content/en/docs/refguide/modeling/menus/translatable-texts/advanced-translations-import.md @@ -6,26 +6,26 @@ weight: 50 ## Introduction -**Advanced Translations Import** allows you to import translations from Microsoft Excel (*.xlsx*) or PO (*.po*) format files. +Use **Advanced Translations Import** to import translations from Microsoft Excel (*.xlsx*) or PO (*.po*) format files. ## Using Advanced Translations Import -To import languages, from the top-bar menu, select **Language > Advanced Translations Import** and choose one of the following options: +To import languages, in the top-bar menu, go to **Language > Advanced Translations Import** and choose one of the following options: -* **From Excel (.xlsx) file** – import translations from a Microsoft Excel (*.xlsx*) format file -* **From PO (.po) files** – import translations from PO (*.po*) format files +* **From Excel (.xlsx) file** – imports translations from a Microsoft Excel (*.xlsx*) format file. +* **From PO (.po) files** – imports translations from PO (*.po*) format files. {{< figure src="/attachments/refguide/modeling/menus/translatable-texts/advanced-translations-import.png" alt="Advanced Translations Import" >}} -When you select an option, a directory selector appears. Select the directory containing the files you want to import. +When you select an option, a directory selector appears. Select the directory containing the files you want to import. -A pop-up will appear confirming the start of the import. +A confirmation pop-up window appears when the import starts. ### Import from Excel -Click **From Excel (.xlsx) file** and select a directory containing a Microsoft Excel (*.xlsx*) format file. The file needs to meet the following requirements: +Click **From Excel (.xlsx) file** and select a directory containing a Microsoft Excel (*.xlsx*) format file. The file must meet the following requirements: -* The file must be named in the format `{app-name}-translations.xlsx` (e.g. *App-translations.xlsx*) +* The file must be named in the format `{app-name}-translations.xlsx` (for example, *App-translations.xlsx*). * The file must have the following columns: * `Mendix Reference` * `Module` @@ -45,13 +45,13 @@ The formats of the Excel file for **Advanced Translations Import** and [Advanced ### Import from PO -Click **From PO (.po) files** and select a directory containing PO (*.po*) format files. The files must be named in the format `{app-name}-{language}.po` (e.g. *App-en_US.po*). +Click **From PO (.po) files** and select a directory containing PO (*.po*) format files. The files must be named in the format `{app-name}-{language}.po` (for example, *App-en_US.po*). {{% alert color="warning" %}} The formats of the PO files for **Advanced Translations Import** and [Advanced Translations Export](/refguide/advanced-translations-export/) are similar. {{% /alert %}} -After completion, a confirmation pop-up appears. If the operation fails, a failure pop-up is displayed instead. +After the import completes, a confirmation pop-up window appears. If the operation fails, a failure pop-up window appears instead. {{% alert color="warning" %}} Do not close the app while the import is running. diff --git a/content/en/docs/refguide/modeling/menus/translatable-texts/batch-replace.md b/content/en/docs/refguide/modeling/menus/translatable-texts/batch-replace.md index c39781537f8..b4d41a24eec 100644 --- a/content/en/docs/refguide/modeling/menus/translatable-texts/batch-replace.md +++ b/content/en/docs/refguide/modeling/menus/translatable-texts/batch-replace.md @@ -6,92 +6,92 @@ weight: 20 ## Introduction -**Batch replace** works on the currently selected language and allows you to replace any existing texts with a new one. +Use **Batch Replace** to replace existing text in the currently selected language. -There are a number of reasons that you may wish to do this: +This feature is useful when you need to do the following: -* The same text should appear in different places in the app, however, it has been entered inconsistently, for example sometimes with capital letters and sometimes not — if you reuse existing text across your app, this will improve the user experience -* If all occurrences of a piece of text are identical, you only need to enter the translation once — this saves time and improves consistency -* If you find better wording for a common label or text, you can change them all at once with a single command +* Standardize inconsistent text that appears in multiple places (for example, text that sometimes uses capital letters and sometimes does not) — reusing text improves the user experience +* Consolidate identical text so you only need to enter the translation once — this saves time and improves consistency +* Update all occurrences of common labels or text with better wording in a single operation {{< figure src="/attachments/refguide/modeling/menus/translatable-texts/batch-replace/batch-replace.png" class="no-border" width="600" >}} ## Using Batch Replace -Batch replace works on the currently selected language, so first you should select the language you want to work on. For more information, see the [Working in the Currently Selected Language](/refguide/translatable-texts/#selected-language) section in *Language Menu*. +Batch Replace works on the currently selected language. First, select the language you want to work on. For more information, see [Working in the Currently Selected Language](/refguide/translatable-texts/#selected-language) in *Language Menu*. -### Documents/modules +### Documents/Modules -You can select one or more modules you want to use for batch translate. For example, you may want to ignore texts from imported and system modules in the default language, or concentrate on translating just the system messages into your chosen language. +You can select one or more modules to use for Batch Replace. For example, you may want to ignore text from imported and system modules in the default language, or concentrate on replacing only the system messages in your chosen language. -Click **Select…** and check the modules you want to work on. +Click **Select** and select the modules you want to work on. {{< figure src="/attachments/refguide/modeling/menus/translatable-texts/batch-replace/batch-replace-modules.png" alt="Module selection screen" class="no-border" width="400" >}} -The default is to work on all modules in the app. +By default, all modules in the app are included. ### Search -To search for phrases that are similar, type what you want to search for. +To search for similar phrases, type what you want to search for. {{< figure src="/attachments/refguide/modeling/menus/translatable-texts/batch-replace/batch-replace-search.png" alt="Batch translate search" class="no-border" width="600" >}} -By default, all the translatable text from the selected module (or modules) will be shown. +By default, all translatable text from the selected modules is shown. -Each found text will be displayed in the **Text** column. -The **#** column shows the number of times it occurs in the selected module (or modules). +Each found text is displayed in the **Text** column. +The **#** column shows the number of times it occurs in the selected modules. -If you select a line, you can look in the **Show occurrence** section to see the **Object** containing the text and the **Document** it appears in. Double-clicking or clicking **Show occurrence** will open the document and select the object so you can easily see the context. +If you select a line, you can view the **Show occurrence** section to see the **Object** containing the text and the **Document** where it appears. Double-clicking the line or clicking **Show occurrence** opens the document and selects the object so you can easily see the context. {{% alert color="success" %}} -Tip: move the dialog box to one side to get a better look at the document. +Move the dialog box to one side to get a better view of the document. {{% /alert %}} ### Replace With -In **Replace with**, type new text that you want to use instead of the existing text. Click **Replace** to confirm the replacement. +In **Replace with**, type new text to use instead of the existing text. Click **Replace** to confirm the replacement. {{< figure src="/attachments/refguide/modeling/menus/translatable-texts/batch-replace/batch-replace-replace.png" class="no-border" width="600" >}} -Identical replacement and original texts will be combined into a single entry. +Identical replacement and original text are combined into a single entry. {{< figure src="/attachments/refguide/modeling/menus/translatable-texts/batch-replace/batch-replace-replaced.png" alt="Show combined entries" class="no-border" width="600" >}} ## Exporting and Importing Text -If you want to translate a language outside Studio Pro, you can export the translatable texts to the Microsoft Excel (*.xlsx*) format, make changes, and then import the changes from the updated Excel file. +If you want to replace text outside Studio Pro, you can export the translatable text to Microsoft Excel (*.xlsx*) format, make changes, and then import the changes from the updated Excel file. -This is particularly useful if you are working on multiple apps and have already got text for, say, the system modules which you want to reuse. +This is particularly useful if you are working on multiple apps and already have text for the system modules that you want to reuse. ### Export to Excel -Click **Export to Excel…** to export the currently displayed text items to a Microsoft Excel (*.xlsx*) format file. +Click **Export to Excel** to export the currently displayed text items to a Microsoft Excel (*.xlsx*) format file. -The file will be in the format shown below: +The file has the format shown below: {{< figure src="/attachments/refguide/modeling/menus/translatable-texts/batch-replace/batch-replace-excel.png" alt="Sample Excel file" class="no-border" width="600" >}} -**Row 1** – *Filter:* indicates the modules which are included in the exported file. +**Row 1** – *Filter:* indicates the modules included in the exported file -**Row 2** – indicates the language. The first column represents the current text, the second column the *replace with* text. +**Row 2** – indicates the language. The first column represents the current text, and the second column represents the *replace with* text -**Rows 3+** – show the current texts +**Rows 3+** – show the current text -You can make changes in column B which will be processed if the file is imported. +You can make changes in column B, which are processed when the file is imported. ### Import from Excel -Click **Import from Excel…** to import a correctly-constructed Microsoft Excel (*.xlsx*) format file. +Click **Import from Excel** to import a correctly constructed Microsoft Excel (*.xlsx*) format file. This does the following: -* The selected module (or modules) are set to the ones in the *Filter:* line of the file -* Any texts which are empty in column B will be ignored -* Any texts in column A which do not match translatable texts in the selected module (or modules) will be ignored -* Any text in column B which is not ignored is entered into the **Replace with** column +* The selected modules are set to the ones in the *Filter:* line of the file +* Any text that is empty in column B is ignored +* Any text in column A that does not match translatable text in the selected modules is ignored +* Any text in column B that is not ignored is entered into the **Replace with** column -Changes will only be made if you click **Replace**. +Changes are only made when you click **Replace**. {{% alert color="warning" %}} -The formats of the Excel files for batch replace and batch translate are similar. You will be warned if you try to import a batch translate file or a batch replace file with the wrong language but you can still import it if you ignore the warning. +The formats of the Excel files for Batch Replace and Batch Translate are similar. You receive a warning if you try to import a Batch Translate file or a Batch Replace file with the wrong language, but you can still import it if you ignore the warning. {{% /alert %}}