Introduction 5-6

Projects/Superalgos/Schemas/Docs-Topics/introduction-005-workspace.json

@@ -0,0 +1,93 @@
+{
+    "topic": "Introduction",
+    "pageNumber": "5",
+    "type": "Workspace",
+    "definition": {
+        "text": "A workspace is an entity storing all system and user-generated information, excluding the state and contents of plugins. In technical terms, a workspace is a JSON file.",
+        "updated": 1609946727314
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "A workspace stores information about:"
+        },
+        {
+            "style": "List",
+            "text": "Any hierarchy that is not included as a plugin."
+        },
+        {
+            "style": "List",
+            "text": "Nodes that may be floating around, detached from hierarchies."
+        },
+        {
+            "style": "List",
+            "text": "Information regarding the physical position and state of all nodes within the design space, even those detached from the hierarchies."
+        },
+        {
+            "style": "Text",
+            "text": "A workspace is not part of any of the hierarchies; instead, it contains them."
+        },
+        {
+            "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 + S."
+        },
+        {
+            "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"
+        },
+        {
+            "style": "Text",
+            "text": "Users may manage multiple workspaces, but only one workspace may be loaded in the system at any point."
+        },
+        {
+            "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."
+        },
+        {
+            "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."
+        },
+        {
+            "style": "Subtitle",
+            "text": "Deleting Workspaces"
+        },
+        {
+            "style": "Text",
+            "text": "To delete a workspace, delete the corresponding workspace file from within the file system application of your operating system."
+        },
+        {
+            "style": "Text",
+            "text": ""
+        }
+    ]
+}

Projects/Superalgos/Schemas/Docs-Topics/introduction-006-nodes-and-structures-of-nodes.json

@@ -0,0 +1,69 @@
+{
+    "topic": "Introduction",
+    "pageNumber": "6",
+    "type": "Nodes and Structures of Nodes",
+    "definition": {
+        "text": "A node is a small data structure containing information that may be related to market information, trading intelligence, the operation of the system, or other concepts. They are visually represented by icons in the design space.",
+        "updated": 1609946951589
+    },
+    "paragraphs": [
+        {
+            "style": "Title",
+            "text": "Structure of Nodes",
+            "updated": 1609946982728
+        },
+        {
+            "style": "Text",
+            "text": "Nodes may be chained together forming structures of nodes. In every structure of nodes there is a parent node with offsprings. That is, a structure of nodes is a data structure composed of any node and its offspring."
+        },
+        {
+            "style": "Text",
+            "text": "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."
+        },
+        {
+            "style": "Title",
+            "text": "Parent-Offspring Relationships"
+        },
+        {
+            "style": "Text",
+            "text": "Nodes in structures of nodes are chained to each other by so-called parent-offspring relationships. These relationships are visually represented by orange dotted lines, which may turn yellow or blue depending on certain visualization properties that the user may control. When nodes are chained together they form structures of nodes."
+        },
+        {
+            "style": "Text",
+            "text": "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."
+        },
+        {
+            "style": "Title",
+            "text": "How to Detach and Attach Nodes"
+        },
+        {
+            "style": "Text",
+            "text": "To detach a node, click on the detach button on the node's menu. To attach a node, right-click it and drag it closer to the node you wish to attach it to. Release the right-click when the target node is highlighted.",
+            "updated": 1609947216203
+        },
+        {
+            "style": "Text",
+            "text": "Use the detach option on the menu to break a relationship."
+        },
+        {
+            "style": "Text",
+            "text": "Nodes in the workspace may be unchained or detached from its parent, carrying all offspring with it. When a node is left unchained, it is no longer taken into account in the logic of the hierarchy, as it no longer belongs to it. When a node is chained back or reattached to the hierarchy, it goes back to being functional."
+        },
+        {
+            "style": "Text",
+            "text": "This feature is useful when testing different configurations, rules or parameters, as it allows to keep alternatives handy in the workspace."
+        },
+        {
+            "style": "Text",
+            "text": "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."
+        },
+        {
+            "style": "Text",
+            "text": " Note: Nodes may not be detached or attached to frozen nodes. You need to unfreeze them before attaching or detaching."
+        },
+        {
+            "style": "Text",
+            "text": " Note: The verbs to chain and to attach may be used interchangeably, as synonyms. Similarly, to unchain and to detach are both valid."
+        }
+    ]
+}