AXitd DU1 DocBook Umgebung V2.0

Mit der Datei DU1\publish\make_titelseiten.bat können Sie ein Stylesheet (notwendige XSL-Datei) für Ihre persönliche Titelseite erzeugen. Eine Anpassung dieser Datei ist nicht notwendig.

java.exe -cp %saxon%saxon.jar;%home%\xsl\extensions\saxon652.jar  
com.icl.saxon.StyleSheet 
-o %home%xsl\fo\mytitlepage.xsl 
%home%xsl\fo\mytitlepage.spec.xml 
%home%xsl\template\titlepage.xsl

Was passiert beim Aufruf?

Um eine persönliche Titelseite zu entwerfen öffnen Sie die Datei DU1\xsl\fo\mytitlepage.spec.xml

<!--
        ********************************************************************
        $Id: titlepage.templates.xml,v 1.22 2003/09/16 16:29:34 bobstayton Exp
        $ ********************************************************************
        This file is part of the DocBook XSL Stylesheet distribution. See
        ../README or http://docbook.sf.net/ for copyright and other
        information.
        ********************************************************************
        --> <!--
        ====================================================================
        --> <t:titlepage font-family="{$title.fontset}"
        t:element="article" t:wrapper="fo:block">
        <t:titlepage-content t:side="recto"
        text-align="center"> <title
        font-size="24.8832pt" font-weight="bold"
        keep-with-next="always"
        param:node="ancestor-or-self::article[1]"
        t:named-template="component.title"></title>
        <subtitle></subtitle> <corpauthor
        font-size="14.4pt"
        space-before="0.5em"></corpauthor>
        <authorgroup font-size="14.4pt"
        space-before="0.5em"></authorgroup> <author
        font-size="20.736pt"
        space-before="0.5em"></author> <othercredit
        space-before="0.5em"></othercredit>
        <releaseinfo
        space-before="0.5em"></releaseinfo> <copyright
        space-before="0.5em"></copyright> <legalnotice
        font-family="{$body.fontset}" margin-left="0.5in" ....
        .....

Editieren Sie die betreffenden Bereiche oder fügen Sie neue Parameter hinzu. Anleitung welche Bereiche sich wie auswirken finden Sie in Bob Staytons Beschreibung bei SageHill

Speichern Sie Ihre Änderungen ab und führen Sie die Datei DU1\publish\make_titelseiten.bat aus.

	Anmerkung
	Standardmäßig wird in der AXitd DocBook Umgebung eine Titelseite mit Titelgrafik d.h eine vorbereitete mytitlepage.xsl bereitgestellt. Machen Sie sich eine Sicherungskopie bevor Sie diese modifizieren. Die Titelgrafik wird im Element <bookinfo> am Anfang Ihres Dokumentes festgelegt.

Um anspruchsvollere Titelseiten zu entwerfen sollten Sie in Ihrem Konfiguration-File (driver_fo.xsl) eine Tabelle mit den Elementen Ihrer Titelseite entwerfen, die das Positionieren der Elemente vereinfacht. Wenn das zu aufwendig ist (z.B. bei Einmalproduktion) empfehle ich die Titelseiten in einem DTP-Programm zu entwerfen und im PDF auszutauschen.

Aufbau und Parameter der fortlaufenden Seiten legen Sie in der Datei DU1\publish\driver\driver_fo.xsl fest. Definieren Sie hier:

etc.

<xsl:import
        href="..\..\xsl\fo\docbook.xsl"/> <xsl:include
        href="..\..\xsl\fo\mytitlepage.xsl"/>
        <!-- bookmarks --> <xsl:param
        name="fop.extensions"
        select="1"></xsl:param> <xsl:param
        name="paper.type"
        select="'A4'"></xsl:param> <xsl:param
        name="table.frame.border.color"
        select="'blue'"></xsl:param>
        <xsl:param name="table.cell.border.color"
        select="'blue'"></xsl:param>
        <xsl:param name="tablecolumns.extension"
        select="'1'"></xsl:param> <xsl:param
        name="alignment">left</xsl:param>
        <xsl:param name="section.autolabel"
        select="1"></xsl:param> <xsl:param
        name="section.label.includes.component.label"
        select="1"></xsl:param> <xsl:attribute-set
        name="section.title.level2.properties"> <xsl:attribute
        name="font-size"> <xsl:value-of
        select="$body.font.master * 1.228"></xsl:value-of>
        <xsl:text>pt</xsl:text> </xsl:attribute>
        </xsl:attribute-set> ..... .....

Anleitung welche Bereiche sich wie auswirken finden Sie in Bob Staytons Beschreibung Print Customizations bei Sagehill.

Bei der PDF- Ausgabe werden für Grafiken die Skalierungsattribute des imagedata Elementes herangezogen um die Grafiken auf der ausgegebenen Seiten entsprechend zu skalieren. Für Seitenbreite wurde eine Grafikbreite von 12cm verwendet, für halbe Seite sind 8cm voreingestellt.

Diese Grafikskalierung wurde bei der Ausgabe in HTML ausgeschaltet. Dort werden die Originalgrößen der Grafiken verwendet. (Attribut ignore.imagescaling in den html- Konfigurationsdateien)

Tipp

Wenn Sie die Grafiken in HTML und PDF Ausgabe verschieden skalieren wollen, müssen Sie in das mediaobject mehrere imageobjecte einfügen und diese unterschiedlich skalieren. Bei der Ausgabe müssen Sie den Parameter <xsl:param name="preferred.mediaobject.role"></xsl:param> entsprechend anpassen. Mit diesem Parameter können Sie bestimmen, welche der Grafiken bei der Ausgabe bevorzugt ausgegeben werden.

Wechseln Sie zur Publikation in Ihre DOS-Konsole.

Wenn Sie die PDF Datei erzeugt haben werden Sie feststellen, dass es an einigen Stellen noch Verbesserungsbedarf gibt, um ein optimales Printergebnis zu erreichen. Nachfolgend einige Tipps zur Verschönerung:

	Anmerkung
	Führen Sie die folgenden Anpassungen erst nach Fertigstellung Ihrer Dokumentation oder an einer Sicherheitskopie durch.

<xsl:param name="body.font.family">sans-serif</xsl:param>

Seitenumbrüche in AXitd DU1

Entscheiden Sie sich einen harten Zeilenumbruch einzufügen, müssen Sie in der XML-Sourcedatei an die entsprechende Stelle die Prozessanweisung, z.B. wie hier zwischen zwei <sect2> Elementen , also Unterabschnitten eingeben. Verwenden Sie dazu einen Texteditor.

	Tipp
	Im XML Mind XML-Editor können Sie diese Processing Instruction (PI) als Kommentar eingeben, als Prozessanweisung funktioniert es nicht, weil kein Ziel der Anweisung angegeben ist. Rufen Sie dazu unter: Bearbeiten -> Kommentar -> Kommentar einfügen auf und geben Sie <?axitd-pagebreak ?> ein

</sect2> 
        <?axitd-pagebreak ?>  ---hier beginnt der neue sect2---
<sect2 id="html_single">

Diese Prozessanweisung wird in der driver_fo.xsl Datei abgefragt und mit einem Pagebreak in XSL:FO umgesetzt. (Beispiel aus driver-fo.xsl)

<!-- eigener pagebreak --> 
<xsl:template match="processing-instruction('axitd-pagebreak')">
      <fo:block break-before='page'></fo:block>
</xsl:template>

Sie können die Prozessanweisung natürlich auch entsprechend umbenennen.

