jsteuer
2020-01-21 b3b4ad4a9796bde61516402fdadd0518b7be6e60
docs: documentation entry for tool declaration
2 files modified
14 ■■■■■ changed files
CHANGELOG.md 1 ●●●● patch | view | raw | blame | history
README.md 13 ●●●● patch | view | raw | blame | history
CHANGELOG.md
@@ -4,6 +4,7 @@
## [Unreleased]
### Added
-   Dokumentation zu einem Werkzeug kann nun über die Werkzeug-Deklaration verlinkt werden
### Changed
### Fixed
### Removed
README.md
@@ -273,12 +273,13 @@
    }
| Schlüssel | Beschreibung  | Beispiel  |
|---------------|---|---|
| displayName   | Der Name des Werkzeugs  |  `"Fill-In-Blank-Editor"`  |
| entry         | Der Einstiegspunkt für das Werkzeugs muss sich auf dem selben Server wie die IDE befinden.  |  `"/mathcoach/www/YOURNAME/fib/tool.html"`  |
| description   | Eine kurze Beschreibung  |   |
| developer     | Name des Werkzeug-Entwicklers  |  |
| extension     | Dateien anhand der Datei-Erweiterung mit dem Werkzeug verknüpfen. Hier sollte etwas Eindeutiges gewählt werden  | `"fib.json"` für Dateien wie `someExercise.fib.json`  |
|-----------|--------------|----------|
| `"description"` | Eine kurze Beschreibung | `"Editor zum Erstellen von Fill-In-Blank Aufgaben."` |
| `"developer"` | Namen der Werkzeug-Entwickler | `"John Doe, Jane Doe"` |
| `"displayName"` | Der Name des Werkzeugs |  `"Fill-In-Blank-Editor"` |
| `"documentation"` | **Optional**. Link zur Werkzeug-Dokumentation. Diese muss sich auf dem selben Server wie die IDE befinden. | `"/mathcoach/www/YOURNAME/fib/docs.html"` |
| `"entry"` | Der Einstiegspunkt für das Werkzeugs. Dieser muss sich auf dem selben Server wie die IDE befinden. | `"/mathcoach/www/YOURNAME/fib/tool.html"` |
| `"extension"` | Dateien anhand der Datei-Erweiterung mit dem Werkzeug verknüpfen. Hier sollte etwas Eindeutiges gewählt werden. | `"fib.json"` für Dateien wie `someExercise.fib.json` |