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:
These steps are described in more detailed in the following sections.
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:
Tips for saving the configuration:
Save the configuration at the same or at least near the location of your model and the documentation files.
Creating and saving a configuration
To add elements, e.g. the models and the documentation files, to the configuration:
Once you add an element in the configuration list, you can see two columns: the first one displays the name of the entry and the second one shows you the location in which the entry is located in your file system.
Configuration editor with two elements
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:
Menu icons and placeholder area
To get a better overview of your configuration list, you can organize the elements in a tree structure similar to a file system. With YAKINDU Model Viewer, you can create folders to group the elements into a clear structure.
To create a folder:
New folder in the configuration editor
YAKINDU Model Viewer supports only unique names for each element in the tree. When you enter a file or folder name which already exists, an exclamation mark is displayed next to it, indicating that there is duplicate name.
To rename a folder you first have to select it. Then you can do one of the following:
Give a new name to the folder and press [ENTER]. The folder is now renamed.
A folder can contain single resources e.g. .mdl files, Word files etc. or other folders. There are two ways you can add an element into a folder:
1. Select a folder and click the the
icon in the menu bar. Then select a file from the file system and it will be added automatically in the selected folder.
2. Drag & drop already existing elements in the configuration editor list into a folder. The targeted folder is highlighted in blue and you can add the element in it.
Drag and drop an element to a folder
Afterwards, the targeted folder is opened and the element that you moved is selected.
Element is added to a folder
To change the order of the elements in the tree, navigate to the element and drag it to a new location. A blue line indicates where the element can be placed.
Rearrange the configuration elements by drag & drop
Right-click on an entry displays an context menu. The menu items ‚Move up/down’ and ‚Move to top/bottom’ accompanied by the related shortcuts, allow you to move the elements accordingly.
Context menu on right-click
To edit a location of an entry, right click on it and select the menu item ‚Edit location’. The file dialog opens where you can choose a new location.
When you don’t need certain files or folders in your configuration, you can simply delete them from the editor.
To delete an element from the configuration list:
Note: Deleting a folder, will also delete the contained elements in it!
Further context menu items allow you to perform actions related to the selected item:
These can also be performed by the accompanied shortcuts or they exist already in the menu bar.
When you have added and arranged all the necessary files, you have successfully created the configuration.
When setting up a new configuration and adding a documentation file without links, a exclamation mark is shown next to the PDF file.
Configuration including a documentation without links
So what we need to do now is creating a link between a model and a documentation:
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
Add link to documentation file
Active configuration with files and links
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:
Export a bundle
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 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.
Activate a bundle
Documentation on the model
Navigate from model to documentation
You can also navigate from the documentation ( .pdf) to the model ( .mdl).
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.
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.
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
With the command line interface you can perform 2 main tasks:
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’.