Skip to content

Commit b84f5be

Browse files
committed
Review
1 parent d5ee96f commit b84f5be

5 files changed

Lines changed: 35 additions & 34 deletions

File tree

content/en/docs/refguide/modeling/menus/version-control-menu/history-dialog.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,23 @@
22
title: "History"
33
url: /refguide/history-dialog/
44
weight: 50
5+
description: "Describes the History pane in Studio Pro, which shows committed changes to an app's development line."
56
---
67
## Introduction
78

8-
Use the **History** pane to see the changes that have been committed to a development line of an app. You can open this pane from the **Version Control** > **History** menu item. The **History** pane displays all revisions at once in a searchable grid, making it easy to view the detailed project history.
9+
Use the **History** pane to see the changes that have been committed to a development line of an app. You can open this pane by selecting **Version Control** > **History** from the menu. The **History** pane displays all revisions at once in a searchable grid, making it easy to view the detailed project history.
910

1011
{{% alert color="info" %}}
11-
In Studio Pro 11.6, a new default view for History was introduced. Partially-cloned apps automatically get the older blocking dialog and through the [Version Control Preferences](/refguide/preferences-dialog/#history-pane), you can choose to keep using the blocking dialog for all apps.
12+
Studio Pro 11.6 introduced a new default view for History. Partially cloned apps automatically use the older blocking dialog. You can also choose to keep using the blocking dialog for all apps through the [Version Control Preferences](/refguide/preferences-dialog/#history-pane).
1213

13-
When using the Revision Selector to select a revision to revert, to merge from, create a branch line off, or to create a deployment archive from, the blocking dialog is still used.
14+
The Revision Selector still uses the blocking dialog when you select a revision to revert, merge from, create a branch line from, or create a deployment archive from.
1415

15-
For more information on the blocking dialog, refer to the [Mendix 10 documentation](/refguide10/history-dialog/).
16+
For more information on the blocking dialog, see the [Mendix 10 documentation](/refguide10/history-dialog/).
1617
{{% /alert %}}
1718

1819
## Revisions
1920

20-
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/revisions.png" alt="Revisions Image" class="no-border" >}}
21+
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/revisions.png" alt="History pane showing a grid of revisions" class="no-border" >}}
2122

2223
Each line in the grid represents a revision in the repository.
2324

@@ -43,9 +44,9 @@ By selecting a revision in this grid, the tabs below the grid will be filled wit
4344

4445
### Comparing Revisions
4546

46-
You can compare any revision to your current working state by right-clicking a revision and selecting **Compare to current state**. This opens the [Comparison pane](/refguide/comparison-pane/), which shows all differences between the selected revision and your current state, including uncommitted changes.
47+
To compare any revision to your current working state, right-click a revision and select **Compare to current state**. This opens the [Comparison pane](/refguide/comparison-pane/), which shows all differences between the selected revision and your current state, including uncommitted changes.
4748

48-
{{< figure src="/attachments/refguide/modeling/menus/view-menu/comparison-pane/history-right-click-menu.png" alt="Compare to current state in History dialog right-click menu" class="no-border" >}}
49+
{{< figure src="/attachments/refguide/modeling/menus/view-menu/comparison-pane/history-right-click-menu.png" alt="Right-click menu showing Compare to current state option" class="no-border" >}}
4950

5051
For more information, see [Comparing Revisions](/refguide/comparing-revisions/).
5152

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ This pane has two levels, so when you zoom into a changed document, you can revi
7070

7171
### Comparison
7272

73-
The [Comparison pane](/refguide/comparison-pane/) shows the differences between a selected historical revision and your current working state, allowing you to see what documents, elements, and properties changed.
73+
The [Comparison pane](/refguide/comparison-pane/) shows the differences between a selected historical revision and your current working state, which allows you to see what documents, elements, and properties changed.
7474

7575
### History {#history-pane}
7676

content/en/docs/refguide/modeling/menus/view-menu/comparison-pane.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@ The **Comparison** pane shows the differences between a selected historical revi
1212
This feature requires a version-controlled app. For apps without version control, the **Comparison** pane is disabled.
1313

1414
{{% alert color="warning" %}}
15-
The key limitation of the **Comparison** pane is that you can only compare a selected historical revision to your current working state. It is not possible to compare two past revisions to each other.
15+
You can only compare a selected historical revision to your current working state. It is not possible to compare two past revisions to each other.
1616
{{% /alert %}}
1717

1818
This feature is similar to the [Changes pane](/refguide/changes-pane/), but while the **Changes** pane shows your local modifications since your last commit, the **Comparison** pane shows differences between any historical revision and your current state.
1919

20-
For more information on comparing scenarios, see [Comparing Revisions](/refguide/comparing-revisions/).
20+
For more information on comparing scenarios, refer to [Comparing Revisions](/refguide/comparing-revisions/).
2121

2222
## Accessing the Comparison Pane and Version Compatibility
2323

2424
To compare a revision to your current state, do the following:
2525

2626
1. Open the **History** dialog by clicking **View** > **History**.
27-
2. Choose a revision from the list by right-clicking it.
27+
2. Right-click a revision from the list.
2828
3. Select **Compare to current state**.
2929

3030
The **Comparison** pane opens and shows all differences between the selected revision and your current working state, including any uncommitted changes.
@@ -39,11 +39,11 @@ When comparing revisions created in older versions of Studio Pro, the models are
3939

4040
The **Comparison** pane shows information at three levels:
4141

42-
* **Level 1**A list of all documents that differ between the two revisions.
43-
* **Level 2**All elements within a selected document that have changed.
44-
* **Level 3**The specific property values that differ for a selected element.
42+
* **Level 1**a list of all documents that differ between the two revisions
43+
* **Level 2**all elements within a selected document that have changed
44+
* **Level 3**the specific property values that differ for a selected element
4545

46-
You can navigate between levels by double-clicking a row or using the **Go to** button. Press <kbd>Backspace</kbd> or click **Back** to return to the previous level.
46+
Navigate between levels by double-clicking a row or clicking **Go to**. Press <kbd>Backspace</kbd> or click **Back** to return to the previous level.
4747

4848
### Unversioned App State
4949

@@ -91,7 +91,7 @@ The **Status** column shows one of the following types:
9191

9292
## Level 2 and 3: Element and Property Differences
9393

94-
Double-clicking a document in Level 1 navigates to Level 2 and Level 3, which appear side by side. Level 2 shows changed elements, and Level 3 shows the property differences for the selected element.
94+
Double-click a document in Level 1 to navigate to Level 2 and Level 3, which appear side by side. Level 2 shows changed elements, and Level 3 shows the property differences for the selected element.
9595

9696
{{< figure src="/attachments/refguide/modeling/menus/view-menu/comparison-pane/comparison-pane-level2-3.png" alt="Comparison Pane Level 2 and Level 3 showing element and property differences" class="no-border" >}}
9797

@@ -117,7 +117,7 @@ The Level 2 grid shows all changed elements within the selected document:
117117

118118
| Column | Description | What It Shows |
119119
|--------|-------------|---------------|
120-
| **Status** | The type of change | An icon and label indicating whether the element was Added, Modified, or Deleted |
120+
| **Status** | The type of change | An icon and label indicating whether the element was added, modified, or deleted |
121121
| **Item** | The element name | The name of the changed element (for example, a widget, entity, or activity) |
122122

123123
Hover over any cell to see the full value in a tooltip.
@@ -144,11 +144,11 @@ In future releases, both versions of the document will be opened side by side fo
144144

145145
## Refresh Behavior
146146

147-
When you are comparing a revision to your current state and you save changes to your app, a **Refresh** button appears in the **Comparison** pane. Click **Refresh** to update the comparison with your latest saved changes.
147+
When you are comparing a revision to your current state and save changes to your app, a **Refresh** button appears in the **Comparison** pane. Click **Refresh** to update the comparison with your latest saved changes.
148148

149149
## Stopping a Comparison
150150

151-
Click the **Stop comparison** button to close the comparison. This action closes the **Comparison** pane and returns it to a blank state. Any documents that were opened as part of the comparison remain open in the editor.
151+
Click **Stop comparison** to close the comparison. This action closes the **Comparison** pane and returns it to a blank state. Any documents that were opened as part of the comparison remain open in the editor.
152152

153153
In the blank state, the **Comparison** pane displays a message with a link to start a new comparison. The **Go to** and **Stop comparison** buttons are disabled until a new comparison is started.
154154

content/en/docs/refguide/version-control/using-version-control-in-studio-pro/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ description_list: true
1313

1414
This document describes how to use [version control](/refguide/version-control/) in Mendix Studio Pro.
1515

16-
For more information on related concepts and the theory behind how version control works in Mendix, see [Version Control](/refguide/version-control/).
16+
For more information on related concepts and the theory behind how version control works in Mendix, refer to [Version Control](/refguide/version-control/).
1717

1818
## Read More

content/en/docs/refguide/version-control/using-version-control-in-studio-pro/comparing-revisions.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,52 +7,52 @@ description: "How to compare a historical revision to your current state to unde
77

88
## Introduction
99

10-
You can compare any historical revision of your version-controlled app to your current working state via the **Comparison** pane. It can help you understand what has changed since a specific commit, see the impact of your recent edits, or review what is affected if you reverted to a past revision.
10+
You can compare any historical revision of your version-controlled app to your current working state using the [Comparison pane](/refguide/comparison-pane/). This helps you understand what has changed since a specific commit, see the impact of your recent edits, or review what is affected if you revert to a past revision.
1111

1212
The comparison shows differences between:
1313

14-
* **Older revision**The historical revision you selected from the **History** pane
15-
* **Newer revision**Your current working state, including all uncommitted changes
14+
* **Older revision**the historical revision you selected from the **History** pane
15+
* **Newer revision**your current working state, including all uncommitted changes
1616

17-
As the comparison always includes your current uncommitted changes, you can use this feature to see how your recent edits differ from any point in your app's history.
17+
The comparison always includes your current uncommitted changes, so you can use this feature to see how your recent edits differ from any point in your app's history.
1818

1919
{{% alert color="warning" %}}
20-
The key limitation of the **Comparison** pane is that you can only compare a selected historical revision to your current working state. It is not possible to compare two arbitrary past revisions to each other.
20+
You can only compare a selected historical revision to your current working state. It is not possible to compare two arbitrary past revisions to each other.
2121
{{% /alert %}}
2222

23-
For more information on the **Comparison** pane and its detailed overview, see [Comparison Pane](/refguide/comparison-pane/).
23+
For more information on the **Comparison** pane and its detailed overview, refer to [Comparison Pane](/refguide/comparison-pane/).
2424

2525
## Common Scenarios
2626

2727
### What Changed Since a Specific Commit?
2828

29-
You can review all changes made since a specific commit, which helps you understand the scope of work done since the selected commit, made by you or other team members.
29+
You can review all changes made since a specific commit. This helps you understand the scope of work done since the selected commit, made by you or other team members.
3030

3131
### What Would Reverting to This Revision Undo?
3232

3333
Before reverting to an older revision, you can compare your current changes to a revision you are considering reverting to and review what changes will be lost. This helps you make an informed decision about whether reverting is safe or if it would undo important work.
3434

3535
### Will My Recent Changes Affect a Specific Area?
3636

37-
To check if your recent uncommitted changes affected a specific area of your app:
37+
To check if your recent uncommitted changes affected a specific area of your app, do the following:
3838

3939
1. Open the **History** dialog and select your most recent commit (HEAD).
4040
2. Right-click and select **Compare to current state**.
4141
3. Look for the documents or elements you are concerned about.
4242

43-
As the comparison includes uncommitted changes, you can see the full impact of your current working session.
43+
Because the comparison includes uncommitted changes, you can see the full impact of your current working session.
4444

4545
## Tips and Tricks
4646

47-
* **Use Expand all and Collapse all** in Level 3 to quickly show or hide all nested property paths. This is especially useful when comparing complex elements with many properties.
48-
* **Right-click any cell** in the grids and select **Copy** to copy the cell value to your clipboard. This is useful for documenting changes or sharing information with your team.
49-
* **Press <kbd>Enter</kbd> to drill down** and <kbd>Backspace</kbd> to go back when navigating the comparison. This is faster than using the mouse to click buttons.
50-
* **Understand version conversions** – When comparing older revisions, remember that model conversions may introduce minor differences in how properties are displayed. These do not affect your stored revisions.
47+
* **Use Expand all and Collapse all** – In Level 3, use these options to quickly show or hide all nested property paths. This is especially useful when comparing complex elements with many properties.
48+
* **Right-click any cell** – In the grids, right-click any cell and select **Copy** to copy the cell value to your clipboard. This is useful for documenting changes or sharing information with your team.
49+
* **Press <kbd>Enter</kbd> to drill down** and <kbd>Backspace</kbd> to go back – Use these shortcuts while when navigating the comparison. This is faster than using the mouse to click buttons.
50+
* **Understand version conversions** – When comparing older revisions, remember that model conversions may introduce minor differences in how properties are displayed. These differences do not affect your stored revisions.
5151

5252
## Read More
5353

5454
* [Comparison Pane](/refguide/comparison-pane/)
5555
* [History](/refguide/history-dialog/)
5656
* [Changes Pane](/refguide/changes-pane/)
5757
* [Version Control](/refguide/version-control/)
58-
* [Using Version Control History](/refguide/peer-review/)
58+
* [Using Version Control History](/refguide/version-control-using-history/)

0 commit comments

Comments
 (0)