Documenting Your Model

From Numerus
Revision as of 16:13, 4 October 2018 by Rsalter (talk | contribs) (→‎Information Panel)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

You can document your model using Comments and Information Panels. Comments are dragged onto the Design Canvas from the Component list and may appear on the Runtime Canvas if so desired. The Information Panel is page of HTML text. It is opened either from the menu by using Tools | Documentation, or by clicking the About... button at the top of the left panel above the model name.

Comment

Comment.png

Comments contain text that appears on the Design Canvas and (optionally) on the Runtime Canvas. Text size, color and background color are set in the Properties pane.

Information Panel

Info.png

The Information Panel displays extended documentation using HTML text. It can be edited either using the provided HTML editor or as plain text. Opening the Information Panel using the About... button always presents the text in Display HTML mode.