More topics
This commit is contained in:
Luis Fernando Molina committed
1 parent
f63630ff0b
commit
cf9cbe5b8a
7 files changed
+88
-35
No files matched your search
@@ -3,12 +3,14 @@
|
||||
"pageNumber": "1",
|
||||
"type": "Docs Intro",
|
||||
"definition": {
|
||||
"text": "Write here a summary for this topic page."
|
||||
"text": "The Docs is a Space within Superalgos Project that allow users to search for information that explain the nodes, concepts and topics related to the different projects.",
|
||||
"updated": 1609151076248
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode."
|
||||
"text": "The Docs pages are organized in categories, explained in the page Docs Page Category.",
|
||||
"updated": 1609151246461
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -3,12 +3,35 @@
|
||||
"pageNumber": "2",
|
||||
"type": "Docs Page Category",
|
||||
"definition": {
|
||||
"text": "Write here a summary for this topic page."
|
||||
"text": "The Docs have 3 different categories of pages. Node, Concept and Topic.",
|
||||
"updated": 1609150759942
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Node Page Category",
|
||||
"updated": 1609150842562
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode."
|
||||
"text": "For each Node defined within the project, there is a Docs Node Page at the Docs, explaining what is that Node used for.",
|
||||
"updated": 1609150987235
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Cocept Page Category"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Concepts are things users must know that are not needed as a Node in the system and are not ellaborate enough to become a topic."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Topic Page Category"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Topics are multi-faceted concepts that needs more than one page to be correctly explained. It is a set of closely related concepts."
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -3,12 +3,14 @@
|
||||
"pageNumber": "3",
|
||||
"type": "Docs Page Name",
|
||||
"definition": {
|
||||
"text": "Write here a summary for this topic page."
|
||||
"text": "The Docs Page Name is not only the visible name of a page, but also they key to identify a page in a unique way within a Project.",
|
||||
"updated": 1609151319050
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode."
|
||||
"text": "The page name can always be found at the top of each page.",
|
||||
"updated": 1609151354901
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -9,8 +9,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Syntax:",
|
||||
"updated": 1609149145741
|
||||
"text": "Syntax",
|
||||
"updated": 1609150394630
|
||||
},
|
||||
{
|
||||
"style": "Json",
|
||||
@@ -18,12 +18,43 @@
|
||||
"updated": 1609141063054
|
||||
},
|
||||
{
|
||||
"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. "
|
||||
"style": "Title",
|
||||
"text": "Available Commands",
|
||||
"updated": 1609150389229
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Docs Goto Command"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Docs Add Command"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Docs Delete Command"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Docs Save Command"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Docs Reindex Command"
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Examples:"
|
||||
"text": "Help on Commands",
|
||||
"updated": 1609150376981
|
||||
},
|
||||
{
|
||||
"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."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Examples",
|
||||
"updated": 1609150399428
|
||||
},
|
||||
{
|
||||
"style": "Json",
|
||||
@@ -38,7 +69,12 @@
|
||||
{
|
||||
"style": "Json",
|
||||
"text": "docs.help doc.save",
|
||||
"updated": 1609141332029
|
||||
"updated": 1609150597166
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": " Anything you type at the command prompt not identified as a command will be treated as a search query. ",
|
||||
"updated": 1609150627730
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -9,8 +9,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Syntax:",
|
||||
"updated": 1609141687587
|
||||
"text": "Syntax",
|
||||
"updated": 1609150441764
|
||||
},
|
||||
{
|
||||
"style": "Json",
|
||||
@@ -18,9 +18,9 @@
|
||||
"updated": 1609148983480
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Where:",
|
||||
"updated": 1609146935337
|
||||
"style": "Title",
|
||||
"text": "Parameters",
|
||||
"updated": 1609150455663
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
@@ -43,7 +43,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Examples:"
|
||||
"text": "Examples",
|
||||
"updated": 1609150465738
|
||||
},
|
||||
{
|
||||
"style": "Json",
|
||||
|
||||
@@ -8,8 +8,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Syntax:",
|
||||
"updated": 1609149769070
|
||||
"text": "Syntax",
|
||||
"updated": 1609150474236
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
@@ -70,8 +70,9 @@
|
||||
"updated": 1609149878993
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Where:"
|
||||
"style": "Title",
|
||||
"text": "Parameters",
|
||||
"updated": 1609150484701
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
|
||||
@@ -985,19 +985,7 @@ function newSuperalgosDocSpace() {
|
||||
|
||||
function checkHelpCommand() {
|
||||
if (command.toLowerCase() === 'docs.help') {
|
||||
renderCommandResultsPage(
|
||||
[
|
||||
"Command line interface general help info: ",
|
||||
"The Docs is equiped with a command line interface from where you can type commands that will help you contribute to the Docs. Each command listed below has it's own help. You just need to type <i>help</i> and the command to get details about it's sintax and examples on how to use it. The following is the list of available commands:",
|
||||
"<b>help</b>: This general purpose help info.",
|
||||
"<b>docs.goto</b>: Use this command to go directly to a Node, Concept or Topic page.",
|
||||
"<b>docs.add</b>: Use this command to add new Nodes, Concepts or Topics to the Docs.",
|
||||
"<b>docs.delete</b>: Use this command to delete existing Nodes, Concepts or Topics from the Docs.",
|
||||
"<b>docs.save</b>: Use this command whenever you would like to save the changes you made to the Docs.",
|
||||
"<b>docs.reindex</b>: Use this command to re-index all the info again so that your changes are visible at search results.",
|
||||
"Note that anything you type not identified as a command will be treated as a search query."
|
||||
]
|
||||
)
|
||||
navigateTo('Superalgos', 'Topic', 'Docs Help Command')
|
||||
return
|
||||
}
|
||||
return 'Not Help Command'
|
||||
|
||||
Reference in new issue
Block a user