Dokumentation von Software Darwin Information Typing Architecture DITA

Inhalt o DITA n n n Namensgebung Geschichte DITA Open Toolkit Zielsetzung Architektur, Elemente

Darwin Information Typing Architecture DITA o DITA ist eine XML-basierte Informationsarchitektur für die Erstellung,

Namensgebung DITA o DITA Darwin: n n o DITA Information Typing: n o Vererbungslehre,

Geschichte von DITA o o o Entwicklung begann in den 90 er Jahren bei

DITA Open Toolkit o o o o Gehört nicht zum OASIS Standard Open Source

Zielsetzung bei der Entwicklung von DITA o o o Bereitstellung von Informationen für die

Definitionen o o o Topic n Durch Titel und Inhalt bestimmte Informationseinheit n Eigenständig,

Topic - zentrales Informationsobjekt in DITA o Generisches Topic n o Konzept n o

Topic Beispiel <? xml version="1. 0" encoding="utf-8"? > <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN„

Domain o o Thematisch zusammengefasste Elemente zur Auszeichnung von Topic-Inhalten nicht auf einen bestimmten

Map – Organisation von Topics o o o 12. 2007 Enthält nur Topic. Referenzen

Map Beispiel <? xml version="1. 0" encoding="utf-8"? > <!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN„

Spezialisierung o o 12. 2007 Ergänzung und Erweiterung bestehender Informationsstrukturen Mögliche Spezialisierung für: n

Zielgruppenmetainformation o Erweiterung im Topic: <p audience="linux"><image href=". . /image/linux. jpg" alt="infopoint"/></p> o Erweiterung

Vordefinierte Stylesheets o o o HTML XHTML PDF Doc. Book Java. Help Eclipse 12.

XML Editoren o Konfiguration für DITA schon im Lieferumfang: n n Frame. Maker XMetal

System-Voraussetzungen o o o Java Development Kit Ant SAXON oder Xalan XSLT processor 12.

Vor- und Nachteile o o Vorteile n Erstellung von Topics danach erst Übergang als

Quellen o o o o DITA Open Toolkit: http: //dita-ot. wiki. sourceforge. net Portal

Slides: 20

Download presentation

Dokumentation von Software Darwin Information Typing Architecture DITA Info. Point 12. 2007 Silver Scherrer 1

Inhalt o DITA n n n Namensgebung Geschichte DITA Open Toolkit Zielsetzung Architektur, Elemente Vor- und Nachteile 12. 2007 Dokumentation von Software Silver Scherrer 2

Darwin Information Typing Architecture DITA o DITA ist eine XML-basierte Informationsarchitektur für die Erstellung, Verteilung und Wiederverwendung (DRY) von Informationen. 12. 2007 Dokumentation von Software Silver Scherrer 3

Namensgebung DITA o DITA Darwin: n n o DITA Information Typing: n o Vererbungslehre, Evolutionstheorie Spezialisierung durch Vererbung Typisierung der Informationen in Topics (Gegenstand, Themengebiet) DITA Architecture: n n Nicht nur Informationen über Struktur (DTD) Regeln für Wiederverwendbarkeit Regeln für Verarbeitung Regeln für Anpassung an eigene Bedürfnisse 12. 2007 Dokumentation von Software Silver Scherrer 4

Geschichte von DITA o o o Entwicklung begann in den 90 er Jahren bei IBM Ablösung von SGML (Structured Generalized Markup Language) 2001 DITA: An XML-based Technical Authoring and Publishing Architecture Mai 2005: OASIS Standard Version 1. 0 n OASIS (Organization for the Advancement of Structured Information Standards) = Non-Profit. Organisation n Beschäftigt sich mit der Entwicklung von E-Business. Standards Mai 2007: OASIS Standard Version 1. 1 n Erweiterung zur Erstellung von Büchern (bisher vor allem in Online-Help stark) 12. 2007 Dokumentation von Software Silver Scherrer 5

DITA Open Toolkit o o o o Gehört nicht zum OASIS Standard Open Source Projekt Zentraler Baustein von DITA Java-basierte Entwicklungsumgebung Umformung DITA XML-Dateien zu HTML oder PDF Aktuelle Version: 1. 4. 1 DTD‘s, XSL-Stylesheets, Ant Build-Dateien, dost. jar, Beispiele, Dokumentation 12. 2007 Dokumentation von Software Silver Scherrer 6

Zielsetzung bei der Entwicklung von DITA o o o Bereitstellung von Informationen für die unterschiedlichsten Zielgruppen, Medien und Formate passende Informationen zur passenden Zeit, im richten Format und an die richtige Person Nutzer bekommt nur Informationen, die er benötigt Trend zum Minimalismus Flexible Informationsarchitektur für schnelle Erweiterungen und Ergänzungen Nicht zu komplexe Informationsarchitektur Verwendung bekannter Technologien n n o XML als Datenformat Elementnamen bekannt aus HTML Single Source Publishing (SSP) 12. 2007 Dokumentation von Software Silver Scherrer 7

Definitionen o o o Topic n Durch Titel und Inhalt bestimmte Informationseinheit n Eigenständig, in sich abgeschlossene Informationen Map n Gesammelte und organisierte Referenzen zu Topics Spezialisierung n Definition neuer Informationstypen (Topics) Integration n Erstellung neuer Dokumententypen aus der Kombination verschiedener Module Anpassung n Ergebnisoutput in unterschiedlicher Form 12. 2007 Dokumentation von Software Silver Scherrer 8

Topic - zentrales Informationsobjekt in DITA o Generisches Topic n o Konzept n o Handlungsanweisungen Referenz n 12. 2007 Begriffsdefinitionen Aufgabe n o Konzepte, Begriffe Glossar n o Basistyp Tabellen, Parameterlisten Dokumentation von Software Silver Scherrer 9

