To document your EventFlows, you can add Notes. Notes can attach to the EventFlow canvas, to individual components, to two or more components selected together, or to Groups. It is even possible to attach a Note to another Note.
The only purpose of notes is to provide documentation directly in your EventFlow. A note icon on your EventFlow canvas has no effect on your application's functionality, it only indicates the presence of information for the developer.
To add a Note:
-
Select where you want the Note to attach. That is:
-
Click anywhere in the EventFlow canvas to create a free-standing Note attached to the EventFlow itself.
-
Select a single component.
-
Select two or more components.
-
Select a Group.
-
-
Right-click and select from the context menu.
-
For component-associated notes , the note icon has a visible connection to the component.
-
For free-standing notes, the note icon appears as an unconnected component.
-
-
To add text to a note, click the note to open its Properties view, and edit the fields in the General tab:
- Name
-
Enter the note title that you want displayed in the EventFlow.
- Description
-
Enter your text in the Description field. The field preserves line breaks, and can render the following HTML tags:
b,p, andbr.
To see the contents of a note in the EventFlow, hover your cursor over its icon. As with other EventFlow components, the General tab's description text is displayed in a tooltip box.
The text you place in Notes is saved with the EventFlow application, but does not
affect the functionality of your application. Note text can be seen as one or more
gui.note elements when you view your EventFlow
application in source form.
When you delete a component that has an attached Note, the Note remains on the canvas and becomes a free-standing note.