diff --git a/docs/_pages/documentation.md b/docs/_pages/documentation.md index 08ba95ba3..6413c25b0 100755 --- a/docs/_pages/documentation.md +++ b/docs/_pages/documentation.md @@ -11,3 +11,70 @@ sidebar: nav: "docs" --- +# How to use the BT editor + +## Edit node + +Only available for port values and actions + +Two options: + +- Double click on the node +- Select the node, then click on the edit button + +![alt_text]({{ "assets/videos/add.mp4" | absolute_url }}) + +## Delete node + +Two options: + +- Select the node, then press Backspace or Delete keys +- Select the node, then click on the delete button + +https://github.com/JdeRobot/bt-studio/assets/124056014/4d280c54-0789-4d76-9944-a15153a8b984 + +## Add input/output to node + +Only available for actions + +1. Enter the edit menu +2. The inputs are in the left and the outputs are in the right +3. Click the add input/output button +4. Write the name of the input/output +5. If the name is valid a green button will be shown to the right of the cancel button. If not then the name is not valid and will need to be changed. +6. Press the green button + +https://github.com/JdeRobot/bt-studio/assets/124056014/0b73db9e-88f7-41d1-8516-ddbcebb07691 + +## Remove input/ouput to node + +Only available for actions + +1. Enter the edit menu +2. The inputs are in the left and the outputs are in the right +3. Hover over the one you want to delete and a red button will appear +4. Press the red button + +https://github.com/JdeRobot/bt-studio/assets/124056014/0a1243e3-b07d-4f69-a873-5401aa5eb84a + +## Zoom + +- Scroll up = Zoom in +- Scroll down = Zoom out + +https://github.com/JdeRobot/bt-studio/assets/124056014/8b902934-d4a1-4e51-89a7-a4b74e30cc9f + +## Download project + +Press on the download button found at the right of the help button. + +https://github.com/JdeRobot/bt-studio/assets/124056014/8b6c4ee9-b4d2-4e38-96b6-2b59e0d34858 + +## Blackboard port values + +When a port value is named enclosed in curly brackets: {example}; then this port will be part of the blackboard instead of just a value. +This will be indicated in the diagram by the port turning to black. + +The blackboard allows you to connect different input and output ports from different parts of the diagram. + +https://github.com/JdeRobot/bt-studio/assets/124056014/db127c45-3b4a-412c-b1f8-c76bfcdcef3c diff --git a/docs/assets/videos/add.mp4 b/docs/assets/videos/add.mp4 new file mode 100644 index 000000000..5e58ca630 Binary files /dev/null and b/docs/assets/videos/add.mp4 differ diff --git a/docs/assets/videos/blackboard.mp4 b/docs/assets/videos/blackboard.mp4 new file mode 100644 index 000000000..04ccbe9e6 Binary files /dev/null and b/docs/assets/videos/blackboard.mp4 differ diff --git a/docs/assets/videos/delete.mp4 b/docs/assets/videos/delete.mp4 new file mode 100644 index 000000000..296c764bb Binary files /dev/null and b/docs/assets/videos/delete.mp4 differ diff --git a/docs/assets/videos/download.mp4 b/docs/assets/videos/download.mp4 new file mode 100644 index 000000000..e820b0cb0 Binary files /dev/null and b/docs/assets/videos/download.mp4 differ diff --git a/docs/assets/videos/edit.mp4 b/docs/assets/videos/edit.mp4 new file mode 100644 index 000000000..fe5e084c9 Binary files /dev/null and b/docs/assets/videos/edit.mp4 differ diff --git a/docs/assets/videos/remove.mp4 b/docs/assets/videos/remove.mp4 new file mode 100644 index 000000000..76464ffd7 Binary files /dev/null and b/docs/assets/videos/remove.mp4 differ diff --git a/docs/assets/videos/zoom.mp4 b/docs/assets/videos/zoom.mp4 new file mode 100644 index 000000000..cc209a827 Binary files /dev/null and b/docs/assets/videos/zoom.mp4 differ