Analytics - Compare Revisions
Gain a better overview of changes implemented between two selected document versions.
General
Compare Revisions allows to compare two revisions of the same document in order to visualize the changes implemented.
The functionality is accessible in the browser version of Yonder:
Click on the ‘hamburger menu’, select ‘Analytics’ and click on ‘Compare Revisions’.
Required roles
In order to access the feature you need the corresponding role (here)
Use Case
Important Information
This advanced functionality is specifically designed for document authors to streamline their work. However, it includes two important restrictions to be aware of:
Unrestricted Visibility: Access is provided to all documents without any permission restrictions. This means that users with access to this feature (see Required roles) can view every document within the system.
Performance Considerations: The document version comparison process is highly processor-intensive. Excessive requests for comparisons can negatively impact the overall system performance. Users are encouraged to use this feature judiciously.
Given these considerations, it is strongly recommended to restrict access to this feature to specific user groups, such as authors and administrators.
Generate Comparison
The user wants to compare two revisions of a document. The revisions do not have to be consecutive.
- Select the document: click on the ‘drop down’ icon in the ‘Select Document’ field.
→ the system proposes the ‘Original’ vs. the currently ‘Revised’ version.
- Select any other version(s): clicking in the corresponding field on the ‘drop down’ icon.
- Name your query: In the field ‘Label’ a name for your query is proposed. You can change this proposal. The query will be stored for further use.
- Execute your query: click GENERATE
View Comparison
To view the generated comparisons, please select the desired entry from the list of ‘Last Generated’
The comparison will open in a new tab.
Outline
In the left column the outline is displayed and chapters that have changed will be coloured accordingly.
Content
In the content view you can change between multiple tabs:
- Versions: the two compared versions are selectable on module level
- Redline: in the module the changes are made visible
- Info: module information such as:
- Type
- Location
- External ID
- Internal ID
- Tags
View Last Generated Comparisons
In the expanded sidebar you can select one of your previously queried comparisons.
Simply click on the desired query and the comparison will open in an additional tab.
Errors
Broken images
- if images don't load respectively are displayed as broken, please ensure that you use the proper URL
- Error message: Images cannot be loaded when using ‘<name>.yondermind.info’ instead of ‘<name>yonder.info’
- if message is confirmed but same URL is used, the comparison is displayed but with broken images
- if the correct URL is used, the images are correctly displayed