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

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: Dita4Publishers
Art der Publikation: Thema
Beschreibung: Sämtliche Artikel zum Dita4Publishers-Plugin von Eliot Kimber. Besonders geschätzt im Plugin: die ePUB-Dateigenerierung.
Aktualisiert am: 07.12.2011
Anzahl der Downloads: 157
Teilen Sie die URL Ihren Xing-Kontakten mit.

21 Mai 10 Leere Seiten aus PDF entfernen

{lang: 'de'}

Leere oder nicht benötigte Seiten sollen aus der PDF-Datei entfernt werden.

Problem der nicht benötigten Seiten

Als PDF-Ergebnis erhält man, auch ohne eine bookmap zu nutzen, eine PDF-Datei mit Deckblatt und Inhaltsverzeichnis. Möchte man jedoch nur eine A4-Seite für eine kleine Änderungsliste oder ähnliches erstellen, wirkt ein Deckblatt und ein Inhaltsverzeichnis mit nur einem Eintrag deplatziert.

Desweiteren enstehen oftmals leere Seiten, die nur im beidseitigem Druck einen Sinn ergeben. Der PDF-Ausdruck geschieht jedoch meistens für den einseitigen Ausdruck, worin die leeren Seiten als störend empfunden werden. (weiterlesen…)

Teilen Sie die URL Ihren Xing-Kontakten mit.

21 Mai 10 Zugangsweg im PDF darstellen

{lang: 'de'}

Anleitung: So koppeln Sie den Zugangspfad zu einem Fenster aus den Handlungsschritten aus und ändern entsprechend das XSL-Stylesheet.

Anmerkung: Der PDF-Output wird mit Hilfe des Idiom-FO-Plugins realisiert. Letzteres verwendet den RenderX als XSL-FO-Prozessor. Die “Personal Edition” unter www.renderx.com/download/personal.html ist kostenlos und zeitlich unbegrenzt für nichtkommerzielle Zwecke nutzbar.

  1. Der Hinweis auf den Zugangsweg zum Bildschirm soll mit einem Cursor-Icon und dem Wort Zugang: gekennzeichnet werden.
    Abbildung 1. Cursor-Icon vorm Zugangspfad
    Zugangsweg
  2. Kopieren Sie das Bild, mit welchem Sie den Zugangspfad “flaggen” möchten, in den Idiom-FO-Plugin-Ordner C:\DITA-OT1.4.2.1\demo\fo\Customization\common\artwork
  3. Fügen Sie in der Datei custom.xsl im Ordner \demo\fo\Customization\fo\attr\custom.xsl folgendes Attributset hinzu:
    <xsl:attribute-set name="p.zugang">
    <xsl:attribute name="font-weight">bold</xsl:attribute>
    </xsl:attribute-set>
    
  4. Fügen Sie in der Datei custom.xsl im Ordner \demo\fo\Customization\fo\xsl folgenden Eintrag für ein Template hinzu:
    <xsl:template match="*[contains(@class, ' topic/p ')]">
    <xsl:choose>
    <xsl:when test="@otherprops='zugang'">
    <fo:block space-before="0.5em">
    <fo:inline><fo:external-graphic src="url({concat($artworkPrefix,
    '/Customization/OpenTopic/common/artwork/icon_cursor.gif')})"/></fo:inline>
    <fo:inline xsl:use-attribute-sets="p.zugang"><xsl:text> Zugang: </xsl:text>
    </fo:inline>
    <xsl:apply-templates/>
    </fo:block>
    </xsl:when>
    <xsl:otherwise>
    <fo:block xsl:use-attribute-sets="p" id="{@id}">
    <xsl:apply-templates/>
    </fo:block>
    </xsl:otherwise>
    </xsl:choose>
    </xsl:template>
    

    Neu ist hier die when-Anweisung. Die otherwise-Anweisung ist das normale Template für einen Absatz.

  5. Versehen Sie den Absatz, der den Zugangsweg beinhalten soll, mit dem Attribut otherprops="zugang". Der obige Screenshot wurde über einen Absatz im prereq-Tag realisiert:
    <prereq>
    <p id="konfigbzr" otherprops="zugang" outputclass="zugang">Klicken Sie
    im <wintitle>Hauptmenü</wintitle> auf
    <menucascade>
    <uicontrol>Systemarbeiten</uicontrol>
    <uicontrol>Konfiguration Module</uicontrol>
    <uicontrol>BZR.</uicontrol>
    </menucascade></p>
    </prereq>
    
  6. Optional:
    Weitere Überlegung sollte sein, diesen Zugangsweg nur einmal zu editieren und dann per conref-Mechanismus in die jeweilige Handlungsanleitung zu ziehen. Falls sich doch mal ein Bildschirm oder Menü ändert, brauchen Sie nur in der Originaldatei den Pfad oder ähnliches ändern und durch Content Referenzierung wird die Änderung in sämtlichen Handlungsanleitungen übernommern.
  7. Optional:
    Falls Sie wie im Beispiel um den Zugangsweg einen Rahmen ziehen möchten, vergeben Sie neben dem otherprops-Attribut noch ein outputclass-Attribut und erstellen in der CSS-Datei eine Deklaration gleichen Names.

