Dokumentation für den XML Assistant v1.2 (Handbuch)

Inhalt:
1. Tutorial zum Schnelleinstieg
    1.1 Datei öffnen
    1.2 Anzeigeregeln verwenden und bearbeiten
    1.3 Templates
2. XML Bearbeiten
    2.1 Grundlegende Funktionen
    2.2 Namespaces verwalten
    2.3 Tastenkombinationen
3. Regeln bearbeiten
    3.1 Beispieldatei öffnen / Sichten anordnen
    3.2 Regeln organisieren
    3.3 Was Regeln sind
    3.4 Darstellungsoptionen
4. Weitere Tipps
    4.1 Auch Element mit eigenem Inhalt anzeigen
    4.2 "Springen" zu Unterelement + Mehrfachauswahl
    4.3 Verschieben von Elementen
5. Jetzt starten!


1. Tutorial zum Schnelleinstieg

Das Tutorial vermittelt anhand konkreter Beispiele die wesentlichen Funktionen des XML Assistants.

1.1 Datei öffnen 

Dateien können Sie über das Menü Datei->Öffnen oder mit dem Icon in der Toolbar öffnen.

Datei öffnen Icon Datei öffnen Menüpunkt

Für dieses Tutorial öffnen wir die Beispieldatei aber über den Menüpunkt Hilfe->Beispiel "Internetseiten".

Beispiel öffnen

Die folgende Abbildung zeigt die geöffnete Datei im XML Assistant. Die Programmfenster ist eingeteilt in: 1) Die Ansicht der XML-Datei als Baum 2) Die Attribute und Elemente der Auswahl im Baum 3) Die Ansicht des XML Codes.

Hauptfenster

1.2 Anzeigeregeln verwenden und bearbeiten 

Anzeigeregeln legen fest, wie die Daten einer XML-Datei dargestellt werden. Für unterschiedliche Typen von XML-Dateien können unterschiedliche Regelsätze angelegt werden.

Der Regelsatz "Internetseiten" ist bereits in der Liste ausgewählt. Es werden die dort definierten Anzeigeregeln auf die Datei angewendet, sie definieren Icons und Text des Baums (links) und die Art der Eingabemöglichkeiten für das gewählte Element (rechts).

Datei mit Anzeigeregeln

Lassen Sie uns die Regeln des Regelsatzes etwas anpassen, um die Funktionsweise besser zu verstehen.

Wählen Sie dazu 'Regeln bearbeiten' in der Toolbar:

Regeln bearbeiten

Daraufhin öffnet sich das Tab "rules.xml":

Tab Regeln bearbeiten

Zur besseren Übersicht minimieren wir die XML Code Ansicht und ordnen das Tab 'Regeln bearbeiten' unterhalb an.

Tab minimieren

Das funktioniert, indem Sie auf den Titel des Tabs mit linker Maustaste klicken, die Maustaste gedrückt halten und dann die Maus in das untere Viertel des Hauptfensters bewegen. Während des Ziehens verändert sich der Mauszeiger.

Fenster mit angeordneten Tabs Bedingungen treffen zu

Nun widmen wir uns wieder den Anzeigeregeln, wir öffnen den Regelsatz "Internetseiten" und die Regel "Internetseite". Klicken wir auf "Bedingung: Seite" und "Bedingungen treffen zu", sehen wir, dass diese Regel z.B. den Text "Seite: http://www.zdf.de (4)" mit einem Icon anzeigt, wenn der Name eines Elements im Baum "Seite" lautet. Diese Regel trifft bei der Beispieldatei mehrmals zu.

Bedingung Bedingung

Ändern Sie nun den Eintrag "Knotentext im Baum" von '$name: [Adresse] ([@id])' in den Text '$name: [Titel] ([@id])'. Die Änderungen werden sofort wirksam. Der in eckigen Klammern eingeschlossene Ausdruck ist kein bloßer Text, sondern wird, falls möglich, als XPath-Ausdruck interpretiert. In unserem Beispiel wird damit anstatt der Adresse der Titel angezeigt.

Andere Anzeige

Wie sie in den bereits existierenden Regelsätzen sehen, stehen noch etliche weitere Konfigurationsmöglichkeiten zur Verfügung. Bitte nehmen Sie sich ein paar Minuten Zeit, um diese auszuprobieren.

1.3 Templates 

Templates dienen dazu, häufig benötigte Codeausschnitte schnell einzufügen. Dies kann häufiges Kopieren/Einfügen ersparen.

Zur Demonstration verwenden wir wieder die Datei "Internetseiten".

Beispieldatei öffnen

Durch Klick mit rechter Maustaste auf den Wurzelknoten öffnet sich das Kontextmenü. In dem Untermenü "Neu" sehen Sie bereits ein Template, das für diesen Knoten definiert wurde. Zum Anlegen eines weiteren Templates wählen wir "Als neues Template" (Unterknoten "Verantwortlich").

Template Als neues Template Dialog Template anlegen

Ein Template ist eine eigene (kleine) XML-Datei, deren Inhalt über das Kontextmenü verfügbar gemacht werden kann. Templates werden wie gewöhnliche XML-Dateien bearbeitet und gespeichert. Sie werden im Unterverzeichnis 'templates' der Installation abgelegt.

Für dieses Beispiel entfernen wir alle Inhalte im Template, dies funktioniert durch Auswahl des obersten Knotens und der Funktion "Bearbeiten->Inhalte entfernen".

Alle Inhalte entfernen

Anschließend mit Ok bestätigen:

Regeln bearbeiten

Nun muss das Template noch für Knoten zur Verfügung gestellt werden. Dazu den Regelsatz "Internetseiten" und die Regel "Internetseite" öffnen, der Unterpunkt "Templates bei Rechtsklick" von "Bedingungen treffen zu" legt fest, welche Templates für diese Knoten in der Auswahlliste erscheinen sollen. Wir fügen das neue Template hinzu.

