CIB format technischer Leitfaden (DE)

4. Ausgabemodule

4.7. CIB format/html

Allgemein
Spezielle Properties für die HTML Ausgabe
Zeichenersetzungen bei der HTML-und RUL-Generierung
Spezielle Properties zum Ändern der Dokument-Eigenschaften

Allgemein

Mit Hilfe dieses Moduls wird eine Rtf-Datei in eine Html-Datei konvertiert. Bei der Konvertierung wird der komplette Textinhalt der Rtf-Datei übernommen. Das Ergebnis soll vom Aussehen her dem Rtf-Text so nahe wie möglich kommen. Bei den unterstützten Browsern handelt es ich um Netscape und InternetExplorer. Der resultierende Html-Code ist XHTML 1.0 konform. Die Einhaltung der Norm XHTML 1.0 ist geplant.

Die Ausrichtung des Konverters basiert qualitativ insbesondere darauf, Rtf-Rohtexte in ein optimales HTML für die CIB dialog Komponenten zu konvertieren. Hierzu werden REF, SERIENDRUCKFELD und FORMULAR-Feldanweisungen in entsprechende Html-Eingabefelder umgesetzt.


Spezielle Properties für die HTML Ausgabe

Optionsname

Optionswert

Datentyp

BackgroundColor

 

Hintergrundfarbe des Html-Dokuments

Default: -1: es wird keine Hintergrundfarbe festgelegt

Long (COLORREF)

BackgroundFilename

Name einer Grafik-Datei, die für den Hintergrund der Html-Seite herangezogen wird

Default: "": es wird keine Hintergrundgrafik angezeigt

Char*

BarcodeGraphicResolution

(ab CIB format Version 5.3.234)

Bei der HTML-Generierung wird jede im RTF enthaltene Barcodegrafik als eigene Grafikdatei (PNG) abgelegt. Die Größe dieser Dateien kann über die Auflösung  (dpi) gesteuert werden.

Ist diese Property gesetzt, wird der Barcode nicht mehr in das HTML geschrieben.

Char*

DuplicateFieldnamePrecedence

Char*

(ab CIB format Version 5.6.251c )

Bei mehrfacher Verwendung eines identisch benannten Steuerelementes (REF-Feld) im RTF kann über diese Property entschieden werden, welche Definition für die Übernahme der Attribute in die RUL-Datei verwendet werden soll.

Mögliche Werte:

First     Erstes Auftreten des REF-Feldes im RTF,
               bisheriges Verhalten (default).

- Last     Letztes Auftreten des REF-Feldes im RTF.

- FirstCibFormfield     Erstes Auftreten des REF-Feldes im RTF mit belegtem cibformfield-Schalter.

- LastCibFormfield     Letztes Auftreten des REF-Feldes im RTF mit belegtem cibformfield-                Schalter.

 

FontsizeMap

(ab CIB format Version 5.3.239)

Werte-Tabelle für das Umsetzen der RTF-Fontgrößen (in pt) in die HTML-Fontgrößen (1 – 6).

Angabe einer Liste von max. fünf Fontgrößen in pt.
Default:  "8;10;12;14;16"

Das ergibt im Default-Fall die folgenden Bereiche für Fontgröße f:
0          < f  <= 8pt                  "1" (HTML-Fontgröße)
8pt       < f <= 10pt                 "2"
10pt     < f <= 12pt                 "3"
12pt     < f <= 14pt                 "4"
14pt     < f <= 16pt                 "5"
16pt     < f                               "6"

Hinweise:
Die Angabe von Dezimalstellen ist möglich, z.B. "10.5".
Die Anlieferung der Wertebereiche wird größensortiert erwartet.
Werden in der Tabelle RTF-Fontgrößen gezielt weggelassen, so wird auch die zugehörige HTML-Fontgröße nicht verwendet.

Beispiel:
";10.5"    ergibt
0 < f <= 10.5t              "2"
10.5pt< f                      "3"

Char*

HtmlIfCibClassOnlyForLoops

Char*

(ab CIB format Version 7.1.0)

Ist diese Property aktiviert, erzeugt der CIB format im HTML BEGIN-END Schachtelungen nur noch für SOLANGE-Schleifen.

0       Verhalten wie bisher, d.h. für jede IF-Abfrage wird eine Begin-END Schachtelung erzeugt. (default)

1       BEGIN-END Schachtelungen nur noch für SOLANGE-Schleifen.

 

HtmlDisableGraphicGeneration

(ab CIB format Version 7.6.4)

Eigenschaft zum Deaktivieren der Generierung von Grafikelementen für die html-Ausgabe.

“FALSE“            Grafik wird erzeugt. (default)

“TRUE” Grafik-Generierung ist deaktiviert.

Char*

HtmlShapeObjects

 

Legt fest ob Objekte (Shapes) aus Word ins HTML konvertiert werden sollen.

Default = False, Shapes werden unterdrückt

Long (boolean)

