Merge pull request #331 from denise-khuu/feature/tutorialTags

feature/tutorialTags

Author: SchettlerKoehler

documentation/Tutorials.md

@@ -9,6 +9,7 @@ Every tutorial has three main parts
 * at least one step
 Additionally, there are optional parts
 * a subtitle
+* tags
 * a conclusion of the tutorial. This will be shown at the last page and can be used to summarize the learned, to foreshadow the next steps on the learning path or to mention useful sources.
 
 The tutorials are written in asciidoc files. 
@@ -100,6 +101,16 @@ To display images within a step, you can use either the [displayContent](https:/
 ```
 The image must be in a folder called `images` in the folder of the playbook (see [Structure](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Structure)).
 
+There is the option to add tags to your tutorials. To do that, you have to add the following syntax after the title or if you have specified a subtitle, after the subtitle.
+
+````
+[tags]
+--
+tagType=tag0;tag1
+tagType=tag0;tag1;tag2
+--
+```
+
 You can also add an optional conclusion text, which is shown on completion of the tutorial. Use this to summarize the important content of the tutorial, to point out what to learn next or to mention other useful informations.
 
 To do that, you have to provide the conclusion at the end of the tutorial (after the last step) surrounded by ```====```.
@@ -116,6 +127,11 @@ These blocks are combined to a complete tutorial.
 ```
 = Title
 == Subtitle
+[tags]
+--
+tagType=tag0;tag1
+tagType=tag0;tag1;tag2
+--
 ====
 Description of the tutorial
 ====

engine/parser.def

@@ -1,10 +1,11 @@
 start
   = headline
     subtitle?
+    tags?
     description
     steps
     conclusion?
-
+    
 headline "headline starting with ="
   = "=" _ string ___
 
@@ -83,6 +84,18 @@ conclusionlines
 conclusionline
   = !blockmarker string __ 
 
+tags
+  = "[tags]" ___
+    "--" ___
+    taglines
+    "--" __
+
+taglines
+  = tagline+ { return { "taglines": text()}; }
+
+tagline
+  = !"--" string __ 
+
 string "string"
   = [^\r\n]+ { return text(); }
 

engine/parser.ts

@@ -20,9 +20,10 @@ export class Parser {
         let result = new Playbook();
         result.title = parseResult[0][2];
         result.subtitle = parseResult[1]? parseResult[1][3]: "";
-        result.description = this.insertNewlineIntoDescription(parseResult[2][2].descriptionlines);
-        result.conclusion = this.insertNewlineIntoDescription(parseResult[4]? parseResult[4][2].conclusionlines: "");
-        for(let index in parseResult[3]){
+        result.tags = this.getTags(parseResult);
+        result.description = this.insertNewlineIntoDescription(parseResult[3][2].descriptionlines);
+        result.conclusion = this.insertNewlineIntoDescription(parseResult[5]? parseResult[5][2].conclusionlines: "");
+        for(let index in parseResult[4]){
             let step = new Step();
             step.text = this.getText(parseResult, index);
             step.lines = this.getLines(parseResult, index);
@@ -35,26 +36,26 @@ export class Parser {
 
     getText(parseResult, index){
         try {
-            return parseResult[3][index][1].steptextlines || parseResult[3][index][2][1].steptextlines;
+            return parseResult[4][index][1].steptextlines || parseResult[4][index][2][1].steptextlines;
         } catch (error) {
-            return parseResult[3][index][2][1].steptextlines;
+            return parseResult[4][index][2][1].steptextlines;
         }
     }
 
     getLines(parseResult, index):Command[]{
         let linebreak = process.platform=="win32" ? "\r\n" : "\n";
         try {
-            return (parseResult[3][index][7].steplines || parseResult[3][index][2][7].steplines).split(linebreak).filter(e => e.trim() != '').map(e => this.createCommand(e));
+            return (parseResult[4][index][7].steplines || parseResult[4][index][2][7].steplines).split(linebreak).filter(e => e.trim() != '').map(e => this.createCommand(e));
         } catch (error) {
-            return parseResult[3][index][2][7].steplines.split(linebreak).filter(e => e.trim() != '').map(e => this.createCommand(e));
+            return parseResult[4][index][2][7].steplines.split(linebreak).filter(e => e.trim() != '').map(e => this.createCommand(e));
         }
     }
 
     getTitle(parseResult, index) {
         try {
             // parseResult[3][index][4][2] step without block
             // parseResult[3][index][2][4][2] step inside a block
-            return (parseResult[3][index][4][2].steptitle || parseResult[3][index][2][4][2].steptitle);
+            return (parseResult[4][index][4][2].steptitle || parseResult[4][index][2][4][2].steptitle);
         } catch(error) {
             return null;
         }
@@ -76,12 +77,30 @@ export class Parser {
 
     getTextAfter(parseResult, index){
         try {
-            return parseResult[3][index][3].steptextafterlines || "";
+            return parseResult[4][index][3].steptextafterlines || "";
         } catch (error) {
             return "";
         }
     }
 
+    getTags(parseResult){
+        let tagDict = {};
+        try{
+            let results = parseResult[2] ? parseResult[2][4].taglines.split(/\r?\n/) : Array();
+            for (let result of results){
+                if(result){
+                    result = result.split("=")
+                    let type = result[0];
+                    let tags = result[1].includes(";") ? result[1].split(";") : Array(result[1]);
+                    tagDict[type] = tags;
+                }
+            }
+        }catch (error) {
+            throw error;
+        }        
+        return tagDict;
+    }
+
     insertNewlineIntoDescription(description: string): string{
         let result = description;
         let offset = 0;

engine/playbook.ts

@@ -8,4 +8,5 @@ export class Playbook{
     public description: string;
     public conclusion: string;
     public steps: Step[] = [];
+    public tags: Record<string, string[]>;
 }