Das TCHELP-Format

Das TCHELP-Format ist ein XML-Dokument, dessen Inhalt zur strukturierten Darstellung von Hilfetexten genutzt wird. Es ermöglicht eine saubere Trennung von Inhalten, Sprachen und Metadaten.

Grundlegender Aufbau

<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>
        </lang>
        <link page="Support" />
</tchelp>

Die XML-Elemente

  • <tchelp>: Das Wurzelelement. Es enthält die Pflichtangaben author und version.
  • <lang>: Definiert eine Sprachsektion (z. B. "de" oder "en") und enthält eine <description>.
  • <section>: Ein Inhaltsblock innerhalb einer Sprache, identifiziert durch ein name Attribut.
  • <link>: Verweist auf andere Hilfeseiten über das page Attribut.