From b3b4ad4a9796bde61516402fdadd0518b7be6e60 Mon Sep 17 00:00:00 2001
From: jsteuer <jan.steuer.htw@gmail.com>
Date: Tue, 21 Jan 2020 11:24:21 +0100
Subject: [PATCH] docs: documentation entry for tool declaration
---
CHANGELOG.md | 1 +
README.md | 17 +++++++++--------
2 files changed, 10 insertions(+), 8 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 4a19755..c193760 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@
## [Unreleased]
### Added
+- Dokumentation zu einem Werkzeug kann nun über die Werkzeug-Deklaration verlinkt werden
### Changed
### Fixed
### Removed
diff --git a/README.md b/README.md
index 4d2b5cc..7559fb7 100644
--- a/README.md
+++ b/README.md
@@ -272,14 +272,15 @@
...
}
-| 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` |
-
+| Schlüssel | Beschreibung | Beispiel |
+|-----------|--------------|----------|
+| `"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` |
+
### Global (Für alle Autoren)
--
Gitblit v1.10.0-SNAPSHOT