initial commit

Author: EduardKrieger

documentation/Functions.md

@@ -18,7 +18,7 @@ The following functions are already implemented:
 * [npmInstall](#npmInstall)
 * [dockerCompose](#dockerCompose)
 * [downloadFile](#downloadFile)
-* [nextKatacodaStep](#nextKatacodaStep)
+* [displayContent](#displayContent)
 * [adaptTemplatesCobiGen](#adaptTemplatesCobiGen)
 * [createDevon4ngProject](#createDevon4ngProject)
 * [addSetupScript](#addSetupScript)
@@ -349,19 +349,19 @@ path: The URL path on which is checked if the server is running
 If the tutorial should be tested on the console environment, you have to specify a port.
 ***
 
-### nextKatacodaStep <a name="nextKatacodaStep"></a>
+### displayContent <a name="displayContent"></a>
 #### parameter
 1. The title of the step.
-2. An array of json objects with files, content, or images to be rendered within the katacoda step.
+2. An array of json objects with files, content, or images to be rendered within the katacoda step. The use for this function is to display an image and some descriptive text. No Katacoda Syntax is allowed in the files or the content!
 3. (Optional) Path to the current directory where the user is located (relative to the workspace directory). Only needed if the directory is changed within this step.
 #### example 
-nextKatacodaStep("Step title", [{ "file": "files/description.md" }, { "content": "This is just plain content." }, { "image": "files/image.png" }])
+display("Step title", [{ "file": "files/description.asciidoc" }, { "content": "This is just plain content." }, { "image": "files/image.png" }])
 
 #### Details
 Available attributes in the json objects:
 
-file: Path to a file whose content is to be displayed in the katacoda step (e.g. .md or .txt file).
-content: Plain text to be displayed in the katacoda step.
+file: Path to a file whose content is to be displayed in the katacoda step (e.g. .asciidoc or .txt file). The file should be following the formating of asciidoc files. additional formating information.
+content: Plain text to be displayed in the katacoda step. This Text should be following the formating of markdown or asciidoc // Todo
 image: Path to an image to be displayed in the katacoda step.
 
 ***

runners/console/index.ts

@@ -413,7 +413,7 @@ export class Console extends Runner {
         return result;
     }
 
-    runNextKatacodaStep(runCommand: RunCommand): RunResult {
+    runDisplayContent(runCommand: RunCommand): RunResult {
         //Only needed for katacoda and wiki runner
         return null;
     }

runners/katacoda/index.ts

@@ -344,7 +344,7 @@ export class Katacoda extends Runner {
         return null;
     }
 
-    runNextKatacodaStep(runCommand: RunCommand): RunResult {
+    runDisplayContent(runCommand: RunCommand): RunResult {
         let tempFile = path.join(this.getTempDirectory(), runCommand.command.name + ".md");
         fs.writeFileSync(tempFile, "");
         for(let i = 0; i < runCommand.command.parameters[1].length; i++) {
@@ -364,7 +364,7 @@ export class Katacoda extends Runner {
         let content = fs.readFileSync(tempFile, "utf-8");
         this.pushStep(runCommand, runCommand.command.parameters[0], "step" + runCommand.stepIndex + ".md");
 
-        this.renderTemplate("nextKatacodaStep.md", this.outputPathTutorial + "step" + runCommand.stepIndex + ".md", { text: runCommand.text, textAfter: runCommand.textAfter, content: content });
+        this.renderTemplate("displayContent.md", this.outputPathTutorial + "step" + runCommand.stepIndex + ".md", { text: runCommand.text, textAfter: runCommand.textAfter, content: content });
 
         if(runCommand.command.parameters[2]) {
             this.currentDir = path.join(this.getVariable(this.WORKSPACE_DIRECTORY), runCommand.command.parameters[2]);

…s/katacoda/templates/nextKatacodaStep.md …ers/katacoda/templates/displayContent.mdrunners/katacoda/templates/nextKatacodaStep.md renamed to runners/katacoda/templates/displayContent.md runners/katacoda/templates/nextKatacodaStep.md renamed to runners/katacoda/templates/displayContent.md

@@ -155,7 +155,7 @@ export class WikiConsole extends WikiRunner {
               return null;
     }
 
-    runNextKatacodaStep(runCommand: RunCommand): RunResult {
+    rundisplayContent(runCommand: RunCommand): RunResult {
         let tempFile = path.join(this.getTempDirectory(), runCommand.command.name + ".md");
         fs.writeFileSync(tempFile, "");
         for(let i = 0; i < runCommand.command.parameters[1].length; i++) {
@@ -172,7 +172,7 @@ export class WikiConsole extends WikiRunner {
         }
 
         let content = fs.readFileSync(tempFile, "utf-8");
-        this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "nextKatacodaStep.asciidoc"), { title: runCommand.command.parameters[0], content: content, path: runCommand.command.parameters[2]});
+        this.renderWiki(path.join(this.getRunnerDirectory(), "templates", "displayContent.asciidoc"), { title: runCommand.command.parameters[0], content: content, path: runCommand.command.parameters[2]});
 
         return null;
     }