CIB format technischer Leitfaden (DE)

13. Benutzung der Feldanweisung „PRINT“

Papierschachtansteuerung
Propertyeinstellungen für CIB format im RTF angeben
Propertyeinstellungen für CIB pdf toolbox im RTF angeben
Tabellenfuss- und Tabellenübertragszeilen formatieren
HTML-Masken und Druckbereiche und Tab-Reiter definieren

Papierschachtansteuerung

{ PRINT ”CIB:Bin:<PaperBinInstruction>” }

<PaperBinInstruction> = <Schachtwert erste Seite>;<Schachtwert restliche Seiten>
noch nicht implementiert

<PaperBinInstruction> = <Schachtwert >

Derzeit wird hier die Angabe von System-Standardschächten und Schachtnummern unterstützt.
Zu den Details siehe Beschreibung der Property „PaperBin“

MS-Office bietet nur sehr begrenzte Möglichkeiten einem Dokument bzw. einzelnen Seiten des Dokumentes feste Papierschachtanweisungen mitzugeben. Zusätzlich hat MS-Office bei diesem Verfahren Abhängigkeiten vom gerade zugeordneten Drucker und dessen verfügbaren Schächten.

Über den „CIB:Bin:“ Parameter ist es möglich, die Schachtansteuerung etwas neutraler zu formulieren und im Dokument als Feldanweisung zu hinterlegen. Es gelten die folgenden Regeln:

  • Der ausgewählte Schacht ist ab der Seite gültig, auf der der „PRINT „CIB:Bin“-Befehl eingetragen wird. 
  • Über einen neuen „PRINT „CIB:Bin“-Befehl auf einer Folgeseite kann der Schacht ab dieser Folgeseite gewechselt werden. D.h. dass im Extremfall jede Druckseite auf einem anderen Schacht ausgegeben werden kann.
  • Werden auf einer Seite mehrere „PRINT „CIB:Bin“-Befehle abgesetzt, so gilt der Letzte.
  • Wenn der Drucker den im „PRINT „CIB:Bin“-Befehl verwendeten Schacht nicht verfügbar hat, wird die Seite auf dem Standardschacht ausgegeben.


Propertyeinstellungen für CIB format im RTF angeben

{ PRINT ”CIB:<propertyname>=<propertyvalue>” }

Über die Feldanweisung PRINT können im RTF-Dokument Properties an den CIB format gesetzt werden. Das Setzen von GET (Lese)-Properties ist generell nicht möglich.

Die angegebene Property ist bei der Ausführung von CIB format/output ab der Stelle wirksam, an der sie im Dokument gesetzt wird. Je nach Typ der Property gelten die angegebenen Einstellungen aber auch für das gesamte Dokument oder für die aktuelle Seite.

Wenn Properties für bestimmte CIB format Funktionen generell nicht im RTF angegeben werden können, so wird im entsprechenden Kapitel explizit darauf hingewiesen.

Eine Liste der Properties, die über die Feldanweisung PRINT an den CIB format gesetzt werden können, wird noch ergänzt.


Propertyeinstellungen für CIB pdf toolbox im RTF angeben

{ PRINT ”CIB:PDFPROP:<propertyname>=<propertyvalue>” }

Die angegebene Property-Einstellung wird von CIB format/pdf so im erzeugten PDF-Dokument gespeichert, dass die Information von der CIB pdf toolbox dort wieder entnommen werden kann. Es werden dazu PDF/A-konforme XMP-Metadaten im XML-Format genutzt, welche mit PDF-Format ab Version 1.4 zur Verfügung stehen.

Je nach Typ der Property gelten die angegebenen Einstellungen für das gesamte PDF oder aber auch für die aktuelle Seite.


Achtung: Die CIB pdf toolbox unterstützt über die im RTF gesetzten Propertyeinstellungen derzeit nur einige Properties. Diese PDF-Properties sind: InputFilename, BackgroundFilename, EncryptOwnerPassword, EncryptUserPassword und FormfieldNamePrefix.

 

Häufige Anwendungen für diesen Feldbefehl sind:

  • Hinterlegen eines Briefes mit Formular- und Briefpapierhintergründen im PDF-Format. Hier kann die BackgroundFilename-Property der CIB pdf toolbox gleich im RTF gesetzt werden.
  • Einfügen einer oder mehrerer Dateien im PDF-Format (oder auch nur einzelne Seiten daraus!) in ein RTF Dokument. Hier kann die InputFilename-Property der CIB pdf toolbox über einen RTF Feldbefehl benutzt werden.

Weitere Details und Beispiele zu diesen Feldbefehlen sind der Schulungsunterlage „Dynamische Dokumente - Band 2 - fortgeschrittene Optionen“ zu entnehmen.


