Formatierungsstil von XML -Dokumenten

Durch die Art und Weise, in der Leerraum geschrieben wird, kann die Erscheinungsweise des Quelltextes eines XML -Dokuments für einen menschlichen Bearbeiter erheblich geprägt werden, auch wenn sich dadurch an der Bedeutung des XML -Dokuments nichts ändert.

In den Kontexten, in denen die Schreibweise von Leerraum für ein XML -Dokument bedeutungslos ist, gehört sie zum Stil eines Autors. In dieser Lektion gibt der Autor Stefan Ram seinen persönlichen Formatierungsstil wieder. Dieser kann sich vom Stil anderer Autoren unterscheiden. Der Leser sollte selber entscheiden, welchen Stil er verwenden möchte. Wichtig ist nur, daß er überhaupt einen einheitlichen Stil der Formatierung verwendet.

Ein XML -Dokument besteht aus verschiedenen Teilen. Es wäre an sich übersichtlich, jeden Teil auf eine Zeile zu schreiben. Aus verschiedenen Gründen ist dies aber nicht möglich: Da manche Teile selber noch einmal unterteilt sind, müßten sie dann doch auf verschiedene Zeilen verteilt werden. Außerdem wären manche Zeilen dann viel zu lang oder zu kurz. So kommt es, daß die Teile eines XML -Textes oft mehrere Zeilen umfassen oder eine Zeile mehrere Teile enthält.

Um einem menschlichen Bearbeiter zu helfen, ein XML -Dokument leicht überblicken zu können, werden dessen Bestandteile so auf verschiedene Zeilen aufgeteilt, daß die Zeilen nicht zu lang und nicht zu kurz sind und gleichzeitig möglichst auch an sinnvollen Grenzen voneinander getrennt werden.

Einrücken

Wenn sich ein Teil über mehrere Zeilen erstreckt, werden alle weiteren Zeilen nach der ersten Zeile um zwei Positionen weiter rechts geschrieben („eingerückt“), um zu kennzeichnen, daß sie zu dem mit der ersten Zeile begonnenen Teil gehören. Diese Einrückung ist aber nur in Kontexten möglich, in denen Leerzeichen und Zeilenenden nicht für sich selbst stehen, sondern als Leerraum dienen. In anderen Lektionen wird erklärt, wann solche Kontexte nicht gegeben sind.

Einige Beispiele sollen diesen Stil der Einrückung verdeutlichen.

Hallo.html (Ausschnitt)

<?xml version="1.0" encoding="UTF-8"?>

Die XML -Deklaration in dem obigen Ausschnitt beginnt mit dem Token "<?xml" und endet mit dem Token "?>". Sie paßt gut auf eine Zeile. Eine Einrückung ist nicht notwendig.

Hallo.html (Ausschnitt)

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" 
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

Die Dokumenttypdefinition in dem obigen Ausschnitt beginnt mit dem Token "<!DOCTYPE" und endet mit dem Token ">". Sie paßt nicht mehr auf eine Zeile, deshalb wird nach dem Literal ""-//W3C//DTD XHTML 1.0 Strict//EN"" eine neue Zeile begonnen. Damit es leicht erkennbar ist, daß diese neue Zeile noch Teil der in der vorherigen Zeile begonnenen Dokumenttypdefinition ist, wird diese neue Zeile um zwei Positionen nach rechts eingerückt. Durch die Einrückung der zweiten Zeile wird eine Unterordnung der zweiten Zeile unter den mit der ersten Zeile begonnenen Teil angedeutet. So ist es mit einem Blick erkennbar, daß der mit der ersten Zeile begonnene Teil in der zweite Zeile noch fortgesetzt wird.

Hallo.html (Ausschnitt)

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="de" lang="de">

  <head> 
    <title>Beispielseite</title> 
    </head>

  <body> 
    <p>Hallo!</p> 
    </body>

  </html>

Der letzte Ausschnitt zeigt ein sogenanntes Element vom Typ "html", das mit der ersten Zeile des Ausschnitts beginnt und sich bis zum Ende des Ausschnitts erstreckt. Ab der zweiten Zeilen sind nun alle Zeilen zunächst um zwei Positionen nach rechts eingerückt, weil sie zu dem mit der ersten Zeile begonnenen Element gehören. (Der Begriff „Element“ wird in anderen Lektionen ausführlicher erklärt, in dieser Lektion dienen die Elemente nur als Beispiele zum Veranschaulichen der Einrückung. Der Leser muß also noch nicht in der Lage sein, ein Element selber erkennen zu können.)

Innerhalb des Elements vom Typ "html" ist ein Element vom Typ "head" enthalten, das sich selber über drei Zeilen von der Markierung "<head>" bis zur Markierung "</head>" erstreckt. Die beiden Fortsetzungszeilen des Elements vom Typ "head" sind selber in bezug auf die erste Zeile "<head>" noch einmal um zwei Positionen nach rechts eingerückt, also insgesamt um vier Positionen. Das gilt entsprechend auch für das folgende Element vom Typ "body".

Schließlich gibt es innerhalb des Elements vom Typ "head" noch ein Element vom Typ "title". Dieses paßt jedoch insgesamt auf eine Zeile und daher ist hier keine weitere Einrückung nötig.