Commit f671b005 authored by Jaden DIEFENBAUGH's avatar Jaden DIEFENBAUGH

[docs][db] update editor docs for #74

parent 1aa46af1
Pipeline #22661 canceled with stages
in 21 minutes and 9 seconds
......@@ -40,21 +40,22 @@ Database Editor
1. `Root Folder field`: The absolute path to the root folder for the data files for this database. This folder is used inside the BEAT system to provide the data files to the database Python code when indexing/executing the database views.
2. `Active Protocol`: Databases can have multiple protocols, but you only edit one at a time. The active protocol is shown, while the others are hidden. The active protocol in this image is "Main".
3. `Protocol Switcher`: A dropdown which lets you switch to other protocols.
4. `Protocol Delete & Clone buttons`: Buttons to delete and clone the active protocol.
5. `New Protocol Button`: Create (and switch to) a new protocol.
4. `Protocol Delete, Clone, and Create buttons`: Buttons to delete, clone, and create protocols. _Delete_ and _Clone_ operate on the active protocol. _Clone_ and _Create_ automatically switch the active protocol to the new protocol.
5. `Protocol Template Insert field`: Search and insert a protocol based on the protocol template name from any database in your prefix.
6. `Protocol Name field`: Change the protocol's name.
7. `Protocol Template field`: Change the protocol's template name.
8. `New Set button`: Add a new set to the protocol.
9. `Protocol Set`: A protocol has sets, each of which are shown in succession. The first set in this image is "training", the second is "testing".
10. `Set Delete & Clone buttons`: Buttons to delete or clone the set.
11. `Set Name field`: Field to change the set's name.
12. `Set Template field`: Field for changing the set's template name.
13. `Set View Name field`: Field for entering the name of the Python View class to use for this set.
14. `New Set Parameter button`: Creates a new parameter for the set, each of which having a name and a string value.
15. `New Set Output button`: Creates a new output for the set.
16. `Output Name field`: Field for changing the output's name.
17. `Output dataformat field`: Field for selecting the output's dataformat.
18. `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.
8. `Protocol Template Warning`: If the active protocol has a template name which is shared by at least one other protocol in any database with different contents, this warning pane will show the protocol names & associated databases. This warning shows because every protocol with the same template name should have the exact same sets/outputs/inputs/parameters.
9. `New Set button`: Add a new set to the protocol.
10. `Protocol Set`: A protocol has sets, each of which are shown in succession. The first set in this image is "training", the second is "testing".
11. `Set Delete & Clone buttons`: Buttons to delete or clone the set.
12. `Set Name field`: Field to change the set's name.
13. `Set Template field`: Field for changing the set's template name.
14. `Set View Name field`: Field for entering the name of the Python View class to use for this set.
15. `New Set Parameter button`: Creates a new parameter for the set, each of which having a name and a string value.
16. `New Set Output button`: Creates a new output for the set.
17. `Output Name field`: Field for changing the output's name.
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
=================
......
This source diff could not be displayed because it is too large. You can view the blob instead.
......@@ -16,7 +16,10 @@
height="1641"
viewBox="0 0 1749 1641"
sodipodi:docname="experiment_editor.svg"
inkscape:version="0.92.2 2405546, 2018-03-11">
inkscape:version="0.92.2 2405546, 2018-03-11"
inkscape:export-filename="/home/jae/code/beat.editor/doc/img/editor_experiment_breakdown.png"
inkscape:export-xdpi="96"
inkscape:export-ydpi="96">
<metadata
id="metadata872">
<rdf:RDF>
......
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