Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "Annotations" section to "Workflow Editor" article #121

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions articles/editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,17 @@ If you leave one or more visualizers open when you stop the workflow, the editor
> [!Tip]
> Many visualizers allow you to access more detailed information or advanced configuration parameters by right-clicking on the visualizer window.

### Annotations

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/).

![Annotations](../images/editor-annotation.png)

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.

> [!Warning]
> Images are not saved in the `.bonsai` file. To ensure accessibility when linking images, consider keeping them in the same folder as the workflow.

### Workflow Extensions

You can create and save workflow extensions by selecting one or more nodes and clicking the `Save Workflow As...` button in the context menu.
Expand Down
Binary file added images/editor-annotation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.