Compare Containers

The Compare functionality in EHANDBOOK-NAVIGATOR allows you to compare two EHANDBOOK containers side by side seamlessly. It helps you to identify differences in content, ensure accuracy, and maintain consistency across documents and document versions. With user-friendly navigation and customizable options, it simplifies the review process.

License information

To use the Compare functionality in EHANDBOOK-NAVIGATOR, you need an AddOn license. For further information, see the License Feature Overview

Comparison levels

Tree view comparison

The EHANDBOOK containers are structured using the Table of Contents (TOCs). The Compare functionality identifies differences between the ToCs of the two containers and displays them in a structured tree view. This visual representation helps you grasp the overall organization and navigate easily through topics and subtopics.

The tree view uses icons and arrows to represent changes visually:

Icons Indicating Changes:

  • Added added: Icons indicate new topics or sections introduced in the right container.

  • Removed removed: Icons denote content present in the left container but has been removed in the right one.

  • Modified modified: Icons show entries present in both containers but whose content has been modified.

  • Added-Disabled added disabled: Icons show the entry itself do not have a content of it’s own,but a section below it is newly introduced in the right container.

  • Removed-Disabled removed disabled: Icons show the entry itself do not have a content of it’s own,but a section below it is removed in the right container.

  • Error error: Icons indicate an error occured during the comparison of topics.

Arrows Indicating Changes:

  • Unchanged unchanged chevron: Arrow indicates there is no change in the chapter.

  • Added added chevron: Arrow indicates the chapter or a sub-chapter of it, has been added.

  • Removed removed chevron: Arrow indicates the chapter or a sub-chapter of it, has been removed..

  • Modified modified chevron: Arrow indicates the chapter or a sub-chapter of it, has been modified..

  • Filtering for changes: The tree view can be filtered to focus on specific types of changes.

Tree View

  1. All Content: To display all the content.

  2. Modified Content: To display the entries that either

    • have been removed from the left-hand side container

    • have been added to the right-hand-side container

    • or contain modified content.

  3. Same Content: To only display entries that are identical in the right-left container.

Textual comparison

You can open the content of the two compared containers by clicking on any entry in the tree view. The contents will be displayed side-by-side with synchronized scrolling. EHANDBOOK will always display the content as it is in the respective container. If the content is unmodified, both sides will look the same. If the entry has been added in the right container, its content will only be visible on the right side, while the left side remains empty. On the other hand, if the content has been removed, it will only be visible on the left side, while the right side remains empty. If the TOC entry is available on both sides but is not identical, the differences will be marked using a colored highlighting as follows.

  • Red: content has been removed

  • Green: content has been added

  • Yellow: content has been modified

If an entry in the treeview is not clickable, the entry does not have a content of it’s own.

Limitation

Note that with EHANDBOOK-NAVIGATOR 13.0 the documentation content will be compared based on whole paragraphs. This leads to the whole paragraphs being marked as added or removed in case of differences. With the next versions of EHANDBOOK-NAVIGATOR, a more detailed comparison will be possible.

Navigating through the differences

The split-screen viewer features navigation buttons that allow you to move through differences one at a time. This functionality is particularly useful for detailed reviews, as it ensures you can focus on each change without losing track of their position. The currently reviewed difference will be marked using an additional border around the colored highlighting indicating the type of change.

Customization options

To ensure good usability, you can customize the colors used to highlight the differences in your preferences.

How to Use the Compare Functionality

Compare Viewer

  1. Load or choose EHANDBOOK Containers: First, ensure that both EHANDBOOK containers you wish to compare are already loaded in the ETAS EHANDBOOK Navigator by opening the Manage Project…​ dialog (1). Alternatively, EHANDBOOK containers can be chosen without being part of an EHANDBOOK project using the option Choose EHANDBOOK Container…​ inside the dropdown menus (4).

  2. Open the "Compare" perspective: It can be opened via the View menu (2) or use the button (3) in the main toolbar.

  3. Select Containers: Utilize the dropdown menus (4) at the top of the comparison perspective to select the two EHANDBOOK containers you want to compare. The left container will be treated as a reference, and differences will be marked accordingly.

  4. Start the comparison: When you click the Compare button (5), the comparison will start.

  5. Swap compared Containers: If you want to swap the currently compared containers (left and right), you can use the Swap button (12). This will exchange the containers and update the comparison.

Depending on the size of the containers, this might take some time.A popup dialog will inform you about the progress of the comparison. The comparison can be aborted by clicking on the cancel button, which will stop the comparison at the next possible step.

  1. View the TOC: Once the comparison is done, the Tree View will automatically display the TOC for both containers, showcasing their respective structures. The visual markers and icons will help you quickly recognize which topics or subtopics have been added, removed, or modified.

  2. Explore Textual Differences: Click on any entry in the TOC to open the split-screen viewer. The left panel (7) will show the content from the left EHANDBOOK container, while the right panel (8) will display the content from the right container. Review the marked changes in the text to understand the modifications made.

  3. Navigate Through Differences: Use the navigation buttons (9) in the split-screen viewer to move through the marked differences in the opened chapter. This feature allows you to review changes one by one, ensuring a thorough examination of the content. The currently examined difference will be highlighted by an added border (10). Right to the navigation buttons you will see the total amount of difference and the index of the marked difference.

  4. Collapse the TOC: If you prefer a larger viewing area for the textual comparison, click the collapse button (11) to hide the Tree View. This will give you a more spacious view, allowing you to focus entirely on the content.

Label Popup in Compare

To display the metadata of labels, you can open the Label Popup by clicking the label name highlighted in blue. For details see Label Popup.

The information loaded from any additional files (such as A2L, HEX, DCM) will be the same in the Label Popups for corresponding labels in the left and right container. Externally loaded containers in compare do not support the loading of corresponding files.