How to work with EHANDBOOK NAVIGATOR

Creating an EHANDBOOK Project

An EHANDBOOK Project can contain one or more containers. The created project is saved as .ehbp format.

To create a new EHANDBOOK project:

While creating a project, only the Windows valid special characters are allowed. It means that the characters like \, /, :, , ?, ", <, >, and | are not allowed.

Loading an EHANDBOOK File or Project

An EHANDBOOK file contains documentation information such as text, structures and interactive models that you access using EHANDBOOK-NAVIGATOR.

To load an EHANDBOOK Container or a project:

  • On the File menu, select Open.
    Select File dialog box is displayed.

  • Select EHANDBOOK container (.ehb), or EHANDBOOK project (.ehbp), or encrypted EHANDBOOK container (.ehbcrypt) and click Open.
    <Or>

  • Click Open icon in the toolbar.
    Select File dialog box is displayed.

  • Select EHANDBOOK container (.ehb), or EHANDBOOK project (.ehbp), or encrypted EHANDBOOK container (.ehbcrypt) and click Open.
    <Or>

  • Press <CTRL+O>.
    Select File dialog box is displayed.

  • Select EHANDBOOK container (.ehb), or EHANDBOOK project (.ehbp), or encrypted EHANDBOOK container (.ehbcrypt) and click Open.
    <Or>

  • Double-click on an EHANDBOOK container (.ehb), or EHANDBOOK project (.ehbp), or encrypted EHANDBOOK container (.ehbcrypt) from the File Explorer Loading an EHANDBOOK File or Project Through File Explorer.

Loading an EHANDBOOK File or Project Through File Explorer

While opening a container (.ehb file) from the File Explorer and if any of an EHANDBOOK file or a project (.ehbp) was loaded already, then OpenEHANDBOOK File dialog box displays.

Open_EHB_file

It asks you whether you want to open only the selected container or it needs to be added to the currently loaded file or a project.
When you click Open, it closes the already opened file/project and opens the selected file/project.

When you click Add to Project, then Manage EHANDBOOK Project displays. Click OK to add the file to the currently opened EHANDBOOK file/project. Refer to Supporting of Multiple EHANDBOOK Files for more details on manage EHANDBOOK project.

Loading Multiple EHANDBOOK Files Through File Explorer

EHANDBOOK-NAVIGATOR allows you to select multiple EHANDBOOK files by holding <Ctrl> key in the File Explorer and opens those files in it. When multiple files are selected, EHANDBOOK-NAVIGATOR displays Open EHANDBOOK files dialog box and offers you to create either a new project or add those files to the currently opened project.

Open multiple EHB Files Dialog

When you click Create new Project, it closes the already opened file or a project and displays Manage EHANDBOOK Project dialog box. Click OK to create a new project.

When you click Add to Project, then Manage EHANDBOOK Project displays. Click OK to add those files along with the files in the currently opened EHANDBOOK project.

Refer to Supporting of Multiple EHANDBOOK Files for more details on manage EHANDBOOK project.

By default, EHANDBOOK-NAVIGATOR displays the list of 5 EHANDBOOK files/projects which were loaded previously. The count can be changed in the Preference page. The last loaded container is listed at the top.

NOTICE

Container content may have been changed externally while viewing the container in the EHANDBOOK-NAVIGATOR!

The container format is an open format, where XML files are grouped in a ZIP archive. The XML files can be changed although the container is in use.

Affected container contents will be changed or displayed incorrectly in the EHANDBOOK-NAVIGATOR. The following information can be affected when changing the source files:

  • documentation texts

  • documentation structure

  • interactive models

Therefore, always check the container in the EHANDBOOK-NAVIGATOR for wrong, missing or incomplete content by validating that the container content corresponds to the ECU documentation source before you start working.

Before working with a container:

  • Open the container in the EHANDBOOK-NAVIGATOR.

  • Validate that the content of the container corresponds to the ECU documentation source.

  • If you find model deviations, wrong, missing or incomplete content, contact the producer of the container to fix this errors.

Loading an A2L File

The EHANDBOOK-NAVIGATOR allows to load an A2L file and generates an EHANDBOOK container. An A2L file should comply with ASAM standard and it should have the valid Functions.

Loading an A2L file

Functions

EHANDBOOK-NAVIGATOR uses functions to structure the contents in the table of contents (TOC) and provides a graphical visualization of their dependencies.

Function Overview A2L file

Loading an A2L file

To load an A2L file:

  • On the File menu, select Convert A2L file…​.
    Convert A2L file to EHANDBOOK container dialog box is displayed.

Convert A2L file

Convert A2L file to EHANDBOOK container dialog box.

  1. A2L file selection

  2. A2L file encoding

  3. Specify the location and name of the container

  4. Checkbox to generate images

  5. Convert A2L file

    • Select the previously loaded A2L file from the "Select A2L file" drop-down menu or click Browse to select it.

    • Select the encoding of the A2L file from the drop-down list. By default, the highest encoding confidence level (e.g. ISO-8859-1) is pre-selected.

    • Select or type the location to generate the EHANDBOOK container or click Browse to select the different file.
      By default, the location is selected where the A2L file exists and the name of the A2L is considered as the container name with .ehb extension. You can change the name of the container by editing it in the text box (3).

    • Check the checkbox (4) to generate the images for functions.
      Please note that this takes several time to generate the images. By default, the checkbox is unselected.

    • Click Convert A2L file. If the same name already exists in the specified path, then EHANDBOOK- NAVIGATOR prompts either to change the location or overwrite the file. An A2L file converts it into an EHANDBOOK container. Please note that it takes few minutes to convert it. The progress bar is displayed.

    • Once the file is converted, a dialog box is displayed as shown below.

Converted A2L file

Dialog box:

  • Click Open in EHANDBOOK-NAVIGATOR.
    It opens the generated container in the EHANDBOOK-NAVIGATOR.
    <Or>

  • Click Show in Directory.
    It locates the file in the File System.
    <Or> Click Close.
    It closes the dialog box.
    The progress bar is displayed which displays the loading status.

Converted A2L file

  1. Images generated for functions

  2. Images are not generated for functions

When you check the checkbox to generate images for functions, the images are generated which helps to visulaize the preview of the images before opening itself, but it takes some time to generate the images during A2L conversion. You can open the functions by clicking Open function overview.

EHANDBOOK-NAVIGATOR converts to a container only for the valid A2L file.

Saving

Save feature helps to save all the changes made in the EHANDBOOK container (.ehb), or EHANDBOOK project (.ehbp), or encrypted EHANDBOOK container (.ehbcrypt).

To save an EHANDBOOK container, or EHANDBOOK project, or encrypted EHANDBOOK container:

Save As

Save As…​ feature helps to save a copy of the current EHANDBOOK container (.ehb) or EHANDBOOK project (.ehbp) with the new name.
To save an EHANDBOOK container, or EHANDBOOK project, or encrypted EHANDBOOK container with the new name:

  • Go to File menu, and click Save As…​ (<CTRL+SHIFT+S>).
    A windows explorer is displayed.

  • Specify the new name and the location to save it.

A container can also be saved as an EHANDBOOK project (*.ehbp format).

Exporting to PDF

This feature helps to export the contents of a particular functional component (FC) to a PDF document.
To export to PDF :

Export_to_PDF

Export to PDF.

  1. FC in Document Explorer

  2. FC in Document Viewer

  3. Context Menu

  4. Export to PDF toolbar icon

Perform one of the following steps:

  1. In the Document Explorer, right-click on the required functional component (FC).
    <Or>

  2. Right-click in the Document Viewer.
    A context menu is displayed.

  • Click Export to PDF…​.

  • In the Export to PDF dialog box, select the location, specify the file name and click Save.
    Please note that depending on the size of the contents it takes few minutes to generate the pdf file.

  • Once the file is exported, a dialog box is displayed as shown below.

ExportPDFDialog

