Tappen Sie nicht in die Falle

Michael Kay, XSLT-Mastermind, hat einen Blog-Eintrag zu The ten most common XSLT programming mistakes verfasst. Der aus meiner Sicht eindrücklichste Hinweis ist Punkt 7:

Don’t use disable-output-escaping. […] 95% of the time, if you see disable-output-escaping in a stylesheet, it tells you that the author was a novice who didn’t know what s/he was doing.

In den Punkten 4 und 10 weist er indirekt darauf hin, dass für gute Ergebnisse eine gewisse Kenntnis der Arbeitsweise bzw. Programmiersprache nötig ist. Das erinnert mich an There is no free lunch! Wer aber die Basishürden überwindet, wird mit einer mächtigen Programmiersprache belohnt, die beliebige Modifikationen an XML-Daten zulässt.

So, und jetzt beginnt die Fußball-WM, wer hat da noch Zeit für Doku?

Elektronische Dokumente

Heurte trafen zwei E-Mails aus völlig verschiedenen Richtungen ein, die den gemeinsamen Nenner »Elektronische Dokumente« besitzen. Beide Themen sind es wert, weiter verfolgt zu werden, möglicherweise kommen sie einfach zur rechten Zeit:

Tradeshift ist eine Plattform für Rechnungsstellung, das Ihrem Unternehmen die Möglichkeit gibt elektronische Rechnungen zu versenden und empfangen.
http://tradeshift.com/de

Inwieweit dies konform geht mit dem deutschen Umsatzsteuerrecht, muss ich noch herausfinden.

Adobe eSignatures ist in Beta veröffentlicht und verspricht signierte PDF-Dokumente zu erstellen.
https://esign.adobe.com/

Auch hier stellt sich die Frage nach der Vertraulichkeit (man muss die Dokumente auf einen Adobe-Server laden und bekommt sie signiert zurück) und der Gültigkeit gemäß Signaturgesetz (oder wie das heißt…)

Bleiben Sie dran!

Schriften mit wissenschaftlichen Symbolen

Anfang der letzten Woche hat das STI Pub Konsortium unter Leitung des American Institute of Physics eine Sammlung von frei verfügbaren Fonts mit einer Vielzahl technische Symbole veröffentlicht. Die Lizenz ist sehr sehr anwenderfreundlich und erlaubt auch die Erstellung abgeleiteter Werke.

Im Unterschied zu vielen anderen derartigen Versuchen liegt die Basisschrift STIXGeneral in den vier üblichen Schnitten Normal, Kursiv, Fett, Fett-Kursiv vor und die Normal-Version verfügt über 3292 Glyphe, die meisten davon Unicode-kodiert. Neben über 200 Pfeilen finden sich über 500 mathematische Operatoren und Unmengen weiterer Sonderzeichen in dem Font. Wer hier nicht fündig wird…

Sehr häufig nachgefragt sind auch Pfeile, von denen STIXGeneral in mehreren Unicode-Bereichen wirklich eine umfangreiche Auswahl bietet: 249 Varianten! (Animiertes GIF, bitte anklicken für die größere Darstellung.)

Mit FrameMaker 8 oder FrameMaker 9 können Sie auf diese Zeichen zugreifen, verschiedene Methoden dazu habe ich in dem Beitrag Unicode-Zeichen eingeben gesammelt.

iPad Countdown

Heute Sonntag 23.5. 4:15h schreibt mir bitte_nicht_antworten von euro.apple.com:

Sehr geehrte(r) Michael M��ller-Hillebrand,
wir freuen uns, Ihnen den Versand Ihrer Bestellung W12345678 bestätigen zu können.

Warum ich das hier erwähne? Meiner Meinung nach wird die Mühe, die Apple ins User Interface Design des iPad gesteckt hat, noch mehr als beim iPhone die allgemeine Erwartungshaltung an Software ändern, nach oben schrauben, und wird damit auch starken Einfluss auf die Technische Dokumentation haben. Na, warten wir’s ab…

Update 29.5.: Meine Webseiten sehen recht brauchbar aus auf dem iPad-Browser (Abbildung anklicken). Hinweise zur Optimierung von Webseiten finden sich in der Safari Reference Library.

Dokumentvergleich – Änderungsanzeige

Diff, Change Tracking, Änderungsverfolgung… you name it…

