S1000D

Die Spezifikation S1000D “International specification for technical publications using a common source database” ist weltweit ein XML Schema für Technische Dokumentation in den Bereichen Luftfahrt und Wehrmaterial. Herausgeber sind auf europäischer Seite die ASD (AeroSpace and Defence Industries Association of Europe, Brüssel) als Nachfolgeorganisation der AECMA, auf US-amerikanischer Seite die AIA (Aerospace Industries of America) und die ATA (Air Transport Association of America, Inc).

Es handelt sich hierbei um eine Spezifikation für die Erstellung technischer Dokumentation. S1000D basiert auf internationalen Standards die vom W3C festgelegt sind. Die Extensible Markup Language (XML) für Text, das Computer-Graphics-Metafile-Format (CGM) für 2D-Illustrationen und die Virtual Reality Modeling Language (VRML) für 3D-Animationen sind Beispiele hierfür.

Die Textanteile der zu erstellenden Dokumentation, sowie alle Grafiken, werden in einer gemeinsamen Quelldatenbank (common source database) gespeichert. Dies ist der „Speicher“ für die Aufbewahrung und Verwaltung von Datenmodulen. Die S1000D definiert jedoch nicht seine Funktionalität oder anderes. Sie besagt lediglich, dass es erforderlich ist, die in einem Programm erzeugten Datenmodule zu speichern und zu verwalten.[1]

Verfügbarkeit

Die S1000D-Spezifikation in englischer Sprache kann auf der Webseite der S1000D kostenlos heruntergeladen werden.[2] Die S1000D ist in 12 Ausgaben verfügbar von Ausgabe 1.7 bis Ausgabe 5.0, mit entsprechenden Zwischenausgaben.

Einige ältere Ausgaben der Spezifikation stehen auch in deutscher Sprache zum Download zur Verfügung.

Geschichte

Vor Ausgabe 2 wurden Aktualisierungen der Spezifikation als Änderungen bezeichnet. Als der Standard Change 9 erreichte, wurde die vorgeschlagene Änderung 10 zu Issue 2.0, wobei frühere Changes als Issue 1.x retro bezeichnet wurden. Issue 1.6 war die erste öffentlich veröffentlichte Version von S1000D und war die erste Ausgabe, die sowohl Operator-Informationen (Crew) als auch Inhalte für Betreuer enthielt.

Änderungsgeschichte der S1000D
Ausgabe Datum Auszeichnungssprache Änderung
1.6 31. März 1995 SGML-DTD

nicht zum Download verfügbar

1.7 01. Februar 1998 SGML-DTD 1.7.1 vom 2. Juli 1998 (führt die IPRF-DTD ein)
1.8 31. Januar 1999 SGML-DTD 1.8.1 vom 31. Mai 2000 (diverse DTD-Änderungen)
1.9 01. April 2001 SGML/XML DTD
2.0 31. Mai 2003 SGML/XML DTD, XML schema Es gibt einen Patch-Ordner, aber keinen offiziellen nummerierten Patch und er enthält nur ein aktualisiertes Datenwörterbuch.
2.1 29. Februar 2004 SGML/XML DTD, XML schema
2.2 01. Mai 2005 SGML/XML DTD, XML schema 2.2.1 vom 01. Mai 2006 (nur XML-Schema)
2.3 28. Februar 2007 SGML/XML DTD, XML schema 2.3.1 vom 01.02.2009 (diverse Schemaprobleme behoben)
3.0 31. Juli 2007 SGML/XML DTD, XML schema 3.0.1 vom 01.02.2009 (diverse Schemaprobleme behoben)
4.0 01. August 2008 XML schema 4.0.1 vom 12. Mai 2009 (umfangreiche Änderungen, aktualisierte BREX)

4.0.2 vom 09.10.2013 (diverse Änderungen, BREX aktualisiert)

4.1 31. Dezember 2012 XML schema 4.1.A vom 7. Nov. 2014 (korrigiert Fehler im Crew-Schema, der IPD-Fig-Nummer und BREX-Problemen)

4.1.B vom 30. Juni 2017 (aktualisierte BREX-Regeln)

4.1.C vom 12. Mai 2020 (fügt fehlende Warn- und Warn-CIR-InfoCodes wieder hinzu)

4.1.D vom 27. Apr 2023 (.swf Dateien in den Bike-Daten durch .gif ersetzt)

4.2 31. Dezember 2016 XML schema 4.2.A vom 31. Mai 2019 (nur Spezifikation; keine Schemaänderungen)
5.0 28. Juni 2019 XML schema 5.0.A vom 01. Nov. 2019 (nur Spezifikation; keine Schemaänderungen)

5.0.B vom 29. September 21 (nur Aktualisierung des Datenwörterbuchs)

6.0 01. September 2024 XML Schema Möglichkeiten für Referenzen

Einführung eines neuen SVG-Profils

Einführung eines neuen, modernisierten S1000D-Logos

neue S1000D-Ausgabenummern-Konvention

S1000D stellt keine Software-Tools zur Erstellung oder Verteilung von Inhalten in Übereinstimmung mit dem Standard zur Verfügung und unterstützt diese auch nicht. Es wird nur das reine XML Schema beschrieben.

Deutschland

Da S1000D eine internationale Spezifikation ist, hat die Bundeswehr gemeinsam mit der Industrie den Arbeitskreis Beschreibende Technische Dokumentation (AK BTD) gebildet, um nationale Bedürfnisse und Interessen zu erkennen und diese an das internationale S1000D-Gremium in Form von Änderungsanträgen weiterzuleiten. Ziel ist die Weiterentwicklung sowie Auslegung der Spezifikation zugunsten nationaler Anforderungen und Anwendungen.[3]

Software

In der Praxis sind einzelne S1000D-Komponenten (Datenmodule, Abbildungen etc.) als Rohdaten nur schwer lesbar, da sie als Austauschformat gedacht sind. Deshalb verwenden S1000D-Redakteure und -Nutzer zur Erstellung, Bearbeitung und Anzeige von S1000D-Inhalten verschiedene Software. Einige der meistgenutzten Anwendungen werden hier aufgelistet:

Autorensoftware

  • Oxygen XML Editor with S1000D Framework
  • R4i Writer
  • Antenna House Formatter
  • XMetaL
  • S-Tools

Anzeige-Software

  • Arbortext® IETP Viewer for S1000D
  • Libroplanta S1000D IETD Viewer
  • R&S® IETDView
  • R4i Viewer
  • SDL LiveContent S1000D

Siehe auch

  • AECMA
  • SGML bzw. XML
  • Computer Graphics Metafile
  • ASD
  • Technical Publications Specification Maintenance Group (TPSMG)
  • Webseite der S1000D

Einzelnachweise

  1. S1000D Council and Steering Committee: About S1000D – S1000D. In: S1000D. S1000D Council and Steering Committee, 2024, abgerufen am 9. September 2024 (amerikanisches Englisch, Absatz: Common Source Data Base (CSDB)). 
  2. S1000D Org: S1000D Downloads. In: S1000D. ASD, AIA, A4A, 2024, abgerufen am 21. August 2024 (englisch). 
  3. Arbeitskreis Beschreibende Technische Dokumentation: Willkommen auf der Internetpräsenz des AK BTD. In: Wayback Machine. Logistikkommando der Bundeswehr Abteilung Planung III 2 - Standards und Spezifikationen, 16. Dezember 2021, archiviert vom Original; abgerufen am 21. August 2024 (Originalseite nicht mehr erreichbar).