Dialog box:

  • Click Open
    It opens the exported file in a PDF viewer.
    <Or>
    Click Show in Directory.
    It locates the file in the File System.
    <Or>
    Click Close.
    It closes the dialog box.
    Export to PDF can also be perfomed by clicking ExportPDFIconbutton in the toolbar or from the File menu.

Exporting contents of multiple functional components to a PDF document is not possible.

Exporting Log Files

Log files record the operations that are performed by you when using EHANDBOOK-NAVIGATOR. If there is an issue with the functioning of EHANDBOOK-NAVIGATOR, the information stored in these log files assist the support team in diagnosing the issue you are facing. EHANDBOOK-NAVIGATOR allows you to export the log files into a zip file. The zip file will contain the necessary log files and the relevant system information.

Changing the file name of the zip file is not recommended.

To export the log files:

  • On the Help menu, select Export Log Files…​.
    Save As dialog box is displayed.

  • Select the location for saving the zip file and click Save.
    The zip file is saved in the location specified.

  • Mail the zip file to ETAS support, specific to your location, with a synopsis of the issue you are facing.

Supporting of Multiple EHANDBOOK Files

EHANDBOOK-NAVIGATOR supports to load and combine multiple EHANDBOOK files. In order to work with EHANDBOOK-NAVIGATOR easily with all the content, more than one EHANDBOOK container can be added to an EHANDBOOK project.

Creating or Modifying an EHANDBOOK Project

Manage Project feature in the File menu helps you to load one or more EHANDBOOK containers.

It is also possible to load a single EHANDBOOK container even before creating a project by clicking on Open icon on the toolbar or by pressing <CTRL+O>. Refer to Supporting of Multiple EHANDBOOK Files above for more details.

To load the container(s):

  • On the File menu, click Manage Project…​
    <Or>

  • Click Manage Project Icon on the toolbar.
    Manage EHANDBOOK Project dialog box is displayed.

  • Click Add EHANDBOOK File(s)…​

  • Select EHANDBOOK File window is opened to select the EHANDBOOK file (s).

  • Select the file(s) which is(are) of .ehb or .ehbcrypt extensions. You can choose one or more file at a time.

  • Click Open to load the selected file(s).

  • The selected file(s) are displayed in the Manage EHANDBOOK Project dialog box

Manage_Project

  1. Manage EHANDBOOK Project dialog box

  2. Add the EHANDBOOK files

  3. Select EHANDBOOK File dialog box

  4. EHANDBOOK files selection

  5. Selected EHANDBOOK files in the Manage EHANDBOOK Project dialog box

Operations in the Manage Project Dialog

You can perform the following operations in the Manage EHANDBOOK Project dialog box:

Replace EHANDBOOK file in a project

This is used to replace the selected EHANDBOOK file with the new one. To replace the EHANDBOOK file, follow the steps below:

  • On the File menu, click Manage Project…​
    Manage EHANDBOOK Project dialog box is displayed.

  • Select the file and click Replace.
    <Or>

  • Select the file and right-click.
    A context menu is displayed.

  • Click ReplaceFile

  • Select EHANDBOOK File window is opened to select the EHANDBOOK file
    (s).

  • Browse and select the EHANDBOOK file.

  • Click Open.
    The selected file will be replaced.

ReplaceProjects

In few cases, if you are replacing a file which has comments in it, then Replace EHANDBOOK File and Import Comments dialog box displays. Click Replace and import comments. The comments which are present in the old file will also be imported into a new file.

ReplaceAndImportComments

When a file is replaced with a new one, the defined alias name and color of the old file will be retained for the new one. Even the position of the new file in the table is same as the old file.

Remove EHANDBOOK file from a project

This is used to delete the selected file(s). To remove the EHANDBOOK file, follow the steps below:

  • On the File menu, click Manage Project.
    Manage EHANDBOOK Project dialog box is displayed.

  • Select the file and click Delete.
    <Or>

  • Select the file and right-click.

  • A context menu is displayed.
    Click Remove_project.

  • The selected file will be removed from an EHANDBOOK project.

RemoveProjectFile

