Um die Deklarationsdateien zu verstehen, die vom InterAction Application Server und dem Web Client verwendet werden, sollten Sie die Grundlagen der Extensible Markup Language (XML) kennen.
XML ist eine Auszeichnungssprache, die HTML ähnelt. Der entscheidende Unterschied ist, dass XML strukturierter und erweiterbar ist – ein XML-Dokument kann eine eigene, benutzerdefinierte Menge von Auszeichnungstags verwenden.
In diesem Abschnitt werden folgende Themen behandelt:
- XML-Deklaration
- Elemente und Tags
- Attribute und Werte
- Kommentare
- Ein XML-Dokument wohlgeformt machen
- Verwendung eines XML-Editors
Diese Anleitung bietet einen sehr kurzen Überblick über XML-Dateien im Zusammenhang mit der Anpassung des Web Client. Für einen umfassenderen Einblick in XML empfehlen wir weitere Ressourcen, die unter Weitere XML-Ressourcen vorgeschlagen werden.
XML-Deklaration
Die erste Zeile eines XML-Dokuments ist immer die XML-Deklaration:
<?xml version="1.0" standalone="yes"?>
Diese Zeile gibt an, welche XML-Version verwendet wird und ob das Dokument eine Document Type Definition (DTD) nutzt. Eine DTD ist eine Sammlung von Regeln, die die erlaubte Struktur eines XML-Dokuments festlegt. Die XML-Dateien, die Sie für den Application Server bearbeiten müssen, gelten als eigenständige Dokumente – das bedeutet, dass es für diese Dateien keine zugehörige DTD gibt.
Elemente und Tags
XML ist ähnlich wie HTML aufgebaut, da es aus Elementen besteht. Ein Element kann Text auszeichnen oder einfach Informationen bereitstellen, die vom Application Server verwendet werden. Zum Beispiel markiert ein „menuItemDeclarations“-Element Text, der als Menüpunkt definiert werden soll.
Sie geben Elemente in einem XML-Dokument an, indem Sie sie in Tags setzen. Ein Tag wird von spitzen Klammern (< und >) umschlossen und enthält den Namen des Elements, zum Beispiel:
<profileDeclarations>
Dies ist ein Beispiel für ein öffnendes Tag für das Element. Alle öffnenden Tags müssen mit einem schließenden Tag abgeschlossen werden. Ein schließendes Tag ist identisch mit dem öffnenden Tag, hat jedoch einen Schrägstrich (/) vor dem Elementnamen:
</profileDeclarations>
Alles, was sich zwischen dem öffnenden und dem schließenden Tag befindet, gehört zum Element. Das Element kann Text, andere XML-Tags oder auch nichts enthalten.
Ein Element kann bestimmte Anforderungen haben, was zwischen den öffnenden und schließenden Tags stehen darf. Zum Beispiel kann ein Element nur Textinformationen erlauben, ein anderes nur weitere Elemente.
Im Gegensatz zu HTML muss in XML jedes öffnende Tag ein entsprechendes schließendes Tag haben. Wenn sich zwischen dem öffnenden und schließenden Tag kein Text oder andere Tags befinden, können Sie beide zu einem einzigen Tag zusammenfassen, indem Sie den Schrägstrich vor das schließende spitze Klammerzeichen setzen. Beachten Sie dazu das folgende Beispiel.
Leere XML-Elemente
|
<formControl type="label"> <controlLabel>Name:</controlLabel> </formControl> |
Dieses Element enthält andere Elemente. Beachten Sie die separaten öffnenden und schließenden Tags (<formControl> und </formControl>), die die Informationen umschließen. |
|
<field id="2/-10401"> </field> |
Dieses Element enthält keinen Text oder andere Elemente – zwischen den <field>- und </field>-Tags steht nichts. Daher können das öffnende und das schließende Tag zu einem einzigen Tag zusammengefasst werden. <field id="2/-10401" /> |
XML-Tags können ineinander verschachtelt werden. Verschachtelte Tags müssen auf derselben Ebene geöffnet und geschlossen werden.
Welche Elemente Sie beim Konfigurieren des Web Client verwenden können, hängt vom Typ der XML-Datei ab, die Sie bearbeiten. Eine Übersicht über die für den Web Client verwendeten Elemente finden Sie in den folgenden Abschnitten:
- Elemente und Attribute für eine Page Method Declaration
- Elemente und Attribute für eine Nugget List Declaration
- Elemente und Attribute für eine Search List Declaration
Attribute und Werte
Ein Element kann auch Attribute besitzen. Ein Attribut liefert zusätzliche Informationen über das Element.
Sie geben Attribute im Start-Tag eines Elements an, mit der Syntax attribute_name = "value". Zum Beispiel hat das field-Element die folgenden zwei Attribute:
-
labelmit dem Wert „Clients“ -
labelClassmit dem Wert „headline“
Attributwerte müssen entweder in einfache oder doppelte Anführungszeichen gesetzt werden. Es spielt keine Rolle, welche Sie verwenden.
Welche Attribute und Werte für ein bestimmtes Element zulässig sind, hängt vom jeweiligen Element ab. Eine Übersicht über die für den Web Client erlaubten Attribute finden Sie in den folgenden Abschnitten:
- Elemente und Attribute für eine Page Method Declaration
- Elemente und Attribute für eine Nugget List Declaration
- Elemente und Attribute für eine Search List Declaration
Kommentare
Eine XML-Datei kann Kommentare enthalten. Diese werden beim Verarbeiten der Datei ignoriert. Kommentare sind nützlich, um Hinweise zu den verschiedenen Tags zu hinterlassen.
Kommentare verwenden die gleiche Syntax wie in HTML – jeder Text zwischen <!-- und --> ist ein Kommentar, zum Beispiel:
<!-- Dies ist ein Kommentar -->
Kommentare dürfen nicht innerhalb eines Tags stehen. Außerdem darf ein Kommentar keine doppelten Bindestriche (--) enthalten.
Die mit dem InterAction Application Server gelieferten XML-Dateien enthalten Kommentare.
Ein XML-Dokument wohlgeformt machen
Eine XML-Datei gilt als wohlgeformt, wenn sie bestimmten Regeln entspricht. Zu diesen Regeln gehören unter anderem:
- Die Datei beginnt mit der XML-Deklaration.
- Alle Attributwerte stehen in Anführungszeichen. Es können einfache oder doppelte Anführungszeichen sein.
- Alle öffnenden Element-Tags haben ein entsprechendes schließendes Tag.
- Alle Element-Tags sind korrekt verschachtelt.
Weitere Informationen zu wohlgeformten XML-Dateien finden Sie in einer der unter Weitere XML-Ressourcen aufgeführten XML-Ressourcen.
Eine XML-Datei gilt als gültig, wenn sie sowohl wohlgeformt ist als auch einer Document Type Definition (DTD) entspricht. Eine DTD ist eine Sammlung von Regeln, die die erlaubte Struktur eines XML-Dokuments festlegt. Die XML-Dateien, die Sie für den InterAction Application Server bearbeiten müssen, gelten als eigenständige Dokumente – das bedeutet, dass es für diese Dateien keine zugehörige DTD gibt.
Der Application Server kann nur wohlgeformte XML-Dateien verarbeiten. Die Verwendung eines XML-Editors ist eine gute Möglichkeit, um sicherzustellen, dass Ihre Dokumente wohlgeformt sind.
Verwendung eines XML-Editors
Obwohl Sie die XML-Dateien des InterAction Application Server mit einem Texteditor bearbeiten können, wird dringend empfohlen, einen validierenden XML-Editor zu verwenden. Der Grund dafür ist, dass der Application Server nur wohlgeformte XML-Dateien verarbeiten kann. Ein validierender XML-Editor kann bestätigen, dass die Datei wohlgeformt ist, bevor Sie Änderungen speichern. Der Editor sollte außerdem Funktionen bieten, die Ihnen helfen, Fehler wie nicht korrekt geschlossene Tags zu finden.
Einige XML-Editoren verwenden auch unterschiedliche Farben für die Tags, was es einfacher macht, die zu bearbeitenden Informationen im Dokument zu finden.
Weitere Informationen zur Verwendung und Validierung von XML-Dokumenten finden Sie in der Dokumentation Ihres XML-Editors.
Es gibt verschiedene kostenlose, Shareware- und kommerzielle XML-Editoren.