<xsl:param name="alignment">left</xsl:param>

Voraussetzung für die Erzeugung kontextsensitiver Hilfen ist das Vorhandensein einer map-Datei oder Zuordnungsdatei, die Ihnen von der SW-Entwicklung zur Verfügung gestellt wird. In dieser Datei muss definiert werden, für welche Dialoge (Bildschirme) eine kontextsensitive Hilfe angezeigt werden soll und welchen Identifikator (ID) diese Hilfe haben muss.

Um die Verknüpfung der Identifikatoren zu Ihrer Docbook Datei herzustellen, ist die Prozessanweisung <?dbhh topicname="some_title" topicid="4321"?> zu verwenden.

Geben Sie an die entsprechende Stelle in Ihrer Datei die enstprechende PI ein. Wichtig ist, dass die PI nur für die Abschnitte verwendet werden kann, für die später auch eine eigene HTML-Instanz erzeugt wird. (ID für Instanz muss vergeben sein)

<chapter id="zweck">
<?dbhh topicname="ID_zweck" topicid="1000"?>
 <title id="titel_zweck">Zweck</title>
   <para>Die vorliegende Dokumentation gibt Anleitung zur Installation und
    Einrichtung zur Bedienung von DocBook Umgebung. Aktuelle Version können
    Sie im Downloadbereich auf der <ulink url="http://www.axitd.de.vu">AXitd
    Homepage </ulink>erhalten. 
....
 </para>
</chapter>
<chapter id="quickstart">
<?dbhh topicname="ID_quick" topicid="1001"?>
 <title>Quickstart<indexterm>
    <primary>Quickstart</primary>
    </indexterm>
   </title>

...

Im vorliegenden Beispiel werden für die IDs: ID_zweck und ID_quick jeweils eine kontextsensitive Hilfeseite zur Verfügung gestellt.

Die HTMLhelp-XSL Stylesheets erzeugen nun automatisch die header-Dateien: alias.h und context.h, die in Ihr HTML-Projekt eingebunden werden. (Beim Kompilieren mit dem HTML Workshop)

alias.h verknüpft die IDs mit der jeweiligen HTML-Datei (hier werden die IDs als Dateiname verwendet)

ID_zweck=zweck.html
ID_quick=quickstart.html

context.h stellt die Verbindung zum HTML-Helpset her

#define ID_zweck   1000
#define ID_quick   1001

Die Ordnungszahlen dienen hierbei nur der internen Verwaltung des HTML-Help Workshops. Der Compiler mapt die numerischen IDs im header file mit den Help Topics.

Kompilieren Sie die Hilfe wie oben beschrieben.

Testen Sie, indem Sie im Menü Test ->HTMLHELP API aufrufen

Testen Sie die kontextsensitiven Instanzen, indem Sie im Feld Map number die Ordnungsnummern aus der context.h eingeben. Im Feld Window geben Sie: main ein. Im Feld Command: HH HELP CONTEXT

Wenn alles klappt sollten die entsprechenden Hilfeseiten aufgerufen werden können.

Laden Sie sich das JavaHelp System (Datei: javahelp-1_1_3.zip oder javahelp-2_0_02.zip) von der Sun JavaHelp Seite herunter. Entpacken Sie die Distribution in ein Verzeichnis Ihrer Wahl. Lesen Sie die Anweisungen zur Einrichtung der JavaHelp Umgebung in der beiliegenden Readme-Datei und Dokumentation.

Öffnen Sie eine DOS Konsole.

Da JavaHelp Probleme mit einigen Unicode Steuerzeichen zu haben scheint, müssen Sie zuerst die Datei: jhelpidx.xml aus dem Verzeichnis DU1\output\javahelp mit einem XML- oder Texteditor öffnen und ändern.

Die betreffenden Zeichen sind XML Character Entities, die bei der Publikation kopiert werden. Insbesondere &#xA, &#8220, or &#x8221, Hard Return, Öffnende und schließende Anführungszeichen. Diese können offensichtlich vom integrierten HTML-Browser nicht angezeigt werden.

Entfernen Sie die betreffenden Zeichen und ersetzen Sie durch 'normale' Anführungszeichen. Entfernen Sie den Hard Return

	Tipp
	Alternativ können Sie auch die common/de.xml im XSL-Verzeichnis nach den Zeichen durchsuchen und durch eine Konfigurationsdatei anpassen. Dann sparen Sie sich die Aufbereitung bei jeder Publikation. Angeblich wird diese Fehlfunktion (nicht von DocBook sondern des JavaHelp Browsers) auch in einer späteren Stylesheet version von DocBook behoben.

Als Nächstes müssen Sie eine Datenbank für die Volltextsuche generieren. Dazu steht Ihnen in Ihrem JavaHelp System das Tool:~\jh1.1.3\javahelp\bin\jhindexer.jar zur Verfügung. Für den Test der Datenbank das Tool ~\jh1.1.3\javahelp\bin\jsearch.jar

Datenbank erzeugen

Der jhindexer generiert die Datenbank für die Volltextsuche, die vom JavaHelp System benutzt wird um Treffer anzeigen zu können. Um die Datenbank zu erzeugen benutzen Sie folgendes Kommando.

	Tipp
	Sie können die erzeugte Datenbank auch im Standalone Betrieb benutzen, lesen Sie dazu die JavaHelp System Dokumentation:

Der allgemeine Aufruf lautet:

Win32 jhindexer [options] [file | folder]*

Für die DU1 Umgebung bedeutet das:

D:\tools\javahelp1_1_3\jh1.1.3\javahelp\bin>java -jar 
jhindexer.jar -c config -db
c:\du1\output\javahelp\JavaHelpSearch c:\du1\output\javahelp\

Lesen Sie die JavaHelp System Dokumentation für weitere Optionen.

	Aufruf des tools jhindexer aus dem Installationsverzeichnis Ihres JavaHelp Systems
	Ihre verwendete Konfigurationsdatei mit dem Namen config. Diese dient für das JavaHelp System u.a. zum Adressieren der Pfadnamen und muss von Ihnen angepasst wird. Liegt in diesem Fall im Verzeichnis des jhindexers
	Die Daten für die Datenbank werden im Verzeichnis JavaHelpSearch abgelegt, auf die das JavaHelp System standardmäßig zugreift
	Das Verzeichnis über das die Volltextsuche-Datenbank erstellt wird

Noch ein paar Anmerkungen zum Config File: Dies dient u.a. zum Ändern der Pfadnamen, die beim Erzeugen der Volltextdatenbank gespeichert werden. Wenn sich die Pfade beim Entwickeln und im späteren Help System unterscheiden kann das System im Config File die Pfade wiederfinden

Weitere Anwendungsfälle sind das Einfügen von Stopwörtern, die nicht indiziert werden und die Definition von bestimmten Pfaden für die Indexierung. Mehr dazu in der Dokumentation zum JavaHelp System.

Datenbank für Volltextsuche testen

Öffnen Sie das Tool jhsearch aus Ihrem JavaHelp System

D:\tools\javahelp1_1_3\jh1.1.3\javahelp\bin>
java -jar jhsearch.jar 
c:\du1\output\javahelp\JavaHelpSearch

Der Standardaufruf aus dem Ordner javahelp\bin\ lautet:

Win32 jhsearch database_folder

jhsearch ist ein kommandobasiertes Programm um die Gültigkeit Ihrer erzeugten Datenbank zu testen. Wenn der Programmaufruf erfolgreich ist, meldet sich das Programm wie folgt:

Geben Sie einen Suchbegriff ein, bei erfolgreicher Suche bekommen Sie die Anzahl der Treffer und die zugehörigen Dateien in denen der Treffer auftaucht angezeigt.

Nachdem Sie nun Index und Volltextsuche erzeugt und bereinigt haben, können Sie Ihre Hilfe in einer JavaHelp Konsole testen.

D:\tools\javahelp1_1_3\jh1.1.3\demos\bin\>java -jar hsviewer.jar

Es öffnet sich eine Auswahlbox für die Auswahl der Helpsetdatei

Klicken Sie auf Browse und wählen Sie Ihre *.hs Datei aus Ihrem javahelp-Verzeichnis aus (c:\du1\output\javahelp)

Um die erzeugten Dateien weiter zu verteilen werden sie am Besten ins jar Format gepackt. Benutzen sie dazu das JAR Tool von Java. Packen Sie das helpset-file (*.hs) und die zugehörige map Datei mit in das jar-Verzeichnis. Zusätzlich natürlich die erzeugten HTML Dateien, die Grafiken und die Inhaltsverzeichnisdatei. Um sicherzugehen, dass nichts fehlt sollten Sie das gesamte ~/output/java_output Verzeichnis mit in Ihr Archiv packen

Informationen zur Verwendung und Konfiguration des JAR Tools erhalten Sie im SUN Themenbereich JAR

Nach Aufruf des XSL utilities müssen Sie folgende Konfigurationen durchführen:

Starten Sie nun die Konvertierung in das von Ihnen gewählte Verzeichnis durch Aufruf des Convert Schalters:

Öffnen Sie nun die erzeugte RTF- Datei aus dem Outputverzeichnis (du1/output) z.B. mit Microsoft Word™ und speichern die Datei im *.doc Format ab. Erfahrungsgemäß sind noch einige Finetune - Maßnahmen erforderlich z.B.

Bestimmt die HTML Ausgabe (Ausgabe einer kompletten HTML Seite)

<xsl:stylesheet
        xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
        version="1.0"> <xsl:import
        href="..\..\xsl\html\docbook.xsl"/> <!--
        +++Grafiken fuer Navigation unterdruecken++++++++++++ -->
        <xsl:param name="navig.graphics" select="0"/>
        <!-- ++++++++Piktogramme zulassen ++++++++++++++++ -->
        <xsl:param name="admon.graphics" select="1"/> 
<!-- ++++++++++++Tabellen ++++++++++++++++++++++++
        --> <xsl:param name="html.cellspacing"
        select="'0.5'"/> <xsl:param
        name="html.cellpadding" select="'4'"/>
        <!-- +++++++generiert index: im Text muss an Stelle leerer Index
        stehen (<index/>)+++ --> <xsl:param
        name="generate.index" select="1"/>
        ........ .......

Die Anpassungen sind im Wesentlichen kommentiert, Standardmäßig wird eine Kopf und Fußzeilengrafik erzeugt. Fügen Sie weitere Parameter nach unten genanntem Schema ein.

Eine Übersicht aller DocBook-Parameter für die HTML-Ausgabe finden Sie im Ordner: DU1/xsl/doc/html/index.html

Beispiel 6.1. Kommentierte Beispiele zur HTML Anpassung

	Wählen Sie 1, wenn die Grafiken für Vorsicht, Achtung, Hinweis etc. angezeigt werden sollen, wählen Sie 0, wenn statt dessen nur der Wortlaut angezeigt werden soll.
	Soll ein Index (Stichwortverzeichnis) erzeugt werden, so ist dieser Parameter auf 1 zu setzen. Anmerkung Im der XML Source muss ein leeres Index Element stehen, damit ein Index generiert wird, ansonsten hilft auch der Parameter 1 nicht weiter.

Bestimmt die HTML Ausgabe in mehrere Seiten (Chunks)

<xsl:stylesheet
        xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
        version="1.0"> <xsl:import
        href="..\..\xsl\html\chunk.xsl"/> <xsl:param
        name="navig.graphics" select="0"/> <xsl:param
        name="admon.graphics" select="1"/> <xsl:param
        name="html.cellspacing" select="'0.5'"/>
        <xsl:param name="html.cellpadding"
        select="'4'"/> <xsl:param
        name="generate.index" select="1"/> <!--
        Benutze die id-Namen als html-Namen -->
        <xsl:param name="use.id.as.filename"
        select="'1'"> </xsl:param> <!--
        Navigation im HTMLTeil ermöglicht wichtig --> <xsl:param
        name="suppress.navigation" select="0"/> 
        <!--output directory for chunks --> 
        <xsl:param name="base.dir" select="'..\umgebung_publish\output\'">
        </xsl:param> .....

Standardmäßig wird auch in dieser Ausgabe eine Titelgrafik als Kopfzeile erzeugt.

Die Anpassungen sind im Wesentlichen kommentiert, standardmäßig wird eine Kopf und Fußzeilengrafik erzeugt. Fügen Sie weitere Parameter nach unten genanntem Schema ein.

Eine Übersicht aller DocBook-Parameter für die HTML-Ausgabe finden Sie im Ordner: DU1\xsl\doc\html\index.html

Beispiel 6.2. Kommentierte Beispiele zur HTML-Chunk Anpassung

	Wenn Sie in Ihrer Dokumentation für die Abschnitte Identifikatoren (IDs) vergeben haben, werden diese als Namen für die HTML-Dateien verwendet, wenn Sie den Parameter setzen. Dies erleichtert das spätere Auffinden im Output-Verzeichnis und die Kontrolle von Links.
	Dieser Parameter bestimmt, in welches Verzeichnis die HTML Dateien ausgegeben werden. Geben Sie hier Ihr Ausgabeverzeichnis für die erzeugten HTML-Fragmente an. Beachten Sie, dass dieses Verzeichnis die Grafiken für alle Ausgabeformate, sowie evtl eingesetzte Stylesheets (css) enthalten muss.

Bestimmt die Ausgabe im HTML-Help Format

