Skip to content

Commit 903e98d

Browse files
committed
Review File menu docs
1 parent d7ce1fa commit 903e98d

5 files changed

Lines changed: 64 additions & 67 deletions

File tree

content/en/docs/refguide/modeling/menus/file-menu/_index.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "File Menu"
33
url: /refguide/file-menu/
4-
description: "Describes the File Menu in Studio Pro."
4+
description: "Describes the File menu in Studio Pro and its options for managing documents and apps."
55
weight: 5
66
---
77

@@ -17,20 +17,20 @@ The **File** menu items are described in the table below:
1717

1818
| Menu Item | Description | Shortcut Key |
1919
| -------------------------- | ------------------------------------------------------------ | ------------------------------------------------- |
20-
| **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/). | <kbd>Ctrl</kbd> + <kbd>N</kbd> |
21-
| **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/). | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>N</kbd> |
22-
| **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/). | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>O</kbd> |
20+
| **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/). | <kbd>Ctrl</kbd> + <kbd>N</kbd> |
21+
| **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/). | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>N</kbd> |
22+
| **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/). | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>O</kbd> |
2323
| **Recent Apps** | Shows a list of recently opened apps for quick opening. | |
24-
| **Save** | Saves the changes in the currently active document tab. | <kbd>Ctrl</kbd> + <kbd>S</kbd> |
25-
| **Save All** | Saves the changes in all documents that are open. | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> |
26-
| **Close** | Closes the current document. You will be asked to save or discard changes when needed. | <kbd>Ctrl</kbd> + <kbd>W</kbd> |
27-
| **Close All** | Closes all document tabs. You will be asked to save or discard changes when needed. | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>W</kbd> |
28-
| **Close App** | Closes the currently open App and returns to the home page. | |
29-
| **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. | |
30-
| **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. | |
31-
| **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/). | |
32-
| **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/). | |
33-
| **Exit** | Closes Studio Pro | |
24+
| **Save** | Saves changes in the currently active document tab. | <kbd>Ctrl</kbd> + <kbd>S</kbd> |
25+
| **Save All** | Saves changes in all open documents. | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> |
26+
| **Close** | Closes the current document. If there are unsaved changes, you are asked to save or discard them. | <kbd>Ctrl</kbd> + <kbd>W</kbd> |
27+
| **Close All** | Closes all document tabs. If there are unsaved changes, you are asked to save or discard them. | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>W</kbd> |
28+
| **Close App** | Closes the currently open app and returns to the home page. | |
29+
| **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. | |
30+
| **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. | |
31+
| **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/). | |
32+
| **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/). | |
33+
| **Exit** | Closes Studio Pro. | |
3434

3535
## Read More
3636

content/en/docs/refguide/modeling/menus/file-menu/export-app-package-dialog.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,56 +9,53 @@ aliases:
99

1010
## Introduction
1111

12-
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.
12+
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.
1313

14-
App packages can be imported again into a new app using the [Import App Package](/refguide/import-app-package-dialog/).
14+
You can import app packages into a new app using the [Import App Package](/refguide/import-app-package-dialog/) feature.
1515

1616
To export the package, open the **File** menu > **Export App Package** and select the relevant options in the **Export App Package** dialog box:
1717

1818
{{< 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" >}}
1919

20-
For more information on what options you can select, see the sections below.
20+
The sections below describe the available options.
2121

2222
## Package Type
2323

24-
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*.
24+
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*.
2525

26-
You can now choose to export your app as the **Solution** or **Source Package**.
26+
You can then choose to export your app as **Solution** or **Source Package**.
2727

2828
{{< 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" >}}
2929

3030
### Solution Package
3131

3232
{{% alert color="info" %}}
33-
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/).
33+
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/).
3434
{{% /alert %}}
3535

36-
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/).
36+
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/).
3737

3838
### Source Package
3939

4040
{{% alert color="info" %}}
41-
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/).
41+
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/).
4242
{{% /alert %}}
4343

44-
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.
44+
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.
4545

4646
## Destination
4747

4848
You can specify the folder to export the package to. The default location is a folder named *packages* inside the app directory.
4949

5050
## Export Data
5151

52-
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:
52+
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:
5353

54-
* **No data** – the package will be exported without data.
55-
* **Existing snapshot** – this option will include the existing database snapshot in the export app package
56-
57-
{{% 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 %}}
58-
59-
* **New snapshot from current database** – will create a new snapshot from the database and include it in the export
60-
61-
{{% 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 %}}
54+
* **No data** – the package is exported without data.
55+
* **Existing snapshot** – this option includes the existing database snapshot in the exported app package.
56+
{{% 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 %}}
57+
* **New snapshot from current database** – creates a new snapshot from the database and includes it in the export.
58+
{{% 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 %}}
6259

6360
## Read More
6461

content/en/docs/refguide/modeling/menus/file-menu/import-app-package-dialog.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,35 @@
22
title: "Import App Package"
33
url: /refguide/import-app-package-dialog/
44
weight: 40
5-
description: "Describes the Import App Package process and Import App Package dialog box."
5+
description: "Describes how to import an app package and the options in the Import App Package dialog box."
66
aliases:
77
- /refguide/import-project-package-dialog/
88
---
99
## Introduction
1010

11-
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.
11+
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.
1212

1313
To import an app package, do the following:
1414

15-
1. Select the **File** menu in the top bar > **Import App Package**
16-
2. Browse to the *.mpk* file you would like to import.
17-
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.
15+
1. Select the **File** menu in the top bar > **Import App Package**.
16+
2. Browse to the *.mpk* file you want to import.
17+
3. Select the relevant options in the **Import App Package** dialog box and click **OK**. The sections below describe the available options.
1818

1919
{{< 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" >}}
2020

21-
App packages can be created using [Export App Package](/refguide/export-app-package-dialog/).
21+
You can create app packages using [Export App Package](/refguide/export-app-package-dialog/).
2222

2323
## Where Should We Store Your App?
2424

2525
Use this setting to select the location where you want to store your app. This can be the [Team Server](#team-server), a [private server](#private-server) (a Git server other than the Team Server), or a [local disk](#local).
2626

2727
### Mendix Team Server {#team-server}
2828

29-
When uploading the app to the Team Server, you can choose between creating a new repository, or uploading to an existing one.
29+
When uploading the app to the Team Server, you can choose between creating a new repository or uploading to an existing one.
3030

3131
#### New Mendix Team Server
3232

33-
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.
33+
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.
3434

3535
#### Existing Mendix Team Server
3636

@@ -41,18 +41,18 @@ For more information about the Mendix Team Server, see [Team Server](/developerp
4141
### Private Server {#private-server}
4242

4343
{{% alert color="info" %}}
44-
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**.
44+
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**.
4545
{{% /alert %}}
4646

4747
In the **App repository address** field, enter the address of the repository you want to upload your app to.
4848

4949
### Locally on Disk {#local}
5050

51-
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.
51+
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.
5252

5353
## App Directory
5454

55-
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.
55+
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.
5656

5757
## Read More
5858

0 commit comments

Comments
 (0)