Text als PDF downloaden
Titel des Downloads: Ausgabeformat PDF
Art der Publikation: Kapitel
Beschreibung: Das gesamte Kapitel "Ausgabeformat PDF" als PDF-Datei. Ohne Leerseiten für den A4-Ausdruck optimiert.
Aktualisiert am: 28.11.2011
Anzahl der Downloads: 460
Teilen Sie die URL Ihren Xing-Kontakten mit.

21 Mai 10 Texteinrückung mit hängender erster Zeile

{lang: 'de'}

Anleitung: So erstellen Sie einen Literaturverzeichniseintrag mit hängender 1. Zeile.

Anmerkung: Der PDF-Output wird mit Hilfe des Idiom-FO-Plugins realisiert. Letzteres verwendet den RenderX als XSL-FO-Prozessor. Die “Personal Edition” unter www.renderx.com/download/personal.html ist kostenlos und zeitlich unbegrenzt für nichtkommerzielle Zwecke nutzbar.

  1. Für ein Literaturverzeichnis sollen die Absätze pro Eintrag eingerückt werden mit der ersten Zeile hängend.
    Abbildung 1. Hängende erste Zeile
    Textindent
  2. Fügen Sie in der Datei custom.xsl im Ordner \demo\fo\Customization\fo\xsl folgenden Eintrag für ein Template hinzu:
    <xsl:template match="*[contains(@class, ' topic/p ')]">
    <xsl:choose>
    <xsl:when test="@otherprops='indent'">
    <fo:block text-indent="-2em" start-indent="4.5em">
    <xsl:apply-templates/>
    </fo:block>
    </xsl:when>
    <xsl:otherwise>
    <fo:block xsl:use-attribute-sets="p" id="{@id}">
    <xsl:apply-templates/>
    </fo:block>
    </xsl:otherwise>
    </xsl:choose>
    </xsl:template>
    

    Neu ist hier die when-Anweisung. Die otherwise-Anweisung ist das normale Template für einen Absatz. Für indent können Sie eigene Entsprechungen finden. Es soll hier nur als Beispiel dienen.

  3. Versehen Sie sämtliche Absätze, die Quellenangaben enthalten sollen, mit dem Attribut otherprops="indent".
    <p otherprops="indent" outputclass="indent">
    Erich Loest: Es geht seinen Gang oder Mühen in unserer Ebene. München 1994 (dtv 10430)</p>
  4. Optional:
    Falls Sie die Texteinrückung auch in XHTML-Output haben möchten, vergeben Sie wie oben ein Attribut outputclass="indent". Erstellen Sie anschließend in der CSS-Datei eine Deklaration gleichen Namens mit einem Eintrag für text-indent.

