From 214954bc9db60b9625a600431ea5f59bcef2b949 Mon Sep 17 00:00:00 2001 From: jsteuer <jan.steuer.htw@gmail.com> Date: Wed, 18 Dec 2019 07:14:37 +0100 Subject: [PATCH] docs --- README.md | 13 ++++++++----- 1 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8d5bcee..ac691a0 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ können. Darüber hinaus werden als Ergänzung einige Hilfsfunktionen zum Bau von Werkzeugen angeboten.  + *Beispielhafte Anwendung: Eine Datei wird angelegt und einem Demo-Editor geöffnet. Dieser generiert eine Groovy-Aufgabe* @@ -18,11 +19,12 @@ kann. Bestimmte Dateien werden anhand ihrer Dateiendung mit dem Werkzeug verknüpft, sodass der Benutzer das passende Werkzeug durch einen einfache Klick im Dateie-Explorer starten kann. Diese Datei wird im folgenden Kontext-Datei genannt und soll dazu dienen das interene Datenmodell (also -alle Informationen, die der Benutzer im Editor angibt) zu speichern. Das gespeicherte Datenmodell kann -zu einem späteren Zeitpunkt wieder geladen werden. Weiterhin kann das Werkzeug aus dem internen -Datenmodell eine MathCoach-Aufgabe (Groovy-Datei) generieren. Weitere Funktionalitäten - beispielsweise -das Starten der generierten Aufgabe in der Aufgaben-Vorschau der IDE - sind ebenfalls für den -Werkzeugentwickler verfügbar. +alle Informationen, die der Benutzer im Werkzeug angibt) zu speichern. Das Werkzeug soll das gespeicherte +Datenmodell zu einem späteren Zeitpunkt wieder laden können. + +Ein Werkzeug kann beispielsweise MathCoach-Aufgabe (Groovy-Datei) generieren. Weitere Funktionalitäten +der IDE - beispielsweise das Starten der generierten Aufgabe in der Aufgaben-Vorschau der IDE - sind +ebenfalls für den Werkzeugentwickler verfügbar. Das Realisieren von Werkzeugen auf diese Art und Weise hat zahlreiche Vorteile: - Werkzeuge werden einheitliche und benutzerfreundlich zur Verfügung gestellt @@ -53,6 +55,7 @@ > sind grundsätzlich nicht verfügbar und müssen vom Werkzeugentwickler eingebunden > werden - siehe "Hilfunktionen für Werkzeug-Entwickler" weiter unten. + > **Hinweis**: Erst, wenn das Werkzeug in die IDE integriert und aus dieser heraus > gestartet wurde, kann die IDE API verwendet werden! Soll das Werkzeug auch ohne die > IDE nutzbar sein (z.B. zum Testen), muss dies bei der Implementierung berücksichtigt -- Gitblit v1.10.0-SNAPSHOT