CIB format technischer Leitfaden (DE)

10. Overlay Funktion

Allgemein
Text-Overlay
Grafik-Overlay
Barcode-Overlay
Beispiele für die Property Belegung
     ▸ Rechtecke
     ▸ Bezierkurve
     ▸ Linie
     ▸ Grafik
     ▸ Text
     ▸ Barcode
     ▸ Kombination

Allgemein

Die Overlayfunktion für den CIB format ermöglicht das Einfügen von Grafiken und Texten an beliebigen Positionen in RTF-Dateien. Die Overlay-Funktion steht in den Modulen print, pdf und view zur Verfügung. Im Folgenden wird der gesamte Funktionsumfang genauer spezifiziert.

 

Durch Angabe der Property „Overlay“ beim Aufruf des CIB format können Anweisungen für die Overlay-Funktion festgelegt werden. Die Property „Overlay“ enthält folgende Informationen:

  • eine Ebenen- und Positionsangabe mit optionaler Größenangabe. Bei Grafiken ist es möglich deren Höhe und Breite anzugeben, bei Texten entfällt diese Angabe.
  • eine Fontangabe (bei Texten)
  • eine Seitenauswahl mit und ohne Prioritäten
  • zusätzliche Daten, alternativ bestehend aus:
    • einem Dateinamen
    • einem Textstring, der optional mittendrin {PAGE}, {NUMPAGES} oder {DATE} enthalten kann.
    • einer Barcode-Angabe, beginnend mit "BARCODE:"


<Overlay>:= <TextOverlay>*;<GrafikOverlay>*;<BarcodeOverlay>*

 

<TextOverlay>:= (ab CIB format Version 5.3.223)

POS:Ebene|X-Position;Y-Position;Seitenangaben;FONT:Font;Font-Size;Font-Style;Font-Color[;Orientierung];Text

 

<GrafikOverlay>:= (ab CIB format Version 5.3.223) :=

POS:Ebene|X-Position,Breite;Y-Position,Höhe;Seitenangaben;Dateiname

 

<BarcodeOverlay>:= (ab CIB format Version 5.3.223):=

POS:Ebene;X-Position;Y-Position;Seitenangaben;BARCODE:Typ;Wert;Orientierung;Breite;Höhe;Prüfziffer

 

Diese Property-Angaben werden im Folgenden näher spezifiziert, aufgeteilt in Text, Grafiken und Barcodes. Diese können in der Property „Overlay“ beliebig oft hintereinander, durch  „;“ getrennt, angegeben werden. Auf korrekte Groß- und Kleinschreibung ist bei der Keyword-Angabe zu achten.


Text-Overlay

Die in der Property„Overlay“ spezifizierten Texte werden an gewünschter Stelle im Ausgabe-Dokument platziert.

Das Keyword „POS:“ kennzeichnet den Positionsteil der Angabe und das Keyword „FONT:“ den Teil, der die Schriftinformationen enthält.

Bezeichnung

Wert

Wirkung

Ebene

Negative Zahl

Anordnung hinter allen Overlay-Elementen, die sich bereits im Dokument befinden. Je kleiner die Zahl, desto weiter hinten wird der Text eingefügt.

Positive Zahl

(einschließlich 0)

0 bezeichnet den Text, der als erstes eingefügt wird.

Je größer die Zahl, desto weiter vorn wird der Text eingefügt.

Eine positive Zahl bedeutet, dass der entsprechende Text, vor allen Elementen angeordnet wird, die sich bereits im Dokument befinden.

Top

Ganz vorn. Wenn mehrere Texte durch „Top“ gekennzeichnet sind, werden sie in der Aufrufreihenfolge eingefügt, das heißt, der als letztes genannte Text kommt ganz vorne auf das Dokument.

keine Angabe

(Das Trennzeichen muss trotzdem angegeben werden.)

Entspricht „Top“

 

Achtung:

Als Trennzeichen sind „|“ oder „/“ möglich.

X-Position

„Center“

In horizontaler Richtung auf Seite zentrieren.

