DocConnect

A model often does not exist on its own. E.g. the model developer creates the model and writes a documentation about its behavior. Other users need that documentation when using the models to understand the underlying concepts, parameters, etc. This means they need to find the related documentation quickly. Thus, YAKINDU Model Viewer gives you the opportunity to create relationships between model elements and documentation in the form of hyperlinks. This allows you to quickly navigate between model elements and documentation parts.

To create links between a specific model and a documentation in YAKINDU Model Viewer, the following steps are necessary:

  • For preparation, you have to create a configuration first.
  • Copy the link of a model element to your clipboard.
  • Paste the link in the documentation file.

These steps are described in more detailed in the following sections.

Creating a configuration

When working in projects you often have to deal with different versions of models and documents which are continuously developed. Different versions often have similar names. When creating and using links between them, the YAKINDU Model Viewer needs to know which versions you work with. This scope can be defined with a so called configuration that you need to create in a first step. The configuration is a kind of container where you can add all files for which you want to create links.

To create a configuration:

  • Click on File > New yconf in the main menu. A file selection dialog opens.
  • Enter the name of the configuration file with extension .yconf, and save it in the desired folder.

Tips for saving the configuration:
Save the configuration at the same or at least near the location of your model and the documentation files.

Create and save a configuration

Creating and saving a configuration

  • Once you have saved it, the configuration opens in a new YAKINDU Model Viewer editor tab.

Configuration view

Configuration editor

To add elements, e.g. the models and the documentation files, to the configuration:

  • Click on the icon "add" icon either on the top left of the tab or in the middle of the editor.
  • A file selection dialog opens. Select the elements you want to add.

Tip: Add links to elements that doesn’t exist yet:

Maybe you want to add links to file types that are not editable (e.g. PDF files) or do not exist at the moment because they are generated automatically later. We have a special feature for you that makes that possible:

  • Add a so called ‚placeholder element’ to the configuration, by clicking the icon "placeholder" icon in the configuration editor, and add the name of your PDF document plus the file extension. A red exclamation mark is displayed next to it to show that the file does not exist yet.
  • You can now add the links to the editable version of the document, e.g. a Word document. (You don’t need to add this file to the configuration)
  • Transform the Word document to PDF. Ensure that it has the same name as the PDF file. It should also be saved at the same location as the configuration file. (If you want to save it as another location, you can use a relative path as name of the placeholder element, e.g. ‚subfoldername/placeholdername.pdf’)
  • As soon as the PDF file is available, YAKINDU Model Viewer will automatically detect the change, the exclamation mark will disappear and the included links will be available.

Menu icons and placeholder area

Menu icons and placeholder area

To delete an element from the configuration list:

  • Select the element by clicking on it.
  • Click on the button at the top of the editor area or press [DEL], and the selected element will be deleted from the configuration list.
  • To delete multiple elements, press [Ctrl+A] to select them all, use [Ctrl+Left click] to select several element, or use [Shift+Left click] to select a range. Then click on the button or [DEL].

You have successfully created the configuration with all necessary files now.

When setting up a new configuration and adding a documentation file without links, a exclamation mark is shown next to the PDF file.

Configuration with no links connected

Configuration including a documentation without links

So what we need to do now is creating a link between a model and a documentation:

  • Activate the configuration for which you want to create links by clicking the ‚Activate’ button at the top of the configuration editor.
  • Open the model from the configuration, e.g. by double-clicking the element in the configuration editor.
  • Right click on a model element and select the ‚Copy link to clipboard(L)’ menu item. Now the link information is stored in your clipboard.

Copy model element to the clipboard

Copy link of model element to the clipboard

Tip: Don’t worry if you forgot the activate your configuration. A pop-up notification appears when clicking ‚Copy link to clipboard’ which allows you to ‚Activate’ an already opened configuration or to create a new one if none exists yet.

Open and activate an existing configuration

