Sachen von Lea zum Lücke-Lernen

• 5 sections + 1 generische

• <sect1> … </sect1> bis <sect5> … </sect5>

• <section> kann auch ineinander verschachtelt werden (generische section)

• allgemeine Topics

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

• beantworten die Frage Was (ist vorhanden/nutzbar)

• beinhalten

  • beschreibende Fakten

  • Syntax eines Kommandos oder einer API-Funktion

  • Tabellen mit Daten

• keine Schritte oder Hintergrundinformationen, nur Fakten

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

  • ist Java-Basiert

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

  • Anpassbar an eigene CI nach entsprechender Einarbeitung

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

• beantworten die Frage warum (etwas zu tun ist)

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

Antenna House Formatter

• kommerzielles Produkt, leistungsfähig und optimierte Typographie

• Grafische Oberfläche zur Darstellung und Prozessierung von FO-Code

Apache FOP

• Open-Source-Software auf Java-Basis

• oft in andere Software eingebunden

• direkt im oxygen XML editor integriert

XSLT - Extensible Stylesheet Language Transformations

• zur Umwandlung von XML-Strukturen in Ausgabeformate auf der Basis von HTML, XML und Text

XSL-FO - Extensible Stylesheet Language Formatting Objects

• zur automatisierten Umsetzung von Print-Layouts bzw. Durckvorstufen wie PDF

XPath - Extensible Path Language

• für Zugriff auf Knoten und Inhalte von XML-Strukturen, meistens in verbindung mit XSLT eingesetzt

• XSLT-Prozessor: Saxon

• XSL-Formatierer (/Renderer): FOP, Antenna House

https://www.data2type.de/xml-xslt-xslfo/xsl-fo/in-drei-schritten-zum-druck

• Wurzel: book bzw. article

• Metadaten: innerhalb von bookinfo

• Kapitel: chapter

• Abschnitte: section (verschachtelt bzw. sect1 bis sect5)

• Titel: title (für book, article, chapter, section)

• Absätze: para (darin weitere Formatierungen)

• Handlungsanweisungen: procedure

• Bilder etc.: inlinemediaobject und darin ist das imageobject

Basiselement fo:block

• <fo:block> Fließtext und weitere Inhalte </fo:block>

• innerhalb von fo:block sind weitere fo:block-Elemente möglich, aber auch inzeilige Inhalte wie <fo:inline font-style=”italic”> Text </fo:inline>

• fo:block genereller Inhaltscontainer, siehe u.a. Bilder, Listen und Tabellen

• Formatierung über zugehörige Attribute mit überwiegend CSS-ähnlicher Syntax

  
  

• expliziter Dokumentationsstandard

• Herausgeber: OASIS

• steht für “Darwin Information Typing Architecture”

• verwendet XML, unabhängig von fest vorgegebenen Werkzeugen

• dient zum Verwalten von Inhalten

• SVG

• MathML

• XSLT

• Concept: Hintergrundinformationen

  • WARUM ist etwas zu tun

• Glossary Entry: Hintergrundinformationen

  • BEDEUTUNG

• Task: Handlungsanweisungen

  • WIE wird etwas ausgeführt

    • strict tasks: Reihenfolge relevant

    • general tasks: Reihenfolge nicht so relevant

• Wird meist über Webhoster geregelt

  • Domain

  • Webspace mit Speicherplatz im GB-Bereich

  • Webserver-Software (z.B. Apache)

  • Datenbankserver-Software (z.B. MySQL)

  • Programmiersprachen (u.a. Python, PHP, Perl)

  • Web-CMS-Software (CMSMS, TYPO3, Wordpress)

  • Objekte die eingebunden werden können

  • (Optional: Weitere Komponenten wie E-Mail, Statistiken…)

• Beantworten die Frage nach Bedeutung

• vermitteln Hintergrundinfos, die zum 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>

• Single Source Publishing, Unabhängigkeit von Präsentationskanälen

• Wiederverwendbarkeit

• strikte Trennung von Inhalten/ Struktur und Layout

• Teilautomation der Aufbereitung von Inhalten für einzelne Ausgabekanäle

• Personalisierung der Angebote

• Content Syndication (Übernahme ext. Texte)

• einfache Erstellung, Änderung, Erweiterung von Publikationen

• Redaktionelle Bearbeitung weitgehend ohne Fachkenntnisse

• Trennung von Inhalten / Struktur und Layout / Design

• Mehrfach/- und Wiederverwendung von Inhalten

DITA:

DocBook:

• simplelist

• itemizedlist

• orderedlist

• variablelist

• segmentedlist

DITA (kleinteilig)

• Topics!

• flexibler, gruppierung kontextabhängiger Information

• verschiedene Ausgabemöglichkeiten

DocBook (monolithisch)

• strikt hierarchisch

• keine Mechanismen, um Inhalt von Kontext zu trennen

• auf Bücher ausgelegt, aber vielzahl an Zielformaten (durch Stylesheets)

• ausführlich getestet und umfangreich gepflegt

• HTML

• HTMLHelp

• PDF

• EPub

(über Stylesheets)

• InDesign Markup Language

• Austauschformat zwischen InDesign Verisonen

• ZIP-Datei in der XML-Strukturen liegen

• genau 1 Wurzelelement, dass alle Inhalte umschließt

• Alle Elemente korrekt durch Anfangs- und Endtags ausgezeichnet

• Elle Elemente korrekt ineinander verschachtelt

• Attributwerte stehen in Anführungszeichen, davor ein Gleichheitszeichen

• Regeln für Schreibweise werden eingehalten

• Reservierte Zeichen je nach Kontext ggf. maskiert

  
  

Wohlgeformtheit und Validität

• ist erst gegeben, wenn Wohlgeformtheit gegeben ist

• Dokument verfügt über eine Definition oder Schema (mittels DTD oder XSD)

• die in der Definition oder in dem Schema definierten Regeln sind eingehalten

• DocBook

• DITA

• OpenDocument

• Mathematical Markup Language

  • Ziel: Mathematische Inhalte XML-basiert online publizieren und in andere Dokumentformate einfügen/verarbeiten

  • Zwei Ausführungen

    • Content-Markup

    • Presentation-Markup

• Einbindung

  • in DocBook direct als Code in <equation>

  • über diverse Formeleditor

• Softwaredokumentation

• rss

• atom

• XML-basiertes Format zum Nachrichtenaustausch

• kann abonniert werden

• Newsfeeds (Mit Headline, Teasertext und Link zum Volltext)

• Zeitschriften-Artikel (Online und PDF)

• Podcasts (Aus einem repo kann man Angebote abonnieren, rss Feed zeigt neue Episoden Episodennamen, Link zu Audiodatei)

• Modellierung und Konvertierung von Inhalten

• XML-Basis und CM-Systemannbindung

• in Praxis Aufgabe für spezialisierte Firmen (Dienstleister)

• ZIP-basiert, enthalten XML

• Inhaltstylpen:

  • png, jpg

  • xml

  • rels (relationships)

• Dokumenteigenschaften

  • Templates

  • Pages

  • Words

  • Characters

  • Appversion

• über XSLT-Transformation

• .xlsx

• .docx

• .idml

• .odt

• Mit XSLT

• HTML Help

• Online-Hilfen

• E-Books