You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Expand and reformat "Commands and Shortcuts" section in "Workflow Editor" article (#120)
* Migrate existing commands and shortcuts to pipe table
* Add tab layout to separate mouse from keyboard controls
* Add `<kbd>` styling tag for keyboard shortcuts
* Add new actions and shortcuts for Bonsai 2.9
* Highlight context menu action as a tip
Copy file name to clipboardExpand all lines: articles/editor.md
+72-86Lines changed: 72 additions & 86 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,19 +23,19 @@ The `Toolbox` allows you to search for available operators to place in the workf
23
23
24
24
Operators inside each major category are further organized by namespaces linked to the packages you have installed. The name of each namespace can give you a hint about what kind of operations or devices can be accessed inside (e.g. the [`Audio`](xref:Bonsai.Audio) namespace provides access to audio capture devices or WAV file readers).
25
25
26
-
Once you have found which operator you want to insert, you can place it by double-clicking, dragging it to the workflow or alternatively right-clicking and selecting a specific placement option. See the [Commands and Shortcuts](#commands-and-shortcuts) section for more information.
26
+
Once you have found which operator you want to insert, you can place it by double-clicking, dragging it to the workflow or alternatively right-clicking and selecting a specific placement option. See the [Actions and Shortcuts](#actions-and-shortcuts) section for more information.
27
27
28
28
### Search Operators
29
29
30
30
Another way to quickly find operators is to use the `Search` textbox. Any text inserted here is matched against available operators, subjects, or namespaces for a match in any order. This means you can search not only for a specific operator name but also by category names to locate all the operators in a namespace (e.g. try typing `Arduino`).
31
31
32
32
> [!Tip]
33
-
> You can directly type and search for operator names when the `Workflow` panel has the input focus. This allows you to simply start typing an operator name and directly select which operator you want with the up/down arrow keys. Once you have the right operator, press the `Enter` key to place it. You can repeat the process multiple times to very quickly chain a sequence of operators.
33
+
> You can directly type and search for operator names when the `Workflow` panel has the input focus. This allows you to simply start typing an operator name and directly select which operator you want with the up/down arrow keys. Once you have the right operator, press the <kbd>Enter</kbd> key to place it. You can repeat the process multiple times to very quickly chain a sequence of operators.
34
34
35
35
Another useful function of the `Search` textbox is to find existing instances of the selected toolbox operator in the workflow. Once you select an operator in the toolbox, you can use the `Find Next` or `Find Previous` commands to jump into the next instance of the operator, subject, or workflow extension, starting from the current cursor position.
36
36
37
37
> [!Tip]
38
-
> You can browse through the reference documentation to learn more about each operator in the `Toolbox` by pressing `F1` or selecting `View Help` from the context menu.
38
+
> You can browse through the reference documentation to learn more about each operator in the `Toolbox` by pressing <kbd>F1</kbd> or selecting `View Help` from the context menu.
39
39
40
40
## Workflow
41
41
@@ -103,86 +103,72 @@ Most properties can be configured simply by changing the text value in the corre
103
103
> [!Note]
104
104
> Some operators have even more specialized editor windows such as camera configuration dialogs or media player controls. If such property pages exist for the currently selected operator, the small `Property Pages` button (<imgsrc="~/images/propertypages.png" />) above the property grid will become active.
105
105
106
-
## Commands and Shortcuts
107
-
108
-
Below is a summary of the most used commands and shortcuts in the workflow editor:
109
-
110
-
### Running the workflow
111
-
112
-
* Click the arrow `Start` button
113
-
* Press `F5`
114
-
115
-
### Stopping the workflow
116
-
117
-
* Click the square `Stop` button
118
-
* Press `Shift`+`F5`
119
-
120
-
### Insert an operator after the selected node
121
-
122
-
* Right-click the operator name and select the `Insert After` option
123
-
* Drag-and-drop the operator from the toolbox to the worflow
124
-
* Double-click the operator name in the toolbox
125
-
* Press the `Enter` key while the operator is selected in the toolbox
126
-
* Copy another node (`Ctrl`+`C`) and paste in the toolbox (`Ctrl`+`V`)
127
-
128
-
### Insert an operator before the selected node
129
-
130
-
* Right-click the operator name and select the `Insert Before` option
131
-
* Hold the `Shift` key together with any of the above commands (e.g., `Shift`+`Enter`)
132
-
133
-
### Insert an operator as a new branch of the selected node
134
-
135
-
* Right-click the operator name and select the `Create Branch` option
136
-
* Hold the `Alt` key together with any of the above commands (e.g., `Ctrl`+`Alt`+`V`)
137
-
138
-
### Create a connection between two operators
139
-
140
-
* Right-click the source node, select the `Create Connection` option and left-click on the target node
141
-
* Drag the source node and drop it on the target node
142
-
143
-
### Remove a connection between two operators
144
-
145
-
* Right-click the source node, select the `Remove Connection` option and left-click on the target node
146
-
* While holding the `Shift` key, drag the source node and drop it on the target node
147
-
148
-
### Selecting multiple nodes
149
-
150
-
* Click an empty space in the workflow panel and drag a box around the nodes to be selected
151
-
* While holding the `Shift` key, press the arrow keys to select a string of nodes around the currently selected node
152
-
* Hold the `Ctrl` key and click on a node to add/remove it from the current selection
153
-
154
-
> [!Note]
155
-
> Many operations can be performed on multi-node selections (e.g., delete, create connections, create a node group, etc.).
156
-
157
-
### Open the type visualizer for an operator
158
-
159
-
* Double-click on the target node while the workflow is running
160
-
* Right-click on the target node and select a visualizer from the `Show Visualizer` dropdown
161
-
* Press `Enter` while the target node is selected
162
-
163
-
### Grouping operators into a node group
164
-
165
-
* Select all the nodes to group and press `Ctrl`+`G` to create a nested workflow
166
-
* Right-click on a multi-node selection and select a group type from the `Group` dropdown context menu
167
-
168
-
> [!Note]
169
-
> You can change the type of an existing group simply by right-clicking on the group node and selecting a different type from the `Group` dropdown.
170
-
171
-
### Open a node group or the default editor for an operator
172
-
173
-
* Double-click on the target node while the workflow is not running
174
-
* If the workflow is running, hold the `Ctrl` key while double-clicking on the target node
175
-
* Press `Ctrl`+`Enter` while the target node is selected
176
-
177
-
### Ungrouping a node group
178
-
179
-
* Right-click on the group node and select the `Ungroup` option from the context menu
180
-
* Press `Ctrl`+`Shift`+`G`
181
-
182
-
### Open context menu
183
-
184
-
* Right-click any node, multi-node selection or empty space in the workflow panel
185
-
* Press `Shift`+`F10`
186
-
187
-
> [!Note]
188
-
> Depending on what is currently selected, the context menu may show different available actions.
106
+
## Actions and Shortcuts
107
+
108
+
> [!TIP]
109
+
> As previously mentioned, right-clicking to bring up the context menu is the most useful action to discover a list of available commands, which will vary depending on the editor panel you right-click in and the current selection.
110
+
111
+
Below is a summary of the most used actions and shortcuts in the workflow editor:
| Insert operator | In the `Toolbox` panel, choose any of these options: <li> Select the operator, drag-and-drop to the `Workflow` panel <li> Right-click the operator, select either of the `Insert` options <li> Double-click the operator <br><br> By default the operator will be placed after a node that is selected in the `Workflow` panel. If a connection can be formed, the two nodes will be connected. <br><br> To insert the operator before a selected node, hold down the <kbd>Shift</kbd> key together with any of the above actions. |
118
+
| Replace operator | In the `Toolbox` panel: <li> With a node already selected in the `Workflow` panel, right-click the operator and select `Replace`|
119
+
| Remove operator | In the `Workflow` panel: <li> Right-click the operator, select `Remove`|
120
+
| Move or duplicate operator | In the `Workflow` panel: <li> Right-click the operator, select `Cut` or `Copy`<li> Right-click another node or anywhere else in the panel, select `Paste`|
121
+
| Create branch | In the `Toolbox` panel: <li> With a node already selected in the `Workflow` panel, right-click the operator and select `Create Branch`|
122
+
| Connect operators | In the `Workflow` panel, choose any of these options: <li> Right-click the source node, select `Create Connection` and left-click on the target node <li> Drag the source node and drop it on the target node |
123
+
| Disconnect operators | In the `Workflow` panel, choose any of these options: <li> Right-click the source node, select `Remove Connection` and left-click on the target node <li> Hold down <kbd>Shift</kbd>, drag the source node and drop it on the target node |
124
+
| Reorder operators | In the `Workflow` panel: <li> Right-click the source node, select `Reorder Connection` and left-click on the target node |
125
+
| Select multiple nodes | In the `Workflow` panel: <li> Click on an empty space and drag a box around the nodes to be selected <br><br> Hold <kbd>Ctrl</kbd> while clicking on a node to add/remove it from the current selection. <br><br> Many operations can be performed on multi-node selections or node groups (e.g., delete, create connections, create a node group, etc.). |
126
+
| Group operators | In the `Workflow` panel: <li> Right-click on a multi-node selection and select a group type from the `Group` dropdown <br><br> On an existing node group, you can do the same action to change the group type. |
127
+
| Ungroup node group | In the `Workflow` panel: <li> Right-click on the group node and select `Ungroup`|
128
+
| Open operator editor or node group | In the `Workflow` panel, choose any of these options: <li> When workflow is not running: double-click <li> When workflow is running: <kbd>Ctrl</kbd> + double-click |
129
+
| Open visualizer | In the `Workflow` panel, choose any of these options: <li> Double-click on the target node <li> Right-click on the target node and select a visualizer from the `Show Visualizer` dropdown <br><br> This action is only available when the workflow is running. |
130
+
| Disable node | In the `Workflow` panel: <li> Right-click on the node and select `Disable`|
131
+
| Enable node | In the `Workflow` panel: <li> Right-click on the node and select `Enable`|
132
+
| Toggle watch | In the `Workflow` panel, choose any of these options: <li> Select the node, click on the `Toggle Watch` button in the toolbar <li> Right-click the node and select `Toggle Watch` from the context menu |
133
+
| New tab or window | In the `Workflow` panel, choose any of these options: <li> Right-click the tab/window bar, select either of the `Open` options <li> Right-click the node, select either of the `Open` options <br><br> In the `Explorer` panel: <li> Right-click the nested node label, select either of the `Open` options |
134
+
| Find node | In the `Toolbox` panel: <li> Search for the operator, right-click on it and choose any of the `Find` options <br><br> In the `Workflow Panel`, choose any of these options: <li> Select the node and click on the `Find Next` and `Find Previous` buttons in the `Toolbar` <li> Right-click the node and select `Find All References`|
135
+
| View help | In the `Workflow` panel: <li> Right-click on the operator and select `View Help`|
136
+
| Go to definition | In the `Workflow` panel: <li> Right-click on the operator and select `Go To Definition`|
0 commit comments