HtmlCreateForm

(ab CIB format Version 5.3.235)

 

Über diese Property wird die Behandling des HTML-Tags „Form“ gesteuert.

0          <Form> wird beim Erzeugen einer htm Seite
             unterdrückt

1          <Form> wird beim Erzeugen einer htm Seite
            eingefügt (default)

Char*

HtmlVersion

Legt die HTML Version der Ausgabe fest:

"HTML32"     Ausgabe entspricht der HTML-Spec Version 3.2

"HTML32Fragment"     HTML Version 3.2 und Ausgabe in Fragmenten

"HTML40"     Ausgabe entspricht der HTML-Spec Version 4.0 (default)

Char*

HtmlZipOutput

(ab CIB format Version 5.3.235)

 

Die Ausgabe aller erzeugten Dateien (HTML, RUL, Grafiken) erfolgt gezippt.

TRUE: Ausgabe gezippt

FALSE: keine gezippte Ausgabe

Default: FALSE

Char*

IfThenElsePart

"Ignore": IF-Felder werden nicht umgesetzt

"AllBranches": alle Inhalte des IF-Feldes werden umgesetzt

"IfOnly": nur der IF-Teil im IF-Feld wird umgesetzt

Default: "Ignore"

Char*

IgnorePapersize

 

TRUE: das Html-Dokument ignoriert die Seitengrenzen des Rtf-Dokuments sowie Kopf- und Fußzeilen; Fußnoten erscheinen am Ende des Html-Dokuments

FALSE: die Seiten des Dokuments sollen wie im Rtf-Text voneinander abgegrenzt erscheinen (mit Kopf- und Fußzeile am Anfang und Ende bzw. Fußnoten am Ende einer Seite)

ACHTUNG: soll das Html-Dokument durchgängig dargestellt werden, also tatsächlich als eine Seite, muss die Property auf TRUE gesetzt werden!

Default: FALSE

Long (boolean)

IncludeText

 

TRUE: Mit dem Feld INCLUDETEXT eingebundene Texte werden ins Html eingefügt

FALSE: Es wird ein Link auf den angegebenen Dateinamen mit geänderter Extension auf *.htm eingefügt.

Default: TRUE

Long (boolean)

InputFilename

Name der zu konvertierenden Rtf-Datei

Default: muss angegeben werden!

Char*

KeepUrlPicturePath

(ab CIB format Version 7.0.3a, 7.1.0)

Über diese Property kann die Behandlung von INCLUDEPICTURE-Grafiken gesteuert werden, die über URL-Pfade angesprochen werden.

0        Der Pfad zu der INCLUDEPICTURE-Grafik wird aufgelöst und die Grafik im HTML in skalierter Form direkt angesprochen. Dafür wird die Grafik selbst neben der HTML-Datei abgelegt
(default)
Dies entspricht dem Standardverhalten vorangegangener Versionen des CIB format. 

1        Der URL-Pfad zu der INCLUDEPICTURE-Grafik ("http://", "ftp://", "gopher://", "https://") wird in die HTML-Datei übernommen. In diesem Fall wird die Größe der Grafik beibehalten und keine Skalierung durchgeführt.

Beispiel für HTML-Ausgabe bei KeepUrlPicturePath=0:
<img src="out_Grafik2.jpg" width="125" height="78" border="0" alt="[Bild out_Grafik2.jpg]">

Beispiel für HTML-Ausgabe bei KeepUrlPicturePath=1:
<img src="https://www.test.de/fileadmin/bilder/ Grafik2.jpg" border="0" alt="[Bild https://www.test.de/fileadmin/bilder/Grafik2.jpg]">

Char*

OutputFilename

Name der zu erzeugenden Html-Datei

Default: Rtf-Dateiname mit Endung ".htm"

Char*

OutputFormat

FormatHtml

Char*

ParagraphBorderToTable

 

TRUE: Absätze mit Rahmen werden in eine Tabelle konvertiert

FALSE: keine Tabellen-Konvertierung; Absätze erscheinen ohne Rahmen

Default: TRUE

Long (boolean)

RulContainsTable

(ab CIB format Version 5.3.234)

Durch Einschalten dieser Property wird das Table-Attribut aus dem Formularfeld in die RUL-Datei übertragen. Dort kann es von neueren Versionen der CIB-Browser ausgewertet werden.

0          Keine Übernahme in RUL-Datei (default)

1          Übernahme in RUL-Datei

Char*

RulFilename

Name der zusätzlich zu erzeugenden Rul-Datei

Default: leer; es wird keine Rul-Datei erzeugt

Char*

ShowHiddenText

 

TRUE: Verborgen formatierter Text wird im Html angezeigt

FALSE: Verborgen formatierter Text wird im Html nicht angezeigt

Default: FALSE

Long (boolean)

TableBorder

 

Dicke des Rahmens um die ganze Tabelle in Pixel