Tabellenfuss- und Tabellenübertragszeilen formatieren

{ PRINT ”CIB:TABLE:RepeatHeader=Bottom|Both|Top[;valign=bottom]” }

 

MS Office bietet keine Formatierungsmöglichkeiten um Tabellenfußzeilen oder Tabellenübertragszeilen kenntlich zu machen. Diese Anforderungen treten in der Praxis bei Listen, die über mehrere Seiten gehen, jedoch häufig auf.

 

Wenn man den PRINT Feldbefehl in passender Syntax in eine Tabellenzeile absetzt, kann man Tabellenfußzeilen und Tabellenübertragszeilen durch den CIB format/output Modul absetzen.

Um eine korrekte Verarbeitung dieser Feldbefehle { PRINT ”CIB:TABLE:RepeatHeader=xxx” } sicher zu stellen, ist die Einhaltung einiger Regeln zu beachten:

  • Der Feldbefehl wird nur in der Tabellenzeile wirksam, in der er im Dokument hinterlegt ist. Das bedeutet, dass er hinter jeder Tabellenzeile abgesetzt werden muss, bei der im Falle eines Tabellenumbruchs ein Übertrag gewünscht wird.
  • Eine Tabellenzeile, nach der eine Übertragszeile ausgegeben werden soll, darf nicht mit „nächsten Absatz zusammenhalten“ formatiert sein.
  • Die Übertragszeile selbst darf nicht mit " nächsten Absatz zusammenhalten" mit der nachfolgenden Tabellenzeile verklebt werden.
  • Derzeit wird nur genau eine Übertragszeile unterstützt, d.h. man kann nicht mehrere Tabellenzeilen hintereinander als Übergabezeilenblock definieren. 
  • Die Übertragszeile darf sich nicht in einer geschachtelten Tabelle befinden.

 valign=bottom: Verwendbar bei RepeatHeader=Bottom|Both

Durch Verwendung des Parameters „valign=bottom“ kann die Position der unteren Tabellenübertragszeile gesteuert werden. Default-mäßig wird die Übertragszeile am unteren Tabellenrand ausgegeben. Bei Einsatz von „valign=bottom“ erfolgt der Andruck am unteren Seitenrand, oberhalb der Fuß(noten)-Zeilen.

 Weitere Details und Anwendungsfälle sind der Schulungsunterlage „Dynamische Dokumente - Band 2 - fortgeschrittene Optionen“ zu entnehmen.

Beispiele:

{ PRINT ”CIB:TABLE:RepeatHeader=Both” }

Eine Tabellenfußzeile wird im Falle eines Seitenumbruches am unteren Tabellenrand und als Kopfzeile vor der Tabelle auf der nächsten Seite wiederholt. Sie überlagert im Zweifel auch eine Tabellenzeile mit der Eigenschaft "RepeatHeader=Bottom".


{ PRINT ”CIB:TABLE:RepeatHeader=Bottom” }

Im Falle eines Seitenumbruches erscheint eine Tabellenfußzeile am unteren Tabellenende. Sie wird dort immer wiederholt (z.B. die Zwischensumme einer Angebotsliste ).

 

{ PRINT ”CIB:TABLE:RepeatHeader=Bottom;valign=bottom” }

Im Falle eines Seitenumbruches erscheint eine Tabellenfußzeile am unteren Seitenrand. Sie wird dort immer wiederholt (z.B. die Zwischensumme einer Angebotsliste ).

 

{ PRINT ”CIB:TABLE:RepeatHeader=Top” }
Eine Kopfzeile wird im Falle eines Seitenumbruches auf der nächsten Seite direkt vor der Tabellenüberschrift wiederholt.

Dieser Feldbefehl kann mit „RepeatHeader=Both / Bottom“ kombiniert werden, d.h. die Top-Zeile wird in der Tabellenzeile abgesetzt, die auf die Both/Bottom-Zeile folgt. Dadurch wird die Möglichkeit eröffnet, die Übertragszeile oben mit einem anderen Text zu versehen wie die Übertragszeile unten.

Spezialfall:

Bei der Kombination mit „Both“ kann die Position der Top-Zeile beeinflusst werden. Sie wird als erste Tabellenzeile nach der Tabellenüberschrift ausgegeben, wenn

  • Die Reihenfolge erst Postenzeile, dann Übertragszeile, in der Tabelle eigehalten wird.
  • Bei einer Tabellenüberschrift, die aus mehreren Zeilen besteht, diese Zeilen nicht unterbrochen werden (z.B. durch verborgene Absätze).

 

(Hinweis: Für Tabellen-Überschriftzeilen hat MS Office eine eigene Formatierung verfügbar).