0 oder keine Angabe

Linker Rand

Zahl > 0

Abstand von links in mm

Y-Position

„Center“

In vertikaler Richtung auf Seite zentrieren.

0 oder keine Angabe

Oberer Rand

Zahl > 0

Abstand von oben in mm

Font

Z.B. Helvetica

Courier

Times

Hier kann die Schriftart angegeben werden.

Font-Size

Positive Zahl

Auch halbe Schritte möglich
z.B. 3.5

Schriftgröße in pt
oder Breite und Höhe in mm.

Font-Style

Bold

Text wird fett gedruckt

Italic

Text wird kursiv gedruckt

Underline

Text wird unterstrichen

Font-Color

RGB-Code, Komponenten durch Punkte getrennt. (R.G.B)

Beispiele

0.0.0         = schwarz

255.0.0    = rot

0.128.0    = grün

0.0.255    = blau

Default: schwarz (das Trennzeichen „;“ muss trotzdem angegeben werden)

Der Text wird in der angegebenen Farbe dargestellt. Die Farbanteile sind durch Punkte getrennt anzugeben.

Orientierung

(ab CIB format Version 6.0.6)

0 | 90 | 180 | 270

Winkel, in dem der Text im Uhrzeigersinn gedreht wird. Es sind nur Vielfache von 90° möglich.

Seitenangaben

<page-numbers> = {[Ausf,][any page number | from-to| All | Even | Odd | NoLast | NoFirst | First | Last]}  *

Die Seiten können bezogen auf das ganze Dokument oder auf eine Ausfertigung angegeben werden.

 

Ausf

Bezeichnung der Textmarke für die Ausfertigung. Es muss immer eine Seitenangabe folgen.

keine Angabe oder “All”

Auf allen Seiten verteilen

“Odd”

Auf geraden Seiten verteilen

“Even”

Auf ungeraden Seiten verteilen

“First”

Nur auf der ersten Seite

“Last”

Nur auf der letzten Seite

“NoFirst”

Alle Seiten bis auf die erste

“NoLast”

Alle Seiten bis auf der letzte

Text

