TOPICS ERSTELLEN, VERWALTEN, ÜBERSETZEN UND PUBLIZIEREN OHNE CMS

Transkript

1 TOPICS ERSTELLEN, VERWALTEN, ÜBERSETZEN UND PUBLIZIEREN OHNE CMS WS5 tekom-ft Karlsruhe

2 Ovidius GmbH Firmenprofil Gegründet 1996, Sitz in Berlin, GF Klaus Fenchel Schwerpunkte: XML-Redaktions- & Publikationssysteme: TCToolbox / spez. Systeme SGML/XML Automatisierung und Prozessketten Publikationsstrecken für autom. Werksatz / Loseblatt-Produktion Werkzeuge: u.a. TCToolbox, XWord, XHelp, FoX, MetaMorphosis, TreeVision, XService, XSLT Zielgruppen & Märkte: Maschinen- und Anlagebau Software- und Luftfahrt/Verteidigung Hardwaredokumentation Automobilindustrie Fachverlage Seite 2

3 Wer spricht? Dipl.-Ing. Ute Mitschke 1982: Programmierung in Assembler für den ersten Z : Dozentin in der Erwachsenen-Weiterbildung : Prozess- und Datenanalyse DASA Hamburg 1998: Unterstützung des DIN bei der Einführung von Acrobat in allen europäischen Normungsinstituten 1999: Erstellung Pflichtenheft, Marktrecherche und Beratung von Stiftung Warentest bei der Auswahl eines XML-basierten CMS 1999: Technische Dokumentation mit FrameMaker 5.5, Addison Wesley 2002: FrameMaker 6+7 Praxisbuch bei Addison Wesley seit Jan. 2012: Senior Consultant bei der Ovidius GmbH, Berlin Seite 3

4 Inhaltsübersicht Dokumentation im Produkt-Lebenszyklus Aufgaben aus den Lebenszyklus FM vom DTP- zum XML-Autorensystem Umschalten von DTP zum XML-Editor Das zusätzliche Menü StructureTools Zielstellung einer XML-Applikation in FM Bestandteile einer XML-Applikation in FM Das Beispiel-Handbuch Die Beispiel-Applikation Bearbeiten des Beispiels Seite 4

5 Dokumentation im Produkt-Lebenszyklus en sket de el Einheitlicher Aufbau vergleichbare Inhalte Redaktionsleitfaden Terminologie Wiederverwendung? Modularisierung? Layoutänderung? (z.b. im Kundenlayout) Übersetzung Konvertierung? (PDF, HTML, Online-Hilfe...) Seite 5

6 Aufgaben aus den Lebenszyklus Ständige inhaltliche Überarbeitung/Aktualisierung: Redaktionsleitfaden oder Inhaltserstellung mit XML Unmissverständliche Inhalte mit definierten Bezeichnern: Terminologie Einsatz von identischen Passagen in verschiedener Dokumentation: Modularisierung Übersetzung / Ausgabe in Länderversionen: automatische Anpassung an veränderte Textlängen und landesspezifische Eigenheiten und Standardtexte Seite 6

7 Inhalte erstellen Direkt in FrameMaker XML-basiert Seite 7

8 Inhalte überprüfen Review-Prozess wird in den Bausteinen über das Attribut Freigabestatus dokumentiert. Review-Prozess betrachtet nicht einzelne Module, sondern die Publikation bzw. Teil-Publikation Mittels Script wird in allen betrachteten Modulen der Freigabestatus im Attribut gesetzt. Seite 8

9 Inhalte optimieren Wiederverwendung von Modulen, die für mehrere Dokumentationsarten (z.b. BA, SA, PA) oder Produktgruppen bzw. Produkte oder Handbuch-Abschnitten gelten Seite 9

10 Inhalte vereinheitlichen Implementierung von Terminologie-Instanzen auf mehreren Wegen: Auszeichnung von Begriffen als das Element Term Nutzung von Variablen z.b. für Menütexte, um die Inhalte leicht austauschen zu können Feingranulare Modularisierung von Inhalten, z.b. für Sicherheitshinweise. Einsatz von vorgefertigten Textinhalten, z.b. die juristisch relevant sind, als Standardtexte (siehe WS7 am Freitag, 9:00 Uhr) Seite 10

