This repository has been archived by the owner on Dec 8, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathexplanation_of_yaml_file_content.yml
86 lines (85 loc) · 5.62 KB
/
explanation_of_yaml_file_content.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# ** means need to be there
Program: **
name : [string] ** (Program Name)
exitValue : [int] ** (output exit value)
executablePaths : **
ExecutableLinux : [string,''] (Path/to/program/in/Linux)
ExecutableMacOSX : [string,''] (Path/to/program/in/MacOSx)
Executable : [string,''] ('Path\to\program\in\Windows')
menu : [string] ** ('Menu:Submenu')
numImputs : [int] ** (number of inputs)
outputsPath : [string] Path/for/outputFiles (if empty it's the same as the first input file)
publication : [string,''] (link to a publication)
helpSupplementary : [string,''] (Help will be found in top right of the box)
desc : [string,'']
website : [string,''] (link to application website)
webServices : [string,''] (link to application webservices)
#outputFilesFromoutputsPath: [string,''] (NOT USED ANY MORE, we use shared folder between docker container and host)
version : [string,''] (link to application version)
Docker:
imageName : [string] ** (name of content in docker hub)
cmd : [string] ** (command to be executed in docker container)
sharedFolders : By default there is two shared folder one for inputs one for outputs. It will automatically create and use sharedfolders for inputs and outputs.
Here it's if you need more specific directories. They will be added when the container will be initiate.
It's better if the directory is setted in the dockerfile before.
- [string path local]<>[String path docker] (link to the shared a specific folder in container, ex. licenced files)
- [string path local]<>[String path docker]
rmks : [string,''] (any remarks)
Inputs: **
- type : [string] ** (biologic type)
connector : [[2,4],true] ** (wich connector)
connectorText : [string] ** (connector text)
OneConnectorOnlyFor : [true,false,''] (Only one connector will be able to be added with the connector)
SolelyConnectors : [true,false,''] (Solely with the connector, usable when it's true, form of restriction)
command2Call : [string,''] (command used before the inputs)
extension : [string] ** (file extension, better if linked with biologic extention type)
Outputs:
- type : [string] ** (biologic type)
connectorText : [string] ** (connector text)
command2Call : [string,''] (command used before the outputs) WARNING if you are using > write '>' or ">".
extension : [string] ** (file extension, better if linked with biologic extention type)
Menus:
- name : [string] ** Default Options (good to have one if you need a menu)
help : [string,''] Default Options
isMenu : [true/false] ** (part of menu options, if severals are true, when you will be able to select and choose options for these menus)
isTab : [true/false] ** (how tab will be seen, if tree it will be tab in tab. If false, it will be tab and label)
- name : [string] ** (Other Option)
help : [string,''] Default Options (will be used in tooltip)
isMenu : [true/false] (part of menu options, if severals are true, when you will be able to select and choose options for these menus)
isTab : [true/false] (how tab will be seen, if tree it will be tab in tab. If false, it will be tab and label)
Panel:
- tab : [string] ** (Other Option)
Arguments: **
- name : -[string] ** (argument to be executed in options
shortName : -[string,''] (short argument to be executed in options
cType : [box,but] ** (box or button used to select the arguement)
values :
vType : [dou,int,boo,flo,byt,sho,lon,combo,text] ** (type of value: double, integer, boolean, float, byte, short, long, combobox, text)
vDefault: [val,string] **
# If [dou,int,boo,flo,byt,sho,lon]
vMin : [val]
vMax :
vJump : 1
# If combo
vValues : ** (need values)
- [string] **
- [string] **
# If text
# will use vDefault only
tooltip : [string] ** will be used in tooltype to help user
label : [string,''] added after the value or the box
oppositeTo :
- [string] name of opposite commands (if this one is selected the other will be removed)
- [string] name of opposite commands (if this one is selected the other will be removed)
parentOf :
- [string] name of children commands (if this one is selected, the other will be available)
- [string] name of children commands (if this one is selected, the other will be available)
selected : [true,false,''] this command is selected by default
cHelp : [string] help for argument
AfterProcess:
- modifications:
- Editor:
- Java
- Form
- Program
- Properties