In case, the selected container has the comments in it, then a confirmation dialog box is displayed. You can check and delete it.

Alias names and change color in the Manage EHANDBOOK Project dialog

EHANDBOOK-NAVIGATOR allows you to define the alias names in the Manage EHANDBOOK Project dialog box. You can also change the color of the flag.

Manage_Projects_alias_Names

  1. Defining the alias name of the file

  2. Changing the color of the file

Define the alias names of the EHANDBOOK file
The Alias name of the EHANDBOOK file contains minimum of 2 characters and maximum of 5 characters. The characters must contain either the upper case characters (A to Z) or numbers (0 to 9) or the combination of both. The Alias name should be unique.
To define the alias names, follow the steps below:

  • Click on the Alias cell in the dialog box and change the name.
    The changed name is updated.

Change the color flag of the EHANDBOOK file
Follow the steps to change the color flag of the EHANDBOOK file.

  • Click on the "Color" cell of the container.
    The predefined colors are displayed.

  • Choose any of the predefined color.
    The selected color is assigned for that particular file.

Working with Multiple EHANDBOOK Files

When you are working with a multiple EHANDBOOK files, it is difficult to identify the information or documentation contents which are displayed in the Document viewer originated from. EHANDBOOK-NAVIGATOR offers a solution by giving the variant colored flags and the alias names to each container.
The usage of colored flags and the alias names in EHANDBOOK-NAVIGATOR are stated below:

  • Displays alias names as well as the assigned color flag for different EHANDBOOK file in the table of contents (TOC). The functions of all the file are aggregated together in the "All Functions" in the Document Explorer.

ManageProjects_Functions

  • The tabs of the Document Viewer and Model Viewer display their assigned color flag and alias names as well.

Manage_Projects_tabs

  • Search proposals show colored flags and alias names to indicate the source of the displayed information.

Manage_Projects_Search

  • In the search results view, a column EHANDBOOK displays all the EHANDBOOK files where your search results are located. You can use the filter to minimize your search results and search the results only in the required EHANDBOOK file(s).

Manage_Projects_SearchResults

  • The blocks representing function in function overview diagrams are colored with the assigned color flag for its background and named with its alias name at the bottom.

Manage_Projects_FunctionOverviewDiag

NOTICE
The graphical model presentation might differ from the real ECU functionality. The EHANDBOOK-NAVIGATOR then may contain erroneous elements and missing user comments in an interactive model when displaying automatic layouts! Therefore, always compare the content of the interactive model in the EHANDBOOK-NAVIGATOR with the real ECUs function by validating that the graphical model presentation corresponds to the ECU documentation source before you start working.
To identify the cause for the wrong, missing or incomplete content, the producer of the container must check the source files from where the container was created. If the source files are correct and the appearance of the error is reproducible, the producer of the container must contact the local sales representative or the ETAS support to report this error.

NOTICE
The EHANDBOOK-NAVIGATOR may display erroneous connections between functions, that do not corresponds to the real ECU software.
The functions' interface descriptions of one ore more EHANDBOOK containers (e. g. function overviews, labels, pop-ups) may not correspond to the real ECU software.
Therefore, always check the conformity of the functions' interface descriptions.

Extracting content of EHANDBOOK container

This feature helps to extract contents from the currently loaded EHANDBOOK container and generate a new EHANDBOOK container by selecting only the required functions from the existing container.

EHANDBOOK container (.ehb) and encrypted EHANDBOOK container (.ehbcrypt) files are supported.
In case of extracting an encrypted container (.ehbcrypt), the same password is used to encrypt the extracted container.

To extract content to a new EHANDBOOK container:

  1. Perform one of the following steps:

    • On the File menu, select Extract Content….
      <Or>

    • In the Document Explorer, right-click on the required topic or subtopic.
      Context-menu is displayed.

    • Click Extract Content…​.
      <Or>

    • In the Document Viewer, right-click and select Extract Content…​.<Or>

    • Click ExtractContent on the toolbar.

    • Extract content to a new EHANDBOOK container window is displayed.

