Chapter 39. Notes in Graphs

Placing Notes into Graph
Resizing Notes
Editing Notes
Formatted Text
Links from Notes
Folding Notes
Notes Properties

Notes let the user type necessary pieces of information directly into a graph. The notes can serve as a documentation to a particular graph.

Notes are rendered in a layer below components: if you place a note over a component, you will see the component rendered over the note.

Notes can serve as containers for components. If you move a note, you also move the components within the note.

Parameters used in text of notes are not resolved. If you type any parameter in a Note, the parameter is not replaced by its value.

Placing Notes into Graph

You can place a note into a graph from the Palette of Components: drag the note from Palette of Components and drop it into the Graph Editor Pane.

An alternative way to place a note to a graph is to click the Note icon in the Palette, move cursor to the desired location in the Graph Editor, and click again.

After that, a new Note will appear there. It has a New note label in the top.

This way, you can paste more Notes in one graph.

Resizing Notes

To resize a Note, highlight it by clicking, and then drag its margins.

Enlarging the Note

Figure 39.1. Enlarging the Note

When you have changed its size, click outside the Note. The highlighting disappears.

Editing Notes

To start editing the note content, double-click the note content. If the note is highlighted, a single click suffices.

If you click on the Note, the formatted text switches to the text in an editor.

Type the text of your note and click outside the note to see the text with proper formatting.

Formatted Text

When you type text of your note, you will see your text without any additional formatting. Optionally, you can make your text formatted.

You can format the text with tools from toolbar above the text. When you have clicked the note the toolbar appears above the note.

To change format of the text, mark the text to be formatted, and click the tool from the toolbar.

Toolbar for Format Editing

Figure 39.2. Toolbar for Format Editing

You can:

  • Use headers of 6 levels

  • Format you text as bold, italics, underlined, strikethrough, preformatted, or monospace

  • Use lists: simple lists, bulleted lists, numbered lists, and mixed lists

  • Insert links

  • Change text color and background color for the whole note

  • Change font size

The default font size configuration is taken from the operating system.

Note with formatted text and markup

Figure 39.3. Note with formatted text and markup

Notes Markup and Escaping Backslashes

Text notes use subset of Confluence wiki syntax to format the content. You can format the note content using the markup directly without icons from toolbar.

The markup in notes uses backslash character (\) as an escape character and \\ to create a new line.

If you paste an absolute Windows path into a note, the backslash characters are replaced with HTML entities to make the path correctly visible when the note is rendered.

You can convert backslashes to entities manually. From toolbar, choose SEscape backslashes.

Folding Notes

Content of a note can be folded (hidden). You can fold any Note by selecting the Fold item from the context menu.

A folded Note has a visible label. Its text is hidden.

A Folded Note

Figure 39.4. A Folded Note

Notes Properties

You can set up many properties of any Note in the Properties tab. Click the Note and switch to the Properties tab (in the bottom).

You can see and edit Text, set its size, color, or the color of a note's background. To edit or see the text, you can open it in a new window.

To change the Text and background color, select one from the toolbox.

The default font sizes are displayed in this tab and can be changed as well. If you want to fold the Note, set the Folded attribute to true.

Each Note has an ID like any other graph component.

Properties of a Note

Figure 39.5. Properties of a Note


VersionCompatibility Notice

Notes have been significantly changed. The previous version allowed you to type a title and text without any formatting, links, etc.

Old notes can be easily converted into the new ones - simply edit the old note and save it.