KAPITEL 10: Das XML-Layout Schema

KAPITEL 10: Das XML-Layout Schema

Einführung

Innerhalb von vistrax werden XML-Layout-Vorlagen an zwei entscheidenden Stellen eingesetzt:

Vorlagen für Besucherausweise
Vorlagen für Besucherscheine

Die Nutzung von XML-basierten Layout-Vorlagen ermöglicht es Ihnen ein individuelles Layout zu erstellen und zu verwenden. Das eingesetzte Layout kann während der Benutzung gewechselt werden.

Die Platzhalter für dynamische Informationen (sog. XML-Elemente/-Tags) können je nach Anforderung von Ihnen hinzugefügt oder entfernt werden.

ACHTUNG!

XML-Dateien für vistrax sind mit der Kodierung UTF8 ohne BOM zu speichern. Eine andere Kodierung kann während des Imports unter Umständen nicht richtig verarbeitet werden. Beim Bearbeiten einer exportierten XML-Layout-Vorlage ist darauf zu achten, dass ein geeigneter Editor verwendet wird, welcher die notwendige Kodierung der XML-Datei nicht verändert. Wir empfehlen den kostenlosen Editor Notepad++.

Aufbau der XML-Struktur

Zur Verfügung stehende Hauptelemente

Nachfolgende Auflistung zeigt die für die Gestaltung von Layouts zur Verfügung stehenden XML- Hauptelemente:

```
 <layout> Root-Element eines Layouts 
```

<page> Definiert eine Seite des Layouts

 <badgedata> Definiert durch seine Unterelemente die Layout-Größe

 <textbox> Element zum Anzeigen von Text

```
 <frame> Rahmen-/Linienelement 
```
```
 <bitmap> Bildelement 
```

 <backgroundBitmap> Hintergrundbild (Achtung: nur einmal pro <page>-Element zu verwenden!)

Das <layout> Element

Das <layout> Element ist das Root-Element einer XML-basierten Layout-Vorlage, durch das die komplette Layout-Definition umschlossen wird.

Das <page> Element

Das <page> Element entspricht einer Seite eines Besucherausweises bzw. Besucherscheins. Alle Layout-Elemente, die von <page> Tags umschlossen werden, werden auf derselben Seite dargestellt.

Das erste <page> Element einer Layout-Definition muss das <badgedata> Element enthalten, mit dem die Größe des Layouts festgelegt wird.

Das <page> Tag bietet als optionales Attribut paper. Mit diesem kann ein Papier-Typ vorgegeben werden (z.B. paper=“DIN A4“). Der Papier-Typ entspricht dem Namen der Papier-Vorlage in der Datenbank.

Hinweis

Das Attribut paper kann in jedem <page> Element angegeben werden, zur Zeit wird aber nur das Attribut des ersten <page> Elements in einem Layout ausgewertet und als Papier-Typ für alle vorhandenen Seiten verwendet.

Das <badgedata> Element

Das <badgedata> Element definiert verschiedene Eigenschaften einer Layout-Seite. Unter anderem wird die Größe des Layouts definiert.

Das Element beinhaltet folgende Unterelemente:

<badgename> Name des Layouts (optional, wird im Vorschau-Fenster als Titeltext angezeigt)

```
<vsize> Vertikale Größe in mm
```
```
<hsize> Horizontale Größe in mm
```

<hflip> Spiegelung des Inhaltes beim Druck um die horizontale Achse (optional, Standard: 0, 0 = Deaktiviert, 1 = Aktiviert)

Das <textbox> Element

Mit dem Element wird ein Text im Layout erzeugt. Das Element beinhaltet folgende Unterelemente:

<top> Oberer Seitenabstand (mm, Kommazahl z.B. 10.5)

<left> Linker Seitenabstand (mm, Kommazahl z.B. 10.5)

<width> Breite (mm, Kommazahl z.B. 10.5)

<height> Höhe (mm, Kommazahl z.B. 10.5)

