Skip to content

Commit dd8129b

Browse files
committed
Add annotation section to editor article
1 parent 3e8351d commit dd8129b

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

articles/editor.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,17 @@ If you leave one or more visualizers open when you stop the workflow, the editor
7878
> [!Tip]
7979
> Many visualizers allow you to access more detailed information or advanced configuration parameters by right-clicking on the visualizer window.
8080
81+
### Annotations
82+
83+
As workflows become more complex, it can be helpful to add labels, comments, or detailed instructions. Bonsai provides a unique [`Annotation`](xref:Bonsai.Expressions.AnnotationBuilder) operator that can be placed on its own or attached to individual nodes and workflow sections. Annotations can be written in plain text or in [Markdown](https://www.markdownguide.org/), a simple formatting language that makes it easy to add rich content such as [headings, lists, links and images](https://www.markdownguide.org/basic-syntax/).
84+
85+
![Annotations](../images/editor-annotation.png)
86+
87+
To use annotations, search for the [`Annotation`](xref:Bonsai.Expressions.AnnotationBuilder) operator in the toolbox and add it to the workflow. You can rename the annotation in the property grid. To open the text editor, right-click the operator and select `Show Default Editor`. Double-click the operator to view the formatted annotation. Like other operators, annotations are part of the workflow and are saved in the `.bonsai` file.
88+
89+
> [!Warning]
90+
> Images are not saved in the `.bonsai` file. To ensure accessibility when linking images, consider keeping them in the same folder as the workflow.
91+
8192
### Workflow Extensions
8293

8394
You can create and save workflow extensions by selecting one or more nodes and clicking the `Save Workflow As...` button in the context menu.

images/editor-annotation.png

52.4 KB
Loading

0 commit comments

Comments
 (0)