Documentation panel

Use the Documentation panel to add notes or comments about the selected entity. You can use the Documentation panel to describe the entity, to document assumptions about it, or to add any other notes you want to help model users understand your model.

Model users can see the documentation when they view the Documentation panel for the selected entity.

Tip: If a slider, knob, or other input object is assigned to an entity that has documentation, a "?" appears on the input object. Click the "?" to view the documentation.

To view the Documentation panel, click the tab at the bottom of the panels. For information about using panels, see Working with panels.

Note: To view the Documentation panel, you must be viewing the model on the Map or Model layer.

Rich Text button

Click this button to use rich text formatting for the documentation. This allows you to specify the font style and size for the text, to use bold face italics, and underline styles, and specify font color, and to select to text alignment.

Note: The font you select in rich text format is for documentation only. It does not affect the font used for entity names and other text in the model.

To use plain text instead, click the Plain Text button.

Documentation

Type the documentation for the selected building block in the large box on the panel.

Concept Link IconSee Also