fez5587/Superalgos
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #572 from julian-molina/develop

Browse Source 
Contribution: Docs Commands
This commit is contained in:
Julian Molina authored and GitHub committed 2021-02-19 21:48:37 +01:00
2 parents 03940207d7 faf6952a66
commit a6b199390c
6 files changed
+92 -166
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

Projects/Superalgos/Schemas/Docs-Books/the-docs-explained.json
+4 -4
View File
@@ -7,13 +7,13 @@
"paragraphs": [
{
"style": "Chapter",
"text": "I->Superalgos->Topic->Docs Basics->Read Chapter I to learn the basics concepts. They are the foundation that will let you understand the commands and styles explained later in this book.",
"updated": 1609763076399
"text": "I->Superalgos->Topic->Docs Basics->Read Chapter I to learn the basic concepts; the foundation that will help you understand the commands and styles explained later in the book.",
"updated": 1613763974146
},
{
"style": "Chapter",
"text": "II->Superalgos->Topic->Docs Commands->The Docs include a powerful command line interface that allows you to quickly fire commands from the search box. Dive into Chapter II to learn the details of each available command.",
"updated": 1609763122458
"text": "II->Superalgos->Topic->Docs Commands->The Docs include a powerful command line interface that allows you to quickly fire commands from the search box. Dive into Chapter II to learn the details of each command.",
"updated": 1613764005330
},
{
"style": "Chapter",
Projects/Superalgos/Schemas/Docs-Topics/docs-commands-002-docs-goto-command.json
+8 -7
View File
@@ -24,22 +24,23 @@
},
{
"style": "List",
"text": "Project: It's the project where the Node, Concept, Topic, Tutorial or Review is defined.",
"updated": 1610975746510
"text": "Project: It's the project where the page is defined.",
"updated": 1613764369592
},
{
"style": "List",
"text": "Docs Page Category: Node, Concept, Topic, Tutorial or Review.",
"updated": 1610975692859
"text": "Docs Page Category: One of the available categories.",
"updated": 1613764395658
},
{
"style": "List",
"text": "Docs Page Name: For Nodes it is the type of node; for Concepts, the concept name; for Topics, the topic's page name, for Tutorials, the tutorial step name; for Reviews, the review page name.",
"updated": 1610975736116
"text": "Docs Page Name: The name of the page.",
"updated": 1613764542342
},
{
"style": "List",
"text": "Docs Page Anchor : This parameter is optional. If present, it refers to an Docs Anchor paragraph defined within the page."
"text": "Docs Page Anchor: This parameter is optional. When present, it refers to a Docs Paragraph with the Docs Anchor Style within the page.",
"updated": 1613764614157
},
{
"style": "Title",
Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json
+46 -89
View File
@@ -9,106 +9,63 @@
"paragraphs": [
{
"style": "Title",
"text": "Syntax",
"updated": 1609150474236
},
{
"style": "Subtitle",
"text": "Option 1: ",
"updated": 1609149432117
"text": "Single-Page Syntax",
"updated": 1613765905233
},
{
"style": "Json",
"text": "docs.add Node to Project: Docs Page Name",
"updated": 1610975287652
"text": "docs.add [Node|Concept|Book] from Project: Docs Page Name",
"updated": 1613766020535
},
{
"style": "Subtitle",
"text": "Example: ",
"updated": 1609149442319
"text": "Examples",
"updated": 1613766032848
},
{
"style": "Json",
"text": "docs.add Node to Superalgos: Binance API",
"updated": 1610975052587
"text": "docs.add Node from Superalgos: Task",
"updated": 1609152405379
},
{
"style": "Json",
"text": "docs.add Concept from Superalgos: References",
"updated": 1613766054009
},
{
"style": "Json",
"text": "docs.add Book from Superalgos: User Manual",
"updated": 1613766091949
},
{
"style": "Title",
"text": "Page-Collection Syntax",
"updated": 1613766298709
},
{
"style": "Json",
"text": "docs.add [Topic|Tutorial|Review] from Project: Docs [Topic|Tutorial|Review] Name->Docs Page Name->Docs Page Number",
"updated": 1613766367064
},
{
"style": "Subtitle",
"text": "Option 2: ",
"updated": 1609149450546
"text": "Examples",
"updated": 1613766391018
},
{
"style": "Json",
"text": "docs.add Concept to Project: Docs Page Name",
"updated": 1609149807897
},
{
"style": "Subtitle",
"text": "Example: ",
"updated": 1609149457691
"text": "docs.add Topic from Superalgos: Docs Styles->Docs Text Style->1",
"updated": 1609152521245
},
{
"style": "Json",
"text": "docs.add Concept to Superalgos: Two-way Reference",
"updated": 1610975077695
},
{
"style": "Subtitle",
"text": "Option 3: ",
"updated": 1609149464103
"text": "docs.add Tutorial from Superalgos: How to Build Indicatiors->Intro->1",
"updated": 1610707006603
},
{
"style": "Json",
"text": "docs.add Topic to Project: Docs Topic Name->Docs Page Name->Docs Page Number",
"updated": 1609149846658
},
{
"style": "Subtitle",
"text": "Example: ",
"updated": 1609149471266
},
{
"style": "Json",
"text": "docs.add Topic to Superalgos: Docs Styles->Docs Text Style->1",
"updated": 1609149878993
},
{
"style": "Subtitle",
"text": "Option 4:",
"updated": 1610706520317
},
{
"style": "Json",
"text": "docs.add Topic to Project: Docs Tutorial Name->Docs Page Name->Docs Page Number",
"updated": 1610706514194
},
{
"style": "Subtitle",
"text": "Example:"
},
{
"style": "Json",
"text": "docs.add Tutorial to Superalgos: How to Build Indicators->Intro->1",
"updated": 1610975123605
},
{
"style": "Subtitle",
"text": "Option 5:",
"updated": 1610706652124
},
{
"style": "Json",
"text": "docs.add Review to Project: Docs Review Name->Docs Page Name",
"updated": 1610975148914
},
{
"style": "Subtitle",
"text": "Example:"
},
{
"style": "Json",
"text": "docs.add Review to Project: Superalgos Project Review->Superalgos Review - Great Project!",
"updated": 1610706675495
"text": "docs.add Review from Project: Superalgos Project Review->Awasome!->2",
"updated": 1610707101903
},
{
"style": "Title",
@@ -116,28 +73,28 @@
},
{
"style": "List",
"text": "Project: It's the project where the Node, Concept, Topic or Review is defined.",
"updated": 1610975793026
"text": "Project: It's the project where the page is defined.",
"updated": 1613764802872
},
{
"style": "List",
"text": "Docs Page Category: Node, Concept, Topic, Tutorial, or Review.",
"updated": 1610975177859
"text": "Docs Page Category: One of the available categories.",
"updated": 1613764813920
},
{
"style": "List",
"text": "Docs Topic / Tutorial / Review Name: The name of the topic /tutorial /review to which the new page will belong.",
"updated": 1610975248463
"text": "Docs topic / tutorial / review name: The name of the topic / tutorial / review the new page will belong to.",
"updated": 1613767524694
},
{
"style": "List",
"text": "Docs Page Name: For Nodes it is the type of node; for Concepts, the concept name; for Topics, the topic's page name, for Tutorials, the tutorial step name; for Reviews, the review page name.",
"updated": 1610975361761
"text": "Docs Page Name: The name of the page.",
"updated": 1613764889322
},
{
"style": "List",
"text": "Docs Page Numer: Optional. A page number to be assigned to the new page. The number affects the position in the corresponding table of contents only. If a Docs Page Number is not provided, the systems assign one.",
"updated": 1610975499631
"text": "Docs Page Numer: Optional. The number affects the position in the corresponding table of contents only. If a Docs Page Number is not provided, the systems assigns one.",
"updated": 1613764928993
}
]
}
Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json
+24 -61
View File
@@ -9,22 +9,18 @@
"paragraphs": [
{
"style": "Title",
"text": "Syntax",
"updated": 1609152160707
},
{
"style": "Subtitle",
"text": "Option 1:",
"updated": 1609152344322
"text": "Single-Page Syntax",
"updated": 1613765905233
},
{
"style": "Json",
"text": "docs.delete Node from Project: Docs Page Name",
"updated": 1609152359725
"text": "docs.delete [Node|Concept|Book] from Project: Docs Page Name",
"updated": 1613766020535
},
{
"style": "Subtitle",
"text": "Example:"
"text": "Examples",
"updated": 1613766032848
},
{
"style": "Json",
@@ -32,74 +28,40 @@
"updated": 1609152405379
},
{
"style": "Subtitle",
"text": "Option 2:"
"style": "Json",
"text": "docs.delete Concept from Superalgos: References",
"updated": 1613766054009
},
{
"style": "Json",
"text": "docs.delete Concept from Project: Docs Page Name",
"updated": 1609152445366
"text": "docs.delete Book from Superalgos: User Manual",
"updated": 1613766091949
},
{
"style": "Subtitle",
"text": "Example:"
"style": "Title",
"text": "Page-Collection Syntax",
"updated": 1613766298709
},
{
"style": "Json",
"text": " docs.delete Concept from Superalgos",
"updated": 1609152464312
"text": "docs.delete [Topic|Tutorial|Review] from Project: Docs [Topic|Tutorial|Review] Name->Docs Page Name->Docs Page Number",
"updated": 1613766367064
},
{
"style": "Subtitle",
"text": "Option 3:"
},
{
"style": "Json",
"text": "docs.delete Topic from Project: Docs Topic Name->Docs Page Name->Docs Page Number",
"updated": 1609152484236
},
{
"style": "Subtitle",
"text": "Example:"
"text": "Examples",
"updated": 1613766391018
},
{
"style": "Json",
"text": "docs.delete Topic from Superalgos: Docs Styles->Docs Text Style->1",
"updated": 1609152521245
},
{
"style": "Subtitle",
"text": "Option 4:",
"updated": 1610706965604
},
{
"style": "Json",
"text": "docs.delete Tutorial from Project: Docs Tutorial Name->Docs Page Name->Docs Page Number",
"updated": 1610706951438
},
{
"style": "Subtitle",
"text": "Example:"
},
{
"style": "Json",
"text": "docs.delete Tutorial from Superalgos: How to Build Indicatiors->Intro->1",
"updated": 1610707006603
},
{
"style": "Subtitle",
"text": "Option 5:",
"updated": 1610707021714
},
{
"style": "Json",
"text": "docs.delete Review from Project: Docs Review Name->Docs Page Name->Docs Page Number",
"updated": 1610707068615
},
{
"style": "Subtitle",
"text": "Example:"
},
{
"style": "Json",
"text": "docs.delete Review from Project: Superalgos Project Review->Awasome!->2",
@@ -111,17 +73,18 @@
},
{
"style": "List",
"text": "Project: It's the project where the Node, Concept, Topic or Review is defined.",
"updated": 1610975967746
"text": "Project: It's the project where the page is defined.",
"updated": 1613764968224
},
{
"style": "List",
"text": "Docs Page Category: Node, Concept, Topic, Tutorial, or Review.",
"updated": 1610975936004
"text": "Docs Page Category: One of the available categories.",
"updated": 1613764977861
},
{
"style": "List",
"text": "Docs Page Name: For Nodes it is the type of node; for Concepts, the concept name; for Topics, the topic's page name, for Tutorials, the tutorial step name; for Reviews, the review page name."
"text": "Docs Page Name: The name of the page.",
"updated": 1613764988027
}
]
}
Projects/Superalgos/Schemas/Docs-Topics/docs-commands-005-docs-save-command.json
+6 -2
View File
@@ -7,10 +7,14 @@
"updated": 1610976014577
},
"paragraphs": [
{
"style": "Important",
"text": "Pages you create or modify remain solely in memory in the context of the browser session until you run this command. Only once you run this command are changes saved to disk. If you refresh the page or close the browser before running the Docs Save Command, changes are lost. Changes are applied to the Docs Search Engine Index only after you run the Docs Reindex Command.",
"updated": 1613765203137
},
{
"style": "Title",
"text": "Syntax",
"updated": 1609157736088
"text": "Syntax"
},
{
"style": "Javascript",
Projects/Superalgos/Schemas/Docs-Topics/docs-commands-006-docs-reindex-command.json
+4 -3
View File
@@ -3,8 +3,8 @@
"pageNumber": "6",
"type": "Docs Reindex Command",
"definition": {
"text": "Use this command to re-index all the pages of the docs, together with all the nodes at the current workspace, so that any changes you made to the content is available through search. ",
"updated": 1609152126427
"text": "Use this command to re-index all the pages of the Docs, together with all the nodes in the current workspace. Changes you made to the content become available through search after running the command.",
"updated": 1613767645758
},
"paragraphs": [
{
@@ -19,7 +19,8 @@
},
{
"style": "Note",
"text": "The reindexing of all the pages and workspace node might take a minute or two. If you workspace is very big, expect it to take even more time than that."
"text": "The reindexing of all the pages and workspace node might take a minute or two. If you workspace is very big, expect it to take even more than that.",
"updated": 1613767567798
}
]
}