Text als PDF downloaden
Titel des Downloads: Ausgabeformat PDF
Art der Publikation: Kapitel
Beschreibung: Das gesamte Kapitel "Ausgabeformat PDF" als PDF-Datei. Ohne Leerseiten für den A4-Ausdruck optimiert.
Aktualisiert am: 28.11.2011
Anzahl der Downloads: 460
Teilen Sie die URL Ihren Xing-Kontakten mit.

20 Mai 10 Einzelkapitel in der DITA-Druckausgabe

{lang: 'de'}

Es sollen Einzelkapitel und Kapitel mit Unterabschnitten im Inhaltsverzeichnis korrekt dargestellt werden.

So soll es aussehen

Abbildung 1. Einzelkapitel in 2. und 4.

Einzelkapitel und Unterkapitel

Damit Kapitel 2 und 4 im Plugin nicht auf der typischen zweigeteilten Startseite eines Kapitels landen, ist einiges in der bookmap zu beachten. (weiterlesen…)

Teilen Sie die URL Ihren Xing-Kontakten mit.

20 Mai 10 Inhaltsverzeichnis Print vs. Online

{lang: 'de'}

Unterschiede zwischen Print- und Online-Inhaltsverzeichnis.

1:1-übertragung des Online-Verzeichnisses?

Meistens ist immer die Online-Hilfe das erst Output-Ergebnis und man macht sich daran, die Haupt-Ditamap als Grundlage für eine Bookmap für den PDF-Output zu nehmen. So sah dann mein erstes Ergebnis des PDF-Inhaltsverzeichnisses so aus:

Abbildung 1. Erster Output im PDF-Format
Inhaltsverzeichnis im PDF
Spätestens jetzt muss man sich Gedanken machen, ob eine 1:1-Kopie des Online-Verzeichnisses für den PDF-Output geeignet ist. Hier im Beispiel des ditalogs liegt es nahe, die verschiedenen Ausgabeformate auch unter einem Stichwort Ausgabeformate zu sammeln. Doch ist dies nicht das, was dem Leser in einem Druckdokument weiterhilft. Hier wäre es besser, den einzelnen Ausgabeformaten ein eigenes Kapitel zu widmen. Man erspart sich die dritte Ebene im Inhaltsverzeichnis und der Leser erhält einen schnelleren überblick. Und überblick steht bei einem Printinhaltsverzeichnis im Vordergrund. Wer wirklich etwas Spezielles sucht, muss über das Stichwortverzeichnis gehen.

Besondere Gestaltung der bookmap

Die Bookmap bedarf also meistens eine überarbeitung und sieht im Ergebnis anders als die Online-ditamap aus.

Abbildung 2. Neue Anordnung
PDF Inhaltsverzeichnis

Egal, wie man die bookmap neu anordnet – man wird sie immer flexibel den Bedürfnissen des Lesers (nicht Nutzers) anpassen müssen.

Text als PDF downloaden
Titel des Downloads: Ausgabeformat PDF
Art der Publikation: Kapitel
Beschreibung: Das gesamte Kapitel "Ausgabeformat PDF" als PDF-Datei. Ohne Leerseiten für den A4-Ausdruck optimiert.
Aktualisiert am: 28.11.2011
Anzahl der Downloads: 460
Teilen Sie die URL Ihren Xing-Kontakten mit.

17 Mai 10 AIR Help – Umlaute im Inhaltsverzeichnis und Index

{lang: 'de'}

Anleitung: So stellen Sie deutsche Umlaute im Inhaltsverzeichnis und Stichwortverzeichnis richtig dar.

Anmerkung: Für die deutschen Umlaute ist noch manuelle Nacharbeit geboten. Für die Suchergebnisse im Search-Tab konnte ich noch keine Lösung finden.

  1. Editieren Sie die Datei C:\DITA-OT1.5\demo\lmi-airhelp\xsl\map2ahtoc.xsl folgendermaßen: Fügen Sie beim xsl:output das Attribut encoding="ISO-8859-1" hinzu.
  2. Editieren Sie die Datei C:\DITA-OT1.5\demo\lmi-airhelp\xsl\map2ahp.xsl in der gleichen Weise: Fügen Sie beim xsl:output das Attribut encoding="ISO-8859-1" hinzu.
  3. Setzen Sie den Build-Befehl für die AIR-Help-Generierung ab. Im Outputverzeichnis ändern Sie danach die Datei DATEINAME.ahix in der ersten Zeile von UTF-8 in ISO-8859-1.