<rotation> Rotationswinkel im Uhrzeigersinn in ° (optional, Standard: 0, ganzzahliger Wert) Rotationspunkt ist der Mittelpunkt der Textbox.

<pt> Schriftgröße (z.B <pt>8</pt>) (optional, Standard: 12, ganzzahliger Wert)

```
<content> Inhalt der Textbox
```

<bold> Fettschrift (optional, Standard: 0, 0 = Deaktiviert, 1 = Aktiviert)

<weight> Fettschrift, überschreibt <bold> (optional, Standard: 0)

<italic> Kursivschrift (optional, Standard: 0, 0 = Deaktiviert, 1 = Aktiviert)

<underlined> Unterstreichung (optional, Standard: 0, 0 = Deaktiviert, 1 = Aktiviert)

<capitaliszed> Kapitälchen (optional, Standard: 0, 0 = Deaktiviert, 1 = Aktiviert)

<rgb> Textfarbe (optional, Standard: 000000, Hex-Farbwert)

<font> Name der zu verwendenden Schriftart

<antialiased> Antialising (optional, Standard: 1, 0 = Deaktiviert, 1 = Aktiviert)

<halign> Horizontale Ausrichtung (optional, Standard: l; l = Links , r = Rechts, c = Mitte)

<fitting> Anpassung des Textes, wenn Textbox zu klein (optional, Standard: 0, 0 = Deaktiviert, 1 = Aktiviert)
  * <code><wrapping> Zeilenumbruch des Textes, sobald der Text das Ende der Textbox erreicht hat (optional, Standard: 0, 0 = Deaktiviert, 1 = Aktiviert)

<clipping> Beschneidung des Textes, wenn Textbox zu klein (optional, Standard: 0, 0 = Deaktiviert, 1 = Aktiviert) * <rtl> Rechts-Nach-Link Ausrichtung des Textes, z.B. für Arabisch (optional, Standard: 0, 0 = Deaktiviert, 1 = Aktiviert)

<padding> Einfügen eines vertikalen Abstands zwischen Text und Textboxrand (optional, Default 1, 0 = Deaktiviert, 1 = Aktiviert)

Das <textbox> Tag besitzt außerdem das optionale Attribut type, mit dem die Textbox eingeordnet werden kann. Über den Typ können in der Maske „Layout ändern“ Schriftart, Farbe etc. für alle Elemente desselben Typs geändert werden. Folgende Werte stehen zur Auswahl:

caption
label
content
footer

ACHTUNG!

Alle <textbox> Elemente gleichen Typs müssen die gleiche Formatierung besitzen, d.h. werden innerhalb der Elemente die oben beschriebenen Tags verwendet, müssen diese mit den gleichen Werten gefüllt werden.

Hinweis

Soll das <textbox>Element in der Maske „Layout ändern“ nicht mittels einer der Type-Gruppen editierbar sein, muss das Attribut weggelassen werden.

Das <frame> Element

Mit dem <frame> Element können Linien und Rahmen abgebildet werden. Das Element beinhaltet folgende Unterelemente:

<top> Oberer Seiten-Offset (mm, Kommazahl z.B. 10.5)

<left> Linker Seiten-Offset (mm, Kommazahl z.B. 10.5)

<width> Breite (mm, Kommazahl z.B. 10.5)

<height> Höhe (mm, Kommazahl z.B. 10.5)

<rotation> Rotationswinkel im Uhrzeigersinn in ° (optional, Default: 0, int) Rotationspunkt ist der Mittelpunkt des Frames.

```
<solid> Gefüllt (0 = FALSE, 1 = TRUE)
```

<rgb> Farbe (optional, Default 000000 → Hex schwarz)

Das <bitmap> und <backgroundBitmap> Element

Mit dem <bitmap> Element können Bilder in die Vorlage eingefügt werden. Das Element beinhaltet folgende Unterelemente:

