Grundlagen von XML für Techn. Redakteure Teil 1

Transkript

1 Grundlagen von XML für Techn. Redakteure Teil 1 mit Beispielen aus der Praxis Dipl.-Ing. Ute Mitschke, MITeinander Verlag, Berlin Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 1/24

2 Überblick: Grundbegriffe Was ist eine Markup Language Was ist ein Element Was ist ein Attribut Was ist eine DTD Syntax der Inhaltsmodelle Wozu gibt es ein XML-Schema Zutaten für eine XML-Anwendung mit FrameMaker Entwicklung einer DTD auf Basis von Funktionsbausteinen Erstellen von Read/Write-Rules passend zur DTD Import der DTD als FrameMaker-EDD Ergänzen von Formatierungsregeln in die EDD Importieren der Elementdefinitionen in ein neues Dokument Bearbeiten des Dokuments als Vorlage Erstellen der Dokumente in FrameMaker Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 2/24

3 Grundbegriffe Was ist eine Markup Language Wie wird Text üblicherweise publiziert formatiert. Titel Placebo 500 xml-resistent, FM Hervorhebung Standard Zusammensetzung: Kreide, Minze, Zucker Darreichungsform und Inhalt: Originalpakkung mit 50 (N2) Tabletten Anwendungsgebiete: Husten, Heiserkeit, Müdigkeit während und nach der Lektüre von Fachliteratur Gegenanzeigen: Keine bekannt Was ist bei Kindern zu beachten? Übermäßiger Verzehr leert den Inhalt der Packung zu schnell Vorsichtsmassnahmen: Vor Kindern ge- Dosierungsanleitung: ben, jedoch nicht wenige te empfohlen. Dosierung für Kinder un keine Einnahme nach 2 Einnahme nicht empfoh Nebenwirkung: wirkt b me von starkem Kaffee Wichtige Hinweise: Do legen, färbt beim Zertre Stand der Information Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 3/24

4 Wie wird Text inhaltlich gekennzeichnet Element Titel Placebo 500 xml-resistent, Element Zusammensetzung Element Darreichungsform Element Anwendungsgebiete Element Gegenanzeigen Element Vorsichtsmassnahmen Element Wechselwirkung Zusammensetzung: Kreide, Minze, Zucker Darreichungsform und Inhalt: Originalpakkung mit 50 (N2) Tabletten Anwendungsgebiete: Husten, Heiserkeit, Müdigkeit während und nach der Lektüre von Fachliteratur Gegenanzeigen: Keine bekannt Was ist bei Kindern zu beachten? Übermäßiger Verzehr leert den Inhalt der Packung zu schnell Vorsichtsmaßnahmen: Vor Kindern geschützt aufbewahren, längere Einnahme führt zu Suchtverhalten Wechselwirkung: keine bekannt Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 4/24

5 Elementstruktur Teil 1 Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 5/24

6 Elementstruktur Teil 2 Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 6/24

7 Elementstruktur Teil 3 oder in einer XML-Text-Darstellung <beipackzettel sprache = "de"><titel>placebo 500 xml-resistent, FM</titel> <zusammensetzung> <inhaltsstoff sprachechem = "de">kreide, </inhaltsstoff> <inhaltsstoff sprachechem = "de">minze, </inhaltsstoff> <inhaltsstoff sprachechem = "de">zucker</inhaltsstoff></zusammensetzung> Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 7/24

