Difference between revisions of "Documenting Your Model"

From Nova Documentation
Jump to: navigation, search
(Labels)
(Labels)
Line 3: Line 3:
 
== Labels ==
 
== Labels ==
  
Labels are components that can be added either to the Model Canvas or Dashboard, and display rich text. To add a label open the [[Frames, Menus, Toolbars, Pallets#Pallets | Components pallet]] and select Label, as shown here,
+
Labels are components that can be added either to the Model Canvas or Dashboard, and display rich text. To add a label open the [[Frames, Menus, Toolbars, Pallets#Pallets | Components pallet]] and select Label, as shown on the left, and drag it to either the Model Canvas or Dashboard. [[File:Help_doc_label_pallet.png|100xpx|thumb|left|Selecting a label from the Component pallet]]  
[[File:Help_doc_label_pallet.png|100xpx|thumb|left|Selecting a label from the Component pallet]] and drag it to either the Model Canvas or Dashboard.
+
  
Unlike other components, labels do not have names, and so the component will appear immediately, ready for editing. [[File:help_doc_label_editing1.png|300xpx|thumb|Newly placed label]]
+
Unlike other components, labels do not have names, and so the component will appear immediately, ready for editing, as shown on the right. [[File:help_doc_label_editing1.png|350xpx|thumb|Newly placed label]] The intial content of the label is <code>Enter Text</code>, which you should delete, substituting your own content.
 +
 
 +
As with any other component, right-clicking on the label produces the Properties pane.
 +
 
 +
 
 +
<br sides="both">
 +
[[File:help_doc_label_props.png|500xpx|center|frame|Label Properties]]

Revision as of 23:33, 2 January 2015

Nova provides two ways to add documentation to your model: Labels and Information Panels. Starting with version 13.4, both Labels and Information Panels use HTML tags to provide a programmable rich text format. Examples of the use of both can be found in the Model Library.

Labels

Labels are components that can be added either to the Model Canvas or Dashboard, and display rich text. To add a label open the Components pallet and select Label, as shown on the left, and drag it to either the Model Canvas or Dashboard.
Error creating thumbnail: File missing
Selecting a label from the Component pallet
Unlike other components, labels do not have names, and so the component will appear immediately, ready for editing, as shown on the right.
Error creating thumbnail: File missing
Newly placed label
The intial content of the label is Enter Text, which you should delete, substituting your own content.

As with any other component, right-clicking on the label produces the Properties pane.



Label Properties