![](images/icons/{{include.icon}}{{ title | downcase | replace: " ", "-" }}.png){kind=icon}
+
+{% if include.table == "yes" and include.icon != "no" %}
+|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
|
+{% endif %}
+
+
+
+{% if include.table == "yes" and include.icon != "no" %}
+ | +{% endif %} + +{% endif %} + +{% if include.definition == "bold" %} + +{{ definition }} + +{% else %} + +{{ definition }} + +{% endif %} + +{% if include.table == "yes" and include.icon != "no" %} + |
-  Data Mine - |
- - | - | - | - | - | - | - | - |
|---|---|---|---|---|---|---|---|---|
- 
- |
-
-  Indicator Bot - |
- - | - | - | - | - | - | - |
- 
- |
-
-
- |
-
-  Process Definition - |
- - | - | - | - | - | - |
|
-
- |
-
-
- |
-
-
- |
-
-  Process Output - |
- - | - | - | - | - |
|
-
- |
-
-
- |
-
-
- |
-
- 
- |
-
-  Output Dataset - |
- - | - | - | - |
|
-
- |
-
-
- |
-
-
- |
-
-  Process Dependencies - |
- - | - | - | - | - |
|
-
- |
-
-
- |
-
-
- |
-
-
- |
-
-  Status Dependency - |
- - | - | - | - |
|
-
- |
-
-
- |
-
-
- |
-
-
- |
-
-  Data Dependency - |
- - | - | - | - |
|
-
- |
-
-
- |
-
-
- |
-
-  Status Report - |
- - | - | - | - | - |
|
-
- |
-
-
- |
-
-
- |
-
-  Execution Started Event - |
- - | - | - | - | - |
|
-
- |
-
-
- |
-
-
- |
-
-  Execution Finished Event - |
- - | - | - | - | - |
|
-
- |
-
-
- |
-
-  Product Definition - |
- - | - | - | - | - | - |
|
-
- |
- - |
-
- |
-
-  Dataset Definition - |
- - | - | - | - | - |
|
-
- |
- - |
-
- |
-
-  Record Definition - |
- - | - | - | - | - |
|
-
- |
- - |
-
- |
-
-
- |
-
-  Record Property - |
- - | - | - | - |
|
-
- |
- - |
-
- |
- - |
-
- |
-
-  Formula - |
- - | - | - |
|
-
- |
- - |
-
- |
-
-  Calculations Procedure - |
- - | - | - | - | - |
|
-
- |
- - |
-
- |
-
-
- |
-
-  Procedure Loop - |
- - | - | - | - |
|
-
- |
- - |
-
- |
-
-
- |
-
-
- |
-
-  JavaScript Code - |
- - | - | - |
|
-
- |
- - |
-
- |
-
-
- |
-
-  Procedure Initialization - |
- - | - | - | - |
|
-
- |
- - |
-
- |
- - |
-
- |
-
- JavaScript Code - |
- - | - | - |
|
-
- |
- - |
-
- |
-
-  Data Building Procedure - |
- - | - | - | - | - |
|
-
- |
- - | - |
-
- |
-
- Procedure Loop - |
- - | - | - | - |
|
-
- |
- - | - |
-
- |
-
-
- |
-
- JavaScript Code - |
- - | - | - |
|
-
- |
- - | - |
-
- |
-
- Procedure Initialization - |
- - | - | - | - |
|
-
- |
- - | - | - |
-
- |
-
- JavaScript Code - |
- - | - | - |
|
-
- |
-
-  Plotter - |
- - | - | - | - | - | - | - |
| - |
-
- |
-
-  Plotter Module - |
- - | - | - | - | - | - |
| - | - |
-
- |
-
-  Plotter Panel - |
- - | - | - | - | - |
| - | - | - |
-
- |
-
-  Panel Data - |
- - | - | - | - |
| - | - | - | - |
-
- |
-
-  Data Formula - |
- - | - | - |
| - | - |
-
- |
-
-  Shapes - |
- - | - | - | - | - |
| - | - | - |
-
- |
-
-  Chart Points - |
- - | - | - | - |
| - | - | - |
-
- |
-
-
- |
-
-  Point - |
- - | - | - |
| - | - | - |
-
- |
- - |
-
- |
-
-  Point Formula - |
- - | - |
| - | - | - |
-
- |
-
-  Polygon - |
- - | - | - | - |
| - | - | - | - |
-
- |
-
-  Polygon Vertex - |
- - | - | - |
| - | - | - | - |
-
- |
-
-  Polygon Border - |
- - | - | - |
| - | - | - | - |
-
- |
-
-
- |
-
-  Style - |
- - | - |
| - | - | - | - |
-
- |
-
-
- |
-
-  Style Condition - |
- - | - |
| - | - | - | - |
-
- |
- - |
-
- |
-
- Style - |
- - |
| - | - | - | - |
-
- |
-
-  Polygon Body - |
- - | - | - |
| - | - | - | - | - |
-
- |
-
- Style - |
- - | - |
| - | - | - | - | - |
-
- |
-
- Style Condition - |
- - | - |
| - | - | - | - | - | - |
-
- |
-
- Style - |
- - |
+{% include /data_mine/process-definition.md heading="##" icon="150-" adding="####" configuring="####" starting="" content="yes" definition="bold" table="yes" more="no"%}
-**{{site.data.data_mine.data_mine}}**
+{% include /data_mine/process-output.md heading="##" icon="150-" adding="####" configuring="" starting="" content="no" definition="bold" table="yes" more="no"%}
-In a way, data mines are catalogs of bots that anyone may create. This hierarchy provides all the tools required to create sensors, indicators, and plotters, with minimal coding required.
+{% include /data_mine/output-dataset.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-Because the hierarchy provides definitions, it does not intervene in the execution of bots. Instead, the definitions in data mines are instantiated from the Network hierarchy by bot instances. Bot instances and process instances are the ones running the code according to the definitions in the corresponding data mine.
+{% include /data_mine/process-dependencies.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-### Adding a Data Mine
+{% include /data_mine/status-dependency.md heading="##" icon="150-" adding="####" configuring="####" starting="" content="yes" definition="bold" table="yes" more="no"%}
-To add a data mine, select *Add Data Mine* on the workspace node menu.
+{% include /data_mine/data-dependency.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-### Configuring a Data Mine
+{% include /data_mine/status-report.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-Select *Configure Data Mine* on the menu to access the configuration.
+{% include /data_mine/execution-started-event.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-```json
-{
-"codeName": "Supermine"
-}
-```
+{% include /data_mine/execution-finished-event.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-* ```codeName``` is the name of the data mine as used within the code of the system.
+{% include /data_mine/product-definition.md heading="##" icon="150-" adding="####" configuring="####" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /data_mine/dataset-definition.md heading="##" icon="150-" adding="####" configuring="####" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /data_mine/record-definition.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /data_mine/record-property.md heading="##" icon="150-" adding="####" configuring="####" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /data_mine/formula.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /data_mine/calculations-procedure.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /data_mine/procedure-loop.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-## Indicator Bot
+{% include /data_mine/javascript-code.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-
+{% include /data_mine/procedure-initialization.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-**{{site.data.data_mine.indicator_bot}}**
+{% include /data_mine/data-building-procedure.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-The indicator bot node holds all definitions required for an indicator bot to function. Definitions are split between the definition of processes and products. Processes are algorithms that go through an input dataset, perform certain calculations, and produce an output. Part of that output is the data products the bot creates.
+{% include /data_mine/plotter.md heading="##" icon="150-" adding="" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-### Adding an Indicator Bot
+{% include /data_mine/plotter-module.md heading="##" icon="150-" adding="####" configuring="####" starting="" content="yes" definition="bold" table="yes" more="no"%}
-To add an indicator bot, select *Add Indicator Bot* on the data mine node menu. An indicator bot is created along with the basic structure of nodes required to define it.
+{% include /data_mine/plotter-panel.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-### Configuring an Indicator Bot
+{% include /data_mine/panel-data.md heading="##" icon="150-" adding="####" configuring="####" starting="" content="yes" definition="bold" table="yes" more="no"%}
-Select *Configure Bot* on the menu to access the configuration.
+{% include /data_mine/data-formula.md heading="##" icon="150-" adding="####" configuring="" starting="" content="no" definition="bold" table="yes" more="no"%}
-```json
-{
-"codeName": "Super",
-"repo": "Super-Indicator-Bot"
-}
-```
+{% include /data_mine/shapes.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-* ```codeName``` is the name of the bot as used within the code of the system.
+{% include /data_mine/chart-points.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /data_mine/point.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /data_mine/point-formula.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /data_mine/polygon.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /data_mine/polygon-vertex.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /data_mine/polygon-border.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /data_mine/style.md heading="##" icon="150-" adding="####" configuring="####" starting="" content="yes" definition="bold" table="yes" more="no"%}
-## Process Definition
+{% include /data_mine/style-condition.md heading="##" icon="150-" adding="####" configuring="####" starting="" content="yes" definition="bold" table="yes" more="no"%}
-
-
-**{{site.data.data_mine.process_definition}}**
-
-As hinted above, most bots, in particular indicators, have two different processes. The reason is that different data structures need to be handled in different manners. The Multi-Period-Daily process handles daily files, while the Multi-Period-Market process handles market files.
-
-### Adding a Process Definition
-
-To add a process definition, select *Add Process Definition* on the bot's menu. A process definition node is created along with the basic structure of nodes comprising the definition.
-
-### Configuring a Process Definition
-
-Select *Configure Process* on the menu to access the configuration.
-
-**Multi-Period-Market:**
-
-```json
-{
- "codeName": "Multi-Period-Market",
- "description": "Brief description of what the bot does.",
- "startMode": {
- "allMonths": {
- "run": "false",
- "minYear": "",
- "maxYear": ""
- },
- "oneMonth": {
- "run": "false",
- "year": "",
- "month": ""
- },
- "noTime": {
- "run": "true"
- },
- "fixedInterval": {
- "run": "false",
- "interval": 0
- }
- },
- "deadWaitTime": 0,
- "normalWaitTime": 0,
- "retryWaitTime": 10000,
- "sleepWaitTime": 3600000,
- "comaWaitTime": 86400000,
- "framework": {
- "name": "Multi-Period-Market",
- "startDate": {
- },
- "endDate": {
- }
- }
-}
-```
-
-**Multi-Period-Daily:**
-
-```json
-{
- "codeName": "Multi-Period-Daily",
- "description": "Brief description of what the bot does.",
- "startMode": {
- "allMonths": {
- "run": "false",
- "minYear": "",
- "maxYear": ""
- },
- "oneMonth": {
- "run": "false",
- "year": "",
- "month": ""
- },
- "noTime": {
- "run": "true"
- },
- "fixedInterval": {
- "run": "false",
- "interval": 0
- }
- },
- "deadWaitTime": 0,
- "normalWaitTime": 0,
- "retryWaitTime": 10000,
- "sleepWaitTime": 3600000,
- "comaWaitTime": 86400000,
- "framework": {
- "name": "Multi-Period-Daily",
- "startDate": {
- "takeItFromStatusDependency": 0
- },
- "endDate": {
- "takeItFromStatusDependency": 1
- }
- }
-}
-```
-
-Both configurations deal with certain aspects of the internal workings of these kinds of processes. These are the ones to be adjusted when creating a new bot:
-
-* ```codeName``` is the name of the process as used within the code of the system; for consistency, always use ```Multi-Period-Market``` and ```Multi-Period-Daily``` accordingly.
-
-* ```description``` is a short description of what the bot does.
-
-
-
-
-
-
-
-
-## Process Output
-
-
-
-**{{site.data.data_mine.process_output}}**
-
-### Adding a Process Output
-
-To add a process output node, select *Add Missing Items* on the process definition node menu. Items that may be missing are created along with the basic structure of nodes required to define them.
-
-
-
-
-
-
-
-
-
-## Output Dataset
-
-
-
-**{{site.data.data_mine.output_dataset}}**
-
-There are other effects of establishing a reference from the output dataset to a product dataset definition. Upon execution, every time a process finishes a processing cycle, it triggers an event that may be consumed by other entities. This event indicates that the datasets impacted by the process have been updated.
-
-An example of other entities that may be listening to such events is that of plotters. Plotters read datasets and create graphical representations of this data over the charts. Charts are constantly updating the information in the form of candles and indicators in realtime, synchronized with the data being extracted from the exchange by the sensor bot. That kind of automatism is possible thanks to the events that processes trigger every time an execution cycle is finished, signaling to everyone listening that new data is available on each of the impacted datasets.
-
-[](https://user-images.githubusercontent.com/13994516/68976798-f01cf400-07f6-11ea-9ffb-198b5853a220.gif)
-
-The image above shows the typical references from output datasets to datasets definitions.
-
-### References
-
-An output dataset must reference a dataset definition.
-
-### Adding an Output Dataset
-
-To add an output dataset, select *Add Output Dataset* on the process output node menu.
-
-{% include tip.html content="Remember that an output dataset must reference a valid dataset definition after creating the output dataset." %}
-
-
-
-
-
-
-
-## Process Dependencies
-
-
-
-**{{site.data.data_mine.process_dependencies}}**
-
-While processes run autonomously, most processes participate in a value-adding chain by which a process produces a data product that other processes may consume as an input to be processed further. This means that bots—while autonomous in their particular jobs—do depend both on other bots and on the data other bots produce.
-
-### Adding Process Dependencies
-
-To add a process dependencies node, select *Add Missing Items* on the process definition node menu. Items that may be missing are created along with the basic structure of nodes required to define them.
-
-
-
-
-
-
-## Status Dependency
-
-
-
-**{{site.data.data_mine.status_dependency}}**
-
-The reference is established to acquire the information relative to what the target process is doing. For example, by reading a status report a process may learn when was the last time the referenced process ran, and what was the last file processed.
-
-The status report referenced may belong to the same process— which is called a self-reference. In such a case, the process is learning what it did the last time it ran. Also, the status report referenced may belong to another process—another bot. In that case, the dependency may be of the Market Starting Point or Market Ending Point types.
-
-* **Self Reference** is mandatory, as a process needs to read it's own status report every time it wakes up.
-
-* **Market Starting Point** is a status dependency existing on Multi-Period-Daily processes so that the process establishing the reference learns the datetime of the start of the market. Usually, the reference is established with the sensor's Historic-Trades process status report. Multi-Period-Market processes do not have this type of status dependency as the date of the start of the market is implied in their dataset (a single file with all market data).
-
-* **Market Ending Point** is a status dependency existing both in Multi-Period-Market and Multi-Period-Daily processes so that the process establishing the reference knows the datetime of the end of the market.
-
-[](https://user-images.githubusercontent.com/13994516/68991956-dfa36280-0864-11ea-87ec-f0e4e3b7bf0f.gif)
-
-The image above shows a case of a self-reference status dependency as well as a market ending point status dependency.
-
-### Adding a Status Dependency
-
-To add a status dependency, select *Add Status Dependency* on the process dependencies node menu.
-
-{% include tip.html content="Remember that a status dependency must be configured, and must establish a reference to the appropriate status report." %}
-
-### Configuring a Status Dependency
-
-Select *Configure Status Dependency* on the menu to access the configuration.
-
-```json
-{
-"mainUtility": "Self Reference|Market Starting Point|Market Ending Point"
-}
-```
-
-* ```mainUtility``` determines the type of status dependency, with possible values being ```Self Reference```, ```Market Starting Point```, or ```Market Ending Point```.
-
-
-
-
-
-
-## Data Dependency
-
-
-
-**{{site.data.data_mine.data_dependency}}**
-
-Most bots consume data other bots have produced. Because bots need the data as input for their calculations, processes establish a data dependency with the dataset definitions of other bots. The reference provides the process with all the information needed to decode the dataset, enabling it to perform the required calculations.
-
-[](https://user-images.githubusercontent.com/13994516/68993034-7840df00-0873-11ea-804d-d24e88ce25f7.gif)
-
-The image above shows data dependencies in one bot referencing dataset definitions of another bot.
-
-### Adding a Data Dependency
-
-To add a data dependency, select *Add Data Dependency* on the process dependencies node menu.
-
-{% include tip.html content="Remember that a data dependency must establish a reference to the appropriate dataset definition." %}
-
-
-
-
-
-
-## Status Report
-
-
-
-**{{site.data.data_mine.status_report}}**
-
-Bots do not run continuously. Instead, they run in cycles. A cycle usually lasts until there is no more data to process, and once they finish, they shut down until the next cycle is due. A status report is a file every bot writes at the end of each cycle with information about the last run, including the datetime of the run and the last record processed.
-
-A status report may be consumed by the same bot producing it, or by other bots.
-
-### Adding a Status Report
-
-To add a status report, select *Add Missing Items* on the process definition node menu. Items that may be missing are created along with the basic structure of nodes required to define them.
-
-
-
-
-
-
-
-## Execution Started Event
-
-
-
-**{{site.data.data_mine.execution_started_event}}**
-
-These references determine when a process is due for another run. By listening to the execution finished event of the process it depends on, it may wake up just in time to process the new batch of data the dependency has just delivered.
-
-Bots form a sort of multi-branched execution sequence with an indeterminate number of dependencies. Every time the bot further down the tree of dependencies finishes a cycle, it triggers the execution of multiple bots listening to its execution finished event.
-
-### Adding an Execution Started Event
-
-To add an execution started event, select *Add Missing Items* on the process definition node menu. Items that may be missing are created along with the basic structure of nodes required to define them.
-
-{% include tip.html content="Remember that an execution started event must establish a reference to the appropriate execution finished event." %}
-
-
-
-
-
-
-
-## Execution Finished Event
-
-
-
-**{{site.data.data_mine.execution_finished_event}}**
-
-The execution finished event is responsible for triggering the execution of every process that depends on the data a bot produces. If bot Alice depends on bot Bob, Alice listens to the execution finished event of Bob so that it may start a new execution cycle as soon as Bob finishes its cycle. Alice listens to Bob's execution finished event by establishing a reference from its execution started event.
-
-[](https://user-images.githubusercontent.com/13994516/68993254-39605880-0876-11ea-9ee7-9f49976bd2dc.gif)
-
-The image above shows a reference established from the execution started event of a process to the execution finished event of another process.
-
-### Adding an Execution Finished Event
-
-To add an execution finished event, select *Add Missing Items* on the process definition node menu. Items that may be missing are created along with the basic structure of nodes required to define them.
-
-
-
-
-
-## Product Definition
-
-
-
-**{{site.data.data_mine.product_definition}}**
-
-A bot may feature multiple products, thus, there may be multiple product definitions. Three main aspects need to be defined in terms of products: the characteristics of the dataset, the composition of each record, and the way records are calculated.
-
-{% include note.html content="A product definition usually references a plotter module, which provides a graphic representation of the underlying dataset" %}
-
-### Adding a Product Definition
-
-To add a product definition, select *Add Product Definition* on the bot's node menu. A product definition is created along with the basic structure of nodes required to make up a product.
-
-### Configuring a Product Definition
-
-Select *Configure Product* on the menu to access the configuration.
-
-```json
-{
- "codeName": "New-Product-Name",
- "singularVariableName": "newProductName",
- "pluralVariableName": "newProductNames"
-}
-```
-
-* ```codeName``` is the name of the product as it is used within the bot's code.
-
-* ```singularVariableName``` is the singular form of the name of the variable representing the product, as is used on strategies (*i.e.:* ```bollingerChannel.direction```, where *bollingerChannel* is the name of the product as defined in its configuration and *direction* is the name of the property.
-
-* ```pluralVariableName``` is the plural form of the variable.
-
-
-
-
-
-
-## Dataset Definition
-
-
-
-**{{site.data.data_mine.dataset_definition}}**
-
-A good part of what makes datasets easy to consume by other bots is the fact that they are standardized in terms of their structure. It is that structure that is specified in the dataset definitions.
-
-### Adding a Dataset Definition
-
-To add a dataset definition, select *Add Dataset Definition* on the bot's node menu.
-
-### Configuring a Dataset Definition
-
-Select *Configure Definition* on the menu to access the configuration.
-
-**Multi-Period-Market:**
-
-```json
-{
- "codeName": "Multi-Period-Market",
- "type": "Market Files",
- "validPeriods": [ "24-hs", "12-hs", "08-hs", "06-hs", "04-hs", "03-hs", "02-hs", "01-hs" ],
- "filePath": "Data-Mine-Name/Bot-Name/@Exchange/Output/Product-Name/Multi-Period-Market/@Period",
- "fileName": "@BaseAsset_@QuotedAsset.json"
-}
-```
-
-**Multi-Period-Daily:**
-
-```json
-{
- "codeName": "Multi-Period-Daily",
- "type": "Daily Files",
- "validPeriods": [ "45-min", "40-min", "30-min", "20-min", "15-min", "10-min", "05-min", "04-min", "03-min", "02-min", "01-min" ],
- "filePath": "Data-Mine-Name/Bot-Name/@Exchange/Output/Product-Name/Multi-Period-Daily/@Period/@Year/@Month/@Day",
- "fileName": "@BaseAsset_@QuotedAsset.json",
- "dataRange": {
- "filePath": "Data-Mine-Name/Bot-Name/@Exchange/Output/Product-Name/Multi-Period-Daily",
- "fileName": "Data.Range.@BaseAsset_@QuotedAsset.json"
- }
-}
-```
-
-
-* ```codeName``` is the name of the dataset as used within the code.
-
-* ```type``` refers to the type of dataset; possible values are ```Market Files``` and ```Daily Files```.
-
-* ```validPeriods``` refers to the time frames handled by the dataset.
-
-* ```filePath``` sets the path on which files are stored; the proper name of the data mine, the bot and the product need to be entered.
-
-* ```fileName``` sets the name of the files that constitute the dataset.
-
-
-
-
-
-
-## Record Definition
-
-
-
-**{{site.data.data_mine.record_definition}}**
-
-Bots store data in the form of arrays of records, in a minimized plain text file and the standard JSON format, although not as objects with named properties, but as arrays.
-
-[](https://user-images.githubusercontent.com/13994516/68998023-303eae00-08ad-11ea-9baa-ddea801c7d6d.png)
-
-The choice of plain text for storage of large volumes of information has benefits in terms of not requiring any sophisticated technology to store and serve the data (*i.e.:* no database is required).
-
-Best practice indicates that there needs to be a balance between the amount of data that is stored and calculations that may be performed at runtime.
-
-Storing objects with named properties in the JSON format would be inappropriate as labels would repeat over and over, creating a ridiculous amount of unnecessary information. However, storing arrays in the JSON standard facilitates the handling of files in the context of JavaScript and Node.JS.
-
-### Adding a Record Definition
-
-To add a record definition node, select *Add Record Definition* on the product definition node menu. A record definition node is created along with the first record property.
-
-
-
-
-
-
-## Record Property
-
-
-
-**{{site.data.data_mine.record_property}}**
-
-Records may have as many properties as required.
-
-{% include important.html content="The order in which record properties are defined around the parent record definition node is the order in which they are stored in the actual record." %}
-
-{% include tip.html content="The first two records are usually the *begin* and *end* records, featuring the corresponding datetimes that indicate when the record starts and ends." %}
-
-### Adding a Record Property
-
-To add a record property, select *Add Record Property* on the bot's node menu.
-
-### Configuring a Record Property
-
-Select *Configure Property* on the menu to access the configuration.
-
-```js
-{
- "codeName": "record-name",
- "isString": false,
- "isCalculated": true
-}
-```
-
-* ```codeName``` is the name of the record as it is used in the bot's code.
-
-* ```isString``` determines if the field is a text string or if, in turn, is a numeric field. Dates are stored in the *epoch* format, which is numeric. The reason why this configuration is important is that fields that are strings need to be stored between "double quotes".
-
-* ```isCalculated``` determines if the field is stored in the dataset or if, instead, is calculated at a later stage. A value *true* means that the record is not stored. In the case ```isCaculated``` is not defined in the configuration, it is assumed to be false.
-
-[](https://user-images.githubusercontent.com/13994516/69139160-3ce72000-0ac0-11ea-9566-a259c9ea6194.gif)
-
-The image above shows a record definition with four record properties.
-
-
-
-
-
-## Formula
-
-
-
-**{{site.data.data_mine.formula}}**
-
-A formula may act in slightly different ways depending on the ```isCaculated``` attribute in the record property configuration:
-
-* When a property is calculated (```"isCalculated": true```), the formula assigns to the property a value that is calculated in the calculations procedure. Even if the property is not stored in the dataset, it is made available as a *calculated property* to other bots that may have the dataset as input.
-
-* When a property is not calculated (```"isCalculated": false``` or the attribute is not defined in the configuration) the formula is applied in the data building procedure.
-
-### Adding a Formula
-
-To add a formula, select *Add Formula* on the record property menu.
-
-
-
-
-
-
-
-
-## Calculations Procedure
-
-
-
-**{{site.data.data_mine.calculations_procedure}}**
-
-Bots store data in the minimized array format as a strategy to build the lightest possible datasets. For the same reason, a bot may choose not to store easily calculable information.
-
-For example, imagine an indicator that stores buy and sell volumes... does it *need* to store the total volume? Given that it is so easy to calculate, the answer is *probably* no. IT is up to the developer to decide, but it is certainly not required.
-
-{% include note.html content="It may not be worthy to store information that can be easily calculated at a later stage." %}
-
-The calculations procedure calculates the properties that the developer chose not to store in the dataset.
-
-### Adding a Calculations Procedure
-
-To add a calculations procedure, select *Add Missing Items* on the product definition node menu. Items that may be missing are created along with the basic structure of nodes required to define them.
-
-
-
-
-
-
-
-## Procedure Loop
-
-
-
-**{{site.data.data_mine.procedure_loop}}**
-
-This is an example of a procedure loop code snippet, in particular, the code that calculates the Popular SMAs product of the Simple Moving Average (SMA) indicator.
-
-{% include important.html content="Calculation procedures may only access data up to 48 hours in the past counting from the datetime of the record being processed. For that reason, the calculation of a moving average requires temporarily storing data in an array." %}
-
-```js
-/* Loop Code. */
-
-let candle = record.current // Our main dependencies are candles
-variable.last200.push(candle.close) // Add the current close value to the last 200 array.
-
-if (variable.last200.length > 200) {
- variable.last200.splice(0, 1) // Remove the first element of the array to keep it at a maximun of 200 elements.
-}
-
-variable.sma20 = calculateSMA(20)
-variable.sma50 = calculateSMA(50)
-variable.sma100 = calculateSMA(100)
-variable.sma200 = calculateSMA(200)
-
-function calculateSMA(periods) { // Having a function saves us from duplicating code.
- /* We check we have enough values to make the calculation */
- if (variable.last200.length < periods) { return 0 } // If we dont, we define the value is zero.
-
- let sum = 0 // Initialize sum variable.
- for (let i = variable.last200.length - periods; i < variable.last200.length; i++) { // Iterate through the last periods
- sum = sum + variable.last200[i]
- }
- let sma = sum / periods
- return sma
-}
-```
-
-### Adding a Procedure Loop
-
-To add a procedure loop, select *Add Procedure loop* on the corresponding procedure node menu. A procedure loop node is created along with the corresponding JavaScript node.
-
-
-
-
-## JavaScript Code
-
-
-
-**{{site.data.data_mine.javascript_code}}**
-
-The platform allows developers great flexibility as all valid JavaScript code is allowed.
-
-{% include important.html content="Until a robust JavaScript editor is implemented on the UI, it is recommended to write code on an external editor and paste it in the UI code bubble to ensure consistency." %}
-
-### Adding a JavaScript Code
-
-To add a JavaScript code node, select *Add Code* on the corresponding parent node menu.
-
-
-
-
-
-
-## Procedure Initialization
-
-
-
-**{{site.data.data_mine.procedure_initialization}}**
-
-procedure_initialization: "The procedure initialization is used to initialize variables used by the procedure loop."
-
-This is an example of a procedure loop code snippet, in particular, the code that initializes the array used in the calculation of the Popular SMAs product of the Simple Moving Average (SMA) indicator.
-
-```js
-/* Initialization Code. */
-variable.last200 = []
-```
-
-### Adding a Procedure Initialization
-
-To add a procedure initialization, select *Add Procedure Initialization* on the corresponding procedure node menu. A procedure initialization node is created along with the corresponding JavaScript node.
-
-
-
-
-
-
-
-
-
-
-
-## Data Building Procedure
-
-
-
-**{{site.data.data_mine.data_building_procedure}}**
-
-This procedure holds the core logic of the bot, as it features the code that performs the calculations required to produce the new data set. The code is split between a procedure initialization and a procedure loop.
-
-### Adding a Data Building Procedure
-
-To add a data buildings procedure, select *Add Missing Items* on the product definition node menu. Items that may be missing are created along with the basic structure of nodes required to define them.
-
-
-
-
-
-
-
-
-## Plotter
-
-
-
-**{{site.data.data_mine.plotter}}**
-
-Plotters usually have a one-to-one relationship with bots, as they are often created as a customized solution. However, in practice, there is no constraint to creating any number of plotters for a single bot or a single plotter for multiple bots.
-
-The overall workflow of a plotter, while reading a dataset, consists in:
-
-* Applying a set of rules to identify certain data points;
-
-* Use those points to form lines and polygons;
-
-* Apply graphical styles to those lines and polygons.
-
-Those actions are performed recursively for each record, and the graphics are plotted on the charts in real-time as data is processed.
-
-
-
-
-
-## Plotter Module
-
-
-
-**{{site.data.data_mine.plotter_module}}**
-
-A single plotter may have several modules. Different modules may be used to plot each product of the bot, or as best suits the expected use-pattern.
-
-[](https://user-images.githubusercontent.com/13994516/71016077-eab41180-20f4-11ea-87e7-7262ff10a1ab.gif)
-
-{% include important.html content="For a bot to use a plotter, the corresponding product definition must establish a reference with the plotter module built to interpret the dataset." %}
-
-[](https://user-images.githubusercontent.com/13994516/71016079-eab41180-20f4-11ea-8afb-96321f9c68d8.gif)
-
-### Adding a Plotter Module
-
-To add a plotter module, select *Add Plotter Module* on the plotter node menu.
-
-### Configuring a Plotter Module
-
-Select *Configure Plotter Module* on the menu to access the configuration.
-
-```json
-{
- "codeName": "Module Name",
- "isLegacy": true,
- "icon": "histogram"
-}
-```
-
-* ```codeName``` is the name used in the code to refer to the module.
-
-* ```isLegacy``` is ```true``` for plotters modules developed entirely in JavaScript, and is ```false``` or doesn't show in the configuration for plotters built with the tools featured in the data mine hierarchy.
-
-* ```icon``` is the name of the image that illustrates the corresponding layer in the Layers Panel. In case the banner is not specified, the *default banner* is used. Current possible values are:
-
-
-| Value | Image|
-| :---: | :---: |
-| ```Default``` |  |
-| ```Histogram``` |  |
-| ```Band``` |  |
-| ```Moving Average``` |  |
-| ```Oscillator``` |  |
-| ```Trend``` |  |
-
-Custom images may be added too. To do that:
-
-1. name the image in the following format: ```The-Image-Name-Icon.png```;
-
-1. place images in the ```WebServer\Images\``` folder;
-
-1. in the configuration of the module, use the name without the *-Icon* ending (e.g.: ```"icon": "The-Image-Name"```)
-
-
-
-
-
-
-
-
-
-## Plotter Panel
-
-
-
-**{{site.data.data_mine.plotter_panel}}**
-
-Beyond the graphic representation of data over the charts, plotters may also feature a *data panel*, that is, a numerical representation of the data showing the exact figures corresponding to the column or period that is in focus (the point of the charts where the mouse pointer is at any point).
-
-### Adding a Plotter Panel
-
-To add a plotter panel, select *Add Plotter Panel* on the plotter module node menu.
-
-
-
-
-
-
-
-
-## Panel Data
-
-
-
-**{{site.data.data_mine.panel_data}}**
-
-The system renders a panel featuring a centered, single-column vertical arrangement of data, with a label and a data field right below it. The label of each data field on the panel is given—by default—by the label set for each panel data node.
-
-### Adding a Panel Data
-
-To add a panel data node, select *Add Panel Data* on the plotter panel menu.
-
-### Configuring a Panel Data
-
-Select *Configure Panel Data* on the menu to access the configuration.
-
-```json
-{
- "valueDecimals": 2
-}
-```
-
-* ```valueDecimals``` sets the number of decimals to be shown on the corresponding data field.
-
-To override the default manner in which the data is assembled on the panel, the following properties may be included and defined:
-
-```json
-{
- "labelText": "The Label",
- "labelPosition": 15,
- "valuePosition": 20,
- "valueDecimals": 2
-}
-```
-
-* ```labelPosition``` and ```valuePosition``` represent the vertical distance of the corresponding fields to the top margin of the panel.
-
-
-
-
-
-
-## Data Formula
-
-
-
-**{{site.data.data_mine.data_formula}}**
-
-### Adding a Data Formula
-
-To add a data formula, select *Add Data Formula* on the plotter panel menu.
-
-
-
-
-## Shapes
-
-
-
-**{{site.data.data_mine.shapes}}**
-
-A plotter recursively renders graphics for each period or candle. This means that a definition of what shapes need to be drawn for a single period is required. The plotter does the same thing for every period or candle that is visible on the screen at any point in time, for any time frame, as long as the corresponding data is available.
-
-[](https://user-images.githubusercontent.com/13994516/71016080-eab41180-20f4-11ea-84c6-a514b87d568f.gif)
-
-In general terms, the process of defining what is going to be rendered on the screen consist of the following four steps:
-
- 1. Identifying points defined by ```[x,y]``` coordinates
- 2. Defining polygons
- 3. Defining default styles
- 4. Defining conditional styles
-
-### Adding Shapes
-
-To add a shapes node, select *Add Shapes* on the plotter module menu.
-
-
-
-
-
-
-## Chart Points
-
-
-
-**{{site.data.data_mine.chart_points}}**
-
-The definition of a point consists of the name of the point and the corresponding values for the ```x``` and ```y``` coordinates. To create such definitions, point and point formulas are used.
-
-### Adding a Chart Points
-
-To add a chart points node, select *Add Chart Points* on the shapes menu.
-
-
-
-
-
-## Point
-
-
-
-**{{site.data.data_mine.point}}**
-
-These coordinate points are used to define polygons. Values for ```[x,y]```coordinates are entered with a point formula.
-
-{% include tip.html content="Each point should be given a significant name so that it is easier to identify them at the time of establishing references with polygon vertices." %}
-
-### Adding a Point
-
-To add a point, select *Add Point* on the chart points node menu.
-
-
-
-
-
-
-## Point Formula
-
-
-
-**{{site.data.data_mine.point_formula}}**
-
-To represent some form of variation of the price or a price derivative over time, a typical point formula consists of the following two coordinates: ```x = datetime``` and ```y = rate```.
-
-For example:
-
-**Point *SMA 20 Begin***
-```js
-x = record.begin
-y = record.previous.sma20
-```
-
-The example above shows the definition of the first of two points necessary to draw the segment of the 20-periods SMA curve for any particular period or candle. In this case, ```x = record.begin``` is the starting datetime of the period and ```y = record.previous.sma20``` is the rate of the 20-periods SMA of the previous period.
-
-{% include note.html content="The above variables are constructed with information originating at the product definition that references the corresponding plotter module." %}
-
-To complete the line segment corresponding to a single period, the closing datetime of the period and the closing rate for the 20-periods SMA are required:
-
-**Point *SMA 20 End***
-```js
-x = record.end
-y = record.sma20
-```
-
-The above system works very well for plotting all sorts of information over the candles, on the charts.
-
-An oscillator like RSI too needs the definition of the starting and ending datetime of the period as the value for the *x-axis*. However, the value for *axis y* fits a different scale.
-
-Anyway, the points definition is just as straight forward, for example:
-
-**Point *RSI Begin***
-```js
-x = record.begin
-y = record.previous.value
-```
-
-**Point *RSI End***
-```js
-x = record.end
-y = record.value
-```
-
-Points do not necessarily need to refer to values on the dataset produced by the corresponding data product. For example, absolute values for the *y-axis* may be used to describe fixed graphical elements, for instance, a horizontal line, or a box.
-
-**Point *Begin 20***
-```js
-x = record.begin
-y = 20
-```
-
-**Point *End 20***
-```js
-x = record.end
-y = 20
-```
-
-**Point *Begin 30***
-```js
-x = record.begin
-y = 30
-```
-
-**Point *End 30***
-```js
-x = record.end
-y = 30
-```
-
-The above four points are used to paint the background of the 20 to 30 value range of the RSI chart. The first two points are also used to draw the dotted line signaling the 20-value mark, and the last two are used for the dotted line indicating the 30-value mark.
-
-{% include note.html content="The reason from separating the definition of points from the definition of polygons is that any point may be used by one or more polygons." %}
-
-### Adding a Point Formula
-
-To add a point formula, select *Add Point Formula* on the point node menu.
-
-
-
-
-
-
-
-
-
-
-## Polygon
-
-
-
-**{{site.data.data_mine.polygon}}**
-
-Polygons are defined by two or more vertices, which map points in a charts point. The graphic representation of polygons originates in styles applied to either or both polygon bodies and polygon borders.
-
-{% include note.html content="The order in which polygons are ordered around the parent shapes node determines the order in which they are drawn on the screen. In cases on which polygons intersect, those drawn last are drawn on top of those drawn first." %}
-
-### Adding a Polygon
-
-To add a polygon, select *Add Polygon* on the shapes node menu.
-
-
-
-
-
-## Polygon Vertex
-
-
-
-**{{site.data.data_mine.polygon_vertex}}**
-
-polygon_vertex: "A polygon vertex is a reference to a point defined in the chart points, constituting a specific coordinate to be used as a vertex of a shape."
-
-Vertices are the main element defining polygons. Once created, each vertex must establish a reference to the corresponding point in the charts point.
-
-[](https://user-images.githubusercontent.com/13994516/71016081-eb4ca800-20f4-11ea-8fee-4d38ecfb0596.gif)
-
-Drawing curves requires two vertices. Painting areas, such as the background of a chart, likely requires four vertices. Note that vertices are not capable of featuring a style. Instead, styles are applied to polygon borders and polygon bodies.
-
-{% include important.html content="Bear in mind that the order in which vertices in a polygon are arranged around the parent polygon node when their *rotational symmetry* property is selected, is the order in which the plotter computes the points. This means that points need to be in the correct order, for example, when drawing a box. Imagine drawing a box on a piece of paper without lifting the pencil... that is how the plotter does it." %}
-
-### Adding a Polygon Vertex
-
-To add a polygon vertex, select *Add Polygon Vertex* on the polygon node menu.
-
-{% include tip.html content="Remember that a vertex must establish a reference to a point in the charts point to be properly defined" %}
-
-
-
-
-
-## Polygon Border
-
-
-
-**{{site.data.data_mine.polygon_border}}**
-
-A polygon border needs at least two vertices to be defined. A border serves to create a *stroke* for the outlines of any sort of polygon, either closed or open, by giving it a style.
-
-### Adding a Polygon Border
-
-To add a polygon border, select *Add Polygon Border* on the polygon node menu.
-
-
-
-## Style
-
-
-
-**{{site.data.data_mine.style}}**
-
-A style applied to a polygon body or a polygon border node acts as the default style.
-
-### Adding a Style
-
-To add a style, select *Add Style* on a polygon border or polygon body node menu.
-
-### Configuring a Style
-
-Select *Configure Style* on the menu to access the configuration.
-
-A typical definition for a polygon body style looks like this:
-
-```json
-{
- "default": {
- "opacity": 0.2,
- "paletteColor": "UI_COLOR.DARK_TURQUOISE"
- },
- "atMousePosition": {
- "opacity": 0.3,
- "paletteColor": "UI_COLOR.DARK_TURQUOISE"
- }
-}
-```
-
-A typical definition for a polygon border style has a couple more properties:
-
-```json
-{
- "default": {
- "opacity": 0.2,
- "lineWidth": 1,
- "lineDash": [0,0],
- "paletteColor": "UI_COLOR.DARK_TURQUOISE"
- },
- "atMousePosition": {
- "opacity": 0.3,
- "lineWidth": 2,
- "lineDash": [0,0],
- "paletteColor": "UI_COLOR.RUSTED_RED"
- }
-}
-```
-
-The first section of the definition refers, as explicitly stated, to the default state of the style.
-
-The second section refers to the style assigned to the column or period on which the mouse pointer is located. This is very useful for highlighting the specific zone of interest as the user browses the charts.
-
-* ```opacity``` is probably self-explanatory: it may range from ```0``` for a fully transparent object to ```1``` for a solid object.
-
-* ```paletteColor``` sets the color for the *fill* or *stroke* in cases of polygon bodies and polygon borders respectively. Use the variable ```UI_COLOR``` followed by a ```.``` and any of the properties in the following list for a selection of currently available colors:
-
-| Variable Value | RGB Value | Color Sample |
-| :--- | :---: | :------------------- |
-| ```DARK``` | 48, 48, 54 | |
-| ```LIGHT``` | 234, 226, 222 | |
-| ```GREY``` | 150, 150, 150 | |
-| ```LIGHT_GREY``` | 247, 247, 247 | |
-| ```WHITE``` | 255, 255, 255 | |
-| ```BLACK``` | 0, 0, 0 | |
-| ```GOLDEN_ORANGE``` | 240, 162, 2 | |
-| ```RUSTED_RED``` | 204, 88, 53 | |
-| ```GREEN``` | 188, 214, 67 | |
-| ```RED``` | 223, 70, 60 | |
-| ```PATINATED_TURQUOISE``` | 27, 153, 139 | |
-| ```TITANIUM_YELLOW``` | 244, 228, 9 | |
-| ```MANGANESE_PURPLE``` | 91,80, 122 | |
-| ```TURQUOISE``` | 74, 207, 217 | |
-| ```DARK_TURQUOISE``` | 2, 149, 170 | |
-
-* ```lineWidth``` is the width of the border line, which should be greater than 0.
-
-* ```lineDash``` is used to turn the border into a dashed-line; the first value corresponds to the length of the dash while the second value defines the length of the space.
-
-{% include note.html content="When using dashed lines, bear in mind that the drawing from one column or period is independent of the next. Big values for dashes and spaces may not work well for lines that span several columns." %}
-
-
-
-
-
-
-
-
-
-## Style Condition
-
-
-
-**{{site.data.data_mine.style_condition}}**
-
-Style conditions offer a way to introduce additional intelligence on the visual representation of data by using styles that respond to certain conditions.
-
-For example, the *Percentage Bandwidth* plotter module assigns a different color to the Moving Average line when it's going up or down.
-
-To do that, a style condition features it's own style so that, when the condition validates true, the new style is applied.
-
-Style conditions me be created in a sequence so that the style may continue changing upon the validation of a series of style conditions. The system evaluates all style conditions in a sequential order determined by their position in the rotational symmetry around the parent node. Each condition that is met may modify or add up to the resulting style that is rendered on screen. That is, the final style is the result of the sequential application of the styles defined for each condition that is met, on top of the default style.
-
-### Adding a Style Condition
-
-To add a style condition, select *Add Style Condition* on a polygon border or polygon body node menu.
-
-### Editing a Style Condition
-
-Select *Edit Condition* on the menu to access the configuration.
-
-Style conditions work pretty much like conditions used on trading systems. The main difference is that the variables available are solely those provided by the bot product definition that reference the corresponding plotter module.
-
-To continue the example of the Percentage Bandwidth plotter, the following is the condition that determines the newly added styles:
-
-```js
-record.previous.movingAverage > record.movingAverage
-```
-
-As hinted earlier, when the condition is met, the default style is modified by a second style that may be created on the menu of the style condition node.
-
-The definition of secondary styles is slightly different from that of the default style, as—in such cases—the ```atMousePosition``` property may no longer be defined:
-
-```js
-{
- "opacity": 0.55,
- "lineWidth": 1,
- "lineDash": [0,0],
- "paletteColor": "UI_COLOR.RED"
-}
-```
-
-
-
-
-
-
-
-
-
-
-
-## Polygon Body
-
-
-
-**{{site.data.data_mine.polygon_body}}**
-
-A polygon body needs at least three vertices to be defined. A body serves to create a *fill* for the outlines of any sort of polygon, either closed or open, by giving it a style.
-
-### Adding a Polygon Body
-
-To add a polygon body, select *Add Polygon Body* on the polygon node menu.
+{% include /data_mine/polygon-body.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
diff --git a/docs/pages/suite/suite-datasets.md b/docs/pages/suite/suite-datasets.md
index a3ed19eb8..37240b33b 100644
--- a/docs/pages/suite/suite-datasets.md
+++ b/docs/pages/suite/suite-datasets.md
@@ -29,7 +29,7 @@ For instance, writting a single file with all historic trades in a market spanni
Let's look into a specific example...
-The Charts offer the possibility to navigate market data in the form of candles over different time periods. It is reasonable to keep candles in time periods of 1 hour and above (up to the 24-hour time period) in a single file. A market spanning 5 years would have less than 44 thousand records ```(5 * 365 * 24)``` of 1-hour candles. It seems reasonable for the Charts to load a single file so as to allow the user to seamlessly navigate large sections of the market in this time period, for instance, several days or weeks.
+The Charts offer the possibility to navigate market data in the form of candles over different time frames. It is reasonable to keep candles in time frames of 1 hour and above (up to the 24-hour time frame) in a single file. A market spanning 5 years would have less than 44 thousand records ```(5 * 365 * 24)``` of 1-hour candles. It seems reasonable for the Charts to load a single file so as to allow the user to seamlessly navigate large sections of the market in this time frame, for instance, several days or weeks.
However, if the user wishes to browse 1 minute candles it is obvious his or her focus does not span days or weeks, let alone the whole market. The person is surely interested in analyzing a very specific point in time. Therefore, loading a single file with over 2.5 million records ```(5 * 365 * 24 * 60)``` would be unreasonable.
@@ -64,7 +64,7 @@ _e.g.:_
The format in which bots store their output is standardized. In an attempt to make data highly accessible, a tree-like folder structure is built following this pattern (which may slightly differ from bot to bot, depending on the specific dataset):
```
-Dataset Name > Process Name > Time Period > Year > Month > Day > Hour
+Dataset Name > Process Name > Time Frame > Year > Month > Day > Hour
```
_e.g.:_
diff --git a/docs/pages/suite/suite-design-space-interface.md b/docs/pages/suite/suite-design-space-interface.md
new file mode 100644
index 000000000..4577eb8e1
--- /dev/null
+++ b/docs/pages/suite/suite-design-space-interface.md
@@ -0,0 +1,95 @@
+---
+title: "Design Space Interface"
+summary: "Navigation allows the use of mouse and keyboard. You may also create shortcuts. Node's menu allows controlling the physics of the environment and provides backup, share and clone functions."
+sidebar: suite_sidebar
+permalink: suite-design-space-interface.html
+---
+
+## Navigation
+
+Left-click on the black background and drag to move around the workspace.
+
+You may also use the following key combinations on your keyboard:
+
+1. Ctrl or ⌘ + ← to pan to the left.
+1. Ctrl or ⌘ + → to pan to the right.
+1. Ctrl or ⌘ + ↑ to pan upwards.
+1. Ctrl or ⌘ + ↓ to pan downwards.
+
+You may also use your keyboard as follows:
+
+1. Alt + ↑ to close the charts and open the design space.
+1. Alt + ↓ to close the design space and open the charts.
+1. Alt + → to open both the design space and the charts, assigning each one-half of the screen.
+1. Ctrl or ⌘ + Shift + ↑ to pull the separation bar up incrementally.
+1. Ctrl or ⌘ + Shift + ↓ to pull the separation bar down incrementally.
+
+## Node Shortcuts
+
+You may define shortcuts for frequently-used nodes with the following procedure:
+
+1. Hover the mouse pointer over the target node until the menu opens up. This puts the node *in focus*.
+1. Click Ctrl or ⌘ + Alt + your preferred key to assign the shortcut.
+1. A sign will appear below the node confirming the assignation of the shortcut.
+
+[](https://user-images.githubusercontent.com/13994516/70344838-f123cd00-185a-11ea-819f-92c4cf1e93ea.gif)
+
+Repeat the same procedure to remove a shortcut.
+
+{% include note.html content="When attempting to assign a shortcut with a keyboard combination that is already in use, the platform will notify of the issue. If you insist by hitting the same keyboard combination two more times, the platform will assign the shortcut as expected." %}
+
+## Node's Menu
+
+Hovering the mouse pointer over nodes causes a menu to pop up. In this situation, the node is *in focus*.
+
+### Arrangement Features
+
+The design space functions under the paradigm of a *self-organizing workspace* in which nodes tend to find their place guided by certain laws of physics, and constrained by their chain relationships.
+
+This self-organizing paradigm saves users the effort of maintaining the arrangement of nodes in a logical manner, in particular when manipulating or creating new nodes.
+
+However, there will be times in which you will want to override this self-organizing nature. The following menu options are tools that will help you manipulate the arrangement of nodes, overriding the physics that affect their floating nature.
+
+| Icon | Pinned / Unpinned |
+| --- | --- |
+|  | The node is pinned to the workspace on a specific ```[x, y]``` coordinate. This status overrides any other setting affecting the node's mobility. Only direct user action by clicking and dragging may move a pinned node. |
+|  | When a node is unpinned, it is free to be affected by other settings, or find its place floating on the workspace. |
+
+
+| Icon | Freeze / Unfreeze |
+| --- | --- |
+|  | Clicking the *freeze* option freezes the node's chain connections with its parent and offspring. Connecting lines turn blue. If you freeze the head node of a hierarchy, then the whole hierarchy is frozen. Freezing node structures is effective only when nodes are loose, that is, when they are not affected by angle or distance settings and are unpinned. In such cases, freezing releases CPU resources, as the platform stops calculating node's positions and status. |
+|  | Clicking the *unfreeze* option unfreezes connections. If you click the option to unfreeze a node and the node does not change its status, it may be because a higher node in the hierarchy is still frozen. |
+
+| Icon | Collapse / Expand |
+| --- | --- |
+|  | Clicking the _minus_ button collapses the structure, hiding offspring nodes. This also has the effect of releasing CPU resources as the platform stops calculating their position and status. In general, it is good practice to keep hierarchies closed when not being actively worked on. |
+|  | Clicking the _plus_ button expands the structure of offspring nodes. |
+
+| Icon | Angle to Parent — Click to cycle through the different options. |
+| --- | --- |
+|  | The *rotational symmetry* is disabled and the node may take any position. The connection line with its parent is yellow.|
+|  | The node is locked to a *rotational symmetry* around its parent node, with sibling nodes using the same setting. The symmetry spans **360 degrees**, and the connection line with the parent node turns orange.|
+|  | The slot of the symmetry around its parent node is limited to **180 degrees**, and the connection line remains orange.|
+|  | The slot of the symmetry around its parent node is limited to **90 degrees**, and the connection line remains orange.|
+|  | The slot of the symmetry around its parent node is limited to **45 degrees**, and the connection line remains orange.|
+
+| Icon | Distance to Parent — Click to cycle through the different options. |
+| --- | --- |
+|  | The distance setting is dissabled and the node may assume any distance to its parent. |
+|  | The node is locked to a distance from its parent node that is **0.25X** of the distance from the parent to its parent. |
+|  | The node is locked to **0.5X** of the distance. |
+|  | The node is locked to **1X** of the distance. |
+|  | The node is locked to **1.5X** of the distance. |
+|  | The node is locked to **2X** of the distance. |
+
+### Productivity Features
+
+The rest of the menu options available in most nodes are the following:
+
+| Icon | Action |
+| --- | --- |
+|  | **Backup**: Downloads a JSON file with the data structure and references concerning the particular node and the structure of offspring nodes in the hierarchy. Use this feature to save your entire workspace or any particular structure of nodes within your workspace so that you may later restore the information, including all references, should you need to. For your reference, the file downloaded is named ```Backup``` followed by the name of the node you are backing up. |
+|  | **Clone**: Downloads a JSON file containing information similar to a backup. The main difference is that the feature is built to facilitate the production of identical copies of any particular structure of nodes of a hierarchy, or a complete hierarchy. Use this feature to accelerate your work process when you need to replicate nodes, for example, to create multiple testing sessions. The file downloaded is named ```Clone``` followed by the name of the node you are cloning. |
+|  | **Share**: Downloads a JSON file containing information similar to a backup. The only difference is that no personal information is included. This is particularly important so that you do not share sensitive information accidentally, such as your API keys. Always use this function when you intend to share work. Do not share your backups. The file downloaded is named ```Share``` followed by the name of the node you are sharing. |
+|  | **Delete**: Deletes the node and all its offspring. Confirmation in the form of an additional click is required. |
diff --git a/docs/pages/suite/suite-design-space-workspace-and-data-structures.md b/docs/pages/suite/suite-design-space-workspace-and-data-structures.md
new file mode 100644
index 000000000..58be58460
--- /dev/null
+++ b/docs/pages/suite/suite-design-space-workspace-and-data-structures.md
@@ -0,0 +1,66 @@
+---
+title: "Design Space, Workspace, and Data Structures"
+summary: "The workspace, nodes, structures of nodes and their parent-offspring relationships are the overarching concepts arranging all information handled by the system."
+sidebar: suite_sidebar
+permalink: suite-design-space-workspace-and-data-structures.html
+---
+
+Superalgos handles numerous concepts encompassing fields such as market information, trading strategies, visualization features, workflows, technical resources, and many more.
+
+All of these concepts are structured so that users may use them intuitively. Learning the Superalgos conceptual framework is the first step in that direction.
+
+## Design Space
+
+**{{site.data.concepts.design_space}}**
+
+In practical terms, the design space is the portion of the system you access when you pull up the sliding panel, hiding the charts in the process.
+
+## Workspace
+
+**{{site.data.concepts.workspace}}**
+
+It contains:
+
+ * All hierarchies with all of their nodes.
+
+ * Nodes that may be floating around detached from hierarchies.
+
+ * Information regarding the physical position and status of all nodes within the design space, even those detached from the hierarchies.
+
+The workspace is not part of any of the hierarchies; instead, it contains them.
+
+{% include note.html content="Users may manage multiple workspaces, but only one workspace may be loaded in the system at any point." %}
+
+{% include tip.html content="Backing up your workspace is the best way to store all the information within the design space, ready to be deployed. Your workspace is saved at the browser level every time you make a change, but still, you should back up your workspace once in a while so that you can go back to past versions or recover from the occasional crash. Also, backups allow you to switch seamlessly from one workspace to another workspace." %}
+
+## Nodes
+
+**{{site.data.concepts.node}}**
+
+### Structure of Nodes
+
+{{site.data.concepts.structure_of_nodes}}
+
+As a consequence, structures of nodes are hierarchical structures, and a logical representation of how the concepts embodied by each node relate to each other.
+
+### Parent-Offspring Relationships
+
+{{site.data.concepts.parent-offspring_relationships}}
+
+The direction of the relationship is determined, in most cases, by the ability of a node to produce the offspring node. That is, the parent node is the one which, by software design, may produce the offspring node.
+
+### Attaching and Detaching Nodes
+
+{{site.data.concepts.chain}}
+
+This feature is useful when testing different configurations, rules or parameters, as it allows to keep alternatives handy in the workspace.
+
+[](https://user-images.githubusercontent.com/13994516/63227849-6d7e9b80-c1eb-11e9-9a02-6f760f383751.gif)
+
+To detach a node, right-click on it and drag it away from the parent node. To attach a node, right-click on it and move it closer to the node you wish to attach it to.
+
+Nodes may be attached only to potential parents. The system limits the way in which nodes may be attached, according to the logic of the information they contain.
+
+{% include note.html content="Nodes may not be detached or attached to frozen nodes. You need to unfreeze them before attaching or detaching." %}
+
+{% include note.html content="The verbs *to chain* and *to attach* may be used interchangeably, as synonyms. Similarly, *to unchain* and *to detach* are both valid." %}
\ No newline at end of file
diff --git a/docs/pages/suite/suite-detachment-and-attachment-of-nodes.md b/docs/pages/suite/suite-detachment-and-attachment-of-nodes.md
index a06148569..b871c72c7 100644
--- a/docs/pages/suite/suite-detachment-and-attachment-of-nodes.md
+++ b/docs/pages/suite/suite-detachment-and-attachment-of-nodes.md
@@ -10,7 +10,7 @@ toc: false
This feature may be handy when testing different configurations, rules or parameters, as it allows to keep alternatives handy in the workspace.
-[](https://user-images.githubusercontent.com/13994516/63227849-6d7e9b80-c1eb-11e9-9a02-6f760f383751.gif)
+[](https://user-images.githubusercontent.com/13994516/63227849-6d7e9b80-c1eb-11e9-9a02-6f760f383751.gif)
{% include note.html content="The verbs *to chain* and *to attach* may be used interchangeably, as synonyms. Similarly, *to unchain* and *to detach* are both valid." %}
diff --git a/docs/pages/suite/suite-getting-ready-to-trade-live.md b/docs/pages/suite/suite-getting-ready-to-trade-live.md
index f215990b7..ef2b62c86 100644
--- a/docs/pages/suite/suite-getting-ready-to-trade-live.md
+++ b/docs/pages/suite/suite-getting-ready-to-trade-live.md
@@ -20,8 +20,8 @@ As soon as you click *Run* in your session, your bot will be forward testing or
The difference is that orders will now go to the exchange.
-**For maximum efficiency, we recommend you run live trading sessions on the 01-min time period. Your bot will then be executed every 60 seconds to evaluate your strategy rules and decide if any action needs to be taken.**
+**For maximum efficiency, we recommend you run live trading sessions on the 01-min time frame. Your bot will then be executed every 60 seconds to evaluate your strategy rules and decide if any action needs to be taken.**
- This is important even if your strategy operates at a lower frequency, as running the live session at the 01-min time period guarantees that the trading bot will exit trades as soon as the one-minute candle closes tagging your stop or take profit target. On the contrary, if you run the live trading session at a time period higher than 01-min, slippage when closing the position may be considerably greater.
+ This is important even if your strategy operates at a lower frequency, as running the live session at the 01-min time frame guarantees that the trading bot will exit trades as soon as the one-minute candle closes tagging your stop or take profit target. On the contrary, if you run the live trading session at a time frame higher than 01-min, slippage when closing the position may be considerably greater.
> **WARNING:** The Superalgos Platform is at a very early stage of development. As such, errors may occur at any point, including errors that can cause you to lose money. You are responsible for taking all precautions before starting trading live. Make sure you test with small amounts of money, the kind you can afford losing. Also, make sure you understand the [Execution Limitations](Execution-Limitations). Trade live at your own risk.
\ No newline at end of file
diff --git a/docs/pages/suite/suite-hierarchies.md b/docs/pages/suite/suite-hierarchies.md
index 3a4e1dca7..0cf9a43ce 100644
--- a/docs/pages/suite/suite-hierarchies.md
+++ b/docs/pages/suite/suite-hierarchies.md
@@ -5,28 +5,16 @@ sidebar: suite_sidebar
permalink: suite-hierarchies.html
---
-{{site.data.concepts.hierarchy}}
+**{{site.data.concepts.hierarchy}}**
-On the designer, the head or parent node of each hierarchy is represented by the corresponding icon surrounded by an ever-present white ring, so that they are easier to locate within the workspace.
+{% include note.html content="On the design space, the head or parent node of each hierarchy is represented by the corresponding icon surrounded by an ever-present white ring, so that they are easier to locate within the workspace." %}
+{% include /crypto_ecosystem/crypto-ecosystem.md heading="##" icon="150-" adding="" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+{% include /charting_space/charting-space.md heading="##" icon="150-" adding="" configuring="" charts="" content="yes" definition="bold" table="yes" more="no"%}
-## Charting Space
+{% include /trading_system/trading-system.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="yes"%}
-{{site.data.charting_space.charting_space}}
+{% include /network/network.md heading="##" icon="150-" adding="" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
-## Crypto Ecosystem
-
-{{site.data.crypto_ecosystem.crypto_ecosystem}}
-
-## Trading System
-
-{{site.data.trading_system.trading_system}}
-
-## Network
-
-{{site.data.network.network}}
-
-## Data Mine
-
-{{site.data.data_mine.data_mine}}
+{% include /data_mine/data-mine.md heading="##" icon="150-" adding="####" configuring="####" starting="" content="yes" definition="bold" table="yes" more="yes"%}
diff --git a/docs/pages/suite/suite-indicators-included-in-the-data-release.md b/docs/pages/suite/suite-indicators-included-in-the-data-release.md
index 39a421b7e..81a294f9f 100644
--- a/docs/pages/suite/suite-indicators-included-in-the-data-release.md
+++ b/docs/pages/suite/suite-indicators-included-in-the-data-release.md
@@ -1,11 +1,11 @@
---
-title: Indicators Included in the Data Release
-summary: ""
+title: Masters indicators
+summary: "A set of indicators built in the Masters data mine including candles, Bollinger Bands (BB), Percentage Bandwidth (%B), Bollinger Channels, and Bollinger Subchannels."
sidebar: suite_sidebar
-permalink: suite-indicators-included-in-the-data-release.html
+permalink: suite-masters-indicators.html
---
-The following indicators are those readily available as soon as you fire up the platform, as the corresponding datasets are included in the data release.
+{% include note.html content="The following indicators are available under the Masters task managers in the data mining section of the network hierarchy." %}
## Candles
diff --git a/docs/pages/suite/suite-indicators-not-included-in-the-data-release.md b/docs/pages/suite/suite-indicators-not-included-in-the-data-release.md
index 7c2bf7e35..4fbb8064c 100644
--- a/docs/pages/suite/suite-indicators-not-included-in-the-data-release.md
+++ b/docs/pages/suite/suite-indicators-not-included-in-the-data-release.md
@@ -1,10 +1,12 @@
---
-title: Indicators Not Included in the Data Release
-summary: ""
+title: Sparta indicators
+summary: "A set of indicators built in the Sparta data mine including Simple Moving Average (SMA), Exponential Moving Averege (EMA), Relative Strenght Index (RSI), and Moving Average convergence Divergence (MACD)."
sidebar: suite_sidebar
-permalink: suite-indicators-not-included-in-the-data-release.html
+permalink: suite-sparta-indicators.html
---
+{% include note.html content="The following indicators are available under the Sparta task managers in the data mining section of the network hierarchy." %}
+
## Simple Moving Average (SMA)
There are three products pre-configured to start calculating as soon as you start the corresponding task, each with different period configurations:
diff --git a/docs/pages/suite/suite-internal-variables.md b/docs/pages/suite/suite-internal-variables.md
index 8e8b61288..76dfe23d2 100644
--- a/docs/pages/suite/suite-internal-variables.md
+++ b/docs/pages/suite/suite-internal-variables.md
@@ -1,52 +1,33 @@
---
title: Internal Variables
-summary: ""
+summary: "The system makes cetain internal variables available to be used on strategies."
sidebar: suite_sidebar
permalink: suite-internal-variables.html
---
These are properties managed internally by the platform that are made available for using within strategies.
-```strategyStage```: Possible values are ```"No Stage"```, ```"Trigger Stage"```, ```"Open Stage"```, ```"Manage Stage"```, and ```"Close Stage"```.
-
-```stopLoss```: The value of your Stop in the active phase.
-
-```stopLossPhase```: The number of the active Stop phase (0, 1, 2, ...).
-
-```takeProfit```: The value of the Take Profit in the active phase.
-
-```takeProfitPhase```: The number of the active Stop phase (0, 1, 2, ...).
-
-```positionRate```: The price at which the position was taken.
-
-```positionSize```: The size of the position.
-
-```balanceAssetA```: Your BTC balance.
-
-```balanceAssetB```: Your USDT balance.
-
-```lastTradeProfitLoss```: The P&L value for the latest completed trade (roundtrip).
-
-```lastTradeROI```: The ROI of your latest trade.
-
-```profit```: The total P&L during the current execution period.
-
-```roundtrips```: The total number of trades in the current execution.
-
-```fails```: The number of trades resulting in losses in the current execution.
-
-```hits```: The number of trades resulting in profits in the current execution.
-
-```periods```: The number of candles evaluated in the current execution.
-
-```positionPeriods```: The number of candles in the current open position.
-
-```positionDays```: The number of days in the current open position.
-
-```distanceToLast.triggerOn```: The number of periods between the last Trigger On and the current candle.
-
-```distanceToLast.triggerOff```: The number of periods between the last Trigger Off and the current candle.
-
-```distanceToLast.takePosition```: The number of periods between the last Take Position and the current candle.
-
-```distanceToLast.closePosition```: The number of periods between the last Close Position and the current candle.
+| Variable | Description |
+|:---|:---|
+| ```strategyStage``` | Possible values are ```"No Stage"```, ```"Trigger Stage"```, ```"Open Stage"```, ```"Manage Stage"```, and ```"Close Stage"```. |
+| ```stopLoss``` | The value of your Stop in the active phase. |
+| ```stopLossPhase``` | The number of the active Stop phase (0, 1, 2, ...). |
+| ```takeProfit``` | The value of the Take Profit in the active phase. |
+| ```takeProfitPhase``` | The number of the active Stop phase (0, 1, 2, ...). |
+| ```positionRate``` | The price at which the position was taken. |
+| ```positionSize``` | The size of the position. |
+| ```balanceAssetA``` | Your BTC balance. |
+| ```balanceAssetB``` | Your USDT balance. |
+| ```lastTradeProfitLoss``` | The P&L value for the latest completed trade (roundtrip). |
+| ```lastTradeROI``` | The ROI of your latest trade. |
+| ```profit``` | The total P&L during the current execution period. |
+| ```roundtrips``` | The total number of trades in the current execution. |
+| ```fails``` | The number of trades resulting in losses in the current execution. |
+| ```hits``` | The number of trades resulting in profits in the current execution. |
+| ```periods``` | The number of candles evaluated in the current execution. |
+| ```positionPeriods``` | The number of candles in the current open position. |
+| ```positionDays``` | The number of days in the current open position. |
+| ```distanceToLast.triggerOn``` | The number of periods between the last Trigger On and the current candle. |
+| ```distanceToLast.triggerOff``` | The number of periods between the last Trigger Off and the current candle. |
+| ```distanceToLast.takePosition``` | The number of periods between the last Take Position and the current candle. |
+| ```distanceToLast.closePosition``` | The number of periods between the last Close Position and the current candle. |
diff --git a/docs/pages/suite/suite-layers.md b/docs/pages/suite/suite-layers.md
index 24561bd0b..7efab99cd 100644
--- a/docs/pages/suite/suite-layers.md
+++ b/docs/pages/suite/suite-layers.md
@@ -83,7 +83,7 @@ For the time being, the chart is fixed on the screen and the user may not move i
### Simple Moving Average (SMA)
-[According to Investopedia](https://www.investopedia.com/terms/e/ema.asp), "A simple moving average (SMA) is an arithmetic moving average calculated by adding recent closing prices and then dividing that by the number of time periods in the calculation average. Short-term averages respond quickly to changes in the price of the underlying asset, while long-term averages are slow to react."
+[According to Investopedia](https://www.investopedia.com/terms/e/ema.asp), "A simple moving average (SMA) is an arithmetic moving average calculated by adding recent closing prices and then dividing that by the number of time frames in the calculation average. Short-term averages respond quickly to changes in the price of the underlying asset, while long-term averages are slow to react."
[](https://user-images.githubusercontent.com/13994516/71260423-217b6900-233b-11ea-9229-d838f8a071da.gif)
diff --git a/docs/pages/suite/suite-multiple-forward-testing-and-live-trading-sessions.md b/docs/pages/suite/suite-multiple-forward-testing-and-live-trading-sessions.md
index cd2a5aebb..390c45efa 100644
--- a/docs/pages/suite/suite-multiple-forward-testing-and-live-trading-sessions.md
+++ b/docs/pages/suite/suite-multiple-forward-testing-and-live-trading-sessions.md
@@ -9,7 +9,7 @@ The platform allows running multiple forward testing and live trading sessions a
The one thing you need to be aware of is that—due to restrictions on API use imposed by exchanges—you may not use the same exchange API key with different processes.
-If you ever need to create a new trading session, you will create a copy of an existing one by cloning the whole task. Once you drop the clone back on the Designer, the new task will have all of the nodes required for trading, including an *exchange account key*.
+If you ever need to create a new trading session, you will create a copy of an existing one by cloning the whole task. Once you drop the clone back on the design space, the new task will have all of the nodes required for trading, including an *exchange account key*.
Just make sure you don't use the same key on more than one session: you need to get a new API key from the exchange and edit the *exchange account key** accordingly.
diff --git a/docs/pages/suite/suite-my-system-gets-slow.md b/docs/pages/suite/suite-my-system-gets-slow.md
index 5442fd2d9..00719e8c2 100644
--- a/docs/pages/suite/suite-my-system-gets-slow.md
+++ b/docs/pages/suite/suite-my-system-gets-slow.md
@@ -11,13 +11,13 @@ If you experience such symptoms, there are several workarounds you may implement
## Display Less Data on the Charts
-If you are zooming out too far in the horizontal time scale with too many candles on the screen, try zooming-in a bit or changing time periods so that candle density decreases.
+If you are zooming out too far in the horizontal time scale with too many candles on the screen, try zooming-in a bit or changing time frames so that candle density decreases.
You may also want to switch off the layers you may not be using. Remember, every piece of graphical information you see on screen represents data your system is reading from your disk and processing to display in a visual environment.
## Close Unused Hierarchies
-The physics that govern nodes in the Designer help the hierarchical structure of information to self-organize. This comes at a cost in terms of processing power.
+The physics that govern nodes in the design space help the hierarchical structure of information to self-organize. This comes at a cost in terms of processing power.
Make sure the two exiting team hierarchies are closed:
diff --git a/docs/pages/suite/suite-on-screen-errors-and-warnings.md b/docs/pages/suite/suite-on-screen-errors-and-warnings.md
index fb6607130..246319802 100644
--- a/docs/pages/suite/suite-on-screen-errors-and-warnings.md
+++ b/docs/pages/suite/suite-on-screen-errors-and-warnings.md
@@ -9,6 +9,6 @@ It may happen that your simulation or live trading is not working as expected. T
[](https://user-images.githubusercontent.com/13994516/63213696-b52ff500-c10f-11e9-9bc1-741ecb0858ef.gif)
-Bear in mind that when the split tab is fully closed, errors will no longer show up in the Designer, as shown in the below video:
+Bear in mind that when the split tab is fully closed, errors will no longer show up in the design space, as shown in the below video:
[](https://user-images.githubusercontent.com/13994516/63213579-528a2980-c10e-11e9-8464-76cb4b369db4.gif)
diff --git a/docs/pages/suite/suite-quick-overview.md b/docs/pages/suite/suite-quick-overview.md
index fcad66b26..6787d5c7a 100644
--- a/docs/pages/suite/suite-quick-overview.md
+++ b/docs/pages/suite/suite-quick-overview.md
@@ -7,25 +7,25 @@ permalink: suite-quick-overview.html
> **Start here:** Watch the [Superalgos Platform Quick Getting Started Guide](https://www.youtube.com/watch?v=_apiM49udL0) video for a quick intro. The video is slightly outdated in that the Superalgos Platform (the client version of the Platform) does not require a login and does not feature a menu on top. Otherwise, the content is still valid.
-The first time you run the platform, you will see a screen split in half. The top half features the space used by the _Charts_ and the bottom half features the _Designer_.
+The first time you run the platform, you will see a screen split in half. The top half features the space used by the _Charts_ and the bottom half features the _design space_.
Use the control in the center of the turquoise bar to pull the bar up and down to make more room for either application.
You may also use your keyboard as follows:
-1. Alt + ↑ to close the Charts and open the Designer.
-1. Alt + ↓ to close the Designer and open the Charts.
-1. Alt + → to set the bar at the middle giving half of the screen to the Charts and the other half to the Designer.
+1. Alt + ↑ to close the Charts and open the design space.
+1. Alt + ↓ to close the design space and open the Charts.
+1. Alt + → to set the bar at the middle giving half of the screen to the Charts and the other half to the design space.
[](https://user-images.githubusercontent.com/13994516/67267448-9d2f7580-f4b2-11e9-8f5c-123f8b0f360b.gif)
-> **TIP:** Pulling the bar to the very top of the screen causes the Charts to stop consuming resources in your machine, and gives you an ample view of the Designer.
+> **TIP:** Pulling the bar to the very top of the screen causes the Charts to stop consuming resources in your machine, and gives you an ample view of the design space.
-**The Designer** is the place where you create. Think of the designer as your toolbox. This is where you will control every aspect of your data, your trading strategies and the overall behavior of the platform in general.
+**The design space** is the place where you create. Think of the design space as your toolbox. This is where you will control every aspect of your data, your trading strategies and the overall behavior of the platform in general.
[](https://user-images.githubusercontent.com/13994516/67267449-9d2f7580-f4b2-11e9-9ae8-1eb1355de07d.gif)
-> **TIP:** Pulling the bar to the very bottom of the screen causes the Designer to stop consuming resources from your machine and offers a full-screen view of the Charts. The image above shows what you will see once you import your first *workspace* (you will learn about it in the next step).
+> **TIP:** Pulling the bar to the very bottom of the screen causes the design space to stop consuming resources from your machine and offers a full-screen view of the Charts. The image above shows what you will see once you import your first *workspace* (you will learn about it in the next step).
**The Charts** show indicators data along with the actions taken by strategies, integrated with market data. This is the section of the platform in which you will see and analyze the result of your work.
diff --git a/docs/pages/suite/suite-references.md b/docs/pages/suite/suite-references.md
index 2367dacd6..2b77ae3c1 100644
--- a/docs/pages/suite/suite-references.md
+++ b/docs/pages/suite/suite-references.md
@@ -5,36 +5,40 @@ sidebar: suite_sidebar
permalink: suite-references.html
---
-{{site.data.concepts.reference}}
+**{{site.data.concepts.reference}}**
-As such, *references* have a *direction* property relative to each of the nodes involved in the reference: the node establishing the reference sets an *outgoing* reference, while the one accepting the reference sets an *incoming* reference.
+## Direction
-For example, a session (testing or live) establishes an outgoing reference with a trading system. This allows the session to access the information within the whole trading system hierarchy, including strategies. At the trading system level, the same reference is viewed as an incoming reference.
+References have a *direction* property relative to each of the nodes involved in the reference: the node establishing the reference sets an *outgoing* reference, while the one accepting the reference sets an *incoming* reference.
+
+For example, a session establishes an outgoing reference with a trading system. This allows the session to access the information within the whole trading system hierarchy, including strategies. At the trading system level, the same reference is viewed as an incoming reference.
[](https://user-images.githubusercontent.com/13994516/70355703-0e649580-1873-11ea-925e-1f0250148d2c.gif)
+## Scope
+
A reference established between nodes of any particular structure within a hierarchy is said to be an *internal* reference relative to the said structure of nodes. Similarly, a reference established with a node outside of the said structure, that is, in a different part of the hierarchy or in another hierarchy, is said to be an *external* reference.
-Examples of internal references may be found in the Data Mine and Crypto Ecosystem hierarchies. For example, let's briefly look into one such case within a *plotter module*:
+Examples of internal references may be found in the data mine and crypto ecosystem hierarchies. For example, let's briefly look into one such case within a plotter module:
-The capture below shows the *shapes* node and several offspring objects: on one hand, several *polygons*; on the other hand, the *chart points* node.
+The capture below shows the shapes node and several offspring nodes: on one hand, several polygons; on the other hand, the chart points node.
[](https://user-images.githubusercontent.com/13994516/71106204-316e3e00-21bf-11ea-8ba0-df5fe9d0000e.gif)
-Notice that *vertices* under each polygon reference to *points* under the *chart points* node.
+Notice that vertices under each polygon reference to points under the chart points node.
This means that the node *shapes* feature several internal references.
-The *backup*, *clone* and *share* operations described later in this section make different uses of the properties of references. We will cover the three of them extensively so that you may make the most of these features.
+{% include note.html content="The *backup*, *clone* and *share* operations make different uses of the properties of references. We will cover the three of them extensively so that you may make the most of these features." %}
## Establishing and Removing References
To establish a reference, right-click on the first node and drag it close to the target node. Grey rings show which nodes you may establish a reference with. In case there are multiple nodes that would accept the reference, the one closer to the node where the reference originates will have its ring highlighted. Releasing the mouse button establishes the reference, or *links* both nodes.
-{% include note.html content="The reference is visually represented by a faint grey dotted line. Such line is visible only when both ends of the reference are visible." %}
-
-Throughout this documentation we may use the verb "*to link* interchangeably with *to establish a reference*, as synonyms.
+The reference is visually represented by a faint grey dotted line. Such line is visible only when both ends of the reference are visible.
To remove a reference or *delink* two nodes, simply right-click the node where the reference originates and make a dentle swipping motion away from the target node.
-[](https://user-images.githubusercontent.com/13994516/71175267-7057ce80-2267-11ea-8e97-4cffaa14b993.gif)
\ No newline at end of file
+[](https://user-images.githubusercontent.com/13994516/71175267-7057ce80-2267-11ea-8e97-4cffaa14b993.gif)
+
+{% include note.html content="Throughout this documentation we may use the verbs *to link*, *to reference* or *to establish a reference* interchangeably, as synonyms." %}
\ No newline at end of file
diff --git a/docs/pages/suite/suite-run-your-first-backtest.md b/docs/pages/suite/suite-run-your-first-backtest.md
index dbd10939a..4e8882875 100644
--- a/docs/pages/suite/suite-run-your-first-backtest.md
+++ b/docs/pages/suite/suite-run-your-first-backtest.md
@@ -15,7 +15,7 @@ To run your first backtest you will need a functional strategy.
## Import a Workspace
-Go to the ```Superalgos Platform/Quick-Start-Examples``` folder, drag ```Share - Workspace - Combined Bull-run rider and Weak-hands buster.json``` and drop it on the _Designer_ to start with a workspace with functioning strategies.
+Go to the ```Superalgos Platform/Quick-Start-Examples``` folder, drag ```Share - Workspace - Combined Bull-run rider and Weak-hands buster.json``` and drop it on the _design space_ to start with a workspace with functioning strategies.
[](https://user-images.githubusercontent.com/13994516/67231208-2907ba00-f43f-11e9-82b4-d78c0ace4d0a.gif)
@@ -25,9 +25,9 @@ Go to the ```Superalgos Platform/Quick-Start-Examples``` folder, drag ```Share -
| :---: | :---: | :---: | :---: | :---: |
| |  |  |  |  |
-Once on the Designer, hit Ctrl or ⌘ + Alt + T (*T* for *Testing*). This shortcut will take you to the *Network* hierachy of the Designer, where you will start the process to run a backtesting session. More precisely, it takes you to *Testing Sessions*, the *task manager* that controls testing sessions.
+Once on the design space, hit Ctrl or ⌘ + Alt + T (*T* for *Testing*). This shortcut will take you to the *Network* hierachy of the design space, where you will start the process to run a backtesting session. More precisely, it takes you to *Testing Sessions*, the *task manager* that controls testing sessions.
-Look around the task manager by clicking and dragging the black background of the Designer. You may also use the following keyboard key combinations to move around:
+Look around the task manager by clicking and dragging the black background of the design space. You may also use the following keyboard key combinations to move around:
1. Ctrl or ⌘ + ← to pan to the left.
1. Ctrl or ⌘ + → to pan to the right.
@@ -50,17 +50,17 @@ Notice the date progress notification displayed below the backtesting session no
It may take anything between 2 to 10 minutes (depending on your machine's processing power) to finish. You can tell the process finished calculating the backtesting session once the progress date stops, and—eventually—disappears.
-To see the backtest simulation on the charts, you first need to make sure that the *Layers Manager* for the corresponding session is visible in the Designer. This is what enables the corresponding simulation layers on the Layers Panel.
+To see the backtest simulation on the charts, you first need to make sure that the *Layers Manager* for the corresponding session is visible in the design space. This is what enables the corresponding simulation layers on the Layers Panel.
To do that, go back to the backtesting session and click  on the left-hand side.
[](https://user-images.githubusercontent.com/13994516/70341075-65a63e00-1852-11ea-9ae4-3b58a26b3c8c.gif)
-Then, you may pull down the horizontal bar to go to the charts and see the simulation. Make sure you are standing on the 1-hour time period. Notice the time box at the bottom of the charts:
+Then, you may pull down the horizontal bar to go to the charts and see the simulation. Make sure you are standing on the 1-hour time frame. Notice the time box at the bottom of the charts:
[](https://user-images.githubusercontent.com/13994516/67237146-fc599f80-f44a-11e9-8da4-c95fc6295d52.gif)
-If you are not at the 1-hour time period use the wheel of your mouse while pointing at the charts to zoom in until you reach the 1-hour time period. You do this so that you may see the results of the backtesting session, which in the case of the example strategies, are calculated and plotted over the 1-hour charts.
+If you are not at the 1-hour time frame use the wheel of your mouse while pointing at the charts to zoom in until you reach the 1-hour time frame. You do this so that you may see the results of the backtesting session, which in the case of the example strategies, are calculated and plotted over the 1-hour charts.
[](https://user-images.githubusercontent.com/13994516/67237088-d7fdc300-f44a-11e9-8ae5-d3fd394ffc22.gif)
@@ -68,7 +68,7 @@ Now go the *Layers Panel* on the left-hand side of the screen and use the wheel
[](https://user-images.githubusercontent.com/13994516/67237090-d8965980-f44a-11e9-86ba-3eb1e6980ae2.gif)
-You may now navigate the charts by clicking and dragging, or by zooming in and out with the wheel of your mouse. If you change the time period, you will not see the simulated data, as each time period may hold its own set of simulations.
+You may now navigate the charts by clicking and dragging, or by zooming in and out with the wheel of your mouse. If you change the time frame, you will not see the simulated data, as each time frame may hold its own set of simulations.
[](https://user-images.githubusercontent.com/13994516/67237276-3e82e100-f44b-11e9-977f-a02da0857b38.gif)
diff --git a/docs/pages/suite/suite-session-parameters.md b/docs/pages/suite/suite-session-parameters.md
index cb1d9d1b3..361b5251a 100644
--- a/docs/pages/suite/suite-session-parameters.md
+++ b/docs/pages/suite/suite-session-parameters.md
@@ -103,13 +103,13 @@ Paper trading sessions only require a *finalDatetime*. If you do not set one eit
}
```
-## Time Period
+## Time Frame
-| Time Period |
+| Time Frame |
| :---: |
|  |
-Testing sessions run in the time period specified in this parameter.
+Testing sessions run in the time frame specified in this parameter.
```js
{
@@ -132,7 +132,7 @@ Available options at the sub-hour level are:
45-min
```
-Available options at larger time periods are:
+Available options at larger time frames are:
```
01-hs
@@ -145,6 +145,6 @@ Available options at larger time periods are:
24-hs
```
-In the context of backtesting sessions, what time period you decide to run the session on depends on the strategies being tested. If strategies make decisions based on the 1 hour candle and above, then ```01-hs``` may be the best choice. However, if decisions are influenced by sub-hour candles then you should match the time periods accordingly.
+In the context of backtesting sessions, what time frame you decide to run the session on depends on the strategies being tested. If strategies make decisions based on the 1 hour candle and above, then ```01-hs``` may be the best choice. However, if decisions are influenced by sub-hour candles then you should match the time frames accordingly.
->**NOTE:** In the context of live sessions, that is, paper trading, forward testing and live trading, you should run the session on the ```01-min``` time period so that the trading bot reacts fast when the price tags the take profit or stop loss targets.
\ No newline at end of file
+>**NOTE:** In the context of live sessions, that is, paper trading, forward testing and live trading, you should run the session on the ```01-min``` time frame so that the trading bot reacts fast when the price tags the take profit or stop loss targets.
\ No newline at end of file
diff --git a/docs/pages/suite/suite-simulation-layers.md b/docs/pages/suite/suite-simulation-layers.md
index 5b2e41e41..c3daa3b04 100644
--- a/docs/pages/suite/suite-simulation-layers.md
+++ b/docs/pages/suite/suite-simulation-layers.md
@@ -13,7 +13,7 @@ permalink: suite-simulation-layers.html
The layers manager allows you to determine which visualization layers will be available at the Layers Panel to plot the results of testing sessions over the charts.
-The layers manager and its offspring nodes must be visible in the Designer
+The layers manager and its offspring nodes must be visible in the design space
Back on the charts, the following layers plot strategies' actions over the market data, providing a comprehensive set of visual clues showing how strategies would behave when trading.
diff --git a/docs/pages/suite/suite-situations-conditions-formulas.md b/docs/pages/suite/suite-situations-conditions-formulas.md
new file mode 100644
index 000000000..1878e02f5
--- /dev/null
+++ b/docs/pages/suite/suite-situations-conditions-formulas.md
@@ -0,0 +1,12 @@
+---
+title: Situations, Conditions and Formulas
+summary: "Situations and conditions are used to define the specific market situations in which a certain event should be triggered. Formulas are used to dynamically determine the value of targets."
+sidebar: suite_sidebar
+permalink: suite-situations-conditions-formulas.html
+---
+
+{% include /trading_system/situation.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="yes"%}
+
+{% include /trading_system/condition.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="yes"%}
+
+{% include /trading_system/formula.md heading="##" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="yes"%}
diff --git a/docs/pages/suite/suite-strategies.md b/docs/pages/suite/suite-strategies.md
new file mode 100644
index 000000000..0687b30fa
--- /dev/null
+++ b/docs/pages/suite/suite-strategies.md
@@ -0,0 +1,36 @@
+---
+title: Strategies
+summary: "Strategies are defined as a sequence of stages."
+sidebar: suite_sidebar
+permalink: suite-strategies.html
+---
+
+{% include /trading_system/strategy.md heading="" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="yes"%}
+
+{% include /trading_system/trigger-stage.md heading="##" icon="150-" adding="" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+
+{% include /trading_system/trigger-on-event.md heading="###" icon="" adding="" configuring="" starting="" content="yes" definition="" table="yes" more="no"%}
+
+{% include /trading_system/trigger-off-event.md heading="###" icon="" adding="" configuring="" starting="" content="yes" definition="" table="yes" more="no"%}
+
+{% include /trading_system/take-position-event.md heading="###" icon="" adding="" configuring="" starting="" content="yes" definition="" table="yes" more="no"%}
+
+{% include /trading_system/open-stage.md heading="##" icon="150-" adding="" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+
+{% include /trading_system/phase-0.md heading="###" icon="" adding="" configuring="" starting="" content="no" definition="" table="yes" more="no"%}
+
+{% include /trading_system/initial-stop.md heading="###" icon="" adding="" configuring="" starting="" content="yes" definition="" table="yes" more="no"%}
+
+{% include /trading_system/initial-take-profit.md heading="###" icon="" adding="" configuring="" starting="" content="yes" definition="" table="yes" more="no"%}
+
+{% include /trading_system/position-size.md heading="###" icon="" adding="" configuring="" starting="" content="yes" definition="" table="yes" more="no"%}
+
+{% include /trading_system/position-rate.md heading="###" icon="" adding="" configuring="" starting="" content="yes" definition="" table="yes" more="no"%}
+
+{% include /trading_system/manage-stage.md heading="##" icon="150-" adding="" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
+
+{% include /trading_system/next-phase-event.md heading="###" icon="" adding="" configuring="" starting="" content="yes" definition="" table="yes" more="no"%}
+
+{% include /trading_system/phase-1.md heading="###" icon="" adding="" configuring="" starting="" content="yes" definition="" table="yes" more="no"%}
+
+{% include /trading_system/close-stage.md heading="##" icon="150-" adding="" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
diff --git a/docs/pages/suite/suite-sysntax-overview.md b/docs/pages/suite/suite-sysntax-overview.md
index 9f2eb869e..8cdf78e15 100644
--- a/docs/pages/suite/suite-sysntax-overview.md
+++ b/docs/pages/suite/suite-sysntax-overview.md
@@ -1,6 +1,6 @@
---
title: Syntax Overview
-summary: ""
+summary: "The syntax for writing conditions and formulas combine references to the data product name, the name of the property, and the time frame."
sidebar: suite_sidebar
permalink: suite-sysntax-overview.html
---
@@ -15,19 +15,19 @@ To do that, you will use the following syntax: ```.productName``` + ```.property
The above syntax returns the value of the property of the declared product at the latest closed candle. This is common throughout all available datasets.
-## Specifying the Time Period
+## Specifying the Time Frame
-When building conditions and formulas, you may want to use analysis concerning different time periods. This is perfectly possible.
+When building conditions and formulas, you may want to use analysis concerning different time frames. This is perfectly possible.
-The variables explained further down this section, written as described for each indicator, are not valid unless they are preceeded by the declaration of the time period they refer to.
+The variables explained further down this section, written as described for each indicator, are not valid unless they are preceeded by the declaration of the time frame they refer to.
To do that, you need to preceed the above syntax with the following:
-```chart.at``` + ```timeperiod```
+```chart.at``` + ```time frame```
Therefore, the complete syntax to build a valid statement is:
-```chart.at``` + ```timeperiod``` + ```.productName``` + ```.propertyName```
+```chart.at``` + ```time frame``` + ```.productName``` + ```.propertyName```
For example:
@@ -35,9 +35,9 @@ For example:
The above statement compares the current 4 hours candle to the previous 4 hours candle.
-The complete list of time periods available is:
+The complete list of time frames available is:
-| Time Period | Syntax |
+| Time Frame | Syntax |
| :---: | :---: |
| 1 min | ```chart.at01min``` |
| 2 min | ```chart.at02min``` |
@@ -59,15 +59,13 @@ The complete list of time periods available is:
| 12 hs | ```chart.at12hs``` |
| 24 hs | ```chart.at24hs``` |
-> **NOTE:** For brevity's sake, when discussing indicators further down this document, the declaration of the time period may sometimes be ommited. However, do remember the statement is only valid with the proper declaration of the time period.
-
## Previous Property
The ```previous``` property is a property common to all products that allows you to retrieve the value of the candle that closed previous to the last one.
-The property is used with the following syntax: ```chart.at``` + ```timeperiod``` + ```.productName``` + ```.previous``` + ```.propertyName```. You may use the property on any of the indicators in a similar way.
+The property is used with the following syntax: ```chart.at``` + ```time frame``` + ```.productName``` + ```.previous``` + ```.propertyName```. You may use the property on any of the indicators in a similar way.
-In addition, you may use the ```previous``` property more than once, to retrieve values further in the past: ```chart.at``` + ```timeperiod``` + ```.productName``` + ```.previous.previous... ...previous``` + ```.propertyName```
+In addition, you may use the ```previous``` property more than once, to retrieve values further in the past: ```chart.at``` + ```time frame``` + ```.productName``` + ```.previous.previous... ...previous``` + ```.propertyName```
For example, ```chart.at1hs.candle.previous.previous.max``` returns the maximum value of two candles before the last closed candle at the 1-hour chart.
@@ -79,7 +77,7 @@ The syntax is ```productName.[currentCandleIndex-n].propertyName``` where *curre
For example, ```chart.at1hs.candle.[currentCandleIndex-5].max``` retrieves the maximum value of the fifth candle previous to the last closed candle at the 1-hour chart.
-> **NOTE:** There is a technical limitation by which you may retrieve the value of a property up to a maximum of 24 hours in the past, whatever number of periods that may represent, depending on the time period you may be working on. For instance, if you are working on the 1 hour time period, you may fetch up to 23 candles before the last one. If you are working on the 1 minute time period, you may retrieve 1439 candles.
+{% include note.html content="There is a technical limitation by which you may retrieve the value of a property up to a maximum of 24 hours in the past, whatever number of periods that may represent, depending on the time frame you may be working on. For instance, if you are working on the 1 hour time frame, you may fetch up to 23 candles before the last one. If you are working on the 1 minute time frame, you may retrieve 1439 candles." %}
## Comparison and Logical Operators
diff --git a/docs/pages/suite/suite-trading-sessions.md b/docs/pages/suite/suite-trading-sessions.md
index 790c19ab9..8ecf2a511 100644
--- a/docs/pages/suite/suite-trading-sessions.md
+++ b/docs/pages/suite/suite-trading-sessions.md
@@ -1,6 +1,6 @@
---
title: Trading Sessions
-summary: "Strategies are defined in a sequence of stages."
+summary: "Trading sessions enabling using the trading bot to perform tests, simulations, and live trading."
sidebar: suite_sidebar
permalink: suite-trading-sessions.html
---
diff --git a/docs/pages/suite/suite-trading-systems.md b/docs/pages/suite/suite-trading-systems.md
new file mode 100644
index 000000000..6ded03833
--- /dev/null
+++ b/docs/pages/suite/suite-trading-systems.md
@@ -0,0 +1,8 @@
+---
+title: Trading Systems
+summary: "A trading system is a device that allows building strategies in a standardized manner."
+sidebar: suite_sidebar
+permalink: suite-trading-systems.html
+---
+
+{% include /trading_system/trading-system.md heading="" icon="150-" adding="####" configuring="" starting="" content="yes" definition="bold" table="yes" more="no"%}
diff --git a/docs/pages/suite/suite-update-datasets.md b/docs/pages/suite/suite-update-datasets.md
index dd7afce02..ecdf56a7a 100644
--- a/docs/pages/suite/suite-update-datasets.md
+++ b/docs/pages/suite/suite-update-datasets.md
@@ -17,7 +17,7 @@ The bots that keep your datasets up to date are too controlled by a task manager
| :---: | :---: | :---: | :---: | :---: | :---: |
|  |  | |  |  |  |
-Open up the Designer section of the platform by dragging the horizontal bar upwards. You may also use Alt + ↑ on your keyboard. This shortcut closes the Charts and opens the Designer.
+Open up the design space section of the platform by dragging the horizontal bar upwards. You may also use Alt + ↑ on your keyboard. This shortcut closes the Charts and opens the design space.
Hit Ctrl or ⌘ + Alt + D (*D* for *Datasets*) to go to the *Masters Datasets* task manager that controls the aforementioned bots. Open the menu and click *Run All Tasks*.
diff --git a/docs/pages/suite/suite-working-with-strategies.md b/docs/pages/suite/suite-working-with-strategies.md
index 71e442385..465344db0 100644
--- a/docs/pages/suite/suite-working-with-strategies.md
+++ b/docs/pages/suite/suite-working-with-strategies.md
@@ -26,7 +26,7 @@ Becoming familiar with the Superalgos Trading Protocol will significantly increa
* [Superalgos Trading Protocol V0.1 - the Long Version, for Beginner Traders](https://medium.com/superalgos/superalgos-protocol-v0-1-the-long-version-for-beginner-traders-f293f1cc6c13).
-The Designer provides a graphic user interface (GUI) for traders to input the _rules_ and _formulas_ that determine the behavior of strategies. Traders need to define the rules to _trigger on_ and _trigger off_ each strategy, to _take a position_, to manage _take profit_ targets and _stops_.
+The design space provides a graphic user interface (GUI) for traders to input the _rules_ and _formulas_ that determine the behavior of strategies. Traders need to define the rules to _trigger on_ and _trigger off_ each strategy, to _take a position_, to manage _take profit_ targets and _stops_.
## Situations and Conditions
@@ -38,7 +38,7 @@ The protocol calls these sets of rules _situations_, in the sense that you are t
In other words, you define _situations_ in which you wish a certain _event_ to happen (i.e.: trigger on the strategy, take a position, etc.) and each situation is described as a set of _conditions_ that need to be met for the _event_ to be triggered.
-[](https://user-images.githubusercontent.com/13994516/63052184-fe4d3280-bede-11e9-87b0-7fb67964450c.gif)
+[](https://user-images.githubusercontent.com/13994516/63052184-fe4d3280-bede-11e9-87b0-7fb67964450c.gif)
The type of _statements_ you will use to define _conditions_ need to evaluate to _true_ or _false_.
@@ -58,7 +58,7 @@ Thanks to the implementation of the Superalgos Trading Protocol, all strategies
You may import any node—formulas, conditions, situations, phases, stages, complete strategies, complete trading systems, and even complete workspaces—simply by dragging and dropping them on the workspace.
-[](https://user-images.githubusercontent.com/13994516/67271115-34e49200-f4ba-11e9-9309-e9e7046384a0.gif)
+[](https://user-images.githubusercontent.com/13994516/67271115-34e49200-f4ba-11e9-9309-e9e7046384a0.gif)
## Working with Multiple Strategies