Text als PDF downloaden
Titel des Downloads: Ausgabeformat AIR-Help
Art der Publikation: Kapitel
Beschreibung: Das gesamte Kapitel "Ausgabeformat AIR-Help" als PDF-Datei. Ohne Leerseiten für den A4-Ausdruck optimiert.
Aktualisiert am: 12.07.2010
Anzahl der Downloads: 116
Teilen Sie die URL Ihren Xing-Kontakten mit.

17 Mai 10 Auto-Update einrichten

{lang: 'de'}

Anleitung – So richten Sie bei der AIR-Help die Suche nach einem Update ein.

Voraussetzung: LMI Airhelp 0.06 als Plugin-Version. Ebenso muss in der Hauptditamap die Prodinfo-Versionsnummer hinterlegt sein.

  1. Nachdem Sie alle inhaltlichen Änderungen vorgenommen haben, nehmen Sie im letzten topicref-Element der Haupt-Ditamap den topicmeta-Eintrag für die Versionsnummer vor. Hier speziell vrm version.
    <topicref href="topics/common/impressum_con.xml"
    scope="local" type="concept" xml:lang="de-de">
    <topicmeta>
    <copyright><copyryear year="2009"/>
    <copyrholder>ditalog.com</copyrholder>
    </copyright>
    <prodinfo>
    <prodname>ditalog</prodname>
    <vrmlist><vrm version="0.2"/></vrmlist>
    </prodinfo>
    </topicmeta>
    </topicref>
    

    Im Beispiel ist die 0.2 die neue Versionsnummer. In der derzeitigen AIR-Applikation ist demzufolge noch die Versionsnummer 0.1 hinterlegt. Erst dieser Unterschied läßt das Adobe Update Framework verkünden, dass eine neue Version zum Download bereitsteht.

  2. Erstellen Sie eine Update-Beschreibungsdatei (update descriptor file).
    <?xml version="1.0" encoding="utf-8"?>
    <update xmlns="http://ns.adobe.com/air/framework/update/description/1.0">
    <version>0.2</version>
    <url>http://example.com/updates/ditalog_0.2.air</url>
    <description>Hier kommt Ihr kurzer Erläuterungstext.</description>
    </update>
    

    Die Einträge für version und url sind obligatorisch. Speichern Sie diese Datei unter dem Namen update.xml lokal ab.

  3. Öffnen Sie die Datei \demo\lmi-airhelp\app\common.as und tragen Sie den Wert für die Variable gAppUpdateUrl ein. Dies ist die URL der Update-Beschreibungsdatei.static public var gAppUpdateUrl:String =”http://example.com/updates/update.xml”;
  4. Starten Sie das Airhelp-Plugin. Im Output-Ordner generieren Sie anschließend mit Hilfe der Datei airhelp-packager.bat die Air-Datei.
  5. Kopieren Sie die Update-Beschreibungsdatei und die soeben erstellte Air-Datei auf den Download-Server. Die hinterlegte Domain bei beiden Dateien muß funktionieren! Testen Sie dies, in dem Sie die URL der Update-Beschreibungsdatei im Browser eingeben.
  6. Starten Sie die alte, noch installierte AIR-Applikation und klicken Sie auf die Update-Schaltfläche. Im Plugin 0.06 ist diese mit der Versionsnummer versehen. Folgendes Fenster erscheint, wenn ein Update verfügbar ist.

    Abbildung 1. Update manuell auslösen
    AIR-Help updaten

    Abbildung 2. Installation starten
    AIR Application - Installation starten