11 Inhalte verwalten Datenablage mit speziellem Konzept: Seite 11

12 Inhalte übersetzen Direkt über die freigegebene Publikation werden die verwendeten Bausteine für die Übersetzung als einzelne XML-Dateien exportiert. Im Dateinamen der Quellsprachen-XML-Module spiegelt sich die Pfadstruktur der Bausteinablage wieder. Nach Übersetzung wird beim Import der Zielsprachen- Module die Pfadstruktur aus dem Dateinamen in der Bausteinablage der Zielsprache aufgelöst. Seite 12

13 Inhalte publizieren Publikation wird auf Basis eines Templates zusammengestellt. Die Inhalte bestehen ausschließlich aus Modulen, die als Texteinschübe importiert werden. In den Kapitel-Dateien selbst darf kein Text direkt geschrieben werden. Publikation aus FrameMaker nach PDF Publikation als epub, Online-Hilfen usw. via XML-Export und entsprechende XSLT-Scripte Seite 13

14 FM vom DTP- zum XML-Autorensystem Erstellen/Auswahl einer geeigneten XML-Struktur-Definition Entwickeln einer Applikation, die XML-Elemente als FrameMaker-Objekte interpretiert und kontextsensitiv Formate zuweist Aufbau einer Modulablage, die die Produkt- und Dokumentstruktur wiederspiegelt Vordefinieren von feststehenden Texten (Adressen, Copyright-Verweise, Maßeinheiten, Querverweis-Absätze usw.), die automatisch vom Übersetzungsprozess ausgeschlossen und konstant wiederverwendet werden Erstellen/Bearbeiten des Layouts entsprechend des Corporate Design ohne Veränderung der XML-Applikation. Erstellen einer Publikation durch Zusammenfügen der Bausteine Unterstützung von Teilprozessen (Export/Import zur Übersetzung, Versionierung, Archivierung usw.) durch Scripte Seite 14

15 Umschalten von DTP zum XML-Editor Grundeinstellung der Programmoberfläche: > Datei > Voreinstellungen > Allgemein Seite 15

16 Das zusätzliche Menü StructureTools Bietet Werkzeuge für die Applikationsentwicklung Seite 16

17 Zielstellung einer XML-Applikation in FM Editieren von XML-Daten Übertragen von XML-Text-Elementen in FrameMaker-DTP- Objekte mit XML-Struktur formatierte Anzeige von XML-Elementen ähnlich wie ein Browser, jedoch für DTP Überprüfung der XML-Struktur und Anzeige von Fehlern Import und Export von XML-Daten Seite 17

18 Bestandteile einer XML-Applikation in FM 1 DTD für die XML-Struktur-Definition 1 Read/Write-Rules-Datei: interpretiert XML-Text (Elemente) als FrameMaker-Objekte während des Imports und Exports. 1 EDD: verknüpft die Element-Definitionen mit Formaten 1 Template: für die konkrete Seiten- und Format-Gestaltung 1 Eintrag in structapps.fm: Um im Programm alle für eine Anwendung benötigten Dateien/Informationen zu einem System zusammen zu binden. Seite 18

19 Bedienungsanleitung Das Beispiel-Handbuch Ein Dokupreis Handbuch MixMate Bedienungsanleitung Copyright 2007 Eppendorf AG, Hamburg. No part of this publication may be reproduced without the prior permission of the copyright owner. eppendorf : Registered trade mark of Eppendorf AG, Hamburg, Germany. MixMate : Registered trade mark of Eppendorf AG, Hamburg, Germany. Bedienungsanleitung B /0507 Seite 19

20 Die Beispiel-Applikation Dokumentstruktur Seite 20

21 Bearbeiten des Beispiels weiter geht es im FrameMaker Seite 21

22 Bevor Sie gehen... Bitte Bewertungsbogen ausfüllen: WS5... und Ihr Zertifikat abholen Seite 22

23 Vielen Dank für Ihre Aufmerksamkeit! XML solutions that work Ute Mitschke Ovidius GmbH Alte Jakobstr D Berlin Tel.: Fax Seite 23