8 Was ist ein Element Container mit einer konkreten Bezeichnung für einen bestimmten Inhalt Schreibweise: <Name> Inhalt </Name> Enthält: z. B. Text-Daten (#PCDATA = Parsable Character Data) andere Elemente Verweise auf andere Dokumentteile (Entitäten) Steht mit anderen Elementen in einer vordefinierten Struktur in Beziehung Eltern-Kind-Beziehung Vorgänger-Nachfolger-Beziehung Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 8/24

9 Was ist ein Attribut Ein Attribut ist ein Kennzeichen innerhalb eines Elements Dient zum Anbringen von Metadaten <BA Version= 1.02 Erstellungsdatum= > Zur Ergänzung eines konkreten Kontext mit inhaltlicher Relevanz <Dokument Teil= Montage > <Warnung Warnart= Gefahr > Informationen, die für Inhaltsbestandteile formal wichtig sind, jedoch nicht eigentlich informativen Inhalt bilden <Liste Listenart= Anstrich > <Bild Breite= 2 cm Länge= 3 cm Datei= Bild.jpg > Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 9/24

10 Was ist eine DTD Document Typ Definition mit der Dateiendung *.dtd Datei in vorgeschriebender Syntax zur Festlegung der Element- und Attributnamen und deren Inhaltsmodellen Inhaltsmodell: <!ELEMENT Dokument (Titel, Anweisungsblock+, Quelle) > <!ATTLIST Dokument Date CDATA #IMPLIED Creator CDATA #IMPLIED Teil (Montage Inbetriebnahme Bedienung Anwendung Instandhaltung Ausserbetriebnahme VerpackTransportLager Entsorgung ) #REQUIRED > Inhaltsmodell des Elements Attributdefinition für Textinhalte Attributdefinition mit Auswahlliste Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 10/24

11 Syntax der Inhaltsmodelle EMPTY für keinen Inhalt ANY für beliebigen Inhalt, für Reihenfolge Adresse (Name, Strasse, Ort) für Alternative (entweder...oder) Adresse (Strassenadresse Postadresse) ( ) zum Gruppieren * Stern für keinmal oder beliebig oft + Pluszeichen für einmal oder beliebig oft (Titel, Kapitel+)? Fragezeichen für kein/genau einmal (Titel?,Vorname,Nachname) Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 11/24

12 Wozu gibt es ein XML-Schema XML-Schema ist eine komplexe Sprache zur Beschreibung eines XML-Typsystems. Dieses XML-Typsystem umfasst die Spezifikation neuer XML- Elemente, deren Attribute, sowie deren Kindelemente. Ein konkretes XML-Schema wird auch als eine XSD (XML-Schema-Definition) bezeichnet und hat die Dateiendung *.xsd. Es ist möglich die Inhaltsmodelle so zu konkretisieren, dass eine Valuierung der Inhalte möglich ist z.b. ob ein Datum-Element wirklich einen Text mit einer Datum-Struktur enthält. Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 12/24

13 Vorteile strukturierter Dokumente Die Verwendung und Einführung von strukturierten Dokumenten ist immer mit einem vergleichsweise hohen Startaufwand verbunden. Dieser Aufwand wird jedoch durch folgende Vorteile gerechtfertigt: XML-Dokumente sind plattformneutral Strukturierte Dokumente besitzen ein einheitliches Erscheinungsbild Durch formatunabhängige Regeln für die Struktur von Dokumenten ist ein einheitlicher und konsistenter Aufbau der Dokumente gewährleistet Strukturierte Dokumente besitzen durch die vorgegebene Struktur praktisch eine Checkliste für den Redakteur, damit Teile nicht vergessen werden. Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 13/24

14 FrameMaker unterstützt den Redakteur bei der Erstellung der Dokumente durch einen kontextsensitiven Elementkatalog Gut strukturierte Dokumente ermöglichen eine wesentlich effizientere Recherchemöglichkeit von Informationen Bestandteile strukturierter Dokumente sind wiederverwendbar Strukturierte Dokumente sind medienneutral aufgebaut Strukturierte Dokumente trennen Form und Inhalt von Dokumenten und erlauben damit eine portable Darstellung des Inhalts und dessen leichtere Übersetzung Formate werden automatisch und kontextabhängig auf Inhalte zugewiesen - der Redakteur kann sich auf den Inhalt konzentrieren. Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 14/24

15 Zutaten für eine XML-Anwendung mit FrameMaker 1 DTD Für Adobe FrameMaker 1 EDD, 1 R/W-Rules-Datei, 1 Template und 1 Eintrag in structapps.fm Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 15/24

16 Entwicklung einer DTD auf Basis von Funktionsbausteinen Dokument Teildokumente eines Handbuchs für verschiedene Anwendungsfälle Bedienung Allgemeine Sicherheitshinweise Montage Außerbetriebnahme usw. Funktionsbaustein Anweisungsblock mit den Elementen Titel Aufforderung (Absätze und Listen) Warnung (Symbol, Gefahrenquelle, Folgen, Maßnahmen) Folgen/Maßnahmen wiederum (Absätze und Listen) Resultat (Absätze und Listen) Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 16/24

17 Erstellen von Read/Write-Rules passend zur DTD element "Dokument" { is fm element "Dokument"; attribute "Date" is fm attribute "Date"; attribute "Creator" is fm attribute "Creator"; attribute "Teil" { is fm attribute "Teil"; value "Montage" is fm value "Montage"; value "Inbetriebnahme" is fm value "Inbetriebnahme"; value "Bedienung" is fm value "Bedienung"; value "Anwendung" is fm value "Anwendung"; value "Instandhaltung" is fm value "Instandhaltung"; value "Ausserbetriebnahme" is fm value "Ausserbetriebnahme"; value "VerpackTransportLager" is fm value "VerpackTransportLager"; value "Entsorgung" is fm value "Entsorgung"; } } Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 17/24

18 Einrichten einer XML-Applikation Menü Datei > Strukturierungswerkzeuge > Anwendungsdatei bearbeiten Wichtig! Nach dem Sichern ausführen: Menü Datei > Strukturierungswerkzeuge > Anwendungsdatei lesen Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 18/24

19 Import der DTD als FrameMaker-EDD Menü Datei > Strukturierungswerkzeuge > DTD öffnen Dazu muss vorher eine XML-Applikation eingerichtet worden sein. Ergänzen von Formatierungsregeln in die EDD Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 19/24

20 Importieren der Elementdefinitionen in ein neues Dokument Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 20/24

21 Bearbeiten des Dokuments als Vorlage Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 21/24

22 Erstellen der Dokumente in FrameMaker Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 22/24

23 Dabei entsteht geführt die Dokumentstruktur Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 23/24

24 Fragen? Sind willkommen! am besten direkt oder oder Vortragsunterlagen finden Sie auf Tekom Regionalgruppe Berlin-Brandenburg 22. Mai 2006 Seite 24/24