Adding / Editing Documentation

You can add or edit documentation in the Modelica text of a class, and display it in an html format.

  1. Activate a class.

  2. Activate Documentation Editor from the Authoring toolbar.

    The Documentation Editor dialog box appears.

    If a documentation already exists for this class, it is displayed.

    If no documentation exists, you can use this editor to create a documentation.



  3. Select your display mode(s):

    • Text Editor : to type and format your text using the text format commands.
    • Html Editor : to check and edit html tags.

    Tip: You can use simultaneously these two modes.

  4. Edit the text:

    • typing text and using the text format commands (in the Text field)
    • typing text and html tags (in the Html field)

  5. Select Insert Equation .



  6. Type your equation then click OK.

    Your equation is inserted.

  7. To add images, click Insert Image .



  8. Browse to select your image then click Open.

    Your image is inserted in the documentation text.

  9. To add an hyperlink to an external document, select a word in your text from the Text editor, then select Create link .



  10. Click Browse or enter an URL, then click OK.

    The hyperlink is inserted.

  11. Click Apply to add this information to the active class without closing the Documentation Editor dialog box.

  12. Select another class.

    Its documentation appears in the Documentation Editor dialog box.

    Note that a red lock appears, to indicate that this class is not the active one, so it cannot be edited.

  13. Click the red lock symbol to activate the component.

    The symbol turns green, you can now edit the documentation of this class.

  14. Use the blue arrows to navigate through the previous and next documentation pages that you have already opened.



  15. Click OK to close the Documentation Editor dialog box.