From 19e29af10d114ffab5cf1535ae1256ec2b161015 Mon Sep 17 00:00:00 2001
From: jsteuer <jan.steuer.htw@gmail.com>
Date: Mon, 30 Sep 2019 07:18:39 +0200
Subject: [PATCH] docs
---
examples/example-ide/README.md | 2 +-
package.json | 3 +--
CHANGELOG.md | 9 ++++++---
README.md | 16 ++++++++++++++--
4 files changed, 22 insertions(+), 8 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index abf9429..ac44566 100644
--- a/CHANGELOG.md
+++ b/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
diff --git a/README.md b/README.md
index e3b5deb..5b5fef7 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/examples/example-ide/README.md b/examples/example-ide/README.md
index 8c3a3de..37dbf76 100644
--- a/examples/example-ide/README.md
+++ b/examples/example-ide/README.md
@@ -22,7 +22,7 @@
{
...
- "editor.external.definitions": [
+ "editor.external.declarations": [
...
{
"displayName": "MyEditor",
diff --git a/package.json b/package.json
index acc5edb..254f69c 100644
--- a/package.json
+++ b/package.json
@@ -1,8 +1,7 @@
{
"name": "@mathcoach/ide-api",
"version": "1.1.0",
- "description": "API zur MathCoach IDE",
- "types": "mathcoach-api.d.ts",
+ "description": "API zur MathCoach IDE",
"main": "./src/index.ts",
"directories": {
"example": "examples"
--
Gitblit v1.10.0-SNAPSHOT