From fb57a53af60ecc4b1b7e11317588b00a12b292a3 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Mon, 18 Jan 2021 14:24:11 +0100 Subject: [PATCH] Docs commands --- .../docs-commands-001-docs-help-command.json | 11 ++--- .../docs-commands-002-docs-goto-command.json | 16 +++---- .../docs-commands-003-docs-add-command.json | 33 ++++++++------ ...docs-commands-004-docs-delete-command.json | 8 ++-- .../docs-commands-005-docs-save-command.json | 4 +- ...-commands-007-docs-repaginate-command.json | 44 +++++++++++++++++++ 6 files changed, 84 insertions(+), 32 deletions(-) create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/docs-commands-007-docs-repaginate-command.json diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-001-docs-help-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-001-docs-help-command.json index ba18e9422..8f84eb21e 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-001-docs-help-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-001-docs-help-command.json @@ -3,8 +3,8 @@ "pageNumber": "1", "type": "Docs Help Command", "definition": { - "text": "The Docs provide a command line interface that users can use to contribute to the Docs. The Docs Help Command provides a list of all available commands at any given Superalgos version.", - "updated": 1609140843415 + "text": "The Docs provide a command line interface that you may use to contribute to the Docs. The Docs Help Command provides a list of all available commands.", + "updated": 1610974835590 }, "paragraphs": [ { @@ -49,7 +49,8 @@ }, { "style": "Text", - "text": "Another way to use this command is by providing the name of another command you would like to see help info on." + "text": "Another way to use this command is to provide the name of a command for which you would like to see help info.", + "updated": 1610974898665 }, { "style": "Title", @@ -73,8 +74,8 @@ }, { "style": "Note", - "text": " Anything you type at the command prompt not identified as a command will be treated as a search query. ", - "updated": 1609150627730 + "text": "Entries in the command prompt not identified as a command are treated as a search query.", + "updated": 1610974943826 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-002-docs-goto-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-002-docs-goto-command.json index 2050dd3d5..08a618950 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-002-docs-goto-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-002-docs-goto-command.json @@ -3,8 +3,8 @@ "pageNumber": "2", "type": "Docs Goto Command", "definition": { - "text": "This command provides a mechanism to navigate to a Docs page or an specific anchor within a page.", - "updated": 1609141474363 + "text": "This command provides a mechanism to navigate to a Docs page or an anchor within the page.", + "updated": 1610975620919 }, "paragraphs": [ { @@ -24,18 +24,18 @@ }, { "style": "List", - "text": "Project : Is the project where the Node, Concept or Topic is defined.", - "updated": 1609148511059 + "text": "Project: It's the project where the Node, Concept, Topic, Tutorial or Review is defined.", + "updated": 1610975746510 }, { "style": "List", - "text": "Docs Page Category : Node, Concept or Topic.", - "updated": 1609148563484 + "text": "Docs Page Category: Node, Concept, Topic, Tutorial or Review.", + "updated": 1610975692859 }, { "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.", - "updated": 1609149220268 + "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 }, { "style": "List", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json index af0429480..94c68e4e2 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json @@ -20,7 +20,7 @@ { "style": "Json", "text": "docs.add Node to Project: Docs Page Name", - "updated": 1609149799453 + "updated": 1610975287652 }, { "style": "Subtitle", @@ -29,7 +29,8 @@ }, { "style": "Json", - "text": "docs.add Node to Superalgos" + "text": "docs.add Node to Superalgos: Binance API", + "updated": 1610975052587 }, { "style": "Subtitle", @@ -48,7 +49,8 @@ }, { "style": "Json", - "text": "docs.add Concept to Superalgos" + "text": "docs.add Concept to Superalgos: Two-way Reference", + "updated": 1610975077695 }, { "style": "Subtitle", @@ -86,8 +88,8 @@ }, { "style": "Json", - "text": "docs.add Tutorial to Superalgos: How to Build Indicators->Intro", - "updated": 1610706570716 + "text": "docs.add Tutorial to Superalgos: How to Build Indicators->Intro->1", + "updated": 1610975123605 }, { "style": "Subtitle", @@ -96,8 +98,8 @@ }, { "style": "Json", - "text": "docs.add Review to Project: Docs Review Name->Docs Page Name->Docs Page Number", - "updated": 1610706722998 + "text": "docs.add Review to Project: Docs Review Name->Docs Page Name", + "updated": 1610975148914 }, { "style": "Subtitle", @@ -114,25 +116,28 @@ }, { "style": "List", - "text": "Project : Is the project where the Node, Concept or Topic is defined." + "text": "Project: It's the project where the Node, Concept, Topic or Review is defined.", + "updated": 1610975793026 }, { "style": "List", - "text": "Docs Page Category : Node, Concept or Topic." + "text": "Docs Page Category: Node, Concept, Topic, Tutorial, or Review.", + "updated": 1610975177859 }, { "style": "List", - "text": "Docs Topic Name: The name of the topic which the new page will belong to.", - "updated": 1609149944222 + "text": "Docs Topic / Tutorial / Review Name: The name of the topic /tutorial /review to which the new page will belong.", + "updated": 1610975248463 }, { "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." + "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 }, { "style": "List", - "text": "Docs Page Numer: Optional. A page number that you would like to assing the new page. This will impact only at the position of the Topic Index. If you don't provide one, it will be automatically assigned the last page number in the collection plus 1.", - "updated": 1610706305834 + "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 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json index b6a103240..09a0c3a9e 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json @@ -111,15 +111,17 @@ }, { "style": "List", - "text": "Project : Is the project where the Node, Concept or Topic is defined." + "text": "Project: It's the project where the Node, Concept, Topic or Review is defined.", + "updated": 1610975967746 }, { "style": "List", - "text": "Docs Page Category : Node, Concept or Topic." + "text": "Docs Page Category: Node, Concept, Topic, Tutorial, or Review.", + "updated": 1610975936004 }, { "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." + "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." } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-005-docs-save-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-005-docs-save-command.json index 556f65d1a..ecfe4e249 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-005-docs-save-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-005-docs-save-command.json @@ -3,8 +3,8 @@ "pageNumber": "5", "type": "Docs Save Command", "definition": { - "text": "Use this command to save the changes you have done while adding, deleting or editing paragraphs at the Docs; or adding or deleting pages. ", - "updated": 1609152030934 + "text": "Use this command to save the changes you've made while adding, deleting or editing paragraphs at the Docs; or adding or deleting pages.", + "updated": 1610976014577 }, "paragraphs": [ { diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-007-docs-repaginate-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-007-docs-repaginate-command.json new file mode 100644 index 000000000..cd39f3f69 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-007-docs-repaginate-command.json @@ -0,0 +1,44 @@ +{ + "topic": "Docs Commands", + "pageNumber": "7", + "type": "Docs Repaginate Command", + "definition": { + "text": "When you add a Docs Topic Page or a Docs Tutorial Page, you may define a page number. The number defines the position of the page within the table of contents. To add a page in-between other pages you may use decimal values. Use the Repaginate command to recalculate all page numbers and leave the whole set in integers.", + "updated": 1610976158171 + }, + "paragraphs": [ + { + "style": "Title", + "text": "Syntax", + "updated": 1610393031768 + }, + { + "style": "Javascript", + "text": "docs.repaginate Category from Project: Topic or Tutorial name." + }, + { + "style": "Title", + "text": "Properties" + }, + { + "style": "List", + "text": "Category: It must be either Topic or Tutorial." + }, + { + "style": "List", + "text": "Project: Any existing already integrated project." + }, + { + "style": "List", + "text": "Topic or Tutorial name: The name given tu the Topic or Tutorial that you want to repaginate." + }, + { + "style": "Title", + "text": "Example" + }, + { + "style": "Javascript", + "text": "docs.repaginate Topic from Superalgos: Docs Commands" + } + ] +} \ No newline at end of file