Hilfeseiten zur Verfügung stellen

Hilfe?

Eine grafische Anwendung ohne Hilfeseiten ist schon fast ein Unding. Weil Schreiben aber (nicht nur) für einen Programmierer äußerst lästig ist, habe ich mich für das HTML-Format entschieden. Einmal ist es gut bekannt, zum andern bringt Java die Unterstützung dafür frei Haus mit :)

Der Rahmen, der die Anwendungen startet (SRStarter) bringt schon einen kleinen Webbrowser mit, der für die Anzeige von Hilfeseiten vorbereitet wurde.

Seitenanfang

Organisation

Die Hauptseite, die beim Start des Hilfebrowsers angezeigt wird heißt general.html, die eingedeutschte Seite entsprechend de-general.html. Diese Datei(en) liegen im Stammverzeichnis res.

Alle weiteren Hilfeseiten liegen in dem Verzeichniss help, bzw. in Deutsch unter help.de (für andere Sprachen einfach de gegen das Landeskürzel austauschen).

Die Verzeichnisstruktur unter help wird im Hilfebrowser abgebildet und die Dateinamen können über den MessageSource-Mechanismus übersetzt werden.

Seitenanfang

Format

Jede Hilfedatei sollte als komplette HTML-Datei angesehen werden. Hierbei muss der <Header>-Bereich nicht notiert werden, wohl aber der Body

<html>
   <body>
      <p>Hier kommt dann der eigentliche Hilfetext</p>
   </body>
</html>

Seitenanfang