From 62e8fe8d98d3d02e14078618b3c1c935da0d3e0a Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Sat, 20 Feb 2021 18:55:40 +0100 Subject: [PATCH] Tutorials --- .../Schemas/Docs-Concepts/project.json | 4 +- .../Schemas/Docs-Nodes/tutorial.json | 147 ++++++++---------- 2 files changed, 65 insertions(+), 86 deletions(-) diff --git a/Projects/Superalgos/Schemas/Docs-Concepts/project.json b/Projects/Superalgos/Schemas/Docs-Concepts/project.json index f454c865a..10f02123c 100644 --- a/Projects/Superalgos/Schemas/Docs-Concepts/project.json +++ b/Projects/Superalgos/Schemas/Docs-Concepts/project.json @@ -1,8 +1,8 @@ { "type": "Project", "definition": { - "text": "Superalgos is a platform that integrates different projects with the goal of automating operation acrross any of them, and extracting valuable information from their own blockchains in order to use them in trading strategies.", - "updated": 1609144195229 + "text": "The Superalgos infrastructure integrates different projects. The main goal of these integrations is to automate cross-project operations, extracting valuable information from blockchains or the particular domain of each project to be used on Trading Systems.", + "updated": 1613841611271 }, "paragraphs": [ { diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/tutorial.json b/Projects/Superalgos/Schemas/Docs-Nodes/tutorial.json index 24a017efb..e31858ea5 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/tutorial.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/tutorial.json @@ -1,7 +1,8 @@ { "type": "Tutorial", "definition": { - "text": "The tutorial hierarchy features a free arrangement of tutorial topic and tutorial step nodes that make up a tutorial. Each node in the hierarchy, including the parent tutorial node, represents a HTML page that is overlaid on top of both the design space and the charting space. " + "text": "The tutorial hierarchy features a free arrangement of Tutorial Topic and Tutorial Step nodes that make up a tutorial. Each node in the hierarchy, including the parent tutorial node, represents an HTML page that is overlaid on top of both the design space and the charting space.", + "updated": 1613839026788 }, "paragraphs": [ { @@ -10,7 +11,18 @@ }, { "style": "Text", - "text": "Nodes in the hierarchy may be arranged freely, meaning that there may be as many tutorial topics and tutorial steps as desired. In general terms, all types of nodes behave similarly in the sense that each node, independently of the precise type, represents a tutorial step in and of itself. There are subtle differences to be covered where appropriate." + "text": "Nodes in the hierarchy may be arranged freely, meaning that there may be as many tutorial topics and tutorial steps as desired. ", + "updated": 1613839088895 + }, + { + "style": "Text", + "text": "In general terms, all types of nodes behave similarly in the sense that each node, independently of the precise type, represents a tutorial step in and of itself. Subtle differences shall be covered where appropriate.", + "updated": 1613839117191 + }, + { + "style": "Success", + "text": "The key similarity among all types of nodes in the hierarchy is that all of them may draw content from a tutorial page in the Docs.", + "updated": 1613839286982 }, { "style": "Block", @@ -23,29 +35,23 @@ }, { "style": "Text", - "text": "The configuration of each node in the tutorial hierarchy determines the content of each step. All types of nodes share the same basic configuration. However, tutorial step nodes have extra properties, described elsewhere." + "text": "The configuration of each node in the tutorial hierarchy determines the content and behavior of each step. All types of nodes share the same basic configuration. However, Tutorial Step nodes have extra properties, described elsewhere.", + "updated": 1613839329036 }, { "style": "Text", - "text": "The layout of the HTML page is fixed (CSS styles are fixed too) and is made out of a sequence of HTML elements, each of which may or may not be used, depending on whether the corresponding configuration parameter exists or not in the configuration." + "text": "The layout of the HTML page follows the layout of the referenced page in the Docs, although displayed within the confines of the tutorial window. ", + "updated": 1613839417342 }, { "style": "Callout", - "text": "In other words, you may choose which elements of a potentially long list are used by filling the corresponding parameters with content or not." + "text": "In other words, you affect the layout of the step by writing content and applying styles to individual paragraphs in the associated Docs Page.", + "updated": 1613839489189 }, { "style": "Note", - "text": "The HTML page features a limited space and does not support scrolling. If too much information is defined in the configuration, the resulting content overflows the available space. There is no system-side control to deal with such overflows, so it's up to you to spread information across multiple steps and keep each page within its limits." - }, - { - "style": "Success", - "text": "You may use HTML element tags and inline CSS as part of the content of parameters. Just consider that they shall be embedded in the fixed layout and their effectiveness may vary.", - "updated": 1609704857821 - }, - { - "style": "Success", - "text": "Configuration items are listed in the order of appearance in the HTML layout, that is, the sequence of HTML elements mentioned earlier.", - "updated": 1609704957111 + "text": "The HTML page features a limited space and does not support scrolling. If too much information is defined in the associated Docs Page, the resulting content overflows the available space in the tutorial window. There is no system-side control to deal with such overflows, so it's up to you to spread information across multiple steps and keep each page within its limits.", + "updated": 1613839536547 }, { "style": "Subtitle", @@ -54,93 +60,66 @@ }, { "style": "List", - "text": "title is the main title of the page." + "text": "icon: the name and project of one of the icons stored in the \\Projects\\[Project-Name]\\Iconsfolder, without the extension. When the configuration exists, the icon is placed within a table, on the left-hand side of the text block featured in the definition field. When there is no icon, the definition occupies the full width.", + "updated": 1613840648780 + }, + { + "style": "Json", + "text": "\"icon\": {\n \"name\": \"balance\",\n \"project\": \"Superalgos\"\n }", + "updated": 1613840669552 }, { "style": "List", - "text": "summary is a block of text preceded with the word Summary." + "text": "position: determines the position of the floating HTML. There are three alternatives... \"Left\", \"Right\", or leave the field empty to position the page in the center of the screen.", + "updated": 1613842749882 + }, + { + "style": "Json", + "text": " \"position\": \"Left\"", + "updated": 1613840787300 }, { "style": "List", - "text": "subTitle is the secondary title of the page.", - "updated": 1609705068885 + "text": "slider: determines the position of the horizontal slider. There are three alternatives... \"toTop\", \"toBottom\", \"toMiddle\".", + "updated": 1613842783566 + }, + { + "style": "Json", + "text": "\"slider\": \"toBottom\"" }, { "style": "List", - "text": "gif is the name of an image in the GIF format. Do not include the .gif extension in the configuration, and make sure that the name of the file features the extension in lowercase. The file must be stored in the \\Projects\\[Project-Name]\\Gifsfolder. The optimum size of the image is 400 px in width. For a step showing only a gif image, use 580 px for the height." + "text": "pressButton: allows you to forcefully \"Stop\" the tutorial, go to the \"Next\" step, go to the \"Previous\" step, or \"Skip\" a step. When a step is loaded and one of these options is configured in this property, the action is applied immediately. A common use of this feature is to skip a step, for instance, a Tutorial Topic node that is used solely for organizational purposes within the hierarchy, thus has no content.", + "updated": 1613842824873 + }, + { + "style": "Json", + "text": "\"pressButton\": \"Next\"", + "updated": 1613841332185 }, { "style": "List", - "text": "image is the name of one of the icons stored in the \\Projects\\[Project-Name]\\Iconsfolder, without the extension. When the configuration exists, the icon is placed within a table, on the left-hand side of the text block featured in the definition field. When there is no icon, the definition occupies the full width." + "text": "docs: the property is used to reference the Docs Tutorial Page that feeds content to the particular tutorial step. The definition requires the name of the Project, the Docs Page Category which is always Tutorial, and the complete name of the tutorial step page.", + "updated": 1613841395148 + }, + { + "style": "Json", + "text": "\"docs\": {\n \"project\": \"Superalgos\",\n \"category\": \"Tutorial\",\n \"type\": \"Tutorial Step - Scales' Best-Kept Secrets\"\n }", + "updated": 1613842164831 }, { "style": "List", - "text": "definition is a block of text in bold style.", - "updated": 1609705317162 + "text": "controlDocs: the property is used to control the behavior of the Docs panel. The panel property may be set to \"Open\" or \"Close\". The property closeTutorialEditor may switch on (true) and off (false) the Docs editor. When set to false, the Docs panel shows the page corresponding to the active tutorial step or the page in the Docs that is requested. When the property is set to true and there is no request to open a Docs page, then the Docs panel shows the search box. The page property is where you define which page in the Docs must be loaded. You must specify the Project, the Docs Page Category, and the type which is the complete name of the page.", + "updated": 1613843493276 }, { - "style": "List", - "text": "bulletListIntro is a block of text that serves as an introduction to the array of bullet points below." + "style": "Json", + "text": " \"controlDocs\": {\n \"panel\": \"Open\",\n \"closeTutorialEditor\": true,\n \"page\": {\n \"project\": \"Superalgos\",\n \"category\": \"Topic\",\n \"type\": \"Trading System Hierarchy\"\n }\n }", + "updated": 1613842185832 }, { - "style": "List", - "text": "bulletArray is the definition of any number of bullet points. The first field on each bullet is rendered in bold style and the second, in plain style. If the fields are left empty, the bullet list will still be included in the HTML, therefore, if you don't want bullets you must delete the whole definition of the bullet array from the configuration." - }, - { - "style": "List", - "text": "paragraph1 is a regular block of text." - }, - { - "style": "List", - "text": "callOut is a block of text in bold style with a green border and the left-hand side of the block." - }, - { - "style": "List", - "text": "externalLink allows you to set up a link that opens in a new tab at the end of the callOut block. Enter the URL in the first field and the anchor text in the second. You may also use HTML to include links anywhere else.", - "updated": 1609705400186 - }, - { - "style": "List", - "text": "paragraph2 is a regular block of text." - }, - { - "style": "List", - "text": "note is a block of text within a blue box preceded with the string Note.", - "updated": 1609705469745 - }, - { - "style": "List", - "text": "tip is a block of text within a green box preceded with the string Tip.", - "updated": 1609705475148 - }, - { - "style": "List", - "text": "important is a block of text within a yellow box preceded with the string Important.", - "updated": 1609705484520 - }, - { - "style": "List", - "text": "warning is a block of text within a red box preceded with the string Warning.", - "updated": 1609705492685 - }, - { - "style": "List", - "text": "position determines the position of the floating HTML. There are three alternatives... Left, Right, or leave the field empty to position the page in the center of the screen.", - "updated": 1609705546655 - }, - { - "style": "List", - "text": "slider determines the position of the horizontal slider. There are four alternatives... toTop, Right, or leave the field empty to position the page in the center of the screen.", - "updated": 1609705629835 - }, - { - "style": "List", - "text": "pressButton allows you to forcefully Stop the tutorial, go to the Next step, go to the Previous step, or Skip a step. When a step is loaded and one of these options is configured in this field, the action is applied immediately." - }, - { - "style": "List", - "text": "documentationURL: opens the Superalgos Documentation in the URL you configure. Use the complete URL, including the https:// protocol header.", - "updated": 1609705696017 + "style": "Text", + "text": "asdf" } ] } \ No newline at end of file