ACHTUNG: 0 bedeutet, daß kein Tabellenrahmen angezeigt wird; es bedeutet auch, daß um die Zellen ebenfalls kein Rahmen dargestellt wird

Default: 1

Long

TableWidthInPercent

 

TRUE: Tabellen- und Zellenbreiten werden relativ in Prozent angegeben

FALSE: Tabellen- und Zellenbreiten werden absolut in Pixel angegeben

Default: TRUE

Long (boolean)

TableReferenceRow

 

TRUE: es wird, wenn nötig, am Ende der Tabelle eine "Referenzzeile" ausgegeben; dies verbessert bei manchen Browsern das Tabellenlayout

FALSE: keine zusätzliche Zeile

Default: FALSE

Long (boolean)

TextboxFontsize

 

Html-Schriftgröße in Textboxen; 0 bedeutet, daß die Schriftgröße im Html nicht verändert wird

Default: 0

Long

TextColor

 

Standardtextfarbe im Html-Dokument; korrespondiert mit der Farbe "automatisch"

Default: -1; Standardfarbe wird nicht festgelegt

Long (COLORREF)

Title

Titel der Html-Seite (erscheint in der Titelleiste des Browsers)

Default: ""; in diesem Fall wird der Titel der Rtf-Datei herangezogen

Char*

WorkSpace

 

 

 

 

 

 

 

(ab CIB format Version 5.3.218):

Definitiert das Arbeitsverzeichnis für alle Dateinamensangaben.

Der Pfad wird als nullterminierte Zeichenkette angegeben. Der Pfad kann absolut angegeben werden oder relativ zum Arbeitsverzeichnis des aufrufenden Prozesses.

Alle Dateiangaben (ohne absoluten Pfad) in den Properties 'InputFilename' oder 'OutputFilename' oder bei INCLUDEPICTURE werden relativ zu diesem Workspace betrachtet.

Es kann auch eine Liste von Arbeitsverzeichnissen angegeben werden. Die einzelnen Angaben werden durch Semikolon getrennt. Für jede verwendete Datei wird eine Suche gestartet und die erste Fundstelle genutzt.

Wird nichts anderes angegeben, so wird der erzeugte Output im ersten Arbeitsverzeichnis der Liste abgelegt.

Char*


Zeichenersetzungen bei der HTML-und RUL-Generierung

Bei der HTML- bzw. RUL-Generierung erfolgen durch den CIB format Zeichenersetzungen für Umlaute und bestimmte Sonderzeichen. In folgender Tabelle werden diese Ersetzungen abhängig von der HTMLVersion dokumentiert. (gültig ab CIB format Version 5.7.0)

Sonder-zeichen

HTML32

HTML40

HTML-Datei

RUL-Datei

HTML-Datei

RUL-Datei

In Namen von HTML-Elementen

In normalem

Text

(ist leer)

In Namen von HTML-Elementen

In normalem

Text

 

ä

 

&auml

 

_

&auml

_

ö

 

&ouml

 

_

&ouml

_

ü

 

&uuml

 

_

&uuml

_

Ä

 

&Auml

 

_

&Auml

_

Ö

 

&Ouml

 

_

&Ouml

_

Ü

 

&Uuml

 

_

&Uuml

_

.

 

 

 

_

 

_

-

 

 

 

_

 

_

´

 

&#180

 

 

&#180

 

"

 

&#147

 

 

&#147

 

ß

 

&szlig

 

_

&szlig

_

&

 

&amp

 

 

&amp

 

 

&euro

 

 

&euro

 

 

&lt

 

 

&lt

 

 

&gt

 

 

&gt

 

§

 

&sect

 

 

&sect

 

°

 

&#176

 

 

&#176

 

`

 

&#145

 

 

&#145

 

,

 

&#130

 

 

&#130

 


Ausnahmen für „setEnums“ und „setValue“:

Folgende Ersetzungen gelten für die RUL-Generierung bei „setEnums“ und „setValue“:

'            ➔ "
\           ➔
\\         ➔ \

Warnung:
 Der CIB dialog meldet bei einem " im Event einen Syntaxfehler, d.h. das " muss maskiert werden:
\\"

Spezielle Properties zum Ändern der Dokument-Eigenschaften

Diese Properties können nicht im RTF über PRINT CIB Befehl gesetzt werden.

Optionsname

Optionswert

Datentyp

DocInfo.Author

Eingabe des Verfassers.

Überschreibt die im RTF hinterlegte Information.

Char*

DocInfo.Title

Eingabe des Titels.

Überschreibt die im RTF hinterlegte Information.

Char*

DocInfo.Subject

Eingabe des Betreffs/Themas.

Überschreibt die im RTF hinterlegte Information.

Char*

DocInfo.Keywords

Eingabe der Stichwörter.

Überschreibt die im RTF hinterlegte Information.
Maximale Länge beträgt 2K.

Char*


Hinweis:

Für C++-Anwender sind die Optionsnamen in einer separaten Headerdatei als defines hinterlegt.