Text: Added Leitfaden section

text/content.troff

@@ -54,7 +54,7 @@ Datenverwaltung
 .LP
 Das vorliegende vereinfachte\**
 .FS
-\**eine genauere Beschreibung der Klassen befindet sich im Anhang.
+eine genauere Beschreibung der Klassen befindet sich im Anhang.
 .FE
 UML Klassendiagramm beschreibt die Struktur der Datenverwaltung.
 Dabei ist das DataObject die Basisklasse aller verwalteten Objekte.
@@ -83,3 +83,59 @@ Wenn es keine Datei mit dem Namen gibt wird schlussendlich ein HTTP-404-Fehler g
 .LP
 Besonders ist auch die Klasse \fChsmw.jotto5.beleg.views.Defaults\fR.
 Sie stellt selber keine View dar, bietet aber statische Methoden und Variablen an welche zwischen allen Views geteilt werden, zum Beispiel ein Grundgerüst für die HTML-Dokumente welche zurückgegeben werden.
+.NH 2
+Leitfäden
+.NH 3
+Kompilieren
+.LP
+Zum Kompilieren der Anwendung selbst wird ein aktuelles JDK\**
+.FS
+Zum Zeitpunkt des Schreibens Version 21 LTS.
+.FE
+sowie eine aktuell Installation von Apache ANT\**
+.FS
+Zum Zeitpunkt des Schreibens Version 1.10.15.
+.FE
+vorausgesetzt.
+Kompiliert wird die Anwendung über das mitgelieferte ANT-Script mit dem Befehl \fCant\fR im aktuellen Ordner.
+Dadurch wird im Hauptordner die Ausgabedatei \fCbeleg.jar\fR erzeugt.
+Die Anwendung kann auch direkt mit \fCant run\fR ausgeführt werden.
+.LP
+Die Javadoc-Dokumentation kann über \fCant doc\fR neu erstellt werden, dafür wird eine zum JDK passende Version von Javadoc benötigt.
+Dieses Dokument kann theoretisch auch mithilfe des Skripts erzeugt werden, über \fCant text\fR\**
+.FS
+Die Quelldateien dafür befinden sich im Unterordner \fCtext\fR.
+.FE
+, dafür ist allerdings eine nichttriviale Einrichtung nötig.\**
+.FS
+Es wird GNU groff benötigt, die damit mitgelieferte Version des ms-Makropakets, die eigene Vorlage der Autorin sowie eine Konfiguration der Schriftart OpenSans.
+.FE
+.NH 3
+Benutzen
+.NH 4
+Starten
+.LP
+Die Anwendung befindet sich in der ausführbaren JAR-Datei \fCbeleg.jar\fR.
+Sie kann wie jede andere JAR-Datei per Doppelklick oder mit dem Kommando \fCjava -jar beleg.jar\fR gestartet werden.
+Dabei ist zu beachten dass die Anwendung im dem Verzeichnis ausgeführt wird in dem sich das \fCstatic\fR-Verzeichnis befindet.
+.LP
+Beim Starten per Doppelklick kann es, je nach Betriebssystemkonfiguration, vorkommen dass kein Konsolenfenster geöffnet wird - für diesen Fall bietet
+die Anwendung die Möglichkeit sich selbst aus laufenden Betrieb zu beenden, siehe Unterpunkt \fBBeenden\fR.
+.LP
+Die Anwendung öffnet nun einen lokalen TCP-Port mit Portnummer 8000 und reagiert darauf auf HTTP-Anfragen.
+Das Webinterface kann in einem beliebigen, hinreichend modernen\**
+.FS
+Getestet wurde mit Mozilla Firefox 140.0.
+.FE
+Browser unter \fChttp://localhost:8000\fR aufgerufen werden.
+.NH 4
+Übersicht
+.LP
+.NH 4
+Beenden
+.LP
+Der typische Weg eine Serveranwendung zu beenden ist das Senden eines entsprechenden Signals an den Prozess.
+Dafür kann meist in der Konsole die Tastenkombination Strg+C verwendet werden, um das Signal \fCSIGINT\fR an die Anwendung zu senden.
+.LP
+Für einfache Handhabung bei der Entwicklung bietet die Anwendung die Möglichkeit aus laufendem Betrieb beendet zu werden ohne auf die Serverkonsole Zugriff zu haben.
+Dafür steht auf der Startseite in den Verwaltungsoptionen der entsprechende Link bereit.