<top> Oberer Seitenabstand (mm, Kommazahl z.B. 10.5)

<left> Linker Seitenabstand (mm, Kommazahl z.B. 10.5)

<width> Breite (mm, Kommazahl z.B. 10.5)

<height> Höhe (mm, Kommazahl z.B. 10.5)

<halign> Horizontale Ausrichtung (optional, Standard: l; l = Links , r = Rechts, c = Mitte)

<valign> Vertikale Ausrichtung (optional, Standard: t; t = Oben , b = Unten, c = Mitte)

<rotation> Rotationswinkel im Uhrzeigersinn in ° (optional, Standard: 0, ganzzahliger Wert). Rotationspunkt ist der Mittelpunkt der Grafik.

<ident> Name des Bildes (Name aus der Datenbank)

Das spezielle <backgroundBitmap> Element identifiziert ein optionales Hintergrundbild. Es entspricht inhaltlich dem Element, darf aber nur einmal pro <page> verwendet werden und muss als erstes Element auf der Seite definiert werden. Bilder, die ohne „Contentmarker“ eingefügt werden (also statische Bilder), müssen in der Datenbank vorhanden sein, damit sie angezeigt werden. Sie können entweder zusammen mit dem Layout aus einer .vxlt Datei importiert werden oder über den Media Browser manuell hinzugefügt werden.

<textbox> - Contentmarker

Bei einer Textbox kann der statische Inhalt des <content> Unterelementes durch einen der folgenden Contentmarker ersetzt werden:

%%badge_no%%
Ausweisnummer

%%badge_barcode%%
Ausweisnummer als barcode

%%mandator_name%%
Name der Mandanten

%%company_name%%
Name der Besucher-Firma

%%company_city%%
Stadt der Besucher-Firma

%%company_country%%
Land der Besucher-Firma

%%company_remarks%%
Hinweise zur Firma, aktivieren Sie das Wrapping-Element des <textbox>-Elementes bei langen Texten (<wrapping>1</wrapping>).

%%visitor_salutation%%
Anrede des Besuchers

%%visitor_title%%
Titel des Besuchers

%%visitor_firstname%%
Vorname des Besuchers

%%visitor_lastname%%
Nachname des Besuchers

%%visitor_email%%
Email des Besuchers

%%visitor_phone%%
Telefonnummer des Besuchers

%%visitor_mobile%%
Mobiltelefonnummer des Besuchers

%%visitor_category%%
Besucherkategorie

%%visitor_name%%
<Titel><Vorname><Nachname>

%%visitor_name2%%
<Nachname>,<Vorname>

%%visitor_name3%%
<Vorname><Nachname>

%%visitor_remarks%%
Hinweise zum Besucher, aktivieren Sie das Wrapping-Element des <textbox>-Elementes bei langen Texten (<wrapping>1</wrapping>).

%%identitycardno%%
Personalausweisnummer

%%employee_salutation%%
Anrede des Mitarbeiters

%%employee_title%%
Titel des Mitarbeiters

%%employee_firstname%%
Vorname des Mitarbeiters

%%employee_lastname%%
Nachname des Mitarbeiters

%%employee_division%%
Abteilung des Mitarbeiters

%%employee_email%%
Email des Mitarbeiters

%%employee_phone%%
Telefonnummer des Mitarbeiters

%%employee_mobile%%
Mobiltelefonnummer des Mitarbeiters

%%employee_name%%
<Titel><Vorname><Nachname>

%%employee_name2%%
<Nachname>, <Vorname>

%%employee_name3%%
<Vorname><Nachname>

%%valid_from%%
Anfangsdatum Gültigkeit (Datum & Zeit)

%%valid_from_dateonly%%
Anfangsdatum Gültigkeit (nur Datum)

%%valid_from_timeonly%%
Anfangsdatum Gültigkeit (nur Uhrzeit)

%%valid_to%%
Enddatum Gültigkeit (Datum & Zeit)