Es gibt mehrere Gründe warum jemand gerne sehen möchte, wo in einem Dokument welche Änderungen gemacht wurden:

  • Der Leser möchte bei einem Update die Stellen mit Änderungen gegenüber seiner letzten Version des Dokuments sofort erkennen
  • Der Korrektur-Leser möchte die Stellen mit Änderungen seit dem letzten Korrekturlauf erkennen
  • In den Übersetzungsprozess sollen nur Abschnitte mit Änderungen geleitet werden

Den letzten Fall möchte ich hier einmal ausklammern, auch wenn dessen wirtschaftliche Relevanz nicht unterschätzt werden darf. Aber hierfür sind eine Vielzahl weiterer Prozessfragen zu klären.

Die ersten beiden Punkte bieten Raum genug. Zum Beispiel, wenn wir Versionssprünge für bestimmte Sprachen oder Produktvarianten unterstellen. Wenn also nicht in allen Sprachen oder Produktvarianten die gleichen Änderungen angezeigt werden sollen (Äa = Änderungsanzeige):

Version     häufige Sprachen    seltene Sprachen
2.0 PDF mit Äa zu 1.0 PDF mit Äa zu 1.0
2.1 PDF mit Äa zu 2.0
2.2 PDF mit Äa zu 2.1
3.0 PDF mit Äa zu 2.2 PDF mit Äa zu 2.0

Wenn Sie dies noch kombinieren mit gesonderter Änderungsanzeige für verschiedene Korrekturleser… dann ist es kein Wunder, dass dies heute nicht oder nur selten stattfindet. Und wenn, dann mit recht hohem Zeitaufwand.

Aber es geht! Mit FrameMaker!

In einem aktuellen Projekt habe ich folgendes umgesetzt:

  • zwei beliebige XML-Fassungen eines Handbuchs werden mit Hilfe eines XML-Tools verglichen
  • das XML-Ergebnis mit Änderungsmarkierungen wird für FrameMaker aufbereitet
  • es entsteht ein FrameMaker-Buch mit FrameMaker-Änderungsmarkierungen, die auf Wunsch noch nachbearbeitet werden können

Im Detail:

Es gibt viele Werkzeuge, mit denen Textdateien oder sogar XML-Dateien vergleichen werden können. Aber erst 2009 fand auch eines, dass Änderungsmarkierungen auch in einem XML-Dokument speichern kann. Dies erfolgt mit Hilfe von Processing Instructions, so dass die XML-Datei nicht durch neue Elemente oder Attribute von vornherein ungültig wird. Dem Werkzeug fehlten noch einige Funktionen, die wir für den Vergleich von Dokumenten benötigen, zum Beispiel den Vergleich auf Textebene. Mittlerweile gibt es eine Version 2.0 von XML Tree Compare zum Testen auf http://www.xmldifftool.com/.

Eine Aufbereitung des Outputs von XTC ist nötig, da FrameMaker Änderungsmarkierungen auf ganz bestimmte Art und Weise erwartet. Zudem bietet die Aufbereitung auch die Möglichkeit, bestimmte technisch motivierte Änderungen zu ignorieren. Da es sich um eine XML-Datei handelt, erfolgt diese Anpassung per XSLT.

Integriert wird das Ganze mit einem Skript, so dass der Vorgang für den Anwender problemlos ist. FrameMakers Einschränkungen im Zusammenhang mit der Änderungsverfolgung werden dabei weitgehend behoben.

Und das Dokument mit Änderungsanzeige kann anschließend mit der Symbolleiste Textänderungen nachverfolgen nach Änderungen durchsucht werden. Wenn gewünscht können auf diese Weise banale Änderungen noch akzeptiert werden. Abgebildet sind hier das alte, das neue und das Dokument mit Änderungsanzeige.
(Für große Darstellung bitte anklicken und mit Pfeiltasten zwischen den Bildern wechseln)

Wenden Sie sich an mich, wenn Sie dies auch für Ihre FrameMaker-Publikationen einsetzen wollen!

Umzug vollzogen

Seit heute kommen meine Webseiten von einem neuen Server. Hoffentlich ist die Performance jetzt besser, denn statt gemeinsam Gast mit vielen anderen bin ich jetzt zumindest in einem virtuellen Server alleine »Herr im Haus«.