Skip to content

Commit 688ef57

Browse files
pradeep-patil-mdxquinntracyMariaShaposhnikova
authored
[CCR-298] Adds documentation for opening read-only document versions from comparison pane. (#12038)
* [CCR-298] Adds documentation for opening read-only document versions in Comparison pane * Review * Fix review comments * Updates historical view supported documents * Review --------- Co-authored-by: Quinn Tracy <142489060+quinntracy@users.noreply.github.com> Co-authored-by: MENDIXDOMAIN\Maria.Shaposhnikova <maria.shaposhnikova@mendix.com>
1 parent bb60681 commit 688ef57

1 file changed

Lines changed: 38 additions & 5 deletions

File tree

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

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The search matches text against all four columns (Status, Document name, Module
7676

7777
#### Context Menu
7878

79-
Right-click any cell in the grid to access the **Copy** option, which copies the cell value to your clipboard.
79+
Right-click any cell in the grid to access the **Copy** option, which copies the cell value to your clipboard. For microflows and workflows, the context menu also contains the **View** option, which opens a specific version of the document. For more information, see the [Document Types with Read-Only Versions](#read-only-versions) section below.
8080

8181
#### Grid Columns
8282

@@ -111,7 +111,7 @@ The task bar at Level 2 and 3 contains the following buttons:
111111
| Button | Action | When Enabled |
112112
|--------|--------|--------------|
113113
| **Back** | Returns to Level 1 | Always enabled |
114-
| **Go to** | Focuses on the selected element in the document | Enabled when an element is selected; remains active even for deleted elements to support cross-tab navigation |
114+
| **Go to** | Focuses on the selected element in the document | Enabled when an element is selected; for deleted elements, enabled only in microflows and workflows (for more information, see [Opening Documents](#opening-documents)) |
115115
| **Expand all** | Expands all collapsed property tree rows in Level 3 | Always enabled when viewing Level 3 |
116116
| **Collapse all** | Collapses all expanded property tree rows in Level 3 | Always enabled when viewing Level 3 |
117117
| **Stop comparison** | Closes the comparison and returns to the blank state | Always enabled during an active comparison |
@@ -145,17 +145,50 @@ Property paths are consolidated into a tree view. Grey rows represent intermedia
145145

146146
## Opening Documents
147147

148-
When you click **Go to** or double-click a document entry in Level 1, the document opens as it currently exists in your app. If the document no longer exists in your current state, Level 2 and 3 is shown but nothing opens in the editor.
148+
When you click **Go to** or double-click a document in Level 1 or an element in Level 2, the document opens in the editor. The version that opens depends on the document type, the status of the document, and the type of comparison.
149149

150-
For text-based properties, you can double-click a property row or use the context menu to open a detailed side-by-side comparison in the [File Differences Viewer](/refguide/file-diff-viewer/). For file-type documents in Level 1, double-click or click **Go to** to open the File Differences Viewer instead of a document editor.
150+
### Document Types with Read-Only Versions {#read-only-versions}
151+
152+
For the following document types, you can open the version of the document from a specific revision:
153+
154+
* Microflows
155+
* Workflows
156+
* Nanoflows
157+
* Domain model
158+
159+
These versions open in a separate tab in read-only mode. You cannot edit the document or its properties. The tab indicates whether it shows the **Older** or **Newer** version. Read-only tabs close when you stop the comparison.
160+
161+
The table below shows which version opens when you click **Go to** or double-click a document:
162+
163+
| Status | Compare to Current State | Compare Revisions |
164+
|--------|--------------------------|-------------------|
165+
| **Added** | The current version opens in edit mode | The version from the newer revision opens in read-only mode |
166+
| **Modified** | The current version opens in edit mode | The version from the newer revision opens in read-only mode |
167+
| **Deleted** | The version from the selected revision opens in read-only mode | The version from the older revision opens in read-only mode |
168+
169+
To open a specific version, right-click a document in Level 1, select **View**, and then select one of the following options:
170+
171+
| Option | What Opens | Available For |
172+
|--------|------------|---------------|
173+
| **Older** | The version from the older revision, in read-only mode | Modified and deleted documents |
174+
| **Newer** | The version from the newer revision, in read-only mode | Added and modified documents, when comparing two revisions |
175+
| **Current** | The document as it is in your app now, in edit mode | Added and modified documents |
176+
177+
### Other Document Types
178+
179+
For all other document types, the document opens as it currently exists in your app, regardless of the type of comparison. If the document no longer exists in your app (for example, because it was deleted), a message says so and nothing opens.
180+
181+
### Files and Text-Based Properties
182+
183+
For text-based properties, double-click a property row or use the context menu to open a detailed side-by-side comparison in the [File Differences Viewer](/refguide/file-diff-viewer/). For modified file-type documents in Level 1, double-click the document or click **Go to** to open the File Differences Viewer instead of a document editor. You cannot open added or deleted files.
151184

152185
## Refresh Behavior
153186

154187
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.
155188

156189
## Stopping a Comparison
157190

158-
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.
191+
Click **Stop comparison** to close the comparison. This action closes the **Comparison** pane and returns it to a blank state. Documents that were open in their current version remain open in the editor. The pane closes read-only versions.
159192

160193
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.
161194

0 commit comments

Comments
 (0)