FAQ-Plugin einbinden (Teil 1)

Anleitung: So binden Sie das im Demo-Ordner befindliche FAQ-Plugin für den HTML-Output ein.

Das Einbinden erfolgt in vier Hauptschritten, die anschließend genauer beschrieben werden:

  1. Ein FAQ-XSL-Plugin im Plugin-Ordner anlegen.
  2. Die faq.css in die individuelle CSS-Datei importieren.
  3. Deutsche Bezeichnungen für die englischen Strings in der string-de-de.xml hinterlegen.
  4. Die Datei ditafaq.xml als Vorlagendatei nutzen, um eigene FAQ-Seiten zu erstellen.

Die folgenden Handlungsschritte sind nach der Lektüre von Eliot Kimbers Tutorial zur Spezialisierung entstanden. Untenstehend finden Sie den Link.

  1. Legen Sie im Plugin-Ordner ein neues Verzeichnis org.yourdomain.faq.html an. Ersetzen Sie org.yourdomain mit Ihrem Domainnamen.
  2. Legen Sie im neu erstellten Ordner eine Datei plugin.xml mit folgenden Inhalt an:
    <plugin id="org.yourdomain.faq.html">
      <feature extension="dita.xsl.xhtml" value="xsl/faq2html_shell.xsl" type="file"/>
    </plugin>
    
  3. Erstellen Sie im Ordner org.yourdomain.faq.html einen Unterordner xsl.
  4. Kopieren Sie aus dem Verzeichnis demo/faq folgende 3 xsl-Dateien in den soeben erstellten Ordner plugins/org.yourdomain.faq.html/xsl:
    • faq2html.xsl
    • faq2html_shell.xsl
    • faq2html_shellImpl.xsl
  5. Im DITA-OT 1.5.3 ist noch ein kleiner Bug. Öffnen Sie die Datei faq2html_shell.xsl und ändern Sie folgenden Eintrag:
    <xsl:param name="OUTEXT" select="'hxml'"/>

    bei select um in:

    <xsl:param name="OUTEXT" select="'html'"/>
  6. Öffnen Sie die Datei faq2html_shellImpl.xsl und löschen bzw. kommentieren Sie folgenden Eintrag aus:
    <!-- <xsl:import href="../../xsl/dita2html.xsl"/> -->
  7. Kopieren Sie die Datei demo/faq/faq.css in den Ordner, wo sich Ihre individuelle CSS-Datei befindet.
  8. Tragen Sie in Ihre individuelle CSS-Datei folgenden Import-Befehl zuoberst ein:
    @import url(faq.css);
  9. Fügen Sie in die Datei DITA-OT/xsl/common/string-de-de.xml folgende 3 Übersetzungen hinzu:
    <str name="Question">Frage</str>
    <str name="Answer">Antwort</str>
    <str name="Return to Top">zum Seitenanfang </str>
    
  10. Kopieren Sie die Datei ditafaq.xml in Ihr topic-Verzeichnis, benennen Sie sie um und nutzen Sie diese als Vorlage für Ihre individuellen FAQ-Seiten. Binden Sie neue FAQ-Topics in die die ditamap ein. Benutzen Sie dabei das Attribut type=”faq”.

Sie können jetzt neue Fragen-und-Antworten-Seiten nach Ihren CSS-Dateien erstellen und gestalten. Allerdings haben Sie noch nicht die Möglichkeit, Elemente der User Interface Domain wie z.B. <uicontrol> zu nutzen. Die Einbindung dieser Domains (Software, User Interface und Programming Domain) erfolgt in Teil 2.)