(zum jetzigen Zeitpunkt wird beliebiger Text und {PAGE},{DATE},{NUMPAGES} unterstützt (ohne Startnummer und Nummernart

Zahl1-Zahl2

Von Seite Zahl1 bis Zahl2

Zahl1-Zahl2,Zahl3, ...,ZahlN-ZahlM

Auf mehren Seiten oder Seitenbereichen verteilen (Komma als Trennzeichen)

Beliebiger Text (kann auch die folgenden Word-Felder enthalten)

Der angegebene Text wird ins Dokument eingefügt.

Wenn mehrere Word-Felder nacheinander eingegeben werden, sind sie durch mindestens ein Leerzeichen zu trennen.

{PAGE \* startnummer                \*  nummernart}

Für „nummernart“ sind folgende Werte möglich:

Arabic = 1,2,3....

ArabicDash = -1-,-2-,-3-...

alphabetic = a,b,c....

ALPHABETIC = A,B,C…

roman = i,ii,iii….

ROMAN = I,II,III....

Fügt die aktuelle Seitenzahl ein, über die Optionen lassen sich Startnummer und Art der Nummerierung angeben.

 

{NUMPAGES \*nummernart}

Fügt die Anzahl der Seiten im Dokument ein.

 

{DATE \@ dd.MM.yyyy hh:mm:ss}

Fügt aktuelles Datum in gewünschtem Format ein.


Hinweis zu den Seitenzahlen

Die Seitenangaben besitzen unterschiedliche Prioritäten, so dass niedrigere Prioritäten von höheren überschrieben werden können. Die Prioritäten sind wie folgt verteilt:

Priorität keine: All, Odd, Even, NoLast, NoFirst

Priorität DIRECT: Last, First, Zahl

Priorität RANGE: Zahl1 – Zahl2

Dabei gilt folgende Rangfolge: Keine Priorität < RANGE < DIRECT

Besitzen zwei Angaben, die eine bestimmte Seite betreffen, gleiche Priorität, so gelten beide, ansonsten gilt die mit der höheren Priorität und die niedriger priorisierte Angabe wird nicht angewendet.

Um auszudrücken, dass bestimmte Anweisungen zusätzlich gelten sollen, sind die Angaben durch geschweifte Klammern zu trennen.

Alles, was innerhalb der geschweiften Klammern steht ist durch oben genannte Prioritäten geregelt, zwischen den geschweiften Klammern gilt jedoch keine Priorisierung.


Grafik-Overlay

Diese Funktionalität wird ab CIB format Version 5.3.223, das Overlay von Rechtecken bereits ab CIB format Version 5.3.220 unterstützt. Die bisher erlaubten Formate sind bmp, jpg, gif und png.

Die in der Property „Overlay“ spezifizierten Grafiken werden an gewünschter Stelle im Ausgabe-Dokument platziert.

Die Property „Overlay“ wird wie folgt belegt:

[POS:Ebene|X-Position,Breite;Y-Position,Höhe;]Seitenangaben;Dateiname

Bezeichnung

Wert

Wirkung

Ebene

wie Text-Overlay

 

 

X-Position

wie Text-Overlay

 

 

Breite

“ScaleToPage”

Auf Seitenbreite anpassen

0 oder keine Angabe

Original-Breite der Grafik(1 pixel=1 pt=1/72in)

Zahl > 0

Breite der Grafik in mm

Y-Position

wie Text-Overlay

 

 

Höhe

“ScaleToPage”

Auf Seitenhöhe anpassen

0 oder keine Angabe

Original-Höhe der Grafik(1 pixel=1 pt=1/72in)

Zahl > 0

Höhe der Grafik in mm

Seitenzahl(en)

wie Text-Overlay

 

 

Dateiname

Pfad zur Grafikdatei

Diese Grafik wird eingefügt

 

Anstelle eines Dateinamens kann angegeben werden, dass ein farbiges Rechteck, eine Linie oder eine Bezier-Kurve an der spezifizierten Stelle platziert werden soll. Der Dateiname muss dann wie folgt ersetzt werden:

RECT:Color[;Orientierung;Transparenz]

LINETO:Color;X2,Y2

BEZIERTO:Color;SX1,SY1,SX2,SY2,X2,Y2

Linien und Bezier-Kurven haben keine Breiten- und Höhenangabe. Sie können nicht über den Wert „Center“ für X- und Y-Position zentriert werden. Die Angabe dieses Wertes wird als „-1“ interpretiert.

Bezeichnung

Wert

Wirkung

RECT: Color

LINETO: Color

BEZIERTO: Color

 

RGB-Code, Komponenten durch Punkte getrennt. (R.G.B)

Beispiele

0.0.0  = schwarz

255.0.0 = rot

0.128.0 = grün

0.0.255  = blau

Das Rechteck bzw. die Linie oder Bezier-Kurve wird in der angegebenen Farbe dargestellt. Die Farbanteile sind durch Punkte getrennt anzugeben.

Orientierung

> 0

Rechteck wird um den angegebenenWinkel im Uhrzeigersinn gedreht.

Transparenz

> 0

Grad der Transparenz für das Rechteck

Beispiel: 75 bedeutet, dass das Rechteck 75% transparent dargestellt wird.

Eine Transparenz von 100% bedeutet, dass das Rechteck unsichtbar wird.

X2

(X-Koordinate für den Endpunkt der Linie bzw. Bezier-Kurve)

0

Linker Rand.

 

Zahl > 0

Abstand von links in mm.

Y2

(Y-Koordinate für den Endpunkt der Linie bzw. Bezier-Kurve)

0

Oberer Rand.

 

Zahl > 0

Abstand von oben in mm.

SX1, SX2

(X-Koordinaten für den ersten und zweiten Stützpunkt der Bezier-Kurve)

0

Linker Rand.

 

Zahl > 0

Abstand von links in mm.

SY1, SY2

(Y-Koordinaten für den ersten und zweiten Stützpunkt der Bezier-Kurve)

0

Oberer Rand.

 

Zahl > 0

Abstand von oben in mm.

 


Barcode-Overlay

(ab CIB format Version 5.3.223)

Die in der Property „Overlay“ spezifizierten Barcodes werden an gewünschter Stelle im Ausgabe-Dokument platziert.


Die Property „Overlay“ wird wie folgt belegt:

[POS:Ebene|X-Position;Y-Position;] Seitenangaben;BARCODE:Typ;Wert;Orientierung;Breite;Höhe;Prüfziffer;Codepage

Bezeichnung

Wert

Wirkung

Ebene

wie Text-Overlay

 

 

X-Position

wie Text-Overlay

 

 

Y-Position

wie Text-Overlay

 

 

Seitenzahl(en)

wie Text-Overlay

 

 

Typ

Ein Barcodetyp aus der von CIB format unterstützten Menge von Typen: z.B.

CodeITF

Code25Industrial

Code25Matrix

Code39

Code39Extended

Code128A

usw.

 

Diese Barcodetyp wird verwendet

Wert

Zahlen

Der individuelle Wert, den der Barcode darstellen soll.

Orientierung

horizontalleft

vertikale Striche nebeneinander, erstes Zeichen links

horizontalright

vertikale Striche nebeneinander, erstes Zeichen rechts

verticalleft

horizontale Striche untereinander, erstes Zeichen oben

verticalright

horizontale Striche übereinander, erstes Zeichen unten

Breite

Strichbreite in mm

(x.xmm; oder x,xmm beides zulässig)

Setzt die Strichbreite des Barcodes

Höhe

Höhe der Barcode-Balken in mm

(x.xmm; oder x,xmm beides zulässig)

Setzt die Höhe der Barcode-Balken

Prüfziffer

default

Barcode wird mit Prüfziffer generiert

nochecksum

Barcode wird ohne Prüfziffer generiert

Codepage

Gibt Codepage für QR Barcode-Daten an. Default: Ansi;

Mögliche Werte:

  • Ascii
  • Pca
  • Ansi
  • CodePageMac
  • CodePagePc
  • CodePagePdf
  • CodePage932ShiftJIS
  • CodePage949Hangul
  • CodePage936GB2312
  • CodePage950ChineseBIG5
  • CodePage1255Hebrew
  • CodePage1256Arabic
  • CodePage1253Greek
  • CodePage1254Turkish
  • CodePage1258Vietnamese
  • CodePage874Thai
  • CodePage1250EastEurope
  • CodePage1251Cyrillic
  • CodePage1257Baltic
  • CodePageUnicode
  • CodePageIdentity
  • CodePage1252Latin1
  • CodePageUtf8

Bemerkung:
Wenn "CodePageUtf8" benutzt wurde, wird fehlende BOM (Bytereihenfolge-Markierung) am Anfang der eigehender Barcode-Daten hinzugefügt.

 

Die genauen Spezifikationen zum Barcode und den einzelnen Barcode-Typen sind dem Barcode-Leitfaden zu entnehmen.


Beispiele für die Property Belegung


Rechtecke
cibrsh.exe --verbose Overlay="POS:Top|100,12;200,50;2;RECT:255.192.234;" -f Test.rtf

Auf die 2. Seite des Dokuments Test.rtf wird auf oberster Ebene an die Position 100mm vom linken Rand und 200mm vom oberen Rand ein Rechteck mit den Maßen 12mm x 50mm gesetzt. Zu sehen ist das Rechteck in Test.pdf.

cibrsh.exe --verbose Overlay="POS:1|20,12.5;100,50;1-2;RECT:255.045.046;";"POS:2|22,12.5;120,50;1-2;RECT:255.192.234;";"POS:3|24,12.5;140,50;1-2;RECT:255.192.195;" -f Test.rtf

Auf beide Seiten des Dokuments Test.rtf werden 3 Rechtecke in unterschiedlichen Farben aufgebracht. Die Rechtecke werden in der Reihenfolge der POS-Angabe übereinandergelegt, d.h. POS=3 ist das Oberste. Zu sehen sind die Rechtecke in Test.pdf.


Bezierkurve

Cibrsh.exe --verbose Overlay="POS:Top|0;0;2,3;BEZIERTO:255.0.0;50,100,120,160,200,200" -f Test.rtf

Auf Seite 2 und 3 der Dokuments Test.rtf wird auf oberster Ebene eine rote Bezier-Kurve aufgebracht. Sie beginnt an Punkt 0,0, endet bei 200,200 und hat die Stützpunkte 50,100 und 120,160.


Linie

Cibrsh.exe Overlay="POS:Top|1;1;Odd;LINETO:255.0.0;100,100" -f Test.rtf

Auf die ungeraden Seiten des Dokuments Test.rtf wird auf oberster Ebene eine rote Linie aufgebracht, die bei Punkt 1,1 beginnt und bei 100,100 endet.


Grafik

cibrsh.exe Overlay="POS:1|50,60;50,50;All;Bild.jpg;POS:2|-60,60;-60,50;All;Foto.jpg" -f Test.rtf

Auf allen Seiten des Dokuments Test.rtf wird auf Ebene1 die Grafik Bild.jpg und auf Ebene2 die Grafik Foto.jpg aufgebracht. Bild.jpg hat vom linken Rand den Abstand 50mm und Breite 60mm, vom oberen Rand den Abstand 50mm und die Höhe 50mm. Foto.jpg hat vom rechten Rand den Abstand 60mm und Breite 60mm, vom unteren Rand den Abstand 60mm und die Höhe 50mm.


Text

cibrsh.exe Overlay="POS:-1|100;100;All;FONT:Arial;30;Underline;255.0.0;90;HUGO;

POS:Top|Center;10;All;FONT:Arial;16;Italic;0.0.255;;{PAGE}" -f Test.rtf

Auf allen Seiten des Dokuments Test.rtf wird auf hinterster Ebene der Text “HUGO” und auf oberster Ebene die Seitennummer aufgebracht. „HUGO“ ist rot, hat Font Arial unterstrichen, Größe 30Pt und beginnt an Position 100,100 (gerechnet von linker, oberer Ecke des Papiers). Die Seitennummer ist blau, hat Font Arial kursiv, Größe 16Pt und beginnt 10 mm vom oberen Rand, zentriert.


Barcode

cibrsh.exe Overlay="POS:Top|10;Center;1,2;BARCODE:CodeITF;1234567890;verticalleft;

0.5mm;5.0mm;nochecksum " -f Test.rtf

Auf den Seiten 1 und 2 des Dokuments Test.rtf wird auf oberster Ebene ein Barcode CodeITF aufgebracht. Der Barcode beginnt 10mm vom linken Rand, zentriert, horizontale Striche untereinander, erster Strich oben. Die Strichbreite ist 0.5 mm, die Höhe 5.0mm. Generiert wird die Zahl „1234567890“ ohne Prüfziffer.


Kombination

cibrsh.exe Overlay="{POS:1|20,30;100,100;1-2;RECT:255.045.046;10;50};

{POS:2|50,60;50,50;All;Test.jpg;POS:3|30;30;All;FONT:Arial;16;Italic;0.0.0;;HUGO}"  -f Test.rtf

In dem Dokument Test.rtf wird auf Ebene 1 auf den Seiten 1 und 2 ein Rechteck aufgebracht. Zusätzlich dazu auf allen Seiten auf Ebene 2 die Grafik Test.jpg und auf Ebene 3 der Text „HUGO“. Das Rechteck ist rosa, die Eckpunkte haben die Koordinaten 20,30 und 100,100, es ist um 10° gedreht und 50% transparent. Die Grafik hat 50mm Abstand vom linken Rand und ist 60mm breit, hat 50mm Abstand vom, oberen Rand und ist 50mm hoch. Der Text beginnt an Position 30,30 und hat Font Arial kursiv, 16Pt in schwarz.