Skip to content

Commit 7abe3f7

Browse files
Remove repetitions
1 parent 10d91a8 commit 7abe3f7

2 files changed

Lines changed: 18 additions & 91 deletions

File tree

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ The **Comparison** pane shows the differences between a selected historical revi
1111

1212
This feature requires a version-controlled app. For apps without version control, the **Comparison** pane is disabled.
1313

14+
{{% 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 arbitrary past revisions to each other.
16+
{{% /alert %}}
17+
18+
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.
19+
1420
## Accessing the Comparison Pane and Version Compatibility
1521

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

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

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

88
## Introduction
99

10-
The **Comparison** pane allows you to compare any historical revision of your version-controlled app to your current working state. This helps you understand what has changed since a specific commit, see the impact of your recent edits, or review what would be 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 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.
1111

1212
The comparison shows three levels of detail: which documents changed, which elements within those documents changed, and which property values differ between the revision and your current state.
1313

14-
{{% 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 arbitrary past revisions to each other.
16-
{{% /alert %}}
17-
18-
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.
19-
20-
## Starting a Comparison
21-
22-
To compare a historical revision to your current state:
23-
24-
1. Open the History pane by clicking **View** > **History**.
25-
2. Right-click the revision you want to compare.
26-
3. Select **Compare to current state**.
27-
28-
The [Comparison Pane](/refguide/comparison-pane/) opens and displays all differences between the selected revision and your current working state, including any uncommitted changes you have made.
29-
30-
## Version Compatibility
31-
32-
When you compare revisions created in older versions of Studio Pro, the older revision is automatically converted to the current Studio Pro version format. This conversion allows you to compare across versions, but the displayed older revision may not be 100% identical to the original due to model conversion differences. For more information, see the [Version Compatibility](/refguide/comparison-pane/#version-compatibility) section in *Comparison Pane*.
33-
34-
## What Gets Compared
35-
3614
The comparison shows differences between:
3715

38-
* **Older revision** – The historical revision you selected from the History pane
16+
* **Older revision** – The historical revision you selected from the **History** pane
3917
* **Newer revision** – Your current working state, including all uncommitted changes
4018

41-
Because 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.
42-
43-
## Understanding the Comparison Results
44-
45-
The Comparison Pane shows results at three levels:
46-
47-
### Document-Level Differences
48-
49-
At Level 1, you see a list of all documents that differ between the two revisions. Each document has a status:
50-
51-
* **Added** (green circle) – The document exists in your current state but did not exist in the selected revision
52-
* **Modified** (yellow circle) – The document exists in both versions but has changes
53-
* **Deleted** (red circle with minus) – The document existed in the selected revision but no longer exists in your current state
54-
55-
### Element-Level Differences
56-
57-
At Level 2, you see which elements within a document have changed. For example, in a page, you might see which widgets were added, modified, or deleted. In a domain model, you might see which entities or associations changed.
19+
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.
5820

59-
### Property-Level Differences
60-
61-
At Level 3, you see the specific property values that differ for a selected element. The grid shows three columns:
62-
63-
* **Property** – The name of the property (shown as a tree structure for nested properties)
64-
* **Older** – The value in the historical revision
65-
* **Newer** – The value in your current state
66-
67-
Grey rows in the property tree represent intermediate path levels without a direct value. The properties are ordered to match how they appear in the corresponding dialog boxes.
68-
69-
## Navigating the Comparison
70-
71-
Use these methods to navigate through the comparison:
72-
73-
* **Double-click** a row to drill down to the next level
74-
* **Press <kbd>Enter</kbd>** on a selected row to drill down
75-
* **Click the Go to button** to drill down or focus on an element in the document
76-
* **Click the Back button** or **press <kbd>Backspace</kbd>** to return to the previous level
77-
* **Use the Expand all button** to expand all property tree nodes in Level 3
78-
* **Use the Collapse all button** to collapse all property tree nodes in Level 3
79-
80-
## Opening Documents
81-
82-
When you click **Go to** or double-click a document in the comparison, the document opens as it currently exists in your project. This allows you to see the document in context and make further edits if needed.
83-
84-
If the document no longer exists in your current state (it was deleted), Level 2 and Level 3 are still displayed so you can review what was in the document, but nothing opens in the editor.
85-
86-
## Refreshing a Comparison
87-
88-
When you are viewing a comparison and you save changes to your app, a **Refresh** button appears in the Comparison Pane. Click **Refresh** to update the comparison to include your latest saved changes. This allows you to iteratively make changes and see how they affect the comparison without restarting the comparison from scratch.
89-
90-
## Stopping a Comparison
21+
{{% alert color="warning" %}}
22+
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.
23+
{{% /alert %}}
9124

92-
Click the **Stop comparison** button in the Comparison Pane to close the comparison. The pane returns to a blank state and is ready for you to start a new comparison. Documents that were opened as part of the comparison remain open in your editor.
25+
For more information on the **Comparison** pane and its detailed overview, see [Comparison Pane](/refguide/comparison-pane/).
9326

9427
## Common Scenarios
9528

96-
### What Changed Since This Commit?
29+
### What Changed Since a Specific Commit?
9730

98-
To see all changes made since a specific commit:
99-
100-
1. Open the History pane and find the commit in question.
101-
2. Right-click the commit and select **Compare to current state**.
102-
3. Review the document, element, and property-level differences.
103-
104-
This helps you understand the scope of work done since that commit, whether by you or other team members.
31+
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.
10532

10633
### What Would Reverting to This Revision Undo?
10734

108-
Before reverting to an older revision, you can preview what would change:
109-
110-
1. Open the History pane and find the revision you are considering reverting to.
111-
2. Right-click the revision and select **Compare to current state**.
112-
3. Review the differences to understand what would be undone by the revert.
113-
114-
This helps you make an informed decision about whether reverting is safe or if it would undo important work.
35+
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.
11536

11637
### Did My Recent Changes Affect This Area?
11738

11839
To check if your recent uncommitted changes affected a specific area of your app:
11940

120-
1. Open the History pane and select your most recent commit (HEAD).
41+
1. Open the **History** dialog and select your most recent commit (HEAD).
12142
2. Right-click and select **Compare to current state**.
12243
3. Look for the documents or elements you are concerned about.
12344

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

12647
## Tips and Tricks
12748

0 commit comments

Comments
 (0)