Topic Beispiel <? xml version="1. 0" encoding="utf-8"? > <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN„ ". . /dtd/task. dtd"> <task id="softwaredocumentation" xml: lang="de-de"> <title>Dokumentation von Software</title> <prolog></prolog> <taskbody> <context>Darwin Information Typing Architecture DITA Agenda</context> <steps> <step><cmd>Namensgebung</cmd></step> <step><cmd>Geschichte</cmd></step> <step><cmd>DITA Open Toolkit</cmd></step> <step><cmd>Zielsetzung</cmd></step> <step><cmd>Architektur</cmd></step> </steps> </taskbody> <related-links> <link href=". . /concepts/dita. xml" format="dita" type="concept"><linktext>DITA</linktext> </link> <link href=". . /concepts/ditavsdocbook. xml" format="dita" type="concept"><linktext>DITA vs Doc. Book</linktext></link> </related-links> </task> 12. 2007 Dokumentation von Software Silver Scherrer 10

Domain o o Thematisch zusammengefasste Elemente zur Auszeichnung von Topic-Inhalten nicht auf einen bestimmten Topictyp beschränkt Insgesamt 7 Domains Beispiele: n indexing-Domain: Indexeinträge n highlighting-Domain: ausschließlich typografische Auszeichnung wie z. B. -Element für die Auszeichnung von Inhalten in Fettschrift n programming-Domain: Beschreibung von Programmiersprachen n software-Domain: Operationen von Software. Programmen n user interface-Domain: z. B. Menüs oder Fensternamen 12. 2007 Dokumentation von Software Silver Scherrer 11

Map – Organisation von Topics o o o 12. 2007 Enthält nur Topic. Referenzen Wiederverwendung von Inhalten Spezialisierung: Bookmap mit speziellen Buch. Spezifikas (Titelseite, Vorwort, etc. ) Dokumentation von Software Silver Scherrer 12

Map Beispiel <? xml version="1. 0" encoding="utf-8"? > <!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN„ ". . /dtd/map. dtd"> <map title="Info. Point"> <topicmeta><author>Silver Scherrer</author> <copyright> <copyryear="2007"></copyryear> <copyrholder>@Info. Point</copyrholder> </copyright> </topicmeta> <topicref href="tasks/infopointthemeoverview. xml" type="concept"> <topicref href="tasks/softwaredocumentation. xml" type="task"> <topicref href="tasks/ditanamensgebung. xml" type="task"/> </topicref> <topicref href="tasks/microsoftdotnet. xml" type="task"/> <topicref href="tasks/hybernate. xml" type="task"/> <topicref href="tasks/struts. xml" type="task"/> <topicref href="tasks/rubyonrails. xml" type="task"/> <topicref href="tasks/javaserverfaces. xml" type="task"/> </topicref> <topicref href="concepts/infopointconceptsoverview. xml" type="concept"> <topicref href="concepts/dita. xml" type="concept"></topicref> <topicref href="concepts/docbook. xml" type="concept"></topicref> </map> 12. 2007 Dokumentation von Software Silver Scherrer 13

Spezialisierung o o 12. 2007 Ergänzung und Erweiterung bestehender Informationsstrukturen Mögliche Spezialisierung für: n Topictypen n Maptypen n Domains n Domain-Attribute Ähnlichkeit zur OO-Vererbung Keine Anpassung der XSLStylesheets nötig Dokumentation von Software Silver Scherrer 14

Zielgruppenmetainformation o Erweiterung im Topic: <image href=". . /image/linux. jpg" alt="infopoint"/> o Erweiterung um ditaval-Datei: Bsp: linux_user. ditaval <? xml version="1. 0" encoding="ISO-8859 -1" ? > <val> <prop att="audience" val="linux" action="include"/> <prop att="audience" val="windows" action="exclude"/> </val> o Erweiterung in build-Datei: <property name="dita. input. valfile" value="linux_user. ditaval"/> 12. 2007 Dokumentation von Software Silver Scherrer 15

Vordefinierte Stylesheets o o o HTML XHTML PDF Doc. Book Java. Help Eclipse 12. 2007 Dokumentation von Software Silver Scherrer 16

XML Editoren o Konfiguration für DITA schon im Lieferumfang: n n Frame. Maker XMetal Epic XMLSpy … 12. 2007 Dokumentation von Software Silver Scherrer 17

System-Voraussetzungen o o o Java Development Kit Ant SAXON oder Xalan XSLT processor 12. 2007 Dokumentation von Software Silver Scherrer 18

Vor- und Nachteile o o Vorteile n Erstellung von Topics danach erst Übergang als Sammlung in Bücher n Gruppieren von kontextsensitiven Informationen n Erweiterbare Menge n Gleiche Informationseinheiten für unterschiedliche Zielgruppen n Gratis n Viele Firmen setzen in Zukunft auf DITA n Viele unterschiedliche Output-Formate im Standard Nachteile n Prototyp 12. 2007 Dokumentation von Software Silver Scherrer 19

Quellen o o o o DITA Open Toolkit: http: //dita-ot. wiki. sourceforge. net Portal für technische Dokumentation: http: //www. doku. info Fragen zu DITA: http: //www. documanager. de/magazin/artikel_1300_dita_darwi n_information_typing_architecture. html DITA-Buch: http: //www. dita-buch. de Wikipedia: http: //www. wikipedia. ch/ Glawe, Gernot: DITA Open Toolkit: Einer für alle; Entwickler Magazin 6. 07 Closs, Sissi: Single Source Publishing; entwickler. press 2007 Erfolgreiche Umsetzungsmöglichkeiten: http: //www. comet. com 12. 2007 Dokumentation von Software Silver Scherrer 20