| CHANGELOG.md | ●●●●● patch | view | raw | blame | history | |
| README.md | ●●●●● patch | view | raw | blame | history | |
| examples/example-ide/README.md | ●●●●● patch | view | raw | blame | history | |
| package.json | ●●●●● patch | view | raw | blame | history |
CHANGELOG.md
@@ -10,17 +10,20 @@ ## [1.1.0] - 2019-06-05 ## [1.1.0] - 2019-09-30 ### Added - Beispiele, siehe `./examples/` - `MC.ide.navigator.navigateToExercise(file,forceOpen)` um zu einer MathCoach-Aufgabe zu navigieren. Somit muss das Werkzeug keine Exercise-Links erzeugen können. - `MC.isReady()` um zu prüfen, ob die Verbindung zur IDE besteht - Dieses Paket liefert nun zusätzlich Hilfsfunktionen zur Entwicklung von externen Werkzeugen. - Hilfsfunktion: `enableOfflineUsageIfNecessary` um die API ohne IDE-Verbindung bereitzustellen - beispielsweise beim Testen oder Offline-Verwenden des Werkzeugs ### Fixed - Bessere Dokumentation der API - Beispiele in der API Dokumentation hinzugefügt - Bessere Dokumentation
@@ -1,7 +1,8 @@ # MathCoach IDE API In diesem Paket ist die öffentliche Schnittstelle zur MathCoach Entwicklungsumgebung (IDE) In diesem Paket ([Das Gitblit Repository findet sich hier](https://newton.htwsaar.de/gitblit/summary/mathcoach!mathcoach-ide-api.git)) ist die öffentliche Schnittstelle zur MathCoach Entwicklungsumgebung (IDE) definiert. Mithilfe dieser Schnittstelle können externe Werkzeuge (z.B. Editoren) erstellt werden. Für den Anwender stehen diese Werkzeuge dann komfortabel - in die IDE integriert - zur Verfügung. @@ -18,7 +19,15 @@ - Von nun an steht die hier definierte API durch die globale Variable `MC` zur Verfügung. - **Hinweis**: Erst, wenn das Werkzeug in die IDE integriert und aus dieser heraus gestartet wurde, kann die API verwendet werden! gestartet wurde, kann die API verwendet werden! (Hinweis: durch nachbilden der API kann eine Nutzung ohne IDE ermöglicht werden, siehe `enableOfflineUsageIfNecessary`) ## 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. #### Kleinere Werkzeuge @@ -120,6 +129,9 @@ ├── examples // Beispiele │ ├── ... │ └── ... ├── src // Hilfsfunktionen für Werkzeugentwickler │ ├── index.ts // Einstiegspunkt │ └── ... ├── mathcoach-api.d.ts // Definition der API ├── package.json ├── package-lock.json examples/example-ide/README.md
@@ -22,7 +22,7 @@ { ... "editor.external.definitions": [ "editor.external.declarations": [ ... { "displayName": "MyEditor", package.json
@@ -2,7 +2,6 @@ "name": "@mathcoach/ide-api", "version": "1.1.0", "description": "API zur MathCoach IDE", "types": "mathcoach-api.d.ts", "main": "./src/index.ts", "directories": { "example": "examples"