Regeln bearbeiten Template auswählen

Daraufhin erscheint dieses Template in der Auswahlliste.

Template in Auswahlliste

2. XML Bearbeiten

Beschreibt die Grundfunktionen zum Bearbeiten des XML Baums im XML Assistant

2.1 Grundlegende Funktionen 

Die wichtigsten Bearbeitungsoptionen erreichen Sie über das Kontextmenü (rechte Maustaste) des Baums oder das Menü "Bearbeiten":

Kontextmenü Menü

Die wesentlichen Funktionen sind:

2.2 Namespaces verwalten 

Namespaces werden ähnlich wie Attribute und Elemente verwaltet. Zum Hinzufügen eines Namespaces den Menüpunkt 'Namespace hinzufügen' wählen (auch in Menü 'Bearbeiten'):

Namespace hinzufügen

In dem Eingabedialog Namespaceprefix und Namespace URI eintragen:

Namespace hinzufügen

Nach Bestätigen mit Ok wird der Namespace angelegt:

Namespace hinzugefügt

Mit rechter Maustaste auf den angezeigten Namespace können Sie diesen Löschen oder Bearbeiten:

Namespace hinzugefügt

2.3 Tastenkombinationen 

Für das Bearbeiten im rechten Bereich können Sie folgende Tastenkombinationen verwenden:

3. Regeln bearbeiten

Der Komfort beim Bearbeiten der XML Dateien im XML Assistant hängt wesentlich von den verwendeten Regeln ab. Anhand einer Beispieldatei wird aufgezeigt, welche Bearbeitungsregeln der XML Assistant bietet.

3.1 Beispieldatei öffnen / Sichten anordnen 

Vorbereitung des Beispiels

Zuerst öffnen wir die benötigten Ansichten. Dazu im Menu 'Hilfe' den Eintrag 'Beispiel "Internetseiten"' wählen.

Beispiel 'Internetseiten' öffnen

Anschließend 'Regeln bearbeiten' wählen.

Regeln bearbeiten...

Daraufhin öffnet sich die Sicht zum Bearbeiten der Regeln. Es empfiehlt sich, wie angezeigt dieses Tab in den unteren Bereich des Programmfensters zu verschieben. Dazu mit gedrückter Maustaste auf den Tabtitel die Maus in den unteren Teil des Fensters ziehen.

Tab neu anordnen

Zu letzt noch den Editor für den XML Code minimieren. Diesen werden wir nicht benötigen.

XML Code Editor minimieren

3.2 Regeln organisieren 

Regeln und Regelsätze

Regeln sind in Regelsätzen organisiert. Für die Beispieldatei ist bereits der Regelsatz "Internetseiten" ausgewählt. Dieser Regelsatz enthält mehrere Regeln.

Regelsatz ausgewählt / Regeln des Regelsatzes

3.3 Was Regeln sind 

Bedingungen und Darstellungsoptionen von Regeln

Regeln enthalten eine oder mehrere Bedinungen (oft ist eine ausreichend) und viele Darstellungsoptionen. Treffen alle Bedinungen zu (1), so werden die Darstellungsoptionen angewandt (2).

Regel mit Bedingungen und Optionen bei Zutreffen der Bedinungen

In diesem Beispiel genügt die Bedingung: "Name ist... Internetseite". D.h. wenn ein Element im Baum diesen Namen hat, wird die Regel angewandt. Die anderen Typen für Bedingungen sind an dieser Stelle beschrieben.

Bedingung Beispiel

Treffen alle Bedingungen zu, werden die Optionen unter "Bedingungen treffen zu" (1) angewandt. Die Optionen betreffen den Baum (2: links) und den Eingabebereich (3: rechts).

Bedingungen treffen zu

3.4 Darstellungsoptionen 

Überblick über die verfügbaren Darstellungsoptionen

Die Darstellungsoptionen sind in verschiedene Kategorien eingeteilt. Diese sind jeweils näher beschrieben. Die Kategorien sind:

Kategorien Darstellungsoptionen

Bitte nehmen Sie sich etwas Zeit, um sich mit den einzelnen Darstellungsoptionen vertraut zu machen.

4. Weitere Tipps

4.1 Auch Element mit eigenem Inhalt anzeigen 

Der XML Assistant verbirgt von der XML Datei so viel wie möglich. Dadurch können Sie sich auf die Inhalte konzentrieren. In manchen Fällen möchten Sie aber auch Elemente mit Attributen/Unterelementen im Eingabebereich (rechts) anzeigen. Dies ist z.B. notwendig, wenn die Reihenfolge von Bedeutung ist. Schalten Sie dazu die Option "Auch Element mit Attributen/Unterelementen anzeigen" ein.

Option

Daraufhin werden auch diese Elemente gelistet.

4.2 "Springen" zu Unterelement + Mehrfachauswahl 

Bei Drücken der Taste Steuerung (STRG) und Bewegen der Maus über einen betreffenden Eintrag sehen Sie eine Hand. Mit Rechtsklick springen Sie zu diesem Element.

Springen zu Unterelement

Durch Klicken mit der linken Maustaste (STRG gedrückt halten) wählen Sie mehrere Einträge aus.

4.3 Verschieben von Elementen 

Zum Verschieben von Elementen bitte in Textfeld klicken. Bei gedrückter STRG-Taste das Mausrad nach oben/unten bewegen, the gewählte Element wird nach oben/unten verschoben.

5. Jetzt starten!

Wir hoffen dass wir Ihnen mit dieser kleinen Einführung helfen konnten, Sie haben nun das Rüstzeug, um selbst los zu legen.