DITA

• ein von der OASIS herausgegebener Standard

• steht für “Darwin Information Typing Architecture”

• verwendet XML, unabhängig von fest vorgegebenen Werkzeugen

• dient zum Erzeugen und Verwalten von Inhalten

XML-basierter Standard zur Strukturierung und Verarbeitung von (technischen) Dokumenten

• Nutzung von Topics

  • Topic sollte eine abgeschlossene Informationseinheit umfassen -> Grundlage für Wiederverwendbarkeit

• Trennung von Inhalt und Formatierung

• Strukturiertes Arbeiten

• Minimalismus

• Strukturierte Erstellung von Inhalten ermöglicht konsistente Bereitstellung und Verarbeitung von Informationen

• DITA unterstützt das Prinzip durch speziellen Satz von jeweils verfügbaren (verpflichtenden oder optionalen) Elementen und möglicher Verschachtelung

• strukturelle Regeln müssen eingehalten werden (Validierung) -> dadurch Inkonsistenzen vermeiden

• Basiseinheiten zur Erstellung und Wiederverwendung

• beim Topic-basierten Schreiben wird größere Anzahl von individuellen Einheiten erzeugt

• alle DITA-Topics müssen mindestens ein title-Element und ein id-Attribut beim Wurzelelement besitzen

minimales Topic:

• soll einzelne Idee umfassen oder einzelne Frage beantworten

• genügend Informationen enthalten, um eigenständig zu sein

• keinen Kontext annehmen (keine Aussagen über Vor- oder Nachstehende Topics)

• einzelne Datei = einzelnes Topic

• allgemeine Topics

• ggf. zur späteren Verfeinerung in die Typen concept, task, reference

• beantworten die Frage warum (etwas zu tun ist)

• vermitteln Hintergrundinformationen zu einem Thema, die zu Verständnis benötigt werden

• Für Handlungsanweisungen, beschreiben das Wie (ausführen)

• Abfolge von Schritten mit (optionalen) Teilergebnissen und dem (optionalen) Endergebnis

Unterscheidung:

-> Strict Tasks (Reihenfolge von Bedeutung) <steps>

-> General Tasks (flexiblere Anordnung von Schritten) <steps-unordered>

• beantworten die Frage Was (ist vorhanden/nutzbar)

• beinhalten

  • beschreibende Fakten

  • Syntax eines Kommandos oder einer API-Funktion (Programmierschnittstellen)

  • Tabellen mit Daten

• keine Schritte oder Hintergrundinformationen, nur Fakten

• Beantworten die Frage nach Bedeutung

• vermitteln Hintergrundinfos, die zum Verständnis benötigt werden

• Informationen über Information (Angabe zu Topicinhalten)

Blockelemente

• erstrecken sich über gesamte Breite

• erzeugen Zeilenumbruch

• zb. p (paragraph), li (list item), codeblock (Quellcode)

Inline-Elemente

• kapseln nur bestimmten Teil innerhalb von Block-Elementen

• zb. b (bold), i (italic), xref (Cross-Referenz/Link)

• Element fig + image

  • image für Bildverweis

  • alt-element für Alternativtext

  • p für Bildunterschrift

  • image kann auch eigenständig (inline) verwendet werden

• xref-element

• interne/externe Referenzen innerhalb von Blockelementen

• Attribut format mit Werten wie html, pdf, dita

• Attribut href für Ziel

• Attribut scope mit Werten external, local oder peer (=Ressource noch nicht verfügbar)

• <related-links> mit Kindelementen <link> möglich

• ungeordnete/geordnete Listen aus HTML übernommen

  • ul-Elemente mit li-Kindelementen

  • ol-Elemente mit li-Kindelementen

  • Verschachtelung von Listen innerhalb von li möglich

• Mit dem note-Element und dessen type-Attribut

  • attention

  • caution

  • danger

  • important

  • note (vorgabewert, kann entfallen)

  • notice

  • restriction

  • tip

mit Maps

• ermöglichen hierarchische Ordnung der Topics für Ausgaben

  -> liefern somit Inhaltsstruktur

• map-elemente enthalten hauptsächlich topicref-Elemente

  -> diese lassen sich weiter verschachteln/ verzweigen

• Glossar-Einträge können mit glossref zusammengeführt werden

• (Teile von) Topics können in anderen wiederverwendet oder in unterschiedlichen Maps abgerufen werden

• mit conref kann auf andere Topics zugegriffen werden

• Informationsarchitekten in Firma können von DITA bereitgestellten Elemente und Attribute an eigene Bedürfnisse anpassen

  • Erzeugung neuer Elemente mit Inhalten in bestimmter Abfolge

  • Erzeugung neuer Attribute mit spezifischen Inhalten

  • Anpassung von Elementnamen an bestimmte Erfordernisse

  • Constraints erlauben Entfernen nicht benötigter oder unerwünschter Elemente

• mit dem freien DITA Open Toolkit (DITA-OT) oder anderen Werkzeugen

  • ist Java-Basiert

  • ermöglicht u.a. die Produktion von HTML, PDF, HTML Help, WebHelp, DocBook, Word RTF ….

  • Anpassbar an eigene CI nach entsprechender Einarbeitung

XML-Basis für Auszeichnungen

• Elemente wie <p>

• Attribute wie <note type=”warning”>

• Topics, Wurzelelemente variieren je nach Topic-Typ: topic für allgemeine Inhalte, task für Aufgaben/ Handlungsanweisungen, concept für Hintergründe/ Kontexte, reference für Details oft in Tabellenform