diff --git a/Projects/Superalgos/Schemas/Docs-Books/users-formula-and-code-examples.json b/Projects/Superalgos/Schemas/Docs-Books/users-formula-and-code-examples.json new file mode 100644 index 000000000..7de37a9ab --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Books/users-formula-and-code-examples.json @@ -0,0 +1,14 @@ +{ + "type": "Users' Formula and Code Examples", + "definition": { + "text": "This book compiles user implementations of ideas for formulas and code in the definition of Trading Systems.", + "updated": 1615909555497 + }, + "paragraphs": [ + { + "style": "Chapter", + "text": "I->Superalgos->Topic->User Examples for Stop Loss->A collection of ideas for stop loss formulas.", + "updated": 1615909896032 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/workspace.json b/Projects/Superalgos/Schemas/Docs-Nodes/workspace.json index 0b14fbd9d..84cf6db8d 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/workspace.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/workspace.json @@ -20,7 +20,8 @@ }, { "style": "List", - "text": "Information regarding the physical position and state of all nodes within the design space, even those detached from the hierarchies." + "text": "Information regarding the physical position and state of all nodes within the design space, even those detached from hierarchies.", + "updated": 1615891174248 }, { "style": "Text", @@ -28,41 +29,6 @@ }, { "style": "Title", - "text": "Working With Workspaces" - }, - { - "style": "Subtitle", - "text": "Saving Workspaces" - }, - { - "style": "Text", - "text": "Workspaces are saved as .json files in the My-Workspaces folder." - }, - { - "style": "Text", - "text": "They are saved automatically every 60 seconds, or at the moment the browser or browser tab is closed. You may also save it manually using the following hot-key combination: Ctrl or ⌘ + Shift + Key-S.", - "updated": 1610620660591 - }, - { - "style": "Success", - "text": " Backing up a workspace downloads the same file to your local Downloads folder. This is a good way to store old versions in case you ever need to go back to a previous state of affairs.", - "updated": 1609946808755 - }, - { - "style": "Important", - "text": " Plugin workspaces may not be modified. When you load a plugin workspace, a new file is created in your My-Workspaces folder as soon as the workspace is saved for the first time, resulting in a copy of the plugin workspace. Any modifications you introduce in the workspace are stored in the copy, not the original plugin.", - "updated": 1609946816684 - }, - { - "style": "Subtitle", - "text": "Creating Workspaces" - }, - { - "style": "Text", - "text": "To create a new workspace, rename any of the existing workspaces by changing the label of the workspace node, and save it as explained above. After you change the label and once the workspace is saved (by any of the usual means), a new file is stored in the My-Workspaces folder." - }, - { - "style": "Subtitle", "text": "Loading Workspaces" }, { @@ -71,14 +37,75 @@ }, { "style": "Text", - "text": "To load a workspace, click the workspaces tab on the left-hand side of the screen and select one of the available files." + "text": "To load a workspace, click the Workspaces Tab on the left-hand side of the screen and select one of the available files.", + "updated": 1615893116990 + }, + { + "style": "Success", + "text": "To load a workspace you got from a third party, you may place the file in the My-Workspaces folder so that you may open it from the workspaces tab. You may also drag the file and drop it on the design space.", + "updated": 1615892822939 + }, + { + "style": "Title", + "text": "" + }, + { + "style": "Title", + "text": "Saving Workspaces" }, { "style": "Text", - "text": "To load a workspace you got from a third party, you may place the file in the My-Workspaces folder so that you may open it from the workspaces tab, or you may drag it and drop it on the design space." + "text": "Workspaces are saved as JSON files in the My-Workspaces folder.", + "updated": 1615891202642 }, { - "style": "Subtitle", + "style": "Text", + "text": "They are saved automatically every 60 seconds, or at the moment the browser or browser tab is closed. You may also save it manually using the following hot-key combination: ", + "updated": 1615886048026 + }, + { + "style": "Text", + "text": "Ctrl or Cmd + Shift + Key-S", + "updated": 1615891225650 + }, + { + "style": "Success", + "text": "Backing up a workspace downloads the same file to your local Downloads folder. This is a good way to store sequential versions in case you ever need to go back to a previous state of affairs.", + "updated": 1615892985307 + }, + { + "style": "Title", + "text": "Plugin Workspaces", + "updated": 1615892918302 + }, + { + "style": "Text", + "text": "Superalgos ships with several plugin workspaces. These are pre-configured workspaces built for specific purposes, for example, to host tutorials, demo strategies, and so on.", + "updated": 1615894320467 + }, + { + "style": "Text", + "text": "In the Workspaces Tab, plugin workspaces are marked with the words \"Plugin\" so that you may differentiate them from your own workspaces." + }, + { + "style": "Important", + "text": "Plugin workspaces may not be modified. When you load a plugin workspace, a new file is created in your My-Workspaces folder as soon as the workspace is saved for the first time, resulting in a copy of the plugin workspace. The copy is saved with the same name as the plugin but in a different folder. Any modifications you introduce in the workspace are stored in the copy, not the original plugin. Bear in mind that if you don't change the name of the workspace, the file in the My-Workspaces folder will be overwritten if you load the plugin Workspace again. This is because the system will automatically write a file with the same name as the plugin.", + "updated": 1615894346258 + }, + { + "style": "Title", + "text": "Creating Workspaces" + }, + { + "style": "Text", + "text": "To create a new workspace, rename any of the existing workspaces by changing the label of the workspace node, and save it as explained above. After you change the label and once the workspace is saved (by any of the usual means), a new file is stored in the My-Workspaces folder." + }, + { + "style": "Success", + "text": "The Tested Exchanges plugin workspace is the best to start with if you wish to create your own Trading System." + }, + { + "style": "Title", "text": "Deleting Workspaces" }, { diff --git a/Projects/Superalgos/Schemas/Docs-Topics/introduction-005-workspaces.json b/Projects/Superalgos/Schemas/Docs-Topics/introduction-005-workspaces.json index a4f85c538..26ac29f6b 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/introduction-005-workspaces.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/introduction-005-workspaces.json @@ -3,8 +3,8 @@ "pageNumber": "5", "type": "Workspaces", "definition": { - "text": "Workspaces are a powerful concept that allow you to work on many different kinds of settings.", - "updated": 1610620984891 + "text": "Workspaces are a powerful concept. They enable working on multiple settings in an orderly fashion.", + "updated": 1615893371936 }, "paragraphs": [ { diff --git a/Projects/Superalgos/Schemas/Docs-Topics/user-examples-for-stop-loss-001-trailing-stop-loss-percentage-of-rate.json b/Projects/Superalgos/Schemas/Docs-Topics/user-examples-for-stop-loss-001-trailing-stop-loss-percentage-of-rate.json index 58f92f209..1b55fe646 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/user-examples-for-stop-loss-001-trailing-stop-loss-percentage-of-rate.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/user-examples-for-stop-loss-001-trailing-stop-loss-percentage-of-rate.json @@ -1,7 +1,7 @@ { - "topic": "User Examples for Stop Loss ", + "topic": "User Examples for Stop Loss", "pageNumber": 1, - "type": " Trailing Stop Loss - Percentage of Rate", + "type": "Trailing Stop Loss - Percentage of Rate", "definition": { "text": "A Trailing Stop Loss tracks the rate and sets the Stop Loss a given distance away from it", "updated": 1615285882641 diff --git a/Projects/Superalgos/Schemas/Docs-Topics/user-examples-for-stop-loss-002-trailing-stop-loss-risk-of-total-quoted-balance.json b/Projects/Superalgos/Schemas/Docs-Topics/user-examples-for-stop-loss-002-trailing-stop-loss-risk-of-total-quoted-balance.json index 4c1c2097f..c1130eb47 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/user-examples-for-stop-loss-002-trailing-stop-loss-risk-of-total-quoted-balance.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/user-examples-for-stop-loss-002-trailing-stop-loss-risk-of-total-quoted-balance.json @@ -1,7 +1,7 @@ { - "topic": "User Examples for Stop Loss ", + "topic": "User Examples for Stop Loss", "pageNumber": 2, - "type": " Trailing Stop Loss - Risk of Total Quoted Balance", + "type": "Trailing Stop Loss - Risk of Total Quoted Balance", "definition": { "text": "This Trailing Stop Loss sets the Stop Loss according to the percentage you are willing to risk out of your Total Quoted Balance", "updated": 1615287509462 diff --git a/Projects/Superalgos/Schemas/Docs-Topics/user-examples-for-stop-loss-003-trailing-stop-loss-initial-stop-loss-risk-and-targets-combo.json b/Projects/Superalgos/Schemas/Docs-Topics/user-examples-for-stop-loss-003-trailing-stop-loss-initial-stop-loss-risk-and-targets-combo.json index d62d36c0d..380ab2d8a 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/user-examples-for-stop-loss-003-trailing-stop-loss-initial-stop-loss-risk-and-targets-combo.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/user-examples-for-stop-loss-003-trailing-stop-loss-initial-stop-loss-risk-and-targets-combo.json @@ -1,7 +1,7 @@ { - "topic": "User Examples for Stop Loss ", + "topic": "User Examples for Stop Loss", "pageNumber": 3, - "type": " Trailing Stop Loss - Initial Stop Loss, Risk and Targets Combo", + "type": "Trailing Stop Loss - Initial Stop Loss, Risk and Targets Combo", "definition": { "text": "Setting an initial Risk Percentage of your Total Quoted Balance, after reaching the first Profit Target your first Trailing Stop Loss takes place. After reaching second Profit Target, we'll set the Trailing Stop Loss to a fixed percentage.", "updated": 1615298179984 diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-034-tutorial-step-what-about-clones.json b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-034-tutorial-step-what-about-clones.json index 3a56c9a8b..69ebfb985 100644 --- a/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-034-tutorial-step-what-about-clones.json +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-034-tutorial-step-what-about-clones.json @@ -32,8 +32,8 @@ }, { "style": "Success", - "text": "Feel free to test the Clones feature! We'll move on to other topics without further due!", - "updated": 1615839231992 + "text": "Feel free to take the time to test the Clones feature on your own! We'll move on to other topics without further due!", + "updated": 1615884678255 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-035-tutorial-step-working-with-workspaces.json b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-035-tutorial-step-working-with-workspaces.json new file mode 100644 index 000000000..b0c6a5c0e --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-035-tutorial-step-working-with-workspaces.json @@ -0,0 +1,34 @@ +{ + "tutorial": "Basic Education", + "pageNumber": "35", + "type": "Tutorial Step - Working with Workspaces", + "definition": { + "text": "You may think of a workspace as a stage in a theatre. It is the setting on which something will play out!", + "icon": { + "name": "workspace", + "project": "Superalgos" + }, + "updated": 1615893942449 + }, + "paragraphs": [ + { + "style": "Text", + "text": "You may set up as many workspaces as you like, each of them for specific use cases. For example:", + "updated": 1615904641004 + }, + { + "style": "List", + "text": "You may have a workspace to build a Trading Sytem that will need specific indicators from a specific Data Mine." + }, + { + "style": "List", + "text": "You may have another workspace setup with all the available indicators so that you may study how each of them works.", + "updated": 1615904707330 + }, + { + "style": "Callout", + "text": "Read this page to learn the basics about how to deal with workspaces...", + "updated": 1615904777283 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-036-tutorial-step-your-workspace-vs-plugins.json b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-036-tutorial-step-your-workspace-vs-plugins.json new file mode 100644 index 000000000..16df1d569 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-036-tutorial-step-your-workspace-vs-plugins.json @@ -0,0 +1,38 @@ +{ + "tutorial": "Basic Education", + "pageNumber": "36", + "type": "Tutorial Step - Your Workspace vs Plugins", + "definition": { + "text": "Go to your File Explorer app and look for the following paths relative to the root Superalgos folder...", + "icon": { + "name": "plugins", + "project": "Superalgos" + }, + "updated": 1615906049600 + }, + "paragraphs": [ + { + "style": "Json", + "text": "\\My-Workspaces\n", + "updated": 1615906070844 + }, + { + "style": "List", + "text": "In this folder, you will find a file named Getting Started.json. This is the current workspace; the one you are using at this moment. Everything you have been doing lately has been stored in this file.", + "updated": 1615906276410 + }, + { + "style": "Json", + "text": "\\Projects\\Superalgos\\Plugins\\Workspaces" + }, + { + "style": "List", + "text": "In this second folder, you will find several files. Each of them is a plugin workspace shipping with Superalgos. The one named Getting-Started.json is the plugin you started with.", + "updated": 1615906281606 + }, + { + "style": "Text", + "text": "" + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-037-tutorial-step-the-current-workspace.json b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-037-tutorial-step-the-current-workspace.json new file mode 100644 index 000000000..7c69dd5d7 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-037-tutorial-step-the-current-workspace.json @@ -0,0 +1,35 @@ +{ + "tutorial": "Basic Education", + "pageNumber": "37", + "type": "Tutorial Step - The Current Workspace", + "definition": { + "text": "The current workspace is the one you are using at any point.", + "icon": { + "name": "workspace", + "project": "Superalgos" + }, + "updated": 1615906908608 + }, + "paragraphs": [ + { + "style": "Text", + "text": "If you close and restart the app, or refresh the UI, the system loads the workspace that was last in use.", + "updated": 1615907362014 + }, + { + "style": "Callout", + "text": "Go to the menu of the Workspace node, double-click on the Getting Started label and change the name of the workspace to Basic Education.", + "updated": 1615907154715 + }, + { + "style": "Text", + "text": "Now hit Ctrl + Shift + Alt + Key-S", + "updated": 1615907276880 + }, + { + "style": "Success", + "text": "You just created a new workspace! Go to the My-Workspaces folder to verify the new file is there.", + "updated": 1615907412107 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-038-tutorial-step-lets-talk-plugins.json b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-038-tutorial-step-lets-talk-plugins.json new file mode 100644 index 000000000..b229efa91 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-038-tutorial-step-lets-talk-plugins.json @@ -0,0 +1,38 @@ +{ + "tutorial": "Basic Education", + "pageNumber": "38", + "type": "Tutorial Step - Let's Talk Plugins", + "definition": { + "text": "Plugins are data structures that ship with the system and that you may call into any workspace using the Plugins hierarchy.", + "updated": 1615914003358, + "icon": { + "name": "plugins", + "project": "Superalgos" + } + }, + "paragraphs": [ + { + "style": "Text", + "text": "Plugins are data structures meant to be reused. That is why they ship as plugins, so that you may place them on any workspace.", + "updated": 1615917170964 + }, + { + "style": "Callout", + "text": "Expand the Plugins node!" + }, + { + "style": "Text", + "text": "As you can tell from the structure of the hierarchy, there are several types of plugins! They ship as JSON files, sorted by type in the plugins folder. Check it out!", + "updated": 1615917052972 + }, + { + "style": "Json", + "text": "\\Projects\\Superalgos\\Plugins", + "updated": 1615916283983 + }, + { + "style": "Text", + "text": "" + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-039-tutorial-step-how-plugins-work.json b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-039-tutorial-step-how-plugins-work.json new file mode 100644 index 000000000..db6d6b7a8 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-039-tutorial-step-how-plugins-work.json @@ -0,0 +1,30 @@ +{ + "tutorial": "Basic Education", + "pageNumber": "39", + "type": "Tutorial Step - How Plugins Work", + "definition": { + "text": "Find the Plugin Trading Systems node and expand it! Note the Plugin File node named Masters-Lightning-Strike...", + "icon": { + "name": "expand-structure-of-nodes", + "project": "Superalgos" + }, + "updated": 1615919140092 + }, + "paragraphs": [ + { + "style": "Text", + "text": "Lightning Strike is the demo Trading System you've been playing with during the Welcome tutorial. It has been placed as a plugin in this workspace!", + "updated": 1615924603782 + }, + { + "style": "Callout", + "text": "Follow the orange dotted line downwards until you find the node it connects to! Use the keyboard trick Ctrl + arrows to go faster!", + "updated": 1615919519995 + }, + { + "style": "Text", + "text": "That's it! You found the Lightning Strike Trading System node. If you drag it to the side, you will find the Plugin File Position node below.", + "updated": 1615919373745 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-040-tutorial-step-positioning-plugins.json b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-040-tutorial-step-positioning-plugins.json new file mode 100644 index 000000000..dca5563f3 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-040-tutorial-step-positioning-plugins.json @@ -0,0 +1,30 @@ +{ + "tutorial": "Basic Education", + "pageNumber": "40", + "type": "Tutorial Step - Positioning Plugins", + "definition": { + "text": "Here's the crazy bit... the Plugin File Position node determines where in the workspace the plugin is placed!", + "updated": 1615921131447, + "icon": { + "name": "plugin-file-position", + "project": "Superalgos" + } + }, + "paragraphs": [ + { + "style": "Text", + "text": "That is why you found the Trading System node on top of the Plugin File Position node!", + "updated": 1615920675491 + }, + { + "style": "Success", + "text": "If you deleted the Trading System node, it would show up again the next time you reload the workspace! Plugins are loaded from the plugin file every time the workspace is loaded!", + "updated": 1615920995477 + }, + { + "style": "Text", + "text": "Feel free to try it! If so you wish, you may delete the Trading System node and refresh the page. Bear in mind that you will need to find the Basic Education tutorial and click Resume on the menu to continue!", + "updated": 1615921187621 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-041-tutorial-step-placing-plugins.json b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-041-tutorial-step-placing-plugins.json new file mode 100644 index 000000000..81ac26247 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/basic-education-041-tutorial-step-placing-plugins.json @@ -0,0 +1,30 @@ +{ + "tutorial": "Basic Education", + "pageNumber": "41", + "type": "Tutorial Step - Placing Plugins", + "definition": { + "text": "To place a plugin in a workspace you must select the option to add the missing plugins on the node of the matching type!", + "icon": { + "name": "plugin-trading-systems", + "project": "Superalgos" + }, + "updated": 1615925984822 + }, + "paragraphs": [ + { + "style": "Callout", + "text": "Let's give it a shot! Select Add Missing Trading Systems in the Plugin Trading Systems node! Confirm with a second click...", + "updated": 1615926026799 + }, + { + "style": "Text", + "text": "That's it! The rest of the plugins available in the Trading-Systems folder are added as Plugin File nodes! You may delete the Plugin File nodes of the trading systems you don't need and keep the ones you need!", + "updated": 1615925783068 + }, + { + "style": "Success", + "text": "Now you may use the Plugin File Position node to place the plugin in the desired position!", + "updated": 1615925560412 + } + ] +} \ No newline at end of file