diff --git a/Client/WebServer/css/docs.css b/Client/WebServer/css/docs.css index 8fcbacd3f..866af2abe 100644 --- a/Client/WebServer/css/docs.css +++ b/Client/WebServer/css/docs.css @@ -921,7 +921,12 @@ text-align: center; vertical-align: middle; } -.docs-link { +.docs-external-link { +text-decoration: none; +color: #31708f; +} + +.docs-chapter { text-decoration: none; color: #31708f; } diff --git a/Client/WebServer/index.html b/Client/WebServer/index.html index 2d9aea595..cc835e04e 100644 --- a/Client/WebServer/index.html +++ b/Client/WebServer/index.html @@ -193,8 +193,8 @@
-
- +
+
diff --git a/Projects/Superalgos/Icons/docs-chapter-style.png b/Projects/Superalgos/Icons/docs-chapter-style.png new file mode 100644 index 000000000..d9e46d9a4 Binary files /dev/null and b/Projects/Superalgos/Icons/docs-chapter-style.png differ diff --git a/Projects/Superalgos/Schemas/Docs-Books/how-to-trade-.json b/Projects/Superalgos/Schemas/Docs-Books/how-to-trade-.json index bb6498e3f..c4dff2daf 100644 --- a/Projects/Superalgos/Schemas/Docs-Books/how-to-trade-.json +++ b/Projects/Superalgos/Schemas/Docs-Books/how-to-trade-.json @@ -7,6 +7,10 @@ { "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": "Chapter", + "text": "Superalgos->Docs Styles" } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Books/the-docs-explained.json b/Projects/Superalgos/Schemas/Docs-Books/the-docs-explained.json new file mode 100644 index 000000000..66a3b6505 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Books/the-docs-explained.json @@ -0,0 +1,27 @@ +{ + "type": "The Docs Explained", + "definition": { + "text": "This book will walk you through everything you need to know about the Docs.", + "updated": 1609762580891 + }, + "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.", + "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.", + "updated": 1609763122458 + }, + { + "style": "Chapter", + "text": "Superalgos->III->Docs Commands Errors" + }, + { + "style": "Chapter", + "text": "Superalgos->VI->Docs Paragraph Styles" + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/UI/Spaces/Docs-Space/ContextMenu.js b/Projects/Superalgos/UI/Spaces/Docs-Space/ContextMenu.js index ddd31825b..f1e422304 100644 --- a/Projects/Superalgos/UI/Spaces/Docs-Space/ContextMenu.js +++ b/Projects/Superalgos/UI/Spaces/Docs-Space/ContextMenu.js @@ -45,6 +45,7 @@ function newSuperalgosDocsContextMenu() { toAnchor: toAnchor, toBlock: toBlock, toInclude: toInclude, + toChapter: toChapter, toSection: toSection, copyLink: copyLink, toWebPageLink: toWebPageLink, @@ -266,6 +267,13 @@ function newSuperalgosDocsContextMenu() { UI.projects.superalgos.spaces.docsSpace.documentPage.render() } + function toChapter() { + let docSchemaParagraph = UI.projects.superalgos.spaces.docsSpace.paragraphMap.get(UI.projects.superalgos.spaces.docsSpace.contextMenu.selectedParagraph.id) + docSchemaParagraph.style = 'Chapter' + forceOutClick() + UI.projects.superalgos.spaces.docsSpace.documentPage.render() + } + function toWebPageLink() { let docSchemaParagraph = UI.projects.superalgos.spaces.docsSpace.paragraphMap.get(UI.projects.superalgos.spaces.docsSpace.contextMenu.selectedParagraph.id) docSchemaParagraph.style = 'Link' @@ -464,6 +472,10 @@ function newSuperalgosDocsContextMenu() { selectedParagraphData = paragraphNode.innerText.trim() return true } + if (paragraphNode.id.indexOf('-chapter') >= 0) { + selectedParagraphData = paragraphNode.innerText.trim() + return true + } if (paragraphNode.id.indexOf('-link') >= 0) { selectedParagraphData = UI.projects.superalgos.utilities.docs.reverseParseLink(paragraphNode.innerHTML) return true diff --git a/Projects/Superalgos/UI/Spaces/Docs-Space/DocumentPage.js b/Projects/Superalgos/UI/Spaces/Docs-Space/DocumentPage.js index e6697651e..42556247b 100644 --- a/Projects/Superalgos/UI/Spaces/Docs-Space/DocumentPage.js +++ b/Projects/Superalgos/UI/Spaces/Docs-Space/DocumentPage.js @@ -144,7 +144,7 @@ function newSuperalgosDocsDocumentPage() { if (UI.projects.superalgos.spaces.docsSpace.currentDocumentBeingRendered.category === 'Topic') { - buildOrderedTopicPageIndex() + buildOrderedTopicPageIndex(thisObject.docsSchemaDocument.topic) generatePreviousAndNextPageNavigation() /* Topic Title */ titleLabel = thisObject.docsSchemaDocument.topic + ' Topic Content' @@ -203,12 +203,13 @@ function newSuperalgosDocsDocumentPage() { } - function buildOrderedTopicPageIndex() { + function buildOrderedTopicPageIndex(topic) { + orderedTopicPageIndexArray = [] let schemaArray = SCHEMAS_BY_PROJECT.get(UI.projects.superalgos.spaces.docsSpace.currentDocumentBeingRendered.project).array.docsTopicSchema for (let i = 0; i < schemaArray.length; i++) { let arrayItem = schemaArray[i] - if (arrayItem.topic === thisObject.docsSchemaDocument.topic) { + if (arrayItem.topic === topic) { let itemAdded = false if (orderedTopicPageIndexArray.length === 0) { orderedTopicPageIndexArray.push(arrayItem) @@ -269,13 +270,11 @@ function newSuperalgosDocsDocumentPage() { key = 'auto-generated-index-paragraph-' + autoGeneratedParagraphIndex paragraph = { style: "Title", - text: "" + arrayItem.type + "" + text: "" + arrayItem.type + "" } autoGeneratedParagraphIndex++ - HTML = HTML + '

' + arrayItem.pageNumber + '. ' +'' + paragraph.text + '

' + HTML = HTML + '

' + arrayItem.pageNumber + '. ' + '' + paragraph.text + '

' } - - HTML = HTML = HTML + '
' // END Container for title and index } function addContent() { @@ -285,22 +284,41 @@ function newSuperalgosDocsDocumentPage() { let key = 'editable-paragraph-' + editableParagraphIndex let paragraph = thisObject.docsSchemaDocument.paragraphs[i] - if (paragraph.style === "Include") { - renderParagraph(paragraph, key) - editableParagraphIndex++ - let error = addIncludedParagraphs(paragraph.text) - if (error !== undefined) { - paragraph = { - style: "Error", - text: error - } - key = 'error-paragraph-' + autoGeneratedParagraphIndex + switch (paragraph.style) { + case "Include": { renderParagraph(paragraph, key) - autoGeneratedParagraphIndex++ + editableParagraphIndex++ + let error = addIncludedParagraphs(paragraph.text) + if (error !== undefined) { + paragraph = { + style: "Error", + text: error + } + key = 'error-paragraph-' + autoGeneratedParagraphIndex + renderParagraph(paragraph, key) + autoGeneratedParagraphIndex++ + } + break + } + case "Chapter": { + renderParagraph(paragraph, key) + editableParagraphIndex++ + let error = addChapterIndex(paragraph.text) + if (error !== undefined) { + paragraph = { + style: "Error", + text: error + } + key = 'error-paragraph-' + autoGeneratedParagraphIndex + renderParagraph(paragraph, key) + autoGeneratedParagraphIndex++ + } + break + } + default: { + renderParagraph(paragraph, key) + editableParagraphIndex++ } - } else { - renderParagraph(paragraph, key) - editableParagraphIndex++ } } } @@ -393,6 +411,44 @@ 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] + + if (project === 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.' + } + + if (SCHEMAS_BY_PROJECT.get(project) === undefined) { + return 'Chapter paragraph style Syntax Error. The Project ' + project + ' could not be found. Check the Docs Chapter Style Syntax. This error message will dissapear as soon as you fix the problem.' + } + + buildOrderedTopicPageIndex(chapterName) + + let key = 'auto-generated-paragraph-' + autoGeneratedParagraphIndex + paragraph = { + style: "Title", + text: 'Chapter ' + chapterNumber + ' - ' + chapterName + } + renderParagraph(paragraph, key) + autoGeneratedParagraphIndex++ + + if (introText !== undefined) { + let key = 'auto-generated-paragraph-' + autoGeneratedParagraphIndex + paragraph = { + style: "Text", + text: introText + } + renderParagraph(paragraph, key) + autoGeneratedParagraphIndex++ + } + + generateMultiPageIndex() + } } function addImages() { @@ -1358,6 +1414,14 @@ function newSuperalgosDocsDocumentPage() { innerHTML = paragraph.text break } + case 'Chapter': { + styleClass = 'class="docs-chapter"' + prefix = '' + role = '' + key = key + '-chapter' + innerHTML = paragraph.text + break + } } HTML = HTML + '

' + prefix + ' ' + innerHTML + sufix + '

' diff --git a/Projects/Superalgos/UI/Utilities/Docs.js b/Projects/Superalgos/UI/Utilities/Docs.js index 9b382dc81..85a61cb26 100644 --- a/Projects/Superalgos/UI/Utilities/Docs.js +++ b/Projects/Superalgos/UI/Utilities/Docs.js @@ -190,7 +190,15 @@ function newSuperalgosUtilitiesDocs() { let HTML = '' let splittedText = text.split('->') if (splittedText.length < 1) { return } - HTML = '' + splittedText[0] + '' + HTML = '' + splittedText[0] + '' + return HTML + } + + function parseChapter(text) { + let HTML = '' + let splittedText = text.split('->') + if (splittedText.length < 1) { return } + HTML = '' + splittedText[1] + '' return HTML }