jsteuer
2019-09-30 560ff79b67466fd381e817bae4bd2b80a1c293c8
docs
1 files modified
22 ■■■■ changed files
README.md 22 ●●●● patch | view | raw | blame | history
README.md
@@ -22,15 +22,19 @@
    gestartet wurde, kann die API verwendet werden! (Hinweis: durch nachbilden der API kann 
    eine Nutzung ohne IDE ermöglicht werden, siehe `enableOfflineUsageIfNecessary`)
## Beispiele
### Beispiele
Im Verzeichnis `./examples/` finden sich Beispiele für externe Werkzeuge. 
## Hilfunktionen für Werkzeug-Entwickler
Dieses Paket beinhaltet zusätzlich Hilfsfunktionen für Werkzeug-Entwickler.
### Hilfunktionen für Werkzeug-Entwickler
Dieses Paket beinhaltet zusätzlich Hilfsfunktionen für Werkzeug-Entwickler. Beispielsweise kann
ein Werkzeug ohne IDE-Anbindung genutzt werden, indem die API nachgebildet wird - aktuell auf
Basis des LocalStorage des Browsers.
    import { enableOfflineUsageIfNecessary } from "@mathcoach/ide-api";
    let offline: boolean = enableOfflineUsageIfNecessary();
#### Kleinere Werkzeuge
### Kleinere Werkzeuge
Für kleiner Werkzeuge bietet es sich an im WWW-Verzeichnis zu entwickeln  (z.B. 
`myTool/tool.html` und `myTool/tool.js`). Die MathCoach-IDE stellt Autovervollständigung beim
Editieren der `tool.js`-Datei zur Verfügung. Da es sich um eine JavaScript-Datei handelt, 
@@ -39,7 +43,7 @@
![Demo](media/usage_tool_developer.gif)
#### Größere Werkzeuge
### Größere Werkzeuge
Für größere Werkzeuge sollte ein Build-System wie [webpack](https://webpack.js.org/) 
oder [PARCEL](https://parceljs.org/) in Kombination mit 
[TypeScript](https://www.typescriptlang.org/) verwendet werden. Das Werkzeug muss nach dem
@@ -59,6 +63,12 @@
        ...
    }
Bei Verwendung einer Entwicklungsumgebung wie Visual Studio Code kann die Typdefinition der
API auch für JavaScript eingebunden werden. Hierfür ist ggf. ein spezielles Kommentar am Anfang
der Datei notwendig (Pfad falls nötig anpassen):
    /// <reference path="../node_modules/@mathcoach/ide-api/mathcoach-api.d.ts"/>
Wie man der Git-Repo URL ansieht, werden Git-Tags verwendet um eine 
Versionierung [(Semantic Versioning)](https://semver.org/lang/de/)
der API zu erreichen. Lässt man die Versionierung weg, wird die