Das TCHELP-Format ist ein XML-Dokument, dessen Inhalt zur strukturierten Darstellung von Hilfetexten genutzt wird. Der grundlegende Aufbau ist wie folgt:
<tchelp author="Max Mustermann" version="1.0">
<lang lang="de">
<description>Hilfe für die Hauptanwendung</description>
<section name="Einleitung">
Dies ist der Inhalt des Einleitungs-Abschnitts.
</section>
<section name="ErsteSchritte">
Inhalt für die ersten Schritte...
</section>
</lang>
<lang lang="en">
<description>Help for the main application</description>
<section name="Introduction">
This is the content of the introduction section.
</section>
</lang>
<link page="Anhang" />
<link page="Support" />
</tchelp>
Detaillierte Beschreibung der XML-Struktur
Die XML-Struktur dient der multilingualen Gliederung von Hilfetexten. Jedes Element und Attribut hat dabei eine spezifische Funktion, um die Inhalte klar und hierarchisch zu organisieren.
Das Wurzelelement des Dokuments ist <tchelp>
. Es umschließt den gesamten Inhalt und muss die obligatorischen Attribute author und version enthalten, um Metadaten über den Ersteller und die Versionsnummer der Hilfedatei festzuhalten.
Innerhalb des <tchelp>
-Elements können eine oder mehrere <lang>
-Sektionen definiert werden. Jedes <lang>
-Element repräsentiert eine spezifische Sprache (z. B. "de" oder "en"), die über das Attribut lang festgelegt wird. Es muss ein <description>
-Tag enthalten, das eine kurze Beschreibung der Hilfe in der jeweiligen Sprache liefert.
Jedes <lang>
-Element wiederum kann mehrere <section>
-Elemente enthalten. Ein <section>
-Block repräsentiert einen einzelnen Abschnitt der Hilfe, dessen Name durch das Attribut name definiert wird, und beinhaltet den eigentlichen Inhalt.
Direkt innerhalb des <tchelp>
-Elements können beliebig viele <link>
-Elemente platziert werden. Diese dienen dazu, auf andere Hilfeseiten oder Dokumente zu verweisen, wobei das Attribut page den Namen der Zieldatei (ohne Endung) angibt.