Zweck

Die Funktion XML ordnen dient dazu, den aktuellen XML-Code der Dokumentvorlage einheitlich zu formatieren und gleichzeitig auf syntaktische Fehler zu prüfen.

Hierzu wird der vollständige XML-Code neu eingelesen, geparst und in einer standardisierten XML-Darstellung (Pretty Print) ausgegeben. Gleichzeitig wird überprüft, ob der XML-Code syntaktisch korrekt verarbeitet werden kann.

Verwendung

Während der Bearbeitung einer Dokumentvorlage kann der Redakteur den XML-Code nach eigenen Vorlieben strukturieren. Beispielsweise können zusätzliche Leerzeilen, individuelle Einrückungen oder andere optische Hervorhebungen eingefügt werden, um die Lesbarkeit während der Entwicklung zu verbessern.

Mit der Funktion XML ordnen wird der vollständige XML-Code anschließend neu formatiert und in einer einheitlichen Darstellung ausgegeben.

Dabei werden unter anderem:

• Einrückungen vereinheitlicht,
• zusätzliche Leerzeilen entfernt,
• die XML-Struktur neu formatiert,
• sowie eine standardisierte XML-Darstellung erzeugt.

Hinweis

Die Funktion dient der Vereinheitlichung der XML-Darstellung und gleichzeitig der Prüfung, ob der XML-Code syntaktisch korrekt verarbeitet werden kann.

Individuelle Einrückungen oder zusätzliche Leerzeilen zur besseren Lesbarkeit werden dabei entfernt und durch eine standardisierte XML-Darstellung ersetzt.

Die gleiche XML-Prüfung erfolgt ebenfalls automatisch beim Veröffentlichen einer Dokumentvorlage. Die Verwendung der Funktion XML ordnen ist daher nicht zwingend erforderlich, empfiehlt sich jedoch bereits während der Entwicklung, um XML-Fehler frühzeitig zu erkennen und zu beheben.

Kann der XML-Code nicht erfolgreich verarbeitet werden, bleibt der ursprüngliche XML-Code unverändert erhalten und eine Fehlerliste wird eingeblendet.

Nach erfolgreicher Korrektur kann die Funktion erneut ausgeführt werden.

Fehlerliste

Kann der XML-Code nicht erfolgreich verarbeitet werden, erscheint unterhalb des XML-Editors die Fehlerliste.

Für den ersten gefundenen Fehler werden folgende Informationen bereitgestellt:

Information	Beschreibung
Beschreibung	Beschreibung des aufgetretenen XML-Fehlers einschließlich Zeile und Position.

Bei der Fehlersuche ist zu beachten, dass sich die gemeldete Zeile häufig auf die Stelle bezieht, an der der XML-Parser den Fehler erstmals erkennt. Die eigentliche Ursache befindet sich jedoch oftmals unmittelbar davor, beispielsweise in der vorherigen Zeile oder innerhalb des vorhergehenden XML-Blocks.

Nachdem der Fehler behoben wurde, kann die Funktion XML ordnen erneut ausgeführt werden. Ist der XML-Code fehlerfrei, wird keine Fehlermeldung mehr angezeigt.

Die Fehlerliste bleibt nach ihrer Anzeige geöffnet und muss bei Bedarf manuell über X geschlossen werden. Bis zum Schließen belegt sie einen Teil des XML-Editors und reduziert den verfügbaren Arbeitsbereich.

Technischer Hinweis

Die Funktion verarbeitet den vollständigen XML-Code mittels eines XML-Parsers und erzeugt daraus eine standardisierte XML-Darstellung (Pretty Print).

Dabei erfolgt gleichzeitig eine Syntaxprüfung des XML-Codes. Dieselbe Parserprüfung wird auch beim Veröffentlichen einer Dokumentvorlage verwendet, sodass ausschließlich syntaktisch gültiger XML-Code veröffentlicht werden kann.

Kann der XML-Code nicht vollständig verarbeitet werden, wird der erste erkannte Fehler in der Fehlerliste ausgegeben. Weitere Fehler können erst ermittelt werden, nachdem der jeweils zuerst gefundene Fehler behoben wurde.