Mid pages

This commit is contained in:
Julian Molina committed 2021-02-19 18:54:48 +01:00
1 parent fd0b6f0e5c
commit 5e446f48ac
11 files changed
+91 -55

No files matched your search

@@ -9,8 +9,8 @@
"paragraphs": [
{
"style": "Text",
"text": "Each project integrated in Superalgos may have it's own collection of pages conforming the project's documentation.",
"updated": 1613753557044
"text": "Each project integrated in Superalgos may have it's own collection of pages making up the project's documentation.",
"updated": 1613755052653
}
]
}
@@ -9,8 +9,8 @@
"paragraphs": [
{
"style": "Text",
"text": "The Docs is a collection of pages organized in categories, each one saved as a JSON file in the following path:",
"updated": 1613753810848
"text": "The Docs is a collection of pages, each one saved as a JSON file in the following path:",
"updated": 1613755076008
},
{
"style": "Json",
@@ -7,29 +7,26 @@
"updated": 1613754155692
},
"paragraphs": [
{
"style": "Title",
"text": "Node Page Category",
"updated": 1609150842562
},
{
"style": "Text",
"text": "Each Node defined in the context of a Project features a Docs Node Page explaining what the Node is and how it is used. This is the page that opens when clicking the help button in the menu of the node.",
"updated": 1613754213596
},
{
"style": "Text",
"text": ""
},
{
"style": "Title",
"text": "Concept Page Category",
"updated": 1610999775828
"text": "Node Page Category",
"updated": 1613756771488
},
{
"style": "Text",
"text": "Concepts are notions or ideas that are not represented as nodes in a hierarchy. Pages in the concept category cover notions or ideas that may be explained in a single page. That is, concepts are notions that may be covered exhaustively on a single page.",
"updated": 1613754367905
"text": "Each Node defined in the context of a Project features a Docs Node Page explaining what the Node is and how it is used. This is the page that opens when clicking the help button in the menu of the node."
},
{
"style": "Title",
"text": "Concept Page Category"
},
{
"style": "Text",
"text": "Concepts are notions or ideas that are not represented as nodes in a hierarchy. Pages in the concept category cover notions or ideas that may be explained in a single page. That is, concepts are notions that may be covered exhaustively on a single page."
},
{
"style": "Title",
@@ -37,8 +34,7 @@
},
{
"style": "Text",
"text": "Topics are multi-faceted, deep concepts that require more than one page to be correctly addressed. Topics are sets of closely related concepts, arranged in a sequence. However, is not a page in and of itself. Instead, it is a collection of pages.",
"updated": 1613754630115
"text": "Topics are multi-faceted, deep concepts that require more than one page to be correctly addressed. Topics are sets of closely related concepts, arranged in a sequence. However, is not a page in and of itself. Instead, it is a collection of pages."
},
{
"style": "Title",
@@ -46,28 +42,23 @@
},
{
"style": "Text",
"text": "A Tutorial hierarchy may arrange different types of nodes including Tutorial Topic and Tutorial Step nodes. Each node in the hierarchy points to a Tutorial Step Page in the Docs from which it draws information. In the context of the Docs, pages in a tutorial are arranged in a sequence, like with topics.",
"updated": 1613754897247
"text": "A Tutorial hierarchy may arrange different types of nodes including Tutorial Topic and Tutorial Step nodes. Each node in the hierarchy points to a Tutorial Step Page in the Docs from which it draws information. In the context of the Docs, pages in a tutorial are arranged in a sequence, like with topics."
},
{
"style": "Title",
"text": "Reviews Page Category",
"updated": 1611000089258
"text": "Reviews Page Category"
},
{
"style": "Text",
"text": "Reviews are user-generated content describing their experience with certain components of Superalgos or other projects.",
"updated": 1611000148351
"text": "Reviews are user-generated content describing their experience with certain components of Superalgos or other projects."
},
{
"style": "Title",
"text": "Books Page Category",
"updated": 1613754499669
"text": "Books Page Category"
},
{
"style": "Text",
"text": "A books is a page in and of itself. The page features a list of topics each constituting a chapter in the book.",
"updated": 1613754996390
"text": "A books is a page in and of itself. The page features a list of topics each constituting a chapter in the book."
}
]
}
@@ -3,19 +3,28 @@
"pageNumber": 4,
"type": "Docs Page Name",
"definition": {
"text": "The Docs Page Name is not only the visible name of a page, but also the unique identifier of a page within a Project.",
"updated": 1611000211462
"text": "The Docs Page Name is not only the visible name of a page displayed as the main title at the top but also the unique identifier of a page within a Project.",
"updated": 1613755348083
},
"paragraphs": [
{
"style": "Text",
"text": "The page name is always featured as the main title of the page.",
"updated": 1611000245347
"text": "The page name is always featured as the main title of the page and no two pages may have the same name.",
"updated": 1613755273710
},
{
"style": "Success",
"text": "It is important to remember the above at the time of naming a page. You should always use an unambiguous descriptive name as the name of a page.",
"updated": 1613755338171
},
{
"style": "Text",
"text": ""
},
{
"style": "Important",
"text": "At this point, the name of the page may not be changed from within the Docs interface. To change the name of the page you need to manually modify the corresponding file, editing the type field.",
"updated": 1613751344931
"text": "At this point, the name of the page may not be changed from within the Docs interface. To change the name of the page you need to manually modify the corresponding file, editing the type field and properly mapping the name of the page in the name of the file.",
"updated": 1613755498049
},
{
"style": "Text",
@@ -3,14 +3,14 @@
"pageNumber": 5,
"type": "Docs Topic Name",
"definition": {
"text": "Refers to the name of the topic, which in turn is a collection of related pages.",
"updated": 1611000285171
"text": "Refers to the name of the topic. Pages with the same Docs Topic Name belong to the same topic.",
"updated": 1613755594915
},
"paragraphs": [
{
"style": "Text",
"text": "Topic names are used to group a set of related pages under a certain topic. ",
"updated": 1609182145551
"text": "There is no page describing a topic. Instead, the Docs Topic Name is used to group a set of related pages under a certain topic.",
"updated": 1613755651132
}
]
}
@@ -3,14 +3,14 @@
"pageNumber": 6,
"type": "Docs Tutorial Name",
"definition": {
"text": "Refers to the name of the tutorial, which in turn is a collection of related pages.",
"updated": 1611000326995
"text": "Refers to the name of the tutorial. Pages with the same Docs Tutorial Name belong to the same tutorial.",
"updated": 1613755729645
},
"paragraphs": [
{
"style": "Text",
"text": "Tutorial names are used to group a set of related pages under a certain tutorial. ",
"updated": 1609182145551
"text": "There is no page describing a tutorial. It is the Turotial hierarchy that determines how tutorials are arranged. However, in the context of the Docs, the Docs Tutorial Name is used to group a set of related pages under a certain tutorial.",
"updated": 1613755796749
}
]
}
@@ -8,8 +8,13 @@
},
"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."
"style": "Important",
"text": "At this point, the number of the page may not be changed from within the Docs interface. To change the number of the page you need to manually modify the corresponding file, editing the pageNumeber field and properly mapping the page number of the page in the name of the file.",
"updated": 1613755941767
},
{
"style": "Success",
"text": "The Docs Repaginate Command helps with arranging page numbers of large collection of pages."
}
]
}
@@ -3,13 +3,40 @@
"pageNumber": 8,
"type": "Docs Node Page",
"definition": {
"text": "Each node in a Project should have a corresponding Node Page defining the node and explaining how it is used.",
"updated": 1611000867717
"text": "Each Node defined in the context of a Project features a Docs Node Page explaining what the Node is and how it is used.",
"updated": 1613756218722
},
"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": "This is the page that opens when clicking the help button in the menu of the node.",
"updated": 1613756213394
},
{
"style": "Text",
"text": "A Docs Node Page features:"
},
{
"style": "List",
"text": "Definition: a short description of what the node is, and what it represents in the hierarchy. The definition is displayed to the left of the node's icon.",
"updated": 1613756314649
},
{
"style": "List",
"text": "Content: all the information relative to the node in terms of how the node is used, how it affects operations, or how it relates to other nodes.",
"updated": 1613756365684
},
{
"style": "List",
"text": "Configuration: a section describing the elements of the node's configuration file."
},
{
"style": "List",
"text": "Auto-generated content: information extracted from the system, workspace, etc., to provide the technical context in which the node exists."
},
{
"style": "Text",
"text": ""
}
]
}
@@ -3,12 +3,14 @@
"pageNumber": 9,
"type": "Docs Concept Page",
"definition": {
"text": "Write here a summary for this topic page."
"text": "Concepts are notions or ideas that are not represented as nodes in a hierarchy. Pages in the concept category cover notions or ideas that may be explained in a single page. That is, concepts are notions that may be covered exhaustively on a single page.",
"updated": 1613756750385
},
"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 of a concept is self-contained.",
"updated": 1613756891822
}
]
}
@@ -3,12 +3,14 @@
"pageNumber": 11,
"type": "Docs Paragraph",
"definition": {
"text": "Write here a summary for this topic page."
"text": "A paragraph is the smallest unit of information managed by the Docs. In a way, a Docs Page is made of paragraphs.",
"updated": 1613757043006
},
"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": "A paragraph may have a style, as explained in the Docs Paragraph Styles page.",
"updated": 1613757122601
}
]
}
@@ -9,8 +9,8 @@
"paragraphs": [
{
"style": "Text",
"text": "A block must have an opening paragraph with the Docs Block Style. The block may include any number of paragraphs. In practice, a block extends until the next block starts, or until the page ends.",
"updated": 1611001401401
"text": "A block must have an opening paragraph with the Docs Block Style. The block may include any number of paragraphs. In practice, a block extends to the point where the next block starts, or until the page ends.",
"updated": 1613757178023
}
]
}