Open and activate an existing configuration

  • Now open the documentation file to which you want to add the link. The file must be an editable text format, e.g. a Word document. (See the section about placeholders if your links should be available in PDF files)
  • Select the text part which should be replaced by the link and press [Ctrl+V]. The link is added to the selected term.
  • Save the file.

Add link to documentation file

Add link to documentation file

  • Create a new PDF document with the same name as the documentation file.

Active configuration with files and links

Active configuration with files and links

Provide link information to others

When you have added all necessary elements to the configuration and the links between the document and the model, you can provide the files and the link information to others by exporting a bundle – a kind of archive. This enables other people to use the added links and navigate quickly between model elements and documentation and vice versa.

To create a bundle:

  • Click on the ‚Export bundle’ button on the top right corner of the configuration editor.

Export a bundle

Export a bundle

  • A file selection dialog opens where you can give a name to the bundle and save it. The bundle file extension should be .ybundle.

After saving the bundle, a dialog window opens and asks you if you want to open it. When selecting ‚yes’, the new bundle opens in a new tab in the editor. You can see a list with the elements that exist in the bundle.

Bundle view

Bundle including a model file, the documentation and link information

YAKINDU Model Viewer supports the navigation between a model and documentation files in both directions via the created links.

In both cases, the easiest way is to open the bundle file ( .ybundle) because it includes all relevant files for you.

  • Go to the main menu and select File > Open File.... A file selection dialog opens and you can select the bundle file ( .ybundle). Alternatively, you can double-click the bundle file in your local file folder and it will open directly in the YAKINDU Model Viewer. The bundle opens in a new tab in the editor area.
  • Activate the bundle by clicking on the ‚Activate’ link in the top left corner of the bundle view. The color of the status bar changes to green indicating that the current bundle is active

Activate a bundle

Activate a bundle

  • Open the model included in your bundle by double clicking it in the bundle view. All model elements having a link are marked with a document icon:
  • Hover the icon to see a preview of the documentation that is related to the model element.

Documentation on the model

Documentation on the model

  • To read the whole documentation, click on the tooltip and the document will open at the position of the link in the YAKINDU Model Viewer.

Navigate from the model to the documentation

Navigate from model to documentation

You can also navigate from the documentation ( .pdf) to the model ( .mdl).

  • Go to the bundle and double-click the PDF file. This will open in a new tab in the YAKINDU Model Viewer.
  • Click on a link (links are blue and underlined) in the document and the model will open in a new tab.
  • The model element corresponding to the link is highlighted by having a red border around it.

Navigate from the documentation to the model

Navigate from the documentation to the model

In general it is possible to activate link handling support for modelviewer links from each type of file on the operating system.

  • Click „Window” - "Preferences"
  • Go to page „General” - "Link Handling"
  • Check the checkbox for ylink link handling
  • Click "Apply and Close"

Activate link handling on the preference page

Activate OS support for following links

Now you can place a link in a word document or a html file that fits to the scheme ‚ylink://’ and points to a model element. If you click on it YAKINDU Modelviewer opens.

The command line interface

With the command line interface CLI you can create bundles without opening YAKINDU Model Viewer. This might be usefull for integrating the bundle creation in your build infrastructure.

To use this command line interface you open the OS shell on the folder „YMV/Model_Viewer/CLI”. Now you start the tool with the following command:

 java -jar ymv-cli.jar

command line interface

With the command line interface you can perform 2 main tasks:

  • create a ybundle based on a documentation configuration file (.yconf)
  • send a link to a defined receiver

Create a bundle

To create a bundle you need to put all necessary files e.g. the model, the documentation and the documentation configuration file in a directory.

With the following command you can bundle these files to a documentation bundle (.ybundle):

java -jar ymv-cli.jar -e -c [path_to_documentation_config] -t [path_to_target_bundle].ybundle 

The newly created bundle needs the extension ‚.ybundle’.