XML-Schemas dokumentieren

Eins meiner selbstgeschriebenen Windows-Programme liest seine Konfiguration aus einer XML-Datei. Nun würde ich für die Anwender gerne eine Referenz (in HTML für die Programm-Webseite) erstellen, die zeigt, wofür welche Parameter gut sind. Wie kann ich vorgehen?

Da man die Validität einer XML-Datei üblicherweise anhand eines XML-Schemas überprüft, liegt es nahe, eben dieses Schema der Dokumentation zugrunde zu legen. Darin definierte Elemente oder Typen kann man mit einer Beschreibung versehen, im folgenden Beispiel das Element <config>:

<xsd:element name="config" type="configType">
  <xsd:annotation>
    <xsd:documentation>
      CONFIG ist das Wurzelelement der XML-Konfigurationsdatei.
    </xsd:documentation>
  </xsd:annotation>
</xsd:element>

Um daraus ein HTML-Dokument zu generieren, bietet sich die Transformation mit Hilfe eines XML-Stylesheets (XSL) an, etwa des über den Soft-Link erhältlichen „xs3p“. Als XSL-Prozessor kann man das Programm msxsl.exe von Microsoft verwenden (Download ebenfalls via Soft-Link). Um es benutzen zu können, müssen Sie gegebenenfalls zuvor noch Microsofts XML Core Services ab Version 4 installieren.

Befindet sich das Schema zum Beispiel in der Datei config.xsd und das Stylesheet in xs3p.xsl, so erzeugt der Aufruf von

msxsl config.xsd xs3p.xsl > config-ref.html

die gewünschte Referenz in der Datei config-ref.html.

Soft-Link (ola)