Ditalog
msgbartop
DITA für Redakteure – von Single Source Publishing bis Self-Publishing
msgbarbottom

21 Feb 13 Metadaten im Text ausgeben

{lang: 'de'}

So geben Sie z.B. das Datum der letzten Änderung unterhalb des Seitentitels aus.

Dieser Artikel ist im kostenlosen eBook Ditalog als EPUB und PDF-Datei verfügbar.

Seit Jahren war ich auf der Suche nach einem Weg, die Metadaten, speziell das Erstellungs- und Aktualisierungsdatum eines Topics, im Text auszugeben. Da ich keine Lösung dafür hatte, habe ich das Aktualisierungsdatum immer im abstract hart kodiert. Bis ich im XMetal-Forum auf ein Skript stieß, das die beiden Datumsangaben im PDF-Output mit ausgibt. Dies habe ich selbst noch nicht ausprobiert. Da ich die Datumsangaben für den XHTML-Output benötige, habe ich das Skript für meine Online-Publikationen folgendermaßen angepaßt.

So soll es aussehen

Aktualisierungsdatum im Text ausgeben

Aktualisierungsdatum in der CHM-Hilfe

In den Formaten CHM, XHTML und EPUB soll oben rechts immer das Datum der Erstellung und der letzten Änderung in grauer Schrift kursiv ausgegeben werden. Und zwar rechtsbündig unterhalb des Titels und vor der Kurzbeschreibung shortdesc.

Metaangaben im Topic

Vorraussetzung ist, dass in jedem Topic, egal ob Task oder Concept etc, folgende Metadaten innerhalb des Tags prolog gefüllt sind.

<critdates>
  <created date="08.06.2012"/>
  <revised modified="01.07.2012"/>
</critdates>

Hat das Topic noch kein Änderungsdatum, lassen Sie den Tag für revised weg.

gen-user-header-Template anpassen

Suchen Sie innerhalb Ihres DITA-Open Toolkits im Ordner xsl/xslhtml nach der Datei dita2htmlImpl.xsl. Innerhalb dieser Datei muss das Template gen-user-header angepasst werden. Es ist das zweite Template im Bereich, der extra für Ihre Modifikationen für den Header, Footer etc angelegt wurde.

<!-- ========== STUBS FOR USER PROVIDED OVERRIDE EXTENSIONS ========== -->

Im vorhandenen Template gen-user-header fügen Sie, wie unterhalb des Kommentars folgende Zeile ist neu aufgeführt, eine neue Zeile ein.

<xsl:template name="gen-user-header">
  <xsl:apply-templates select="." mode="gen-user-header"/>
</xsl:template>
<xsl:template match="/|node()|@*" mode="gen-user-header">
  <!-- to customize: copy this to your override transform, add the content you want. -->
  <!-- it will be placed in the running heading section of the XHTML. -->
  <!-- folgende Zeile ist neu! -->
  <xsl:apply-templates select="*[contains(@class, ' topic/prolog ')]" 
  mode="gen-user-header"/>
</xsl:template>

Unterhalb dieses angepaßten Templates gen-user-header fügen Sie ein zweites Template hinzu.

<xsl:template match="*[contains(@class, ' topic/prolog ')]">
  <p align="right">
    <xsl:if test="*[contains(@class,' topic/critdates ')]/
    *[contains(@class,' topic/created ')]/@date">
    <span>Erstellt am <xsl:value-of select="*[contains(@class,' topic/critdates ')]/
    *[contains(@class,' topic/created ')]/@date"/>.   </span></xsl:if>
    <xsl:if test="*[contains(@class,' topic/critdates ')]/
    *[contains(@class,' topic/revised ')]/@modified">
    <xsl:for-each select="child::*[contains(@class,' topic/critdates ')]/
    *[contains(@class,' topic/revised ')]">
    <span>Letzte Änderung: <xsl:value-of select="@modified"/></span>
    </xsl:for-each>
    </xsl:if>
   </p>
</xsl:template>

Formatierung in der CSS-Datei

Der Absatzp hat eine class="header-metadata" erhalten. Diese Klasse müssen Sie noch Ihrer CSS-Datei hinzufügen.

.header-metadata
{
  text-align: right;
  font-style: italic;
  color: #C2C2C2;
  margin-right:10px;
}

Plugin

Da ich die Metadaten nur für Onlinehilfen und eBooks benöte, die des Öfteren aktualisiert werden, habe ich das Template in ein Plugin ausgelagert.

Links