HTML-Masken und Druckbereiche und Tab-Reiter definieren


{ PRINT "CIB:CNV:HTML_BEGIN" } und { PRINT "CIB:CNV:HTML_END" }

dient zur Klammerung einer HTML-Maske.


{ PRINT "CIB:CNV:RESULT_BEGIN" } und { PRINT "CIB:CNV:RESULT_END" }

dient zur Klammerung eines Druckbereichs.

 

{ PRINT "CIB:CNV:HTML_TAB:Text" }

Dient zur Definition eines Tab-Reiters für die HTML-Maske.

An Masken- und Ergebnisdokument werden häufig unterschiedliche Anforderungen gestellt. Eine Möglichkeit ist, für jeden Zweck ein eigenes RTF-Dokument zu verwenden. Diese klare Trennung hat jedoch den großen Nachteil der Redundanz und des hohen Pflegeaufwands.

Zur Vermeidung der Redundanz wird meist dasselbe RTF-Dokument sowohl für das Erzeugen eines Ergebnisdokuments, als auch für das Generieren einer HTML-Maske für die Eingabe von Restdaten verwendet. Ohne weitere Vorgaben sind Masken- und Ergebnisdokument identisch.

Hier bietet jedoch der CIB format als Alternative spezifische Befehle die es ermöglichen, einen Teil des Dokuments nur in der Restdatenerfassungsmaske, einen anderen Teil im Ergebnisdokument zu verwenden. Für die Klammerung dieser Bereiche wird der Befehl { PRINT:CNV:.....} benutzt. Texte, die sich außerhalb dieser Klammern befinden, werden sowohl im Masken- als auch im Ergebnisdokument ausgegeben. Zur besseren Lesbarkeit können die Bereiche optional in zwei fest definierte Farben eingefärbt werden:

Feldbefehl und Bereich für das Maskendokument in einem Blauton: RGB 1,1,254

Feldbefehl und Bereich für das Ergebnisdokument in einem Orangeton: RGB 254,70,1

Diese speziellen Farben werden vom CIB format bei der Verarbeitung in Schwarz umgesetzt, alle anderen Farbtöne aber original belassen.

Die verwendeten Feldanweisungen gelten nur bei Einsatz der CIB office Module. Bei HTML-Konvertierung mit einem anderen Tool oder bei Darstellung des Ergebnisdokuments in einer anderen Software wie beispielsweise Microsoft© Word wirken die Feldbefehle nicht. Konkret wird die Einfärbung in Masken- und Ergebnisdokument angezeigt, und alle Bereiche landen sowohl im Masken-  als auch im Ergebnisdokument.

Hinweise

  • Die CIB Workbench bietet Hilfsmittel zur einfachen Definition von Masken- und Druckbereichen per Mausklick. 
  • Manuelles Einfügen ist möglich, beispielsweise über mit „Strg + F9“ erstellte leereFelder.
  • Die CIB:CNV Befehle (außer HTML_TAB ) sind nur paarweise erlaubt und dürfen sich nicht überlappen.
  • HTML_TAB:Text: Dem hier definierten Tab-Reiter „Text“ werden alle im RTF nachfolgenden Zeilen zugeordnet. Das Ende wird markiert durch den nächsten Tab-Reiter oder dem Ende des RTF-Dokuments.
  • CIB:CNV und INCLUDETEXT:
    Die Feldbefehle beziehen sich auf den ganzen Bereich, der zwischen den beiden Befehlen steht. Ist hier ein weiterer Baustein per INCLUDETEXT eingefügt, so gilt die Kennzeichnung auch für diesen Bereich.
    Die geschachtelte Verwendung des CIB:CNV Befehls in dem per INCLUDETEXT eingefügten Baustein ist nur in Ausnahmen erlaubt. Bei konkreten Anforderungen wenden Sie sich bitte an den CIB Support.

Beispiele

Fall 1: Text nur für das Maskendokument:

Eingabe.RTF:     Allgemeiner Text 1

{print "CIB:CNV:HTML_BEGIN"}
Html-Bereich
{print "CIB:CNV:HTML_END"}

 

Allgemeiner Text 2

{print "CIB:CNV:RESULT_BEGIN"}
Druckbereich
{print "CIB:CNV:RESULT_END"}

 

Allgemeiner Text3

Eingabe.htm:    Allgemeiner Text 1
HTML-Bereich
Allgemeiner Text 2
Allgemeiner Text3
Aufruf mit CIB runshell:  cibrsh OutputFormat=FormatHtml -h Eingabe.RTF

 

Fall 2: Text nur für das Ergebnisdokument

Beispiel siehe Kapitel „CIB format/RTF-Filter“