Compare Containers

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

License information

To be able to use the Compare functionality in EHANDBOOK-NAVIGATOR you need an AddOn license. Please have a look at License Feature Overview for further information.

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 users grasp the overall organization and navigate easily through topics and subtopics.

Icons Indicating Changes: The tree view uses icons to visually represent changes:

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

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

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

Please note that once a sub-entry contains modifications, all entries containing this sub-entry will also be marked as modified.

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

Tree View

To display the whole content, please use the filter (1) All Content. To only display entries that are identical in the right left container container, use the filter (3) Same Content. The filter (2) Modified Content displays 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.

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. In case the content is unmodified, both sides will look the same. In case 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. In case the TOC entry is available on both side, but is not identical, the differences will be marked using a colored highlighting.

  • red: content has been removed

  • green: content has been added

  • yellow: content has been modified

Navigating through the differences

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

Customization options

To ensure a good usability, the colors used for highlighting the differences can be customized by each user in the preferences.

How to Use the Compare Functionality

Code Viewer

  1. Load EHANDBOOK Containers: Begin by ensuring that both EHANDBOOK containers you wish to compare are already loaded in the ETAS EHANDBOOK Navigator. This can be achieved by opening the Manage Project…​ dialog (1). The comparison functionality only works with containers currently available in the loaded EHANDBOOK project.

  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 reference, and differences will be marked accordingly.

  4. Start the comparison: The comparison will start when you click the Compare button (5). Please note that this might take some time depending on the size of the containers.

  5. 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.

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

  7. Navigate Through Differences: Use the navigation buttons (8) located 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 (9).

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