First Book of Tutorials

Projects/Superalgos/Schemas/Docs-Books/first-steps-tutorials.json

@@ -0,0 +1,19 @@
+{
+    "type": "First Steps Tutorials",
+    "definition": {
+        "text": "This Book will help you find the right tutorials for you to do when you just arrive to Superalgos. The order of the Tutorials listed is the one you should follow.",
+        "updated": 1610014928439
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "You can explore the content of these tutorials by reading this book, or even better, locate the tutorials in the workspace where they are defined and DO the tutorial there. There is a big difference between reading the content and doing the tutorial, since in the last case the tutorial will positionn you at the right places withing the Desing Space and the Charting Space so as to facilitate your understanding.",
+            "updated": 1610015175932
+        },
+        {
+            "style": "Chapter",
+            "text": "I->Superalgos->Tutorial->Test Tut",
+            "updated": 1610016446699
+        }
+    ]
+}

Projects/Superalgos/Schemas/Docs-Books/the-docs-explained.json

@@ -7,30 +7,30 @@
     "paragraphs": [
         {
             "style": "Chapter",
-            "text": "Superalgos->I->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.",
+            "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
         },
         {
             "style": "Chapter",
-            "text": "Superalgos->II->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.",
+            "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
         },
         {
             "style": "Chapter",
-            "text": "Superalgos->III->Docs Commands Errors"
+            "text": "III->Superalgos->Topic->Docs Commands Errors"
         },
         {
             "style": "Chapter",
-            "text": "Superalgos->IV->Docs Commands Messages",
+            "text": "IV->Superalgos->Topic->Docs Commands Messages",
             "updated": 1609783744261
         },
         {
             "style": "Chapter",
-            "text": "Superalgos->V->Docs Paragraph Styles"
+            "text": "V->Superalgos->Topic->Docs Paragraph Styles"
         },
         {
             "style": "Chapter",
-            "text": "Superalgos->VI->Docs Context Menu Actions"
+            "text": "VI->Superalgos->Topic->Docs Context Menu Actions"
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Topics/docs-paragraph-styles-024-docs-chapter-style.json

@@ -8,8 +8,56 @@
     },
     "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": "Title",
+            "text": "Syntax",
+            "updated": 1610015500246
+        },
+        {
+            "style": "Javascript",
+            "text": "Chapter Number->Project->Docs Page Category->Docs Category Name->Intruction Text",
+            "updated": 1610015888193
+        },
+        {
+            "style": "Title",
+            "text": "Parameters"
+        },
+        {
+            "style": "List",
+            "text": "Chapter Number: Any string that represents the chapter number to be displayed.",
+            "updated": 1610015596538
+        },
+        {
+            "style": "List",
+            "text": "Project : Is the project where the Docs Page belongs to."
+        },
+        {
+            "style": "List",
+            "text": "Docs Page Category : Topic or Tutorial.",
+            "updated": 1610015631058
+        },
+        {
+            "style": "List",
+            "text": "Docs Category Name: For topics, the topic's name, for tutorials, is the tutorial's name.",
+            "updated": 1610015910027
+        },
+        {
+            "style": "List",
+            "text": "Introduction Text: It is an introduction text to be displayed between the Chapter Title and the Chapter Index. This parameter is optional.",
+            "updated": 1610015785424
+        },
+        {
+            "style": "Title",
+            "text": "Examples"
+        },
+        {
+            "style": "Javascript",
+            "text": "I->Superalgos->Topic->Docs Basics",
+            "updated": 1610015852514
+        },
+        {
+            "style": "Javascript",
+            "text": "IV->Superalgos->Tutorial->Getting Started->This is the first tutorial you should do.",
+            "updated": 1610015836892
         }
     ]
 }

Projects/Superalgos/UI/Spaces/Docs-Space/DocumentPage.js

@@ -508,12 +508,13 @@ function newSuperalgosDocsDocumentPage() {
 
                 function addChapterIndex(chapterText) {
                     let splittedChapterText = chapterText.split('->')
-                    let project = splittedChapterText[0]
-                    let chapterNumber = splittedChapterText[1]
-                    let chapterName = splittedChapterText[2]
-                    let introText = splittedChapterText[3]
+                    let chapterNumber = splittedChapterText[0]
+                    let project = splittedChapterText[1]
+                    let category = splittedChapterText[2]
+                    let chapterName = splittedChapterText[3]
+                    let introText = splittedChapterText[4]
                     
-                    if (project === undefined || chapterNumber === undefined || chapterName === undefined) {
+                    if (project === undefined || category === undefined || chapterNumber === undefined || chapterName === undefined) {
                         return 'Chapter paragraph style Syntax Error. Some of the required parameters are undefined. Check the Docs Chapter Style Syntax. This error message will dissapear as soon as you fix the problem.'
                     }
 
@@ -521,11 +522,28 @@ function newSuperalgosDocsDocumentPage() {
                         return 'Chapter paragraph style Syntax Error. The Project <i>' + project + '</i> could not be found. Check the Docs Chapter Style Syntax. This error message will dissapear as soon as you fix the problem.'
                     }
 
-                    buildOrderedTopicPageIndex(chapterName)
+                    if (category !== 'Topic' && category !== 'Tutorial') {
+                        return 'Category must be either Topic or Tutorial. Found: <i>' + category + '</i>'
+                    }
 
-                    if (orderedTopicPageIndexArray.length === 0) {
-                        return 'Chapter paragraph style Syntax Error. The Topic <i>' + chapterName + '</i> could not be found. Check the Docs Chapter Style Syntax. This error message will dissapear as soon as you fix the problem.'
-                    } 
+                    switch(category) {
+                        case 'Topic': {
+                            buildOrderedTopicPageIndex(chapterName)
+
+                            if (orderedTopicPageIndexArray.length === 0) {
+                                return 'Chapter paragraph style Syntax Error. The Topic <i>' + chapterName + '</i> could not be found. Check the Docs Chapter Style Syntax. This error message will dissapear as soon as you fix the problem.'
+                            } 
+                            break
+                        }
+                        case 'Tutorial': {
+                            buildOrderedTutorialPageIndex(chapterName)
+
+                            if (orderedTutorialPageIndexArray.length === 0) {
+                                return 'Chapter paragraph style Syntax Error. The Tutorial <i>' + chapterName + '</i> could not be found. Check the Docs Chapter Style Syntax. This error message will dissapear as soon as you fix the problem.'
+                            } 
+                            break
+                        }
+                    }
 
                     let key = 'auto-generated-paragraph-' + autoGeneratedParagraphIndex
                     paragraph = {
@@ -544,8 +562,17 @@ function newSuperalgosDocsDocumentPage() {
                         renderParagraph(paragraph, key)
                         autoGeneratedParagraphIndex++
                     }
-
-                    generateTopicMultiPageIndex()
+                    
+                    switch(category) {
+                        case 'Topic': {
+                            generateTopicMultiPageIndex()
+                            break
+                        }
+                        case 'Tutorial': {
+                            generateTutorialMultiPageIndex()
+                            break
+                        }
+                    }
                 }
             }