Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
58 lines (42 sloc) 1.92 KB

DocumentationTree - Benutzerhandbuch

1. Voraussetzung

Um die Anwendung starten zu können, wird mindestens Java-Version 8 (>= 8u60) vorausgesetzt.

2. Start

Die Anwendung kann mit einem (Doppel-)Klick auf die Jar-Datei gestartet werden.

Alternativ lässt sich die Anwendung auch über eine Konsoleneingabe starten:

java -jar documentationtree-<Version>-jar-with-dependencies.jar

Dazu muss documentationtree-<Version>-jar-with-dependencies.jar im aktuellen Verzeichnis liegen.

Beim Start erscheint folgender Dialog:

Startbildschirm

Das Verzeichnis wird initial immer auf das Verzeichnis, in dem die Jar-Datei liegt, eingestellt.

Hier ist eine Datei auszuwählen, die eine Lua-Table enthält, die über

return <table>

zurückgegeben wird.

3. Darstellung

3.1. Datei öffnen

Kann die Datei gelesen und geöffnet werden, wird der Inhalt der Datei wie folgt angezeigt:

Anzeige der Daten aus einer Lua-Table-Datei

3.2. Knoten markieren

Beim Klick auf den Button "Markieren" werden Knoten nach folgenden Regeln gefärbt:name: value

  1. Der ausgewählte Knoten wird in blau gefärbt.

  2. Knoten, deren Text mit dem des ausgewählten Knoten identisch sind, werden blau gefärbt.

  3. Knoten über dem ausgewählten Knoten werden rot gefärbt; Knoten über den Knoten von 2. werden grau gefärbt.

  4. Knoten unter dem ausgewählten Knoten werden grün gefärbt.

  5. Knoten, die mit den Knoten unter 4. identisch sind, werden ebenfalls grün markiert.

Gefärbte Knoten
Gefärbte Knoten mit Unterknoten

Durch einen Klick auf den Button "Markierungen löschen" werden alle gefärbten Knoten in ihren Ursprungszustand zurückgesetzt.