Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.
Prev | Next |
Notes
Notes are textual descriptions that can be added to an element, diagram, feature or connector in Enterprise Architect. They provide valuable information that describes the entity being modeled. Many newcomers to modeling are not aware that these textual descriptions are core to many of the modeling languages including UML, BPMN and SysML; without them the model would be hard to understand and remain opaque. A well-formed note is unambiguous and doesn’t contain redundant information that has been entered in other properties of the entity.
The notes can be formatted using the Notes Toolbar, conveniently located above the 'Notes' field. This formatting can be carried through to documentation generated from the model, and includes such markup as italics, bolding, bullets and hyperlinks. Glossary Terms and model elements can also be referenced from the 'Notes' field. There are also convenient keyboard shortcuts available for quick editing in the 'Notes' field.
Notes can be accessed in the Notes Window, which can be docked anywhere in the application, or through the 'Properties' dialog for an element, feature, connector or diagram. Many experienced modelers have the Notes window visible and when they select an entity in a diagram, the Project Browser or another window that object immediately becomes the focus of the window and they can view, create or edit the notes. As you type text into the Notes window, the number of characters of text contained in the field is displayed in the left-hand end of the Status bar.
The title of the Notes window reflects the type of object you have selected. If you are looking at the notes of an element, the window has the title 'Element Notes'; if you have selected a diagram, the window has the title 'Diagram Notes', and so on.
Access
Ribbon |
Start > Explore > Properties > Notes Design > Element > Properties > Notes |
Context Menu |
Right-click on model element | Properties | Notes |
Keyboard Shortcuts |
|
Notes Context Menu options
Option |
Action |
See also |
---|---|---|
Create | Glossary Definition |
Click on this option to create a Project Glossary definition, with the Glossary term taken from the selected 'Notes' text. To create the Glossary entry:
The term displays in the 'Notes' text as a hyperlink, which displays the Glossary definition of the term in the 'Glossary Detail' dialog. Once you have created a Glossary definition, here or elsewhere in the model, you can add the Glossary term anywhere in the text of the Notes window (or 'Notes' field of a dialog) where, again, it becomes a Ctrl+click hyperlink to the definition. Either:
|
Project Glossary Glossary Detail |
Create | New Element from Selection |
Click on this option to create a new element in the model, the name of which is taken from the selected Notes text.
|
Add Elements Directly To Packages |
Create | Element on Diagram |
Click on this option to create a new element in the model, and explicitly in the diagram also, with its name taken from the selected Notes text. This option does not make the selected text a hyperlink to the element.
|
Toolbox Shortcut Menu |
Create | Link to Existing Element |
Click on this option to create a hyperlink from the selected Notes text to an existing element in the model.
|
Select |
Search for <'selected'> |
Click on this option to display a subset of the functions of the common Code Editor menu 'Search' option, to locate a text string outside the element. In a 'Notes' field (not in the Notes window) you can perform a search of the text for a text string:
|
Code Editor Context Menu |
Undo
|
These six options provide simple functions for editing the Notes text. |
Keyboard Options For Notes
Option |
Description |
See also |
---|---|---|
Switch text orientation |
Hold , press Description: On a line of text, right-justifies or left-justifies the paragraph in which that line occurs. Use the keys on the left of the alphanumeric keyboard to left-justify the text; use the keys on the right of the keyboard to right-justify the text. |
|
Insert Date and Time |
Description: Inserts the current date and time at the cursor position, in the format: DD/MM/YYYY HH:MM:SS AM (or PM) For example: 22/12/2016 3:39:50 PM |
|
Spell check Notes text |
Description: Performs a simple spell check on the Notes text. |
|
Undo changes |
Description: Reverses the last change made to the Notes text. |
|
Redo changes |
or
Description: Re-applies the last reversed change to the Notes text. |
|
Copy |
Description: Copies a highlighted Notes text string to the Enterprise Architect buffer. |
|
Paste |
Description: Pastes a copied or cut text string from the Enterprise Architect buffer into the Notes text. |
|
Cut |
Description: Removes a highlighted Notes text string and places it in the Enterprise Architect buffer. |