Softwaretechnik-Blog
Mittwoch, März 17, 2010
Ankreuzfelder von XSL-FO nach PDF
Ankreuzfelder in XSL-FO einfügen ist über Unicode einfach möglich. Allerdings werden sie bei der Generierung von PDF nicht automatisch richtig übernommen. Das folgende XSL-FO liefert beispielsweise die nachfolgende PDF-Datei:
Die Ankreuzfelder fehlen im PDF-Dokument. Warum? Bei der PDF-Generierung wird auf die Standard-Schriftarten zurückgegriffen, die im PDF zur Verfügung stehen. Sie unterstützen allerdings kein Unicode und stellen deshalb die Ankreuzfelder ersatzweise durch das Zeichen # dar. Man kann sich die eingebetteten Schriftarten in dem Eigenschaften des PDF-Dokumentes auf der Registerkarte "Schriften" anzeigen lassen. (Im Adobe Reader unter Datei > Eigenschaften...)
Um die Unicode-Zeichen in PDF anzeigen zu können, muss also eine Unicode-Schriftart im PDF eingebettet werden. Das wirft zwei Fragen auf:
1. Frage: Wie schreibe ich in XSL-FO, dass eine Unicode-Schriftart verwendet werden soll?
2. Frage: Wie veranlasse ich FOP diese Schriftart in das PDF einzubetten?
Antwort auf Frage 1:
Spontan würde man zunächst vielleicht auf "Arial Unicode MS Standard" zurückgreifen. Diese Schriftart ist auf vielen Windows-Betriebssystemen verfügbar, weil sie mit Microsoft Office ausgeliefert wird. Dann würde der XSL-FO Code wie folgt aussehen, um diese Schriftart festzulegen:
Wenn dann die ArialUnicodeMS-Schriftart in die PDF-Datei mit eingebettet wird (siehe Antwort unten auf Frage 2), sieht das im Ergebnis so aus:
Das sieht doch prima aus: Die Ankreuzfelder sind da und die Schrift ist eingebettet. Das war noch keine große Überraschung, oder? Die Überraschung kommt aber jetzt, denn Arial Unicode MS unterliegt der Lizenz von Agfa Monotype Corp. und darf nicht frei kopiert werden (siehe http://www.fonts.com/FontServices/LicensingOptions.htm). Bei den Dateieigenschaften der ArialUni.ttf kann man diese Lizenzbedingung auch nachlesen:
Mein Verständnis von den Lizenzbedingungen ist, dass man Arial Unicode MS nicht in PDF-Dokumente einbetten und weitergeben darf. Um jedes derartige Lizenzproblem zu umgehen, sollte man also eine freie Alternative zu Arial Unicode MS finden.
Eine gute Alternative ist das Projekt "Free UCS Outline Fonts" (siehe http://savannah.gnu.org/projects/freefont). Unter der GNU General Public License v3 sind verschiedene Fonts verfügbar. Verwendet man die Schriftart FreeMono würde es in XSL-FO so aussehen:
Die Ankreuzfelder werden nun in der PDF-Datei angezeigt und die Freie Schriftart FreeMono ist eingebettet, so dass es keine Lizenzprobleme wie bei der Arial Unicode MS geben sollte. (Nachdem das geklärt ist, wird es langsam Zeit für die Antwort auf Frage 2.)
Antwort auf Frage 2:
Um die Schriftart FreeMono (oder eine andere) in das PDF einzubetten, sind die folgenden drei Schritte notwendig.
Schritt 1:
Aus der True Type Font-Datei FreeMono.ttf muss eine Font Metrics-Datei erzeugt werden. Der folgende Aufruf erzeugt die entsprechende Datei freemono.xml:
Schritt 2:
Die Font Metrics-Datei muss in eine FOP-Konfiguration eingebunden werden. Dazu geht das folgende Beispiel davon aus, dass unterhalb von .\lib das fop.jar, die nachfolgende Konfigurationsdatei, die True Type-Datei FreeMono.ttf und die Font Metrics-Datei freemono.xml liegen. Hier ein Beispiel für die Datei fop-config.xml:
Jetzt erklärt sich auch, woher bei der Antwort auf die Frage 1 der Namen der font-family stammte. Er ist in der name-Eigenschaft des font-triplet angegeben.
Schritt 3:
Um die FOP-Konfigurationsdatei zu verwenden, muss sie beim Aufruf von FOP als Parameter mit angegeben werden:
Weitere Details zur Antwort auf Frage 2 können unter http://xmlgraphics.apache.org/fop/0.94/fonts.html nachgelesen werden.
<?xml version="1.0" encoding="UTF-8"?>
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format">
<fo:layout-master-set>
<fo:simple-page-master master-name="A4" page-width="210mm" page-height="297mm">
<fo:region-body region-name="region-body" margin="2cm"/>
</fo:simple-page-master>
</fo:layout-master-set>
<fo:page-sequence master-reference="A4">
<fo:flow flow-name="region-body">
<fo:block>
<fo:block>Boxes from XSL-FO to PDF</fo:block>
<fo:block >☐ Box</fo:block>
<fo:block >☑ Box checked</fo:block>
<fo:block >☒ Box x-marked</fo:block>
</fo:block>
</fo:flow>
</fo:page-sequence>
</fo:root>
Die Ankreuzfelder fehlen im PDF-Dokument. Warum? Bei der PDF-Generierung wird auf die Standard-Schriftarten zurückgegriffen, die im PDF zur Verfügung stehen. Sie unterstützen allerdings kein Unicode und stellen deshalb die Ankreuzfelder ersatzweise durch das Zeichen # dar. Man kann sich die eingebetteten Schriftarten in dem Eigenschaften des PDF-Dokumentes auf der Registerkarte "Schriften" anzeigen lassen. (Im Adobe Reader unter Datei > Eigenschaften...)
Um die Unicode-Zeichen in PDF anzeigen zu können, muss also eine Unicode-Schriftart im PDF eingebettet werden. Das wirft zwei Fragen auf:
1. Frage: Wie schreibe ich in XSL-FO, dass eine Unicode-Schriftart verwendet werden soll?
2. Frage: Wie veranlasse ich FOP diese Schriftart in das PDF einzubetten?
Antwort auf Frage 1:
Spontan würde man zunächst vielleicht auf "Arial Unicode MS Standard" zurückgreifen. Diese Schriftart ist auf vielen Windows-Betriebssystemen verfügbar, weil sie mit Microsoft Office ausgeliefert wird. Dann würde der XSL-FO Code wie folgt aussehen, um diese Schriftart festzulegen:
<fo:block> <fo:block>Boxes from XSL-FO to PDF</fo:block> <fo:block font-family="ArialUnicodeMS">☐ Box</fo:block> <fo:block font-family="ArialUnicodeMS">☑ Box checked</fo:block> <fo:block font-family="ArialUnicodeMS">☒ Box x-marked</fo:block> </fo:block>
Wenn dann die ArialUnicodeMS-Schriftart in die PDF-Datei mit eingebettet wird (siehe Antwort unten auf Frage 2), sieht das im Ergebnis so aus:
Das sieht doch prima aus: Die Ankreuzfelder sind da und die Schrift ist eingebettet. Das war noch keine große Überraschung, oder? Die Überraschung kommt aber jetzt, denn Arial Unicode MS unterliegt der Lizenz von Agfa Monotype Corp. und darf nicht frei kopiert werden (siehe http://www.fonts.com/FontServices/LicensingOptions.htm). Bei den Dateieigenschaften der ArialUni.ttf kann man diese Lizenzbedingung auch nachlesen:
Mein Verständnis von den Lizenzbedingungen ist, dass man Arial Unicode MS nicht in PDF-Dokumente einbetten und weitergeben darf. Um jedes derartige Lizenzproblem zu umgehen, sollte man also eine freie Alternative zu Arial Unicode MS finden.
Eine gute Alternative ist das Projekt "Free UCS Outline Fonts" (siehe http://savannah.gnu.org/projects/freefont). Unter der GNU General Public License v3 sind verschiedene Fonts verfügbar. Verwendet man die Schriftart FreeMono würde es in XSL-FO so aussehen:
<fo:block> <fo:block>Boxes from XSL-FO to PDF</fo:block> <fo:block font-family="FreeMono">☐ Box</fo:block> <fo:block font-family="FreeMono">☑ Box checked</fo:block> <fo:block font-family="FreeMono">☒ Box x-marked</fo:block> </fo:block>
Wenn dann die FreeMono-Schriftart in die PDF-Datei mit eingebettet wird, sieht das im Ergebnis so aus:
Antwort auf Frage 2:
Um die Schriftart FreeMono (oder eine andere) in das PDF einzubetten, sind die folgenden drei Schritte notwendig.
- Schritt 1 - Erzeugen einer Font Metrics-Datei aus der True Type Font-Datei FreeMono.ttf
- Schritt 2 - Erstellen einer FOP-Konfigurationsdatei, die die Einbettung der Schriftart steuert
- Schritt 3 - Aufrufen von FOP unter Verwendung der Konfigurationsdatei
Schritt 1:
Aus der True Type Font-Datei FreeMono.ttf muss eine Font Metrics-Datei erzeugt werden. Der folgende Aufruf erzeugt die entsprechende Datei freemono.xml:
java -cp %CLASSPATH% org.apache.fop.fonts.apps.TTFReader FreeMono.ttf freemono.xml
Schritt 2:
Die Font Metrics-Datei muss in eine FOP-Konfiguration eingebunden werden. Dazu geht das folgende Beispiel davon aus, dass unterhalb von .\lib das fop.jar, die nachfolgende Konfigurationsdatei, die True Type-Datei FreeMono.ttf und die Font Metrics-Datei freemono.xml liegen. Hier ein Beispiel für die Datei fop-config.xml:
<?xml version="1.0"?> <fop version="1.0"> <base>./lib</base> <source-resolution>72</source-resolution> <target-resolution>72</target-resolution> <default-page-settings height="297mm" width="210mm"/> <renderers> <renderer mime="application/pdf"> <filterList> <value>flate</value> </filterList> <!-- Hier werden Freie Unicode Fonts des Projektes Free UCS Outline Fonts verwendet (siehe http://savannah.gnu.org/projects/freefont). --> <font metrics-url="fop-freemono.xml" kerning="yes" embed-url="FreeMono.ttf"> <font-triplet name="FreeMono" style="normal" weight="normal"/> </font> </fonts> </renderer> </renderers> </fop>
Jetzt erklärt sich auch, woher bei der Antwort auf die Frage 1 der Namen der font-family stammte. Er ist in der name-Eigenschaft des font-triplet angegeben.
Schritt 3:
Um die FOP-Konfigurationsdatei zu verwenden, muss sie beim Aufruf von FOP als Parameter mit angegeben werden:
java -jar .\lib\fop.jar -c .\lib\fop-config.xml input-with-boxes.fo -pdf output-with-boxes.pdf
Weitere Details zur Antwort auf Frage 2 können unter http://xmlgraphics.apache.org/fop/0.94/fonts.html nachgelesen werden.
Archives
