Skip to content

Commit e261dfa

Browse files
committed
fixed typos
1 parent 5ca41e3 commit e261dfa

6 files changed

Lines changed: 19 additions & 17 deletions

File tree

documentation/Functions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -352,20 +352,20 @@ If the tutorial should be tested on the console environment, you have to specify
352352
### displayContent <a name="displayContent"></a>
353353
#### parameter
354354
1. The title of the step.
355-
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!
355+
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!
356356
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.
357357
#### example
358358
display("Step title", [{ "file": "files/description.asciidoc" }, { "content": "This is just plain content." }, { "image": "files/image.png" }])
359359

360360
#### Details
361361
Available attributes in the json objects:
362362

363-
1. 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.
364-
2. content: Plain text to be displayed in the katacoda step. This Text should be following the formating of asciidoc files.
365-
3. image: Path to an image to be displayed in the katacoda step.
363+
1. 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.
364+
2. content: Plain text to be displayed in the Katacoda step. This Text should be following the formating of asciidoc files.
365+
3. image: Path to an image to be displayed in the Katacoda step.
366366

367367
#### Formatting rules for content and .asciidoc or .txt files.
368-
* You can add headers to structure your text. The generated headers are shown in the examples below. The headers should fit into the overall structure of the generated wiki so level 1 header arent allowed, but the other header can be used at your judgement.
368+
* You can add headers to structure your text. The generated headers are shown in the examples below. The headers should fit into the overall structure of the generated wiki so level 1 header are not allowed, but the other header can be used at your judgement.
369369
* A list always needs an empty newline between the last row and the list.
370370
* Use asciidoc style of links
371371

engine/wikiRunner.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ import * as ejs from "ejs";
88
export abstract class WikiRunner extends Runner {
99

1010
public outputPathTutorial: string;
11+
public commandCntMap = new Map();
12+
13+
protected readonly INSTALLED_TOOLS: string = "installedTools";
1114
protected fileTypeMap = new Map([ [".java", "java"],[".ts", "typescript"],
1215
[".js", "javascript"], [".html", "html"],
1316
[".scss", "css"], [".asciidoc", "asciidoc"], ]);
14-
protected readonly INSTALLED_TOOLS: string = "installedTools";
15-
public CommandCntMap = new Map();
17+
1618

1719

1820
init(playbook: Playbook): void {
@@ -21,7 +23,7 @@ export abstract class WikiRunner extends Runner {
2123
this.setVariable(this.WORKSPACE_DIRECTORY, path.join(this.getWorkingDirectory()));
2224
this.setVariable(this.INSTALLED_TOOLS, "");
2325
for(let i = 0; i< playbook.steps.length; i++){
24-
this.CommandCntMap.set(i, playbook.steps[i].lines.length-1);
26+
this.commandCntMap.set(i, playbook.steps[i].lines.length-1);
2527
}
2628
}
2729

@@ -49,7 +51,7 @@ export abstract class WikiRunner extends Runner {
4951
}
5052

5153
protected checkForTextAfter(runCommand: RunCommand): string{
52-
return this.CommandCntMap.get(runCommand.stepIndex) == runCommand.lineIndex
54+
return this.commandCntMap.get(runCommand.stepIndex) == runCommand.lineIndex
5355
? runCommand.textAfter
5456
: undefined;
5557
}

runners/wikiConsole/templates/adaptTemplates.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<%if(title){%>== <%- title; %>
22
<%if(text){%><%- text; %><%}%><%}else{%>
33

4-
=== Generate CobiGen Templates
4+
=== Generate CobiGen templates
55
<%if(text){%><%- text; %><%}%>
66

77
How to use CobiGen, to generate templates for the following code generation.
@@ -12,7 +12,7 @@ More information about CobiGen on https://devonfw.com/website/pages/docs/master-
1212

1313
* An installed devonfw distribution is needed. To execute the CobiGen CLI, you have to install the devonfw IDE first. Follow the https://devonfw.com/website/pages/docs/devonfw-ide-introduction.asciidoc.html[devonfw IDE] documentation to install the same.
1414

15-
==== Generate CobiGen Templates with CobiGen CLI
15+
==== Generate CobiGen templates with CobiGen CLI
1616

1717
First open a command prompt in your current workspace. You should be inside your devonfw directory, if not change your directory to *<%= devonPath;%>*.
1818
Run the CobiGen command `devon cobigen adapt-templates`

runners/wikiConsole/templates/addSetupScript.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<%if(title){%>== <%- title; %>
22
<%if(text){%><%- text; %><%}%><%}else{%>
33

4-
=== Run a Setupscript
4+
=== Run a setup script
55
<%if(text){%><%- text; %><%}%><%}%>
66

77
Run a Script to setup the enviroment for the Tutorial.
@@ -33,7 +33,7 @@ The editor opens a new editor window for an untitled file where you can insert t
3333
Save the file by selecting *Save* or *Save as* in the file context menu or by using the keyboard shortcut ctrl+s.
3434
A file explorer window opens where you should set the filename to *<%= scriptNameLinux; %>* and save it to your current directory.
3535

36-
==== Run the Setupscript
36+
==== Run the setup script
3737

3838
.Operating system
3939
. Windows +

runners/wikiConsole/templates/createFolder.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<%if(title){%>== <%- title; %>
22
<%if(text){%><%- text; %><%}%><%}else{%>
33

4-
=== Create Folder
4+
=== Create folder
55
<%if(text){%><%- text; %><%}%><%}%>
66

7-
==== Creating a new Folder
7+
==== Creating a new folder
88

99
A folder can be created either from within an IDE like VSCode or Eclipse by simply right clicking in the file explorer and creating a new folder. Another approach is to use the Terminal.
1010

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<%if(title){%>== <%- title; %>
22
<%if(text){%><%- text; %><%}%><%}else{%>
33

4-
=== Generate new Templates for CobiGen
4+
=== Generate new templates for CobiGen
55

66
<%if(text){%><%- text; %><%}%>
77

@@ -11,7 +11,7 @@ More information about CobiGen on https://devonfw.com/website/pages/docs/master-
1111
==== Prerequisites
1212
An installed devonfw distribution is needed. To execute CobiGen in Eclipse IDE, you have to install the devonfw IDE with the Eclipse IDE first. Follow the https://devonfw.com/website/pages/docs/devonfw-ide-introduction.asciidoc.html[devonfw-ide] documentation to install the same.
1313

14-
==== Generate CobiGen Templates with Eclipse IDE
14+
==== Generate CobiGen templates with Eclipse IDE
1515

1616
First, open Eclipse IDE, and if your file explorer is empty load any file, create a file, or project into Eclipse.
1717
Right-click any file in the file explorer to open a dropdown menu where you can select CobiGen and an additional menu opens. Select *Adapt Templates...* and CobiGen starts generating a new template folder. CobiGen gives you a warning that existing templates will be overridden in your current workspace, you can confirm to continue. If the folder is already existing CobiGen will inform you, that for updating your templates you have to use the *Update Templates...* functionality else CobiGen will create a folder and download the latest template to use it. You can confirm the messages with *OK* or *Update* and the CobiGen templates folder is imported successfully.

0 commit comments

Comments
 (0)