|
1 | 1 | ---
|
2 |
| -title: Annotations |
| 2 | +title: Notes |
3 | 3 | ---
|
4 | 4 |
|
5 |
| -import EmbedMachine from '@site/src/components/EmbedMachine'; |
6 |
| - |
7 |
| -Annotations are notes you can use to annotate your machine, positioned anywhere inside your machine. Annotations are useful for information or comments you want to add to your machine that are only visible inside Stately Studio and not included when you export as code. |
| 5 | +You can use notes to annotate your machine, positioned anywhere inside your machine. Notes are useful for information or comments you want to add to your machine that are only visible inside Stately Studio and not included when you export as code. |
8 | 6 |
|
9 | 7 | <EmbedMachine
|
10 | 8 | embedURL="https://stately.ai/registry/editor/embed/5b170468-d66a-4136-84c8-676c8fea82e8?machineId=7879be19-d267-4e75-9a7d-6a870d540257"
|
11 | 9 | name="Annotated dog walk machine"
|
12 | 10 | />
|
13 | 11 |
|
14 |
| -Unlike [**descriptions**](descriptions.mdx), annotations don’t need to be connected to a state or transition and can be added or positioned anywhere inside your machine. |
| 12 | +Notes are formatted with Markdown so you can add links, images, and other formatting to your annotations. |
15 | 13 |
|
16 | 14 | :::tip
|
17 | 15 |
|
18 |
| -For now, annotations only support plain text. If you want to include text formatting, links, or images, [use **descriptions**, which have markdown support](descriptions.mdx). |
| 16 | +Unlike [**descriptions**](descriptions.mdx), notes don’t need to be connected to a state or transition and can be added or positioned anywhere inside your machine. |
19 | 17 |
|
20 | 18 | :::
|
21 | 19 |
|
22 |
| -## Add annotations to your machine |
23 |
| - |
24 |
| -You can add annotations anywhere on your machine from **Design** and **Simulate** mode, but you can only edit them in **Design** mode. |
25 |
| - |
26 |
| -Annotations are unrelated to a state or transition. Still, their layout position is connected to the closest root or parent state when you create them, which helps give your annotations enough space in the auto layout. |
| 20 | +## Add notes to your machine |
27 | 21 |
|
28 |
| -1. Right-click anywhere on the canvas to open the canvas menu. |
29 |
| -2. Choose **Add annotation** to create a new annotation on the canvas. |
30 |
| -3. Type your annotation text into the annotation. |
| 22 | +You can add notes anywhere on your machine from **Design** and **Simulate** mode, but you can only edit them in **Design** mode. |
31 | 23 |
|
32 |
| -## Edit annotations |
| 24 | +Notes are unrelated to a state or transition. Still, their layout position is connected to the closest root or parent state when you create them, which helps give your notes enough space in the auto layout. |
33 | 25 |
|
34 |
| -- Select an annotation to edit it, then click inside the annotation to edit its text. |
35 |
| -- Select and hold an annotation to drag and change its position on the canvas. |
| 26 | +- Use the <PlusSquare size={18}/> plus icon button in the canvas tools and choose **Note**. |
| 27 | +- Right-click anywhere on the canvas and choose **Add note**. |
36 | 28 |
|
37 |
| -## Delete annotations |
| 29 | +### Edit and delete notes |
38 | 30 |
|
39 |
| -- Select an annotation to edit it, then use backspace to delete the annotation. |
40 |
| -- Right-click on an annotation to open the **Delete** option menu, then use **Delete** to delete the annotation. |
| 31 | +- Double-click or use the <kbd>Enter</kbd> key to edit the contents of a note. |
| 32 | +- Use the <kbd>Backspace</kbd> key to delete the selected note. |
0 commit comments