Add or Read Notes for Model Layers

You can describe your model with notes to help others to understand it. You can add notes to any system in the model hierarchy by entering text, showing website content, or inheriting note content from the parent system. For each system, you can also choose not to show any notes.

To get started, in the Modeling tab, under Design, click Notes. If the model has notes associated with it, they appear in a pane to the right of the model. As you navigate the hierarchy, notes for each system appear. If the model does not have notes, you can add them.

Manage Notes Files

Notes are stored in a file with the extension .mldatx. If you want your model to have notes, first create the notes file. See Add and Edit Notes. After you create the file, the notes you add are saved automatically.

You can have multiple notes files associated with the same model, for example, for users with different roles. The person using the model can then select among notes files that match your model. Notes files contain model name and version information to ensure the notes file and model match.

The .mldatx file is saved separate from the model. If you move your model to a different folder, the .mldatx file does not also move, but the association remains if the file is on the MATLAB® path.

Read and Edit Modes

Use the Notes pane to edit and read notes. Use the Read/Edit Notes toggle to switch between modes. When you click Edit Notes, the editing features are enabled. When you click Read Notes, the editing features are not available. Instead, the content displays in read-only format. As you navigate the model, the Notes pane updates with the content for the current system.

Add and Edit Notes

  1. In the model, on the Modeling tab, under Design, click Notes. The notes interface appears to the right of the model and includes instructions to get started.

  2. Click the Create a notes file button.

  3. Enter a name for the notes file, or use the default name, and click Save.

  4. The Notes pane is in editing mode. You can add notes in these ways:

    • Enter text in the text editor.

    • From the menu, select Use URL for Notes and enter a URL whose content you want to show as notes for the current system.

    • Navigate to a different system in the model and enter text, use a URL, or select Show Parent Notes.

    • Select No Notes.

  5. When you have finished adding and editing, click the Read Notes toggle button to put the notes in reading mode.

To edit notes from reading mode, navigate to the system whose content you want to edit and click the Edit Notes toggle button .

Related Topics