...... <!-- ========================= -->
        <!-- filename für output --> <xsl:param
        name="htmlhelp.chm"
        select="'handbook.chm'"/>
        <!-- Piktogramme anzeigen --> <xsl:param
        name="admon.graphics" select="1"/> <!-- zeigt
        Favoriten an --> <xsl:param
        name="htmlhelp.show.favorities" select="1"/>
        <xsl:param name="html.cellspacing"
        select="'0.5'"/> <xsl:param
        name="html.cellpadding" select="'4'"/>
        <!-- benutze die hhk (Index Datei --> <xsl:param
        name="htmlhelp.use.hhk" select="1"/>
        ..............

Die Anpassungen sind im Wesentlichen kommentiert. Standardmäßig wird eine Kopf- und Fußzeilengrafik erzeugt. Fügen Sie weitere Parameter nach unten genanntem Schema ein.

Eine Übersicht aller DocBook-Parameter für die HTML-Ausgabe finden Sie im Ordner: .DU1\xsl\doc\html\index.html

Beispiel 6.3. Beispiel zur Anpassung der HTML Help Ausgabe

	Name der komprimierten Hilfe
	Diesen Parameter setzen, wenn die Hilfe das Register Favoriten erhalten soll

Dieser Driver unterscheidet sich vom driver_help nur dadurch, dass nicht erneut alle Inhaltsdateien ausgegeben werden sondern nur die Projektdateien, die zur Generierung der komprimierten Hilfe erforderlich sind. Benutzen Sie diese Datei, wenn Sie bereits die HTML Seiten ausgespielt haben und die Hilfe durch Verändern der Parameter noch anpassen wollen. Siehe:„driver_htmlhelp.xsl“

 .......<!-- Es werden nur Projectfiles erzeugt
        --> <xsl:param name="htmlhelp.only"
        select="1"></xsl:param> ..... 

Bestimmt die Ausgabe im JavaHelp Format

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:import href="..\..\xsl\javahelp\javahelp.xsl"/>
<!-- axitd docbook du1.2 03.2005 -->
<!-- Navigation im HTMLTeil ermöglicht wichtig -->
<xsl:param name="suppress.navigation" select="1"/>
<!-- Grafiken zum Navigieren -->
<xsl:param name="navig.graphics" select="0"/>
<!-- Titel der über der Hilfe angezeigt wird, nicht Dateiname -->
<xsl:param name="htmlhelp.title" select="'AXitd'"/>
<!-- === fügt Stylesheet ein === -->
<xsl:param name="html.stylesheet.type">text/css</xsl:param>
<xsl:param name="html.stylesheet" select="'global.css'"/>
<!-- ========================= -->

...... 

Die Anpassungen sind im Wesentlichen kommentiert. Standardmäßig wird eine Kopf- und Fußzeilengrafik erzeugt. Fügen Sie weitere Parameter nach unten genanntem Schema ein.

Eine Übersicht aller DocBook-Parameter für die HTML-Ausgabe finden Sie im Ordner: DU1\xsl\doc\html\index.html

Beispiel 6.4. Beispiel zur Anpassung der JavaHelp Ausgabe

	Soll die Navigation zur folgenden HTML-Seite im Navigationsfenster ermöglicht werden?
	Jeder HTML Datei wird das Stylesheeet global.css zugewiesen

Erzeugt die XSL:FO Ausgangsdatei für PDF,RTF Ausgabe durch FOP oder anderen FO-Prozessoren (z.B. Antenna House XSLT Formatter oder RenderX XEP). Diese Datei wird nach Ihrer Bestätigung in eine PDF-Datei ausgegeben.

Die PDF Erzeugung wurde bewusst in die 2 Schritte: Erzeugung XSL:FO und von dort aus in PDF, getrennt um eventuelle Manipulationen am XSL:FO vornehmen zu können und die FO-Datei für Publikation in andere Medien zur Verfügung zu stellen. Wenn Sie diesen Schritt auslassen wollen können Sie mit FOP auch direkt aus Ihrem XML-Source PDF Dateien erzeugen, siehe dazu die FOP-Dokumentation

java -jar saxon.jar  -o ..\output\temp_output.fo 
..\Projects\%1\%2.xml driver\driver_fo.xsl "fop.extensions=1" 

....

fop -c userconfig.xml -fo "..\output\temp_output.fo" 
"..\output\ausgabe.pdf" 

Erzeugt die PDF-Ausgabe, wenn Sie Module zu einem PDF File zusammenfassen wollen. Wie make_pdf.bat in zwei Prozess schritte aufgeteilt.

java.exe -cp %saxon%saxon.jar;%home%\xsl\extensions\saxon652.jar 
 com.icl.saxon.StyleSheet -o %output%\temp_output.fo 
%projects%\%1\%2.xml 
%publish%\driver\driver_fo.xsl 
fop.extensions="1" 
current.docid="%3"

In dieser batch werden die Module mit Referenz auf die ID des aufgerufenen Dokumentes (Parameter: current.docid) aufgerufen. Die Parameter für die Übergabe der Referenzdaten werden durch das driver file: driver_fo.xsl an den XSL Prozessor übergeben:

<!-- olinks -->
<xsl:param name="insert.xref.page.number">no</xsl:param>
<xsl:param name="use.local.olink.style" select="0"></xsl:param> 
<xsl:param name="target.database.document">olinkdb_fo.xml</xsl:param>
<xsl:param name="xref.label-title.separator">: </xsl:param>
<xsl:param name="xref.with.number.and.title" select="1"></xsl:param>

Um die Titelseiten in der PDF-Ausgabe auf Ihre Bedürfnisse anzupassen (Layout, wie z.B.Position der Titelzeile, Grafiken, Elemente etc. , (nicht Inhalt der Elemente, der wird in driver.xsl festgelegt) müssen Sie im ersten Schritt ein Stylesheet mytitlepage.xsl erzeugen.

Dazu bearbeiten Sie zuerst die Datei mytitlepage.spec.xml mit Ihren Vorgaben, woraus DocBook dann eine mytitlepage.xsl erstellt, die bei der Umwandlung in PDF berücksichtigt wird.

In der AXitd DocBook Umgebung ist bereits eine voreingestellte mytitlepage.spec.xml enthalten. Diese können Sie übernehmen oder anpassen.s. Verzeichnis: DU1/xsl/fo/mytitlepage.spec.xml

Näheres zur Erzeugung von Titelseiten für die PDF-Ausgabe siehe Dokumentation zu DocBook.

Wenn Sie Änderungen an der mytitlepage.spec.xml vornehmen können Sie diese mit der Titelseiten_template_erzeugen.bat in die mytitlepage.xsl umwandeln.

saxon -o
"..\xsl\fo\mytitlepage.xsl"
"..\xsl\fo\mytitlepage.spec.xml"
"..\xsl\template\titlepage.xsl"
pause

An der Batch-Datei selbst sind keine Anpassungen notwendig. Bei der nächsten Erzeugung einer PDF-Datei werden Ihre Änderungen, die Sie in der mytitlepage.spec.xml vorgenommen haben wirksam.

Steuert die HTML-Ausgabe für Einzelseiten (Chunks), es wird die Anpassungsdatei driver_html_chunks.xsl angezogen.

Ihre XML-Datei wird in mehrere HTML-Einzelseiten zerhackt.

java -jar saxon.jar  "..\Projects\%1\%2.xml" 
"driver\driver_html_chunks.xsl"

Die Ausgabe erfolgt ins Verzeichnis .\output in das auch die zugehörige Grafiken exportiert werden.

	Tipp
	Sichern Sie die Daten nach Produktion in ein anderes Verzeichnis.(Nach Datum sortieren)

Steuert die HTML-Ausgabe in eine einzelne HTML-Datei mit Inhaltsverzeichnis. Es wird die Konfigurationsdatei driver_html.xsl angezogen.

java -jar saxon.jar  -o "..\output\output.htm" 
"..\Projects\%1\%2.xml" "driver\driver_html.xsl"

Steuert die HTML Ausgabe, wenn Sie mehrere Module zu einer HTML Datei zusammenfassen wollen.

java.exe -cp %saxon%saxon.jar;%home%\xsl\extensions\saxon652.jar
 com.icl.saxon.StyleSheet 
-o %output%\output.htm 
%projects%\%1\%2.xml 
%publish%\driver\driver_html.xsl 
target.database.document="olinkdb_html.xml" 
olink.base.uri="output.htm" 
current.docid="%3"

Beim Aufrufen des Befehls muss als dritter Parameter die ID des aufrufenden Dokumentes (current.docid) mit angegeben werden. Als Ausgabedatei ist die Datei du1\output\output.htm voreingestellt. Die Referenzen werden mit der target database olinkdb_html.xml aufgelöst, die wiederum auf das Datenfile xxxxx_html.db verweist, die im gleichen Verzeichnis liegt.

Steuert die HTML-Help Ausgabe. Es wird die Konfigurationsdatei driver_htmlhelp.xsl angezogen.

java -jar saxon.jar   "..\Projects\%1\%2.xml" 
"driver\driver_htmlhelp_projectfiles.xsl" 

Steuert die JavaHelp Ausgabe. Es wird die Konfigurationsdatei driver_javahelp.xsl angezogen.

java.exe -cp %saxon%saxon.jar;%home%\xsl\extensions\saxon652.jar  com.icl.saxon.StyleSheet 
 %projects%\%1\%2.xml %publish%\driver\driver_javahelp.xsl base.dir=%output%\javahelp\

Steuert die bedingte JavaHelp Ausgabe. Es wird die Konfigurationsdatei driver_javahelp_profile.xsl angezogen.

java.exe -cp %saxon%saxon.jar;%home%\xsl\extensions\saxon652.jar 
 com.icl.saxon.StyleSheet 
 %projects%\%1\%2.xml %publish%\driver\driver_javahelp_profile.xsl 
base.dir=%output%\javahelp\

Steuert die Ausgabe der HTML-Help Produktion, wenn Sie nur neue Projektdateien erzeugen wollen (z.B. nach Änderung der HTML-help driver Files etc.) Ihre Projektinhalte aber ansonsten gleich bleiben. Es wird die Anpassungsdatei driver_htmlhelp_projektfiles.xsl angezogen.

 java -jar saxon.jar   "..\Projects\%1\%2.xml" 
"driver\driver_htmlhelp_projectfiles.xsl" 

Erzeugt mittels des libxml2 tools xmllint eine temporäre XML-Datei, in der die XIncludes durch den Inhalt der referenzierten Module ersetzt werden:

%xmllint%xmllint.exe --xinclude 
%projects%\%1\%2.xml > %projects%\%1\modules_resolved.xml

Die temporäre XML-Datei heißt immer: modules_resolved.xml, wird ins aktuelle Projektverzeichnis publiziert und kann mit den normalen Stylesheets weiterverarbeitet werden.

Dient zum Erzeugen des data files für die Zusammenfassung mehrerer Module zu einer HTML Seite.

%xmllint%xsltproc.exe 
--xinclude 
--stringparam collect.xref.targets "only" 
--stringparam targets.filename "%projects%\%1\%2_html.db" 
%home%\xsl\html\docbook.xsl 
%projects%\%1\%2.xml

Für die Produktion kommt das Werkzeug xsltproc™ aus dem Verzeichnis C:\du1\xmllint2\ zum Einsatz, das die im aufrufenden XML-file enthaltenen XIncludes auflöst und eine komplette Datei für alle Referenzen in den verknüpften Modulen erstellt. Die Ausgabe erfolgt in die Datei: xxxxx_html.db, die ins root Verzeichnis Ihres Projektes abgelegt wird. Wird bei der Publikation einer HTML Seite mit dem Befehl make_html_module verarbeitet.

Dient zum Erzeugen des data files für die Zusammenfassung mehrerer Module zu einer PDF Datei.

%xmllint%xsltproc.exe 
--xinclude 
--stringparam collect.xref.targets "only" 
--stringparam targets.filename "%projects%\%1\%2_pdf.db" 
%home%\xsl\fo\docbook.xsl 
%projects%\%1\%2.xml

Für die Produktion kommt das Werkzeug xsltproc™ aus dem Verzeichnis C:\du1\xmllint2\ zum Einsatz, das die im aufrufenden XML-file enthaltenen XIncludes auflöst und eine komplette Datei für alle Referenzen in den verknüpften Modulen erstellt. Die Ausgabe erfolgt in die Datei: xxxxx_fo.db, die ins root Verzeichnis Ihres Projektes abgelegt wird. Wird bei der Publikation einer HTML Seite mit dem Befehl make_pdf_module verarbeitet.

Dient zum Erzeugen eines mindmaps für eine Projektübersicht.

%xmllint%\xsltproc -o %output%\%2.mm 
#%publish%\driver\tools\docbk2mm.xslt 
%projects%\%1\%2.xml

Für die Produktion kommt das Werkzeug xsltproc™ aus dem Verzeichnis C:\du1\xmllint2\ zum Einsatz, die mittels des Stylesheets docbk2mm.xslt eine Datei erzeugt, die Sie in Freemind öffnen können.

Erzeugt eine HTML Liste der verwendeten Grafiken.

java.exe -cp %saxon%saxon.jar;%home%\xsl\extensions\saxon652.jar  
com.icl.saxon.StyleSheet 
-o %output%\images.htm 
%projects%\%1\%2.xml 
%publish%\driver\tools\imagedata.xsl 

Mittels des Stylesheets imagedata.xsl wird in das output Verzeichnis eine HTML Datei mit einer Übersicht über alle im aufgerufenen Dokument verwendeten Grafiken erzeugt.

Erstellen Sie zuerst ein Masterdokument der Ebene article, book oder set in einem übergeordneten Projektordner (Unterordner du1\projects). Das Masterdokument ist eine Schablone die vorgibt, in welcher Reihenfolge welche Module publiziert werden sollen, kann aber gleichzeitig auch beliebige DocBook Dokumente enthalten.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"../../struktur/DocBook/docbookx.dtd" 
[
<!ENTITY intro "part1/intro.xml">
<!ENTITY basics "part1/getting_started.xml">

]>
<book>

<title>User Guide</title>
<subtitle>This should show how it should work with modules</subtitle>

<xi:include href="&intro;" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="&basics;" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="end/end.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
<xi:fallback>
					
			<para>
				<emphasis>FIXME: MISSING XINCLUDE CONTENT</emphasis>
			</para>
		</xi:fallback>
	</xi:include>

</book>

Das Masterdokument ist folgendermaßen aufgebaut:

	DTD und Kopf des Moduls (validiert gegen book Element). Masterdokument ist ein normales Docbook Dokument (set, book), allerdings ist XInclude kein DocBook Element, so dass es beim Validieren gegen die DocBook DTD zur Fehlermeldung kommt. Falls dies stört, kann die DTD entsprechend modifiziert werden und in die driver files eingebunden werden. In XXE kann es geöffnet und bearbeitet werden ohne dass es zur Fehlermeldung kommt.
	Entitäten mit Verweis auf die verknüpften Module. Nicht unbedingt notwendig, Pfade können auch direkt in die hrefs geschrieben werden. Dient aber der besseren Lesbarkeit und Editierbarkeit. Die Module sind in Unterordnern abgelegt. Ermöglicht bessere Verwaltung der Module.
	Inhalt des Masterdokumentes. Das Masterdokument wird beim späteren Publizieren als ganz normales DocBook Dokument verarbeitet, daher sind alle DocBook Elemente erlaubt.
	Verweis auf die Module mit XInclude. Welche Hierarchiebene die Module haben wird in den Modulen selbst angegeben. Hier handelt es sich um chapter Elemente. Die Module können ebenfalls selbst Verweise auf andere Dokumente enthalten.
	Fallback, falls ein Modul (noch) nicht existiert. In der Ausgabe wird der Text: FIXME: MISSING XINCLUDE CONTENT als Erinnerung ausgegeben, beim Auflösen der XIncludes, kommt es zur Fehlermeldung, allerdings wird Prozess nicht abgebrochen. Anmerkung Kommt (zumindest bei mir) aber zu Fehlermeldungen bei der PDF Publikation, weil ein nicht zusammenhängender XSL:FO block gebildet wird, der von FOP nicht verarbeitet werden kann. Daher bei PDF Publikation mit Vorsicht zu genießen.

	Anmerkung
	Beispieldokumente für Module sind im Ordner du1\Projekte\beispiel_modul\part1

Die Module sind gültige DocBook Dokumente, und können daher einzeln validiert oder prozessiert werden. Die Deklaration bestimmt, in welcher Ebene sie ins Master Dokument eingefügt werden. Im Beispiel handelt es sich um Module in der chapter Ebene, das nach den DocBook Regeln erstellt wird. Für die bessere Verwaltung ist es sinnvoll die Module in Unterordnern abzulegen. Es ist unbedingt notwendig, das Attribut id des übergeordneten Knotens (hier chapter) zu vergeben.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"../../../struktur/DocBook/docbookx.dtd">
<chapter id="intro">
	<title>Introduction to the documentation</title>

	<para>This guide shows you how to use the software.</para>
	<para>If you don&#39;t want to believe, try it</para>
</chapter>

Es ist sinnvoll den Grafikordner (verwenden Sie die Bezeichnung images) in den selben Unterordner zu platzieren, um Austauschbarkeit und Versionierbarkeit zu gewährleisten.

In der Beispieldatei: getting_started.xml, die sich im Unterordner part1 des Projektes beispiel_modul befindet, sind 2 Grafiken eingebunden. Die erste Grafik hat einen relativen Verweis auf das Grafikverzeichnis des Hauptordners beispiel_modul/images, die zweite Grafik ist auf den Grafikordner im Unterverzeichnis beispiel_modul/part1/images verlinkt. Beide Grafiken werden korrekt angezeigt und sind auch in der Ausgabe anzeigbar. Da bei beiden Grafiken nur ein relativer Verweis in der Form ../images/grafik.gif den Speicherort der Grafik verrät ist es wichtig zu verstehen, wie die Grafikverweise von XInclude aufgelöst werden.

Obwohl Sie die Grafiken in einem beliebigen Unterverzeichnis ablegen können, ist es sinnvoll den Grafikordner (verwenden Sie die Bezeichnung images) in den Unterordner des jeweiligen Dokumentes zu platzieren, um Austauschbarkeit und Versionierbarkeit zu gewährleisten.

Module werden untereinander durch das Kommando olink verknüpft. Innerhalb eines Dokumentes können xrefs und link verwendet werden. Damit der XSLT Prozessor erkennt, in welchem Zusammenhang die Dokumente stehen, muss einmalig eine Datenbank mit diesen Informationen gebildet werden.

Data file erzeugen

	Anmerkung
	Beispiel data files befinden sich im Ordner du1\Projekte\beispiel_modul\master_html.db bzw. du1\Projekte\beispiel_modul\master_fo.db

Die Referenzen aller Module werden in einer Datei abgelegt, dem sogenannten data file. Dies ist eine Informationsübersicht über alle möglichen Ziele auf die ein Querverweis gesetzt werden kann. Es wird mit folgendem Aufruf vor Publikation erzeugt . Das data file wird später in die Target Database eingebunden.

C:\du1\xmllint2>
xsltproc --stringparam collect.xref.targets "only" 
         --stringparam targets.filename "intro.db"
         ..\xsl\html\docbook.xsl 
         ..\Projects\beispiel_modul\master.xml


Writing intro.db for chapter(introduction_sw5)

In der AXitd Umgebung Aufruf durch das Kommando make_datafile_pdf oder make_datafile_html (Syntax: make_datafile_xxx [Projektordner] [XML-Datei ohne Dateiendung] abkürzen. Dadurch wird für das XML-Modul, dass Sie aufrufen, ein data file mit dem Namen der zugehörigen XML Datei und der Endung *_html.db oder *_fo.db. erzeugt.

Beispielaufruf für das Modul master.xml im Verzeichnis beispiel_modul:

C:\du1\publish>make_datafile_html beispiel_modul  master

Durch diesen Aufruf wird für das Modul master.xml das data file master_html.db ins Unterverzeichnis du1\projects\beispiel_modul erzeugt.

	Anmerkung
	Die Datei wird immer durch den Aufruf des Masterdokumentes (im Beispiel master.xml) aufgerufen

Das data file fasst alle die Linkinformationen aller Module zusammen, indem es die im Masterdokument vorhandenen XIncludes auflöst.

	Achtung
	Wenn Sie als Ausgabeform mehrere HTML-Dateien oder multiple PDF Dateien planen müssen Sie für jedes Modul ein data file erzeugen und Ihre olink Datenbank entsprechend anpassen.

Target Database

	Anmerkung
	Beispiel für die target database im Verzeichnis du1\projects\beispiel_modul\olinkdb_fo.xml bzw. du1\projects\beispiel_modul\olinkdb_html.xml

Bevor Sie mit dem Erstellen der Inhalte beginnen müssen Sie einmalig manuell eine target database erstellen und im Projektverzeichnis ablegen.

Im Falle der Ausgabe einer HTML-Datei bzw. der Zusammenfassung der Module zu einer PDF Datei enthält die target database einfach nur den Verweis zum erzeugten data file und muss auch bei Erweiterung um Module nicht angepasst werden.

Bei einer Ausgabe in mehrere HTML Dateien oder mehrerer PDF Dateien enthält die relative Struktur, wie Sie im HTML Output publiziert werden soll und legt diese in einem sitemap Element ab. Die Verzeichnisstruktur spiegelt nur die Struktur des Outputs wider, wie Ihre Quelldokumente strukturiert d.h. in welchen Unterordnern sie abgelegt sind ist davon unabhängig. Bei Erweiterung von Modulen müssen Sie die Datenbank bei diesen Ausgabeformen anpassen.

Beispiel 7.1. Beispiel: target database für Output einer (non chunked) HTML Datei

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE targetset SYSTEM "../../xsl/common/targetdatabase.dtd" 
[
<!ENTITY main_targets SYSTEM "master_html.db">
]>

<targetset>
 <targetsetinfo> example target database </targetsetinfo>

     
	    <sitemap>
		    <dir name="root">
			     <document targetdoc="doku_sw5">
				     &main_targets;
				    </document>
		     </dir>
	     </sitemap>
</targetset>

	DTD targetset, immer im angegebenen Verzeichnis
	Verweis auf das globale data files, das wie oben beschrieben vor Publikation gebildet werden muss.
	sitemap Element, in das die Verknüpfungen der einzelnen Module und die Hierarchie zueinander abgebildet werden

Die Referenzbasis (output.htm) wird bei der Publikation an den Prozessor übergeben. Beispiel aus make_html_module.bat:

java.exe -cp %saxon%saxon.jar;%home%\xsl\extensions\saxon652.jar  com.icl.saxon.StyleSheet 
-o %output%\output.htm %projects%\%1\%2.xml %publish%\driver\driver_html.xsl 
target.database.document="..\..\Projects\beispiel_modul\olinkdb_html.xml" 
olink.base.uri="output.htm" current.docid="%3"

Sie kann bei einer fixen Bezeichnung auch alternativ dazu im driver File definiert sein.

	Anmerkung
	Wenn Sie den Ausgabenamen (z.B. output.html) vor Publikation verändert haben müssen Sie auch die Datei make_html_module.bat entsprechend anpassen.

Werden die Module in mehrere HTML Module ausgegeben (chunk mode), muss das sitemap Element entsprechend der Unterordnerstruktur angepasst werden.

Zum Bearbeiten Ihrer modularen Dokumentation öffnen Sie zuerst das Masterdokument.

XXE meldet Ihnen, dass das zu öffnende Dokument Verweise mit XInclude enthält und gibt Ihnen Hinweise, wie die Dokumente zu bearbeiten sind. Das Prinzip ist ganz einfach: XXE kennzeichnet die referenzierten Dokumente mit einem grauen Hintergrund und sperrt sie zunächst für die Bearbeitung. Alle Dokumentteile des Masterdokumentes werden mit einem gewöhnlichen weißen Hintergrund gekennzeichnet und sind wie in einem ganz normalen DocBook Dokument zu bearbeiten.

	Anmerkung
	Beachten Sie, dass das Masterdokument durch die Verwendung der XIncludes kein gültiges DocBook Dokument mehr ist und als ungültig validiert wird. Um sicher zu gehen, dass es in den folgenden Schritten korrekt weiterverarbeitet wird können Sie es mit einem XInclude fähigen Parser (z.B. Xerces) validieren

Um ein referenziertes Modul zu bearbeiten müssen Sie zuerst den Cursor an die zu bearbeitende Stelle im Dokument positionieren. Wählen Sie dann aus dem Menü: Bearbeiten -> Dokumententenverweis -> Bearbeite referenziertes Dokument.

XXE öffnet das referenzierte Dokument zum Bearbeiten im normalen Editiermodus. Nehmen Sie Ihre Eingaben vor und wechseln Sie danach zurück ins Masterdokument indem Sie Bearbeiten -> Dokumententenverweis -> Bearbeite Ausgangsdokument aus dem Menü wählen.

	Achtung
	Die im Modul gemachten Änderungen sind leider nicht im Masterdokument sichtbar. Um diese anzeigen zu lassen müssen Sie das Masterdokument schließen und erneut öffnen.

Für die Weiterverarbeitung müssen Sie vor jeder Publikation zuerst eine temporäre XML Datei erzeugen, in der der Inhalt der referenzierten Module implementiert ist, der von den Stylesheets weiterverarbeitet werden kann.

Öffnen Sie eine Windows Konsole und geben Sie folgenden AXitd Befehl ein:

resolve_modules [Projektordner des Masterdokumentes] [Dateiname des Masterdokumentes ohne Dateiendung].

Für das Beispieldokument master.xml im Projektordner beispiel_modul geben Sie folgendes Kommando ein:

resolve_modules beispiel_modul master

Es wird die temporäre Datei modules_resolved.xml in den von Ihnen gewählten Projektordner erzeugt. Diese kann nun publiziert werden.

Wenn Sie die die Datei modules_resolved.xml editieren, können Sie erkennen, dass die XIncludes durch den Inhalt der referenzierten Datei und dem xml:base Attribut im Hauptknoten ersetzt wurden.

<chapter id="getting_started" xml:base="part1/getting_started.xml">

Die Datei modules_resolved.xml in Ihrem Projektverzeichnis können Sie nun mit dem AXitd Publikationsbefehl make_html_module zur Erzeugung einer HTML-Datei weiterverarbeiten.

make_html_module [Projektordner, in der die temporäre Gesamtdatei erzeugt wurde] [temporäre Datei, immer modules resolved.xml] [id des root-Dokumentes]

make_html_module beispiel_modul modules_resolved.xml doku_sw5

um die Verarbeitung besser zu verstehen, folgend der Aufruf in der batch- Datei:

java.exe -cp %saxon%saxon.jar;%home%\xsl\extensions\saxon652.jar 
 com.icl.saxon.StyleSheet -o %output%\output.htm 
%projects%\%1\%2.xml %publish%\driver\driver_html.xsl 
target.database.document="olinkdb.xml" olink.base.uri="output.htm" 
current.docid="%3" 

Mit dem dritten Parameter,im Beispiel doku_sw5, wird die ID des root Dokumentes der Dokumentation an den XSL Processor übergeben. Diese ist notwendig, um die Ausgangsbasis für die Verlinkung der Module untereinander zu kennzeichnen, da diese aus den XSL Stylesheets nicht erkennbar ist. Der Prozessor kann aufgrund dieser Angabe in der angegebene Datenbank olinkdb.xml abrufen, mit welchem Dokument er mit der Auflösung der olinks beginnen muss, und in welcher Beziehung die Dokumente zueinander stehen.

	Anmerkung
	Für die HTML Publikation muss die Bezeichnung der olink-Datenbank olinkdb.xml beibehalten werden, ansonsten müssen Sie die make_html_module.bat entsprechend abändern.

Die Ausgabe output.html wird wie gewohnt in das output Verzeichnis \du1\output publiziert und kann beliebig umbenannt werden.

In der AXitd Umgebung wird bei der PDF Publikation davon ausgegangen, dass Sie aus Ihren erstellten Modulen ein Gesamtdokument in einer PDF Datei zusammenfassen wollen. Wollen Sie für jedes Modul eine eigene PDF Datei erzeugen und die erzeugten PDF-Dateien miteinander verlinken, ist die Umgebung entsprechend anzupassen.

Zur Publikation nach PDF müssen Sie den Befehl make_pdf_module benutzen, nachdem Sie folgende Voraussetzungen geschaffen haben.

make_datafile_pdf beispiel_modul master

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE targetset SYSTEM "../../xsl/common/targetdatabase.dtd" [
<!ENTITY intro_targets SYSTEM "part1/intro_fo.db">
<!ENTITY gs_targets SYSTEM "part1/getting_started_fo.db">
<!ENTITY main_targets SYSTEM "master_fo.db">
]>
<targetset>
	<sitemap>
		<dir name="root">
			<document targetdoc="doku_sw5">
				&main_targets;
				
			</document>
		</dir>
	</sitemap>
</targetset>

make_pdf_modul resolved_modules.xml doku_sw5

Wird hier nur kurz beschrieben, entsprechende Befehle werden in späterer Version zur Verfügung gestellt.

Publikation RTF oder WML

Bereiten Sie die Datei resolved_modules.xml analog der Vorgehensweise für modulare PDF Dokumente vor. „Gesamtdatei nach PDF publizieren“

Öffnen Sie das XSL Utility , wie unter RTF Publikation beschrieben. „Publikation in RTF o. WML“

Editieren Sie die Parameter für den Aufruf des driver_fo Stylesheets, und geben Sie die folgenden beiden Parameter ein:

• current.docid: ID des Ausgangsdokument (im Beispiel doku_sw5)

• target.database.docfile: Speicherpfad der olinkdb_fo.xml für die Publikation

Der filename muss analog der Abbildung im Format file:///C:/... eingegeben werden.

Starten Sie die Konvertierung nachdem Sie das Ausgabeverzeichnis festgelegt haben.

Die Verlinkung müsste in die erzeugte Ausgabedatei übernommen worden sein.

Um bedingte Dokumente zu erstellen müssen Sie für jedes Dokument ein separates Datenfile erstellen. Erzeugen Sie für verschiedene Profile verschiedene data files, indem Sie die batchdatei make_html_module bzw. make_pdf_module editieren und den Ausgabenamen anpassen. Rufen sie die modifizierte Batchdatei dann mit Ihren Profiling Parametern auf.

Publizieren Sie in die verschiedenen Ausgaben mit Verweis auf die für die Profile erzeugten Datafiles. Erzeugen Sie dafür am besten für jedes Profil eine target database.

Zum Bearbeiten von XML-Dateien verwendet Trados das Programm Tag Editor. Dieses Programm benötigt für die Bearbeitung eine ini-Datei, die über einen sog. DTD Wizard erzeugt werden kann.

In DU1 ist eine Trados .ini Datei im Verzeichnis struktur\DocBook\DocBookUmgebung.ini abgelegt. Verwenden Sie diese Datei beim Bearbeiten und Analysieren von DocBook Dokumenten.

Erstellen Sie einen Ordner translations, der folgende Inhalte enthält:

Editieren Sie die Quelldatei und ändern Sie den Header:

<?xml version="1.0" encoding="ISO-8859-1"?>
<?xml-stylesheet type="text/xsl" href="xsl\html\docbook.xsl"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"struktur/DocBook/docbookx.dtd"> 

Dies ist notwendig, um das Stylesheet für die Voransicht im Tag Editor anzuziehen und die DTD entsprechend auf den Übersetzungsordner zu verweisen.

Packen Sie den Ordner und senden Sie ihn mit Anleitung an die Übersetzer

Passen Sie evtl. den Dateinamen so an, dass die Sprachversion erkenntlich ist und die Quelldatei nicht überschrieben wird. Wenn Sie sprachabhängige Grafiken verwenden müssen Sie die übersetzte Datei in einem eigenen Ordner in der Verzeichnisebene von Projects ablegen, wenn nicht können Sie sie in das Verzeichnis der Quelldatei ablegen.

Zuerst müssen die Header der übersetzten Quelldateien wieder entsprechend angepasst werden. Bei häufigen Übersetzungsprozessen empfiehlt es sich ein Transformationsskript für die Übersetzung zu verwenden

Als nächstes muss der entsprechende Language Code im Kopf des DocBook Root Elementes (wenn Sie verschiedensprachige Abschnitte verwenden, müssen Sie an allen Stellen anpassen) eingesetzt werden.

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"struktur/DocBook/docbookx.dtd">
<book lang="it">
  <title>Fehlerkompendium</title>

  <subtitle>d-lab.2</subtitle>
 

Die weitere Publikation erfolgt analog zur Quelldatei.

Identifikation und Separation von Änderungen

Übersetzung von Änderungen im Gesamtzusammenhang

Reset der Ursprungsdatei

Folgende Stylesheets werden verwendet:

Beim Aufruf der Stylesheets müssen die gewünschten Profiling Parameter angegeben werden. In der AXitd Du1 Docbook Umgebung sieht der Aufruf dazu folgendermaßen aus. (Beispiel für html, andere Ausgabeformen analog)

pdf:
make_pdf_profile 
du1 du2_0 "profile.condition=internal"

html-chunk:
					make_html_chunk_profile 
du1 du2_0 "profile.condition=internal"

html-help:
make_htmlhelp_profile 
du1 du2_0 "profile.condition=internal"

javahelp:
make_javahelp_profile 
du1 du2_0 "profile.condition=internal"

html:make_html_profile 
du1 du2_0  "profile.condition=internal"

	Name Ihrer XML Datei ohne Endung .xml
	Bedingung, nach der gefiltert werden soll

Im Output werden nun alle Elemente, die das Attribut profile.condition="internal" haben, ausgespielt und zusätzlich alle, deren condition Attribut leer ist. Alle Elemente, bei denen das Attribut condition nicht internal heißt und nicht leer sind werden nicht ausgespielt. (condition=external).

	Anmerkung
	Sie können auch alle Textpassagen ausspielen, die kein Attribut haben, d.h. hier die weder als 'internal' noch als 'external' gekennzeichnet sind und damit für alle übrigen Leser gelten, indem Sie die Profile-Bedingung leer lassen ("profile.condition=''")

Besondere Betrachtung verdient das Attribut role. Dieses sollte nur in Ausnahmefällen für das Profiling verwendet werden, da es auch für andere Zwecke, wie z.B. bei inline-Auszeichnungen <emphasis role="bold> verwendet wird und diese dann bei bedingtem Text nicht ausgespielt werden.

Beim 2stufigen Profiling wird ein temporäres XML-File in das Project-Verzeichnis gespielt, das von dort aus mit den 'normalen' Publikationsmitteln weiterverarbeitet wird.

Wie schon oben beschrieben ist dies immer dann vorzuziehen, wenn xrefs und olinks verwendet wurden, die aus dem temporären File aufgelöst werden können.

DocBook XSL Configurator is a Java application used to create DocBook XSL FO customization layers. The application presents users with a tabbed pane containing several tables. Each row in each table contains several cells, one of which is editable and contains the text of the default setting for a specific DocBook XSL FO parameter. Users create projects containing paths to DocBook XML, common-customization XSL, an external XSLT processor, etc. Users then click through the tables, select DocBook XSL FO parameters they want to include in a customization layer, edit those parameters, include the customization layer in a project, write out the customization layer as an XSL file, and apply the XSL to the project's XML using the project's specified XSLT processor.

DocBook XSL Configurator version 0.5.3_1661 is an alpha release. It supports version 1.66.1 of the DocBook XSL FO parameter set. It does not yet support the DocBook XSL HTML parameter set.

Default FO parameter settings, help text, and guidelines for attribute sets ("property sets") are taken from the DocBook XSL package's FO documentation. Attribute set defaults are just guidelines. Attribute sets typically can contain additional parameters not included in the defaults. Some parameters, though legal, may be inappropriate in some cases. Consult the latest version of the XSL W3C Recommendation at: http://www.w3.org/TR/xsl/ for more exact information on an attribute set.

DocBook XSL Configurator also includes a "From the Wild" table that provides users with nifty little snippets of XSL intended to help with formatting not implemented in the DocBook XSL FO parameter set. Currently, the number of these snippets is very small; however, the "From the Wild" snippet collection has the potential to grow very large and be very helpful.

Target Audience

If you are a beginner with DocBook XSL, DocBook XSL Configurator can help you a great deal by bringing all the DocBook XSL FO parameters together, with help, in a GUI. You don't have to switch windows seeking help, and you don't have to manually type out the file containing the XSL FO customization layer.

If you are an expert with DocBook XSL, this application may still be of use to you. You may benefit from the speed with which you can create and edit customization layers; you may find that DocBook XSL Configurator projects help you organize documentation sets; or, you may find the application useful for saving customization layers and associating them with specific DocBook XML instances.

Wenn Sie Ihre Umgebungsvariablen bereits auf AXitd DU1 gesetzt haben, starten Sie den XSL Configurator mit dem Aufruf: xsl_config aus einer DOS- Konsole.

Wenn nicht, wechseln Sie ins Verzeichnis: publish\driver\tools\DBXSLcfg_0.5.3_1661\ und starten die Applikation mit dem Aufruf: java -jar DocBookXSLConfigurator.jar

Der XSL Configurator unterstützt Sie beim Schreiben von Konfigurationsdateien für XSL:FO.

Besonders hilfreich ist die Kategorisierung der Parameter in der linken Menüübersicht. Diese ist auch für erfahrene Anwender hilfreich, da man sich nicht immer alle Parameter heraussuchen muss.

Wählen Sie die einzelnen Kategorien aus und setzen Sie die gewünschten Parameter indem Sie diese in der Spalte: Include in XSL ankreuzen.

Erzeugen Sie Ihre Konfigurationsdatei, indem Sie den Button drücken oder aus dem Menü Execute -> Write XSL File auswählen.

Sie werden noch aufgefordert den Speicherort anzugeben, danach startet die Generierung des XSL Files.

Binden Sie das erzeugte Konfigurationsfile mit XSL:include in die Datei D:\_xml\du1_2\publish\driver\driver_fo.xsl ein um die AXitd DU1 Funktionen nutzen zu können.

Außerdem können Sie mit dem XSL Configurator auch direkt PDF und Postscriptdateien erzeugen. Dazu müssen Sie das tool entsprechend konfigurieren. lesen Sie dazu die Projektdokumentation.