Anleitung, um die HTML-Hilfe zu schreiben:
Beiträge sind sehr willkommen. Wenn Sie einen Beitrag für die
HTML-Hilfe selbst erstellen wollen, kontaktieren Sie bitte den
Hauptersteller:
fritzdotmuelleratmaildotcom
Die Struktur des \help Verzeichnisses:
\help\index.htm
Listet die auf dem System installierten Hilfedateien auf.
Wird automatisch geladen, wenn 'LANG' nicht auf eine verfügbare
Sprache gesetzt ist und Englisch (EN) nicht installiert ist.
\help\%LANG%\index.htm
HELP wird diese Datei standardmäßig laden.
%LANG% ist die durch Setzen der 'LANG' Umgebung gewählte Sprache.
Wenn 'LANG' nicht gesetzt ist, wird EN vermutet (verwendet).
\help\%LANG%\help.htm
HELP wird diese Datei laden, wenn der Benutzer F1 drückt oder
auf "Hilfe über die Hilfe" klickt.
\help\docinfo\bi\nls\%LANG%.bi
Speichert Sprachlisten, zur Verwendung mit Aitor's Tool
"bookshlf", um den den Sprachenindex (\help\index.htm) zu erstellen.
Erzeugen von komprimierten Hilfeateien:
Sie sollten für Ihren komprimierten Dateisatz einen Namen wie z.B.
\help\...\[name]\[name].zip
verwenden.
Wenn Sie Ihre Hilfedateien komprimieren wollen, sollten sie im Zip-
Format sein. Sie sollten den gleichen Dateinamen wie das Verzeichnis,
in dem sie gespeichert sind und die Zip-Dateiendung haben.
Zum Beispiel:
\help\en\myhelp\myhelp.zip
Die index.htm kann innerhalb der Zip-Datei sein, aber help und
bookshlf funktionieren besser, wenn sie außerhalb sind.
Verzeichnisstrukturen sind innerhalb der Zip-Datei zulässig. Jedoch
sollte auf Verschlüsselung und auf andere Komprimierungsformate
verzichtet werden, da sie nicht unterstützt werden.
Modifizierte Versionen der Hilfedateien erzeugen:
Verwenden Sie bei allen modifizierten Versionen einen eindeutigen Titel
auf der Titelseite (oft index.htm). Dies vermeidet Verwirrung oder
Konflikte, und, am allerwichtigsten, ist laut Teil 4A der
GNU Free Documentation Lizenz 1.1 auch erforderlich.
Neben dem Ändern des Titels aktualisieren Sie bitte auch die History,
Liste der Autoren usw. entsprechend der Sektion 4 der
GNU Free Documentation Lizenz 1.1.
Wenn der Datensatz ein neues oder modifiziertes Paket beschreiben soll
oder der Datensatz einer grundlegenden Änderung (z.B. einer Über-
setzung) unterlegen soll, ist es am besten, einen abweichenden Unter-
verzeichnisnamen zu verwenden, wie es oben unter "Die Struktur des
\help Verzeichnisses" erklärt wurde.
Dies ist einfach durch ein "Suchen und Ersetzen" in der index.htm des
Unterverzeichnisnamens zu erledigen, und es ist es wert.
Zum Beispiel könnte eine abgespeckte Version des "hhstndrd" Daten-
satzes "hhmicro" genannt werden. Das wäre dann auch der Name des
Unterverzeichnisses und der Titel in der index.htm könnte sein:
FreeDOS Hilfe (hhmicro 1.0)
Es ist akzeptabel, nur die Versionsnummer (anstelle des Namens und des
Verzeichnisses "hhmicro") zu verändern, wenn Updates herausgebracht
werden.
Neue Dateien erzeugen oder hinzufügen:
Es wird empfohlen, daß die folgende Lizenzinfo an das Ende jeder neuen
Hilfedatei geschrieben wird (außer es handelt sich um eine allein-
stehende Datei, die nicht in einer Hilfedokumentation enthalten ist):
...
<hr>
<address>
<b>Copyright © 2008
<a href="mailto:meineemail@adresse.com">Mein Name</a></b><br>
Diese Datei bildet einen Teil der FreeDOS HTML Hilfedokumentation
und ist gedeckt durch ihre Bedingungen, siehe auch:
<a href="../index.htm">index.htm</a>
</address>
</body>
</html>
Das Mitliefern einer Email-Adresse ist freiwillig; wenn Sie Ihre
Hilfedateien auf eine Webseite laden, können Email-Adressen zu
Spamzwecken verwendet werden.
Die Bedingungen sind die GNU Free Documentation Lizenz 1.1.
Dateien aus einer .zip-Datei bearbeiten:
Vielleicht wollen Sie die html-Dateien entpacken, damit sie mit einem
anderen Browser gelesen oder mit einem Editor bearbeitet werden können.
Beachten Sie in diesem Fall bitte, daß die Zip-Dateien in der Rangliste
vor den unkomprimierten Dateien stehen; wenn Sie sichergehen wollen,
daß Help eine bearbeitete, unkomprimierte Version einer Datei liest,
sollten Sie die Originalversion dieser Datei innerhalb der Zip-Datei
ersetzen oder löschen.
Hilfedateien testen:
Die Refernzbrowser um Hilfedateien zu testen sind:
* der FreeDOS HTML Hilfe-Betrachter (help.exe),
* ein Chromium Derivat.
Tables erzeugen:
Unglücklicherweise unterstützt Help keine Tabellentags.
Verwenden Sie für Informationstabellen die vorformatierenden
Tags <pre> </pre>
Generelle Tipps:
Drücken Sie F5 oder Strg+R um die von der Hilfe angezeigte Datei zu
aktualisieren. Die Auswirkungen von Änderungen an der Datei werden
sofort angezeigt. Dies ist nützlich, wenn Hilfedateien in einer
windowsartigen Umgebung editiert werden.
Um den HTML Hilfeviewer bei Dateien zu verwenden, die noch nicht in
die Hilfedateien integriert sind, kann der Schalter zum Umgehen des
Hilfepfads verwendet werden:
help /O[Laufwerk:][Pfad]Dateiname[.htm]
oder, wenn relativ zum /HELP Verzeichnis:
help /L[Unterverzeichnis]Dateiname[.htm]
Siehe auch:
Von der HTML Hilfe unterstützte Tags
Quellen des Autors
Copyright © 2003-4 Robert Platt, aktualisiert 2008 und 2020
von W. Spiegl
Diese Datei bildet einen Teil der FreeDOS HTML Hilfedokumentation
und ist gedeckt durch ihre Bedingungen, siehe auch: index.htm