Skript für Metadaten im Text für PDF-Dateien im XMetal-Forum

Dieser Artikel ist im kostenlosen eBook Ditalog als EPUB und PDF-Datei verfügbar.

24 Nov 11 Der Romantische Nebel des Buchmarkts (RNB)

{lang: 'de'}

Im Oktober 2011 schrieb Sascha Lobo seine Allgemeinen Feststellungen zur Buchsituation. Nicht nur der Titel, auch der erste Absatz der Feststellungen gleichen einem Manifest:

0. Ich möchte in einer Welt leben, in der kluge Leute für das Nachdenken bezahlt werden, und dazu sind Bücher ziemlich gut geeignet. Das ist übrigens auch mein Argument für ein starkes Urheberrecht (mit digitalen Anpassungen, allerdings).

Leider verhält es sich bei mir nicht ganz so romantisch – obwohl ich mein Geld auch durch Nachdenken verdiene. Ich habe als Technischer Redakteur meine Urheberrechte am ersten Arbeitstag meinem Chef überschrieben. Er bezahlt mich nicht fürstlich, aber regelmäßig. Dafür gibt er täglich das Thema vor. Nun werde ich mich mit allzu harscher Kritik gegenüber meinem Chef zurückhalten. Solange wohl, wie dessen Geschäftsmodell mich und meine Familie ernährt.

Der Buchmarkt wird so lange nicht mit einem neuen Geschäftsmodell aufwarten, wie er genug Menschen ernährt. Natürlich wird es immer einen Buchmarkt geben. Genauso wie es noch Druckereien mit Druckern aus Fleisch und Blut gibt, obwohl ja jeder einen Drucker auf dem Schreibtisch zu stehen hat. Wer schon mal versucht hat, eine ePub-Datei mit einem Schleifenband zu versehen, wird sich das gänzliche Verschwinden des Buchmarkts sowieso nicht wünschen.

Gestern hielt ich im Supermarkt Lobos Wortschatz-Taschenbuch in der Hand. Ein Meisterwerk der Taschenbuchkunst. Sowohl der Inhalt als auch das Design waren genial. Und trotzdem hätte ich es nicht für einen Euro gekauft. Es will etwas von meinem Zeitkontingent beanspruchen – mit unterhaltsamen Zeittotschlagen! Aber was ist schon das Lesen von unterhaltsamen Zeittotschlagtexten gegen das Schreiben eigener Texte? Gegen das Aktivwerden, das Kreieren, die Kommunikation? Es beschlich mich ein unbeschreibares Gefühl der Trauer.

Lobos Wortschaftzfähigkeit ist gewaltig. So konstatiert er in den Feststellungen zur Buchsituation, nirgends gibt es alle Bücher wegen DRM, dem Senfgas des Internet. Ich war entzückt ob dieses Bildes. Bis die Verzückung nach einigen Tagen nachließ und ich mich fragen konnte: Was hat nur das Internet mit DRM zu tun? Richtiger muss es doch heißen: … dem Senfgas des Buchmarkts!

Ich habe der Ursache der lähmenden und alsbald nachlassenden Verzückung einen Namen gegeben: es ist der Romantische Nebel des Buchmarkts (RNB).

Woran erkennt man den RNB? Das ist ja das Schwierige. Er vernebelt auf geniale Weise. Aber ein sicheres Indiz für das Vorhandensein des RNB ist, dass sich der Autor an Amazon abmüht. Denn jedem außerhalb des Buchmarkts ist klar: Amazon is shipping goods. Buchmarkt und Amazon basieren auf dem selben Geschäftsmodell. Es ist, als ob zwei Verkäufer der Katze im Sack über die Beschaffenheit des Sackes fachsimpeln.

Ist der RNB etwas Schlimmes? Nein, er ist romantisch, unterhaltsam und inspirierend – wie jede Innenansicht. Außerdem reisen manche mit Nebelhörnern durchs Land und dürfen vor einem Publikum vortragen, die den RNB schlichtweg für den Nebel des Grauens halten. Auf diese Idee muss man erstmal kommen!

Wo immer ich den Romantischen Nebel des Buchmarkts vermute, lasse ich ein paar Tage verstreichen, bis der Nebel sich legt. Dann durchstöbere ich die Zuschriften zu z.B. den Allgemeinen Feststellungen zur Buchsituation nach unbeantworteten Kommentaren. Das sind die Außenansichten zur Buchsituation. Es funktioniert! Nach der romantischen Unterhaltung folgt nun die Inspiration.

09 Feb 11 Wie generiere ich EPUB-Dateien im Dita4Publishers-Plugin?

{lang: 'de'}

Jeder Redakteur, der seine DITA-Quellen auch im ePUB-Format veröffentlichen möchte, kommt um das Plugin Dita4Publishers von Eliot Kimber nicht herum.  Die ePUB-Generierung steht – zumindestens bei mir – in der ersten Zeit der Ausseinandersetzung mit diesem Plugin im Mittelpunkt. Erst später werde ich mich auf die Suche nach weiteren Vorzügen machen.

Im User-Guide des Plugins heißt es lapidar:

You can use the EPUB transformation type by simply specifying a transtype value of “epub” rather than “html” and use the same parameters you would use for HTML generation.

Dieser kleine Satz muss sich wahrlich erarbeitet werden. Als Ergebnis meiner Ausseinandersetzung entstand ein eigenes Kapitel im Ditalog.

Dieser Artikel ist im kostenlosen eBook Ditalog als EPUB und PDF-Datei verfügbar.

Links zum Thema

  1. Download Dita4Publishers von Sourceforge
  2. Firefox-Addon ePUB-Reader

11 Jan 11 Die Konterrevolution der elektronischen Bücher

{lang: 'de'}

»E-Books: Die Konterrevolution der elektronischen Bücher« · http://bit.ly/f6EuU4 (FTD)

21 Dez 10 Aus einem E-Book zitieren

{lang: 'de'}

Die letzten Wochen habe ich mir die Mühe gemacht, meine Diplomarbeit über die DDR-Literatur der 70er und 80er Jahre mit Hilfe des DITA-OTs neu zu veröffentlichen. Da ich weiß, dass einige Schüler und Studenten nur bestimmte Kapitel interessieren, habe ich die Arbeit sowohl als Gesamtausgabe als auch als einzelne Kapitel veröffentlicht. Jedes Kapitel erhielt ein verkürztes Literaturverzeichnis und Stichwortverzeichnis. Und siehe da: als PDF erhält das Kapitel natürlich eine andere Seitennummerierung als das integrierte Kapitel in der Gesamtausgabe! Natürlich soll auch eine ePUB-Version folgen und so weiter. Auf welche Weise soll man Zitiermöglichkeiten schaffen?

Kapitel und Abschnitte

Ich habe mich entschieden, den Text redaktionell zu bearbeiten und ihn in Kapitel und Abschnitte zu unterteilen. Die Abschnitte sind sinnvoll zusammenhängende Texteinheiten. Es hätte aber auch eine stupide Absatzzählung werden können. Es ist also ähnlich wie die Einteilung in der Bibel oder in Gesetzestexten. Das funktioniert so lange, wie der Autor bei Entstehung daran denkt, die Nummerierung vorzunehmen. Oder nachträglich eine Nummerierung vorgenommen wird. Was ist aber mit der Vielzahl von bereits veröffentlichten E-Books oder Blog-Posts?

Eines Lösung müßte m. E.  folgendes berücksichtigen:

  1. Eine Referenzierung auf Textstellen soll für jedermann nachvollziehbar sein – ohne Hilfesmittel. Das bedeutet, dass eine lange Prüfsumme zum Identifizieren nicht ohne Hilfsmittel zu verifizieren wäre und somit nicht in Frage kommt?
  2. Das Referenzier-System muss von jedermann anwendbar sein. Eine DOI, die eine Agentur davor schaltet und Kosten mit sich bringt, kommt ebenfalls nicht in Frage?
  3. Ideal wäre ein Referenzier-System, das auch auf bereits veröffentlichte Text jeglicher Art Anwendung finden kann.

Wie könnte innerhalb der DITA-Spezifikation eine Lösung aussehen?

Links zum Thema

  1. Blogpost auf teleread.com
  2. Lesen.net – Forum

20 Okt 10 Manu, Hollywood und Social Media

{lang: 'de'}

Manu ist eine erfrischende Bloggerin – denn sie warf einen Kiesel in die ruhige  See der Aufklärung. Sie recherchierte im Juni 2010, dass hinter in Schulen ausgelegten Geschenkgutscheinen für Bücher ein Vertrieb von Finanzdienstleistungen steckt. Der Vertrieb warf im Oktober 2010 einen mannsgroßen Brocken auf den Kiesel: Per Anwaltschreiben wurde die Bloggerin aufgefordert, den Post zu löschen. Nun schlagen die Wellen hoch, werden größer – der Groundswell beginnt, hier und jetzt und immer weiter…

Der Groundswell oder wie man ein Erdbeben lostritt

Charlene Li und Josh Bernoff haben im gleichnamigen Buch viele Beispiele zusammengetragen, wie Unternehmen vom Groundswell überrollt wurden. Den ersten Groundswell lösten 2007 die großen Filmgesellschaften wie Disney, Warner Bros. und Sony mit einem Brocken auf digg.com aus: Digg sollte ein Link, der auf eine Webseite mit dem geknackten HD-DVD-Verschlüssungscode 09 F9 11 02… zeigte, entfernen. Und tatsächtlich entfernten die digg-Macher den Link.

Nun besorgten sich andere Blogger den Code. Am nächsten morgen tauchten 88 Links mit dem Code auf. Zum Abend waren es schon 3172 Links. Digg.com gab es auf, Links zu zensieren. Grant Robertson aus der digg-Mannschaft kommentierte das Phänomen mit einem Spruch aus einer TV-Show:

Aus dem Internet kann man nichts entfernen. Das ist so, als würde man versuchen, das Pipi aus einem Schwimmingpool zu bekommen.

Manus Recherche ist auch hier zu finden: www.webcitation.org/5tb90oNIc. Und an vielen weiteren Stellen.

Natürlich wissen wir, dass man nichts geschenkt bekommt. Immer ist eine Gegenleistung zu erbringen. Manu hat sich im Fall der Büchergeschenkgutscheine die Zeit genommen, die Gegenleistung zu ergründen. Die Scheine konnten so lange in Schulen ausliegen, wie sich niemand die Zeit nahm, auf sie in irgendeiner Form zu reagieren. Sie hat sie sich genommen. Nun wird sie viel unangenehme Zeit aufbringen, um Menschen in Deutschland die Funktionsweise des sozialen Internets nahe zu bringen.

Sowohl die Filmgesellschaften als auch der Finanzvertrieb nahmen an, dass es sich mit einem Blogpost genauso verhält wie mit einem Papieraushang am Schwarzen Brett: wenn man ihn abnimmt, gerät die Information in Vergessenheit. Manus Blogpost wird natürlich auf Jahre hinaus im Web präsent sein. Alle Beteiligten verlieren viel Zeit und für den Finanzvertrieb ist es der Kommunikations-Gau schlechthin. Da sich der Blogpost nicht mehr aus dem Internet entfernen läßt, hat der Finanzvertrieb nur eine Chance, Vorbehalte über sein Wirken auszuräumen: er muss ein anderes Geschäftsmodell entwickeln und darüber im Internet berichten. Ein Geschäftsmodell, bei dem man stolz und froh ist, wenn Blogger darüber kostenlos berichten und Werbung machen. (weiterlesen …)

18 Okt 10 Technische Dokumentation im Überblick

{lang: 'de'}

Beim Ditalog steht DITA als eine bestimmte Technologie im Mittelpunkt. DITA steht für Single Source Publishing und Wiederverwendbarkeit (reuse). Der Redakteur ändert an einer zentralen Stelle die Bezeichnung für die Schaltfläche A in B – und schwupps – heißen nun sämtliche A-Schaltflächen B. Vererbung in Sekundenschnelle. Natürlich ist das Blog ganz aus Sicht des Redakteurs geschrieben. Nämlich, wie ein Redakteur seine Startschwierigkeiten im Praxisalltag überwindet.

Hauptanwendungsgebiet von DITA ist immer noch die Technische Dokumentation. Letztere soll hier im Blog nicht zu kurz kommen: die Sicht auf das Endprodukt – die Nutzersicht. Viele Blogs geben Hinweise und Tipps in Sachen Technischer Dokumentation. Ein umfangreiches deutschsprachiges Angebot unterbreitet Marc Achtelig auf www.indoition.com in seiner Rubrik Know-How. Besondere Erwähnung verdienen die Punkte:

eine umfangreiche, gut sortierte Linksammlung, in der es sich zu stöbern lohnt.  Wer Marc Achteligs Know-How offline lesen möchte, dem sei diese PDF-Broschüre zum Download empfohlen:

27 Sep 10 Neue Publikation für HTML, CHM und ePUB

{lang: 'de'}

Nun ist es mir schon wieder passiert: weil ich mir keine Notizen gemacht hatte, durfte ich von neuem herausfinden, warum mein HTML-Output mit dem Plugin TOCJS wieder die Umlaute nicht richtig darstellt.

Umlaute falsch in DITA TOCJS-Navigation

Falsche Darstellung der Umlaute im Navigationsframe des TOCJS-Plugins

Es gilt, die Datei \demo\tocjs\xsl\tocjs.xml zu editieren. Ändern Sie den Wert für encoding von utf-8 auf ISO-8859-1. So muß es am Ende aussehen:

<xsl:output method="text" encoding="ISO-8859-1"/>

Diese Aktualisierung des TOCJS-Plugins ist auch in die neue PDF-Publikation mit eingeflossen. In ihr sind sämtliche Kapitel mit den Ausgabeformaten HTML, CHM und ePUB mit eingebunden. Wenn Ihnen die Ditalog-Artikel eine Hilfe waren, schreiben Sie darüber in Ihrem Blog! Wenn Sie Ihnen keine Hilfe waren, schreiben Sie die Gründe ebenfalls in Ihrem Blog.

Text als PDF downloaden
Titel des Downloads: Ausgabeformate HTML und CHM
Art der Publikation: Kapitel
Beschreibung: Sämtliche Artikel zu den Ausgabeformaten HTML, HTML mit dem Plugin TOCJS (Javascript-Navigationsframe) sowie CHM (Windowshilfe). Ohne Leerseiten.
Aktualisiert am: 18.04.2011. Die EPUB-Generierung ist in der Kapitelausgabe "Dita4Publishers" zu finden.
Anzahl der Downloads: 453

21 Mai 10 DITA-Plugin dita4publishers installieren

{lang: 'de'}

Anleitung: So installieren Sie das Plugin Dita4Publishers.

  1. Downloaden Sie das Plugin unter http://sourceforge.net/projects/dita4publishers/files/. Die Dateisyntax ist dita4publishers-datum.zip.
  2. Entpacken Sie die Zip-Datei. Als Ergebnis erhalten Sie folgende Zip-Dateien und Ordner:
    • dita4publishers_toolkit_plugins.zip
    • documentation
    • epubs
    • sample_data
    • xslt
  3. Entpacken Sie die Datei dita4publishers_toolkit_plugins.zip in den Plugin-Ordner Ihrer Toolkit-Installation.

    Abbildung 1. plugins als Zielverzeichnis zum Entpacken

    Entpacken Dita For Publishers

    Im Ergebnis entstehen im Verzeichnis \plugins folgende Unterordner:

    • net.sourceforge.dita4publishers.doctypes
    • net.sourceforge.dita4publishers.epub
    • net.sourceforge.dita4publishers.pubmap.html
    • net.sourceforge.dita4publishers.shakespear.doctypes
    • net.sourceforge.dita4publishers.shakespear.html
    • net.sourceforge.dita4publishers.xmldomain.doctypes
    • net.sourceforge.dita4publishers.xmldomain.html
  4. Öffnen Sie das Toolkit auf Kommandoebene und geben Sie den Befehl
    ant -f integrator.xml

    ein.

  5. Probieren Sie die Generierung eines mitgelieferten Beispiels aus dem Ordner \sample_data, welcher beim Entpacken des ursprünglichen Archivs von Sourceforge entstanden ist. Kopieren Sie den Ordner \wizard-of-oz in den DITA-OT-Ordner \samples.
  6. Wechseln Sie in das Toolkit-Fenster und geben Sie folgenden Build-Befehl ab:
    java -jar lib\dost.jar /i:C:/DITA-OT1.5/samples/wizard-of-oz/wizard-of-oz.ditamap
    /transtype:epub
    /outdir:C:/DITA-OT1.5/out /logdir:C:/DITA-OT1.5/log

    Im Out-Ordner sollte sich nun die erzeugte epub-Datei befinden.

Da das Plugin die Templates für XHTML zu Grunde legt, ist es ratsam, mit einer ditaval-Datei über das Product-Attribut bestimmte Links herauszufiltern. So sieht dann mein Build-Befehl mit Filter folgendermaßen aus:

java -jar lib\dost.jar /i:C:/DITA-SRC/Installationsanleitung.ditamap
/transtype:epub /filter:C:/DITA-SRC/filters/admin-print.ditaval
/outdir:C:/DITA-SRC/out/epub-admin /logdir:C:/DITA-SRC/log

Text als PDF downloaden
Titel des Downloads: {title}
Art der Publikation: {version}
Beschreibung: {description}
Aktualisiert am: {meta-revised}
Anzahl der Downloads: {hits}