Text als PDF downloaden
Titel des Downloads: Ausgabeformat AIR-Help
Art der Publikation: Kapitel
Beschreibung: Das gesamte Kapitel "Ausgabeformat AIR-Help" als PDF-Datei. Ohne Leerseiten für den A4-Ausdruck optimiert.
Aktualisiert am: 12.07.2010
Anzahl der Downloads: 116
Teilen Sie die URL Ihren Xing-Kontakten mit.

17 Mai 10 Version und Copyright festlegen

{lang: 'de'}

Anleitung – So befüllen Sie automatisch die Datei airhelp.ahp mit Versionsnummer und Copyright-Angaben.

Damit die Angaben der Outputdatei airhelp.ahp automatisch aus den DITA-Quelldateien gefüllt werden, ist es wichtig, innerhalb der Haupt-Ditamap im letzten topicref-Eintrag ein topicmeta-Abschnitt einzufügen. Diesen gilt es entsprechend zu füllen.

<topicref href="topics/common/impressum_con.xml" id="impressum_con" scope="local"
type="concept" xml:lang="de-de">
<topicmeta>
<copyright><copyryear year="2009"/>
<copyrholder>ditalog.com</copyrholder>
</copyright>
<prodinfo>
<prodname>ditalog</prodname>
<vrmlist><vrm version="0.2"/></vrmlist>
</prodinfo>
</topicmeta>
</topicref>

Anmerkung: Ohne diese Angaben funktioniert auch der Auto-Update-Mechanismus nicht!

Text als PDF downloaden
Titel des Downloads: Ausgabeformat AIR-Help
Art der Publikation: Kapitel
Beschreibung: Das gesamte Kapitel "Ausgabeformat AIR-Help" als PDF-Datei. Ohne Leerseiten für den A4-Ausdruck optimiert.
Aktualisiert am: 12.07.2010
Anzahl der Downloads: 116
Teilen Sie die URL Ihren Xing-Kontakten mit.

17 Mai 10 DITA-Build-Datei anpassen

{lang: 'de'}

Die Datei sample_airhelp.xmlanpassen.

Ant-Befehl

Da ich Quelldateien außerhalb des DITA-OT-Ordners in einem Ordner C:\DITA-SRC abspeichere, lautet der Ant-Befehl zum Generieren der AIR-Help-Dateien folgendermaßen:

ant -f C:\DITA-SRC\build\ditalog-airhelp.xml -logger org.dita.dost.log.DITAOTBuildLogger

Build-Datei

Da ich meine individuelle CSS-Datei nutzen und eine Log-Datei generiert haben möchte, habe ich der sample_airhelp.xml zwei property-Elemente hinzugefügt und als ditalog-airhelp.xml abgespeichert.

<project name="sample_airhelp" default="sample2lmi-airhelp" basedir=".">
<property name="dita.dir" value="C:/DITA-OT1.5"/>
<import file="${dita.dir}/integrator.xml"/>

<target name="sample2lmi-airhelp" depends="integrate">
 <ant antfile="${dita.dir}/build.xml" target="init">
  <property name="args.logdir" value="C:/DITA-SRC/log" />
  <property name="args.css" value="C:/DITA-SRC/css/ditalog.css" />
  <property name="args.copycss" value="yes" />
  <property name="args.input" value="C:/DITA-SRC/ditalog.ditamap"/>
  <property name="output.dir" value="C:/DITA-SRC/out/air-ditalog/help"/>
  <property name="transtype" value="lmi-airhelp"/>
 </ant>
</target>
</project>

Text als PDF downloaden
Titel des Downloads: Ausgabeformat AIR-Help
Art der Publikation: Kapitel
Beschreibung: Das gesamte Kapitel "Ausgabeformat AIR-Help" als PDF-Datei. Ohne Leerseiten für den A4-Ausdruck optimiert.
Aktualisiert am: 12.07.2010
Anzahl der Downloads: 116
Teilen Sie die URL Ihren Xing-Kontakten mit.