%%valid_to_dateonly%%
Enddatum Gültigkeit (nur Datum)

%%valid_to_timeonly%%
Enddatum Gültigkeit (nur Uhrzeit)

%%valid_date_time_line1%%
Informationen zum Gültigkeitszeitraum, abhängig vom Validity Mode nur mit …_Line2 zu verwenden.

%%valid_date_time_line2%%
Informationen zum Gültigkeitszeitraum, abhängig vom Validity Mode nur mit …_Line1 zu verwenden.

%%date%%
Das aktuelle Datum

%%time%%
Die aktuelle Uhrzeit

%%now%%
Das aktuelle Datum und die aktuelle Uhrzeit

%%vehicle%%
Kfz-Nummernschild

%%visit_remarks%%
Hinweise zum Besuch, aktivieren Sie das Wrapping-Element des <textbox>-Elementes bei langen Texten (<wrapping>1</wrapping>).

%%reason%%
Besuchsgrund

%%gate%%
Eingang

%%whereabouts%%
Aufenthaltsort(e)

%%_%%
Ein Leerzeichen zwischen zwei anderen Contentmarkern. Dadurch lassen sich überflüssige Leerzeichen vermeiden, falls einer der umschließenden Contentmarker ohne Inhalt ist. Sollten durch die Ersetzungen der anderen Contentmarker mehrere aufeinanderfolgende %%_%% entstehen (z.B. weil der Inhalt eines Contentmarkers nicht existiert), so werden diese zu einem Leerzeichen zusammengefasst. Kombinationen aus einem Leerzeichen und einem %%_%%-Contentmarker werden zu einem Leerzeichen zusammengefasst. %%_%%-Contentmarker zu Beginn und zu Ende eines Textes werden entfernt.

Beispiele:

DayLong:

    
    %valid_date_time_line1% = 01.02.2013 - 02.02.2013
    %valid_date_time_line2% = <Leer>

DayToDay:

     %valid_date_time_line1% = 01.02.2013 - 02.02.2013
     %valid_date_time_line2% = 08:00:00 - 17:00:00

Continuous:

       
       %valid_date_time_line1% = 01.02.2013 08:00:00 -
       %valid_date_time_line2% = 02.02.2013 17:00:00

<bitmap> - Contentmarker

Bei einem Bild kann der statische Inhalt des <ident> Unterelementes durch einen der folgenden Contentmarker ersetzt werden:

%%company_logo%%
Firmenlogo der Besucher-Firma

%%mandator_logo%%
Mandantenlogo

%%visitor_photo%%
Foto des Besuchers

%%employee_photo%%
Foto des Mitarbeiters

Aufbau einer Layout-Vorlage

Grundgerüst

Das Grundgerüst einer Layout-Vorlage besteht aus einem einzigen <layout> Element und mehreren <page> (inkl. <badgedata>) Elementen. Der Aufbau ist wie nachfolgend skizziert:

<?xml version=“1.0“ encoding=“UTF-8“?>
<layout>
<page>
<badgedata>
<vsize>120</vsize>
<hsize>90</hsize>
</badgedata>
</page>
</layout>

Das obige Grundgerüst stellt lediglich eine leere Seite dar. Das Grundgerüst kann durch weitere Page-Elemente ergänzt werden.

→Ein ausführlicheres Beispiel finden Sie hier←

ZURÜCK

WEITER

Table of Contents

KAPITEL 10: Das XML-Layout Schema

Einführung

ACHTUNG!

Aufbau der XML-Struktur

Zur Verfügung stehende Hauptelemente

Das <layout> Element

Das <page> Element

Hinweis

Das <badgedata> Element

Das <textbox> Element

ACHTUNG!

Hinweis

Das <frame> Element

Das <bitmap> und <backgroundBitmap> Element

<textbox> - Contentmarker

Beispiele:

<bitmap> - Contentmarker

Aufbau einer Layout-Vorlage

Grundgerüst