ExtractContentWindow

Extract content to a new EHANDBOOK container.

  1. Selected functions.

  2. Search filter.

  3. All tables of contents.

  4. Checkbox to show selected functions.

  5. Target location.

  6. Checkbox to extract comments.

  7. Extract container.

  1. Select the required function components (FCs).
    When you choose Extract Content from Document Explorer or Document Viewer, pre-selected FC’s (1) are shown in the Extract content to a new EHANDBOOK container window. You can also filter the function components (FCs) by typing the text in the Filter (2) which helps to find the function names quickly.

  2. Click Show Interface Elements Icon (3) to change the Tables of Contents.
    To select all function components, click Select All. To view only the list of selected function components click the checkbox Only show selected (4).

  3. Select or type the target location (5) for extracting the container or clickBrowse.
    By default loaded container’s location is pre-selected in the target path and the container name is suffixed with _Extract.

EHANDBOOK container will not be generated if the name and path of the extracting container is same as the loaded container. EHANDBOOK container will be generated only if the file extension of the extracting container is same as the loaded file extension.

  1. Check the checkbox Extract comments for selected contents (6) to copy comments to the extracted container.
    By default, the checkbox is unselected.

  2. Click Extract.
    Please note, based on the number of entries and size of the contents, extracting the contents takes some time.

  3. Once the EHANDBOOK container is extracted successfully, the below dialog
    box is displayed.

ExtractContentDialog

Dialog box.

  1. Click Open in EHANDBOOK-NAVIGATOR.

    • It opens the generated container in the EHANDBOOK-NAVIGATOR.
      <Or>

    • Click Open Output Folder.
      It opens the extracted container’s file location.
      <Or>

    • Click Close.
      It closes the dialog box.
      EHANDBOOK-NAVIGATOR generates a new container with the extracted functions. The tables of contents of the extracted container contains the extracted functions only.

Annotating the Values from A2L/HEX/DCM/CDF Files

The values for Scalar Parameters and System Constants are annotated to the Model Viewer (like live data from INCA and data from measurement files). This helps to understand more easily on how an ECU function is calibrated. EHANDBOOK-NAVIGATOR takes the values from the loaded A2L (*.a2l), HEX (*.hex, *.s19) or DCM (*.dcm)/CDF (*.cdfx)/PaCo (*.xml) files. The Display Value (Display all values)/Hide Value (Hide all values) shows or hides the values.
To annotate the values:
Firstly, load the A2L, HEX, DCM/CDF/PaCo files as below:

  • Go to Data menu → Measurement and Calibration Files.
    Measurement and Calibration Files dialog box is displayed.

  • Select the A2L, HEX, DCM/CDF/PaCo files and click Load.
    The selected A2L, HEX, DCM/CDF/PaCo files are loaded.
    Then, annotate the values for Scalar Parameters and System Constants by any of the following methods:

  • Right-click on a label in the Interactive Model/Function Overview Diagram.
    A context menu is displayed.

  • Click Display Value.
    <Or>

  • Click Display all values in the Status bar.
    <Or>

  • Go to Data menu, select Display all Values.
    The values are annotated in the Model viewer based on the values feeded in the respective A2L, HEX, DCM/CDF/Paco files.

Annotation_Values

Annotation of values.

On the same way, you can also hide all the displayed values.

The "Find in current tab" feature will not search the annotated values.

Create AsciiDoc References from Model Explorer

To create model reference for documentation from Model Explorer:

  • Go to Model Explorer.

  • Select the required model and right-click.
    A context menu is displayed.

  • Click Copy as model reference for AsciiDoc.
    <Or>

  • Press <CTRL+C>.
    A notification pop-ups.

ModeLReference_Pop-up

The model reference path is copied and it can be pasted in the AsciiDoc file.

To create function overview reference for documentation from Model Explorer:

  • Go to Model Explorer.

  • Select the required model and right-click.
    A context menu is displayed.

  • Click Copy as function overview reference for AsciiDoc.
    A notification pop-ups.

The model reference path is copied and it can be pasted in the AsciiDoc file.

The function overview feature is available at the function overview diagram level or at the function component root node level.

Both features are available in all model languages (ASCET/Simulink/C-code models).

Working with Bookmarks

Bookmarks feature in EHANDBOOK-NAVIGATOR allows you to store the location of the container topics, subtopics, and the interactive models for later retrieval. Topics containing textual content can be bookmarked.
The tasks that assist in using Bookmarks view are as follows:

Creating a Bookmark

To create a bookmark for textual content:

  • In the Document Explorer, right-click on the required topic or subtopic and select Create Bookmark…​ in the context menu displayed.
    Create Bookmark window is displayed.
    <Or>

  • In the Document Viewer, go to the required topic and click Star_icon icon.
    Create Bookmark window is displayed.

  • Enter the Name and Description for the bookmark.
    The location of the selected topic is displayed in theLocationtext box.

  • Enable theTransferablecheckbox to use the bookmarks across multiple containers. If you disable theTransferablecheckbox, bookmarks created will not work across multiple containers.

  • Click Create to create the bookmark.
    The bookmark is created and can be accessed from the Bookmarks view.

To create a bookmark for interactive model:

  • Right-click on the required interactive model or model block and select Create Bookmark in the context menu displayed.
    Create Bookmark window is displayed.
    <Or>

  • To the right of the breadcrumb bar, click Star_icon icon.
    Create Bookmark window is displayed.

  • Enter the Name and Description for the bookmark.
    The location of the selected topic is displayed in the Location text box.

  • Click Create to create the bookmark.
    The bookmark is created and can be accessed from the Bookmarks view.

When you move the mouse cursor over the bookmark name, the name and description about the bookmark is displayed.

You can bookmark the Function Overviews that contain multiple functions. The created bookmark will consist of a list of names corresponding to those functions. You can assign a name using the Edit Bookmark feature to modify it.

To show/ hide star icon in the Document Viewer, go to the File menu → Preferences…​.→ Bookmarks and select the required checkbox.

Editing a Bookmark

To edit a bookmark:

  • In the Bookmarks view, right-click the bookmark you want to edit and select Edit in the context menu.
    Edit Bookmarks window is displayed.

  • Edit the Name and Description for the bookmark and click Finish.
    The changes made to the bookmark are saved.

Deleting a Bookmark

To delete a bookmark:

  • In the Bookmarks view, right-click the bookmark you want to delete and Select Delete.
    The bookmark is deleted.

Creating a Folder

To create a folder:

  • In the Bookmarks view select Create a Folder in the context menu.
    Create a Folder window is displayed.

  • Enter the Name and Description for the folder and click Finish.
    The folder is saved in the My Bookmarks folder.

You can create a folder within a folder.

You can drag and drop bookmarks to the folder. Same bookmarks can be used in multiple folders.

Editing a Folder

To edit a folder:

  • In the Bookmarks view , right-click the folder you want to edit and select Edit in the context menu.
    Edit Folder window is displayed.
    <Or>

  • Click the folder you want to edit and press F2.
    Edit Folder window is displayed.

  • Edit the Name and Description for the folder and click Finish.
    The changes made to the folder are saved.

Deleting a Folder

To delete a folder:

  • In theBookmarks view, right-click the folder you want to delete and click Delete.
    The folder is deleted.

Importing Bookmarks

To import bookmarks to Bookmarks view:

  • Click Import Bookmarks icon present in the "Bookmarks" view.
    Import Bookmarks window is displayed.
    <Or>

  • From theFile menu, selectImport.
    Import window is displayed.

  • SelectBookmarks from the Documentation folder and then click Next.
    Import Bookmarks window is displayed.

Import_bkmrk

  • Click From a previous EHANDBOOK-NAVIGATOR version button and select the version from the drop-down list.

Only bookmarks that you have created in the previous navigator versions are displayed in the drop-down list.

  • Click Browseand select the Bookmarks file (*.bookmarks) you want to import.

  • Click Finish.
    The bookmarks are imported to the "Bookmarks" view.

Bookmarks are imported into a folder having the name of the *.bookmarks file.

Import Bookmarks functionality is not supported in Basic Mode of EHANDBOOK-NAVIGATOR. A message is displayed indicating the non-availability of the function in Basic Mode.

Exporting Bookmarks

To export bookmarks from Bookmarks view:

  • Select the Bookmark or Bookmarks folder you want to export.

  • ClickExport Bookmarksicon present in theBookmarks view.
    Export Bookmarks window is displayed.
    <Or>

  • From theFile menu, select Export.
    Export window is displayed.

  • Select Bookmarks from the Documentation folder and then click Next.
    Export Bookmarks window is displayed.

Export_bkmrk

  • Click Browse and select the location for exporting the Bookmarks file.

  • Select or clear the Bookmarks or Bookmarks folder as required.

  • Click Finish. The bookmark file (*.bookmark) is exported to the selected location.

Export Bookmarks functionality is not supported in Basic Mode of EHANDBOOK-NAVIGATOR. A message is displayed indicating the non-availability of the function in Basic Mode.

Valid or Invalid Bookmarks

My Bookmarks folder displays all the bookmarks created. This includes valid and invalid bookmarks. Valid bookmarks are highlighted and invalid bookmarks are grayed out. Clicking on the invalid bookmark displays the following error message.

Invalid_bookmark

Working with Comments

Comments feature in EHANDBOOK-NAVIGATOR allows you to add comments to specific portions of Document Viewer. Comments can be added to titles, figures and paragraphs. You can delete a comment. Comments can also be imported while importing another container into it.. You can also copy the comment to clipboard, which can be used in any other application by pasting it from clipboard.

Comments feature in EHANDBOOK-NAVIGATOR basic mode support to write and save comments, but importing of comments are not allowed.

Comments are saved within the container. It can also be extracted to a new EHANDBOOK container.
Comments_ui

  1. Comments empty

  2. Comments text box

  3. Comments added

  4. Options icon

Comments_decorators

  1. Contains comments and import comments

  2. Contains comments

  3. Contains comments

To add comments:

  • Hover the mouse next to a title, figure or a paragraph.
    A comment icon is displayed.

  • Click on the comment icon to add comments.
    A text box is displayed to add the comment.

  • Add the required comment.
    The color of the comment icon changes indicating the presence of comments.

To delete comments:

  • Click on the required comment icon, if the comment text box is not open.

  • On the top right corner of the comment text box, click on the options icon.
    A menu is displayed.

  • Click Delete comment to delete the comment.
    The comments added are deleted.

To copy comments to clipboard:

  • Click on the required comment icon, if the comment text box is not open.

  • On the top right corner of the comment text box, click options icon.
    A menu is displayed.

  • Click Copy text to clipboard to copy the comment.
    <Or>

  • Select the comment and right-click.
    A context menu is displayed.

  • Select Copy.
    <Or>

  • Select the comment and press <CTRL+C>.
    The comments added are copied and it can be pasted to any application.

To save comments in the container:

  • When you close EHANDBOOK-NAVIGATOR or when you open some other container, a prompt message is displayed to save the changes. Click Save in the prompt message to save the comments in the container.

The comments which are added in the file will also be saved when you save it by clicking Save or Save as…​ in the File menu.

To import comments:

  • From the File menu, select Import.
    Import window is displayed.

Import_Comments

  • Select Comments from the Documentation folder and then click Next.
    Import Comments window is displayed

  • Click Browse and select the container from which you want to import the comments.

  • Click Next. A summary of the comments imported is displayed. In the summary, a list of comments that cannot be imported to a location (error marker) is displayed. This helps you to know the comments which are affected.

ImportComments_Summary

  • Click Next.

ImportComments_Details

  • Click Finish to complete importing of comments.

Using Navigation History

Navigation history records the locations you have visited previously in the EHANDBOOK container. It is similar to the history feature available in a web browser. It records locations containing interactive models and documentation in their respective editors. The number of entries in the history is limited to 50, after which the last entry would be cleared out. Navigation buttons allow you to navigate back and forth within the navigation history.

The system records navigation history in the following scenarios:

  • For the Document Viewer:

    • Clicking on entries in the TOC.

    • Show Documentation from Model Viewer.

    • through the Label popup.

    • through the Bookmarks.

    • through the Clickpick.

    • Opening a search hit from Global search.

  • For the Model Viewer:

    • Opening an interactive model.

    • Opening a function overview.

    • Navigating in or out.

    • While using the Model Explorer.

    • While using the breadcrumb bar.

The system clears the existing navigation history in the following scenarios:

  • For the Document Viewer:

    • When the Document Viewer is closed.

  • For the Model Viewer:

    • When the Model Viewer is closed.

    • When an open location is used.

    • When a URI (Uniform Resource Identifier) is entered through the breadcrumb bar.

    • When a function is added/removed/edited from a function overview.

Navigating Back

navigation_backward

  1. Back button

  2. Drop down button

  3. Prior locations visited

You can navigate to the prior locations one at a time or jump directly to a previous location in the Navigation History. Navigation buttons are enabled after you have explored more than one location.

You can use these navigation buttons are as follows:

  • Click Backward(1) in the toolbar.
    It navigates back to one location at a time.

  • Click the drop-down button (2) in the toolbar.
    A list of locations (3) visited before the active location is displayed.

  • You can select the location you want to navigate from a list of locations (3).
    The selected location is displayed.

Navigating Forward

navigation_forward

  1. Forward button

  2. Drop-down button

  3. Subsequent locations visited

You can navigate to the subsequent locations one at a time or jump directly to a subsequent location in the Navigation History. Navigation buttons are enabled after you have explored more than one location.

You can use these navigation buttons are as follows:

  • Click Forward(1) in the toolbar.
    It navigates forward to one location at a time.

  • Click the drop-down button (2) in the toolbar.
    A list of locations (3) visited subsequent to the active location is displayed.

  • You can select the location you want to navigate from a list of locations (3).
    The selected location is displayed.

Sorting and Filtering Keyboard Shortcuts

EHANDBOOK-NAVIGATOR supports filtering and sorting of available keyboard shortcuts.

keyboard_shortcut

  1. Filter field

  2. Sort button

To filter keyboard shortcuts:

  • Go toHelpmenu and click Keyboard Shortcuts…​ (<CTRL+F1>).
    <Or>

  • Click Keyboard Shortcuts button in the toolbar.
    Keyboard Shortcuts window is displayed.

  • Type the text in the Filter field(1).
    Filtered entries are displayed.

To sort keyboard shortcuts:

  • Go to Helpmenu and click Keyboard Shortcuts…​ (<CTRL+F1>).
    <Or>

  • Click Keyboard Shortcuts button in the toolbar.
    Keyboard Shortcuts window is displayed.

  • Click Sort button(2).
    The column is sorted alphabetically from A-Z.

  • To reverse the sorting click on the Sort button again.

Attachment Handling

EHANDBOOK-NAVIGATOR supports adding attachments to the table of contents. It also allows the deletion of existing attachments. Both operations require a save of the EHANDBOOK container to be persisted. Attachments can be added at topic level or at an attachments level inside a topic.

Adding an Attachment

  • Right click on the FC to which you want to add the attachment.

  • Select Add Attachment.. from the context menu.

ContextMenu_AddAttachment

  • You will get a popup to select the attachment you wish to add.

File_selection

  • Select the file and click on Open.

  • The attachment gets added to the topic as shown below

Attachment_Bullet

  • You can also select the Attachments and add new attachments.

  • A attachmentDecorator symbol will be shown on the attachments which are newly added.

  • You can save the newly added attachment to the container by clicking on the save (save) button.

Deleting an Attachment

  • Right click on the attachment that you want to delete.

  • Click on Delete Attachment from the context menu.

Delete_Attachment

  • The selected attachment gets deleted.

  • Click on the save (save) button to save the changes on to the container.