Commit d9b32223 authored by Flavio TARSETTI's avatar Flavio TARSETTI
Browse files

Merge branch 'docedit' into 'master'

[doc][editor] added some reference to link in general documentation

See merge request !28
parents 3329b7a1 1708134d
Pipeline #24764 passed with stages
in 28 minutes and 30 seconds
.. _editor-beakdowns:
Editor Breakdowns
......@@ -18,6 +19,8 @@ Some of these editors are more complex than others - if you can't figure somethi
.. note:: If the images are too small, right-click on the image in your browser and click `View Image` to see the image in another tab at full resolution!
.. _generic-editor-features:
Generic Editor Features
......@@ -32,6 +35,8 @@ Generic Editor Features
7. `Python file generation button`: Generates a Python file based off a template for the object's type. This button is only available when editing objects of types that have Python files associated with them.
8. `Description field`: A short description of the object.
.. _database-editor:
Database Editor
......@@ -57,6 +62,8 @@ Database Editor
18. `Output dataformat field`: Field for selecting the output's dataformat.
19. `Quick Jump menu`: An overview of the protocols and sets in your database. Clicking on a protocol name will switch you to that protocol, and clicking on a set will jump you to that set. You can also create protocols & sets using the corresponding buttons.
.. _dataformat-editor:
Dataformat Editor
......@@ -72,6 +79,8 @@ Dataformat Editor
8. `New Subfield button`: Each dict field can have any amount of subfields added to it.
9. `New Field button`: Dataformats can have any arbitrary amount of top-level fields.
.. _algorithm-editor:
Algorithm Editor
......@@ -92,6 +101,8 @@ Algorithm Editor
13. `New Output button`: Adds a new output to the group.
14. `Delete Group button`: Deletes the group. The first group cannot be deleted, because all algorithms require at least one group.
.. _toolchain-editor:
Toolchain Editor
......@@ -122,6 +133,8 @@ How to use the Graphical Editor:
* Right-click on the background canvas to create blocks, insert them from existing toolchains, or insert them based off of an algorithm or database protocol.
* Select and operate on multiple blocks by shift-clicking blocks or by click-dragging an area select box. When any blocks are selected, all connections will be hidden except for those connected to/from the selected blocks. Click anywhere on the background canvas to dismiss the selection.
.. _experiment-editor:
Experiment Editor
......@@ -24,13 +24,9 @@
.. _beat_editor:
Local editor for BEAT objects
Local Editor for BEAT Objects
.. todo::
Write user guide
.. toctree::
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment