Das Konzept des WebDoc Quick Guide 

Wozu noch eine Dokumentation zu HTML, CSS & Co. ?

Der HTML 4.0 Syntax Quick Guide - so der ursprüngliche Name - ist aus dem Wunsch entstanden, eine Dokumentation über HTML zu erstellen, die sich zum schnellen Nachschlagen der Syntax eignet. Bei den meisten der zu Beginn dieses Projekts verfügbaren Dokumentationen zu diesen Themen gestaltete sich die Suche nach der richtigen Syntax ziemlich zeitaufwendig, da man bei den meist sehr textlastigen Beschreibungen erst mal die richtige Stelle finden mußte, um die gewünschte Information aus dem Text zu extrahieren. Daneben fehlten häufig Angaben über die HTML - Version oder es fehlten Angaben über die Attribute usw. usf.. Kurzum für den halbwegs Fortgeschrittenen gab es nicht das handliche Dokument zum schnellen Nachschlagen. Daran hat sich nach meiner Kenntnis bis heute nicht viel geändert.

Durch die intensive Beschäftigung mit den Spezifikationen des W3C wurde schnell klar, dass fast alle der verfügbaren Dokumententationen wesentliche Informationen nicht enthalten. Das Paradebeispiel hierfür ist das Inhaltsmodell von HTML Elementen (mehr dazu unter "HTML Grundlagen").
Eigentlich wäre es naheliegend gewesen, die Spezifikationen als Arbeitsgrundlage zu verwenden - was hin und wieder sowieso zu empfehlen ist - jedoch weisen diese auch einige Nachteile auf. Zum einen sind einige der Inhalte nicht leicht zu lesen, was häufig an der in SGML verwendeten Notation liegt. Zum anderen sind immer wieder Sprünge zu anderen Stellen des Dokuments notwendig, wobei trotz der vorbildlichen Verwendung von Querverweisen der Überblick leicht verloren geht. Als Dokument, das sich zum schnellen Nachschlagen eignet, würde ich es daher nicht bezeichnen. Das war sicher auch nicht vorrangiges Ziel.

Das Konzept des HTML und des CSS Syntax Quick Guide

Eine Dokumentation, wie ich sie mir vorstelle, sollte keine wichtigen Informationen unterschlagen, kurz aber doch möglichst exakt den Sachverhalt widergeben und dabei einen schnellen Zugriff auf alle relevante Information in übersichtlicher Weise liefern.

Ein wichtiger Grundbaustein zur Realisierung dieses Vorhabens war, die Syntax in Form von Diagrammen darzustellen. Syntaxdiagramme werden häufig bei Programmiersprachen als Darstellungsmitttel der Syntax verwendet. Weder HTML noch die Cascading Style Sheets sind Programmiersprachen, doch auch sie haben eine Syntax, die sich auf die gleiche Art und Weise darstellen läßt. Der Vorteil der Diagramme liegt darin, dass die Syntax visualisiert wird und damit wesentlich schneller erfasst werden kann als über die z.T. kryptisch anmutende SGML Schreibweise. Die kompakte SGML Notation ist im Übrigen auch nicht für Menschen gedacht, sondern soll von Computerprogrammen verarbeitet werden.

An sich sind Verweise in Hypertexten ja eine feine Sache und der geübte Leser hat damit längst keine Schwierigkeiten mehr. Wenn es aber notwendig wird, für das Inhaltsmodell z.B. des Elements DIV an drei verschiedene Stellen des (Original-) Dokuments zu springen, dann kann das schon etwas lästig sein. Oder wenn man sich die auf mehrere Seiten verteilten Beschreibungen von Attributen und den dazugehörigen Werten zusammensuchen muss, kommt schon mal der Wunsch nach einer etwas kompakteren Darstellung auf.

Um häufiges Hin- und Zurückspringen zwischen verschiedenen Seiten zu vermeiden, werden im WebDoc Quick Guide Frames verwendet. Zwar werden dadurch Sprünge durch Neuladen einzelner Frameinhalte ersetzt, aber es ist z.B. im HTML Syntax Quick Guide immer klar erkennbar, welche Information zu welchem Element gehört. Außerdem ist jedes Element stets von der gleichen Stelle aus sofort abrufbar. Im Übrigen sind alle, ein bestimmtes Element betreffende Informationen auch immer zu einer Einheit zusammengefasst. Beispielsweise sind alle Attribute eines Elements ausschließlich als komplette Liste dargestellt.
Die Darstellung der Daten erfolgt so weit möglich einem gleichbleibenden Schema, was die schnelle Informationsaufnahme fördert.

Häufig fehlen in Dokumentationen zu HTML und Style Sheets Angaben zur Version, seien es Versionen der Spezifikationen des W3C oder Versionen von Browsern, die das entsprechende Feature unterstützen. Eine Frage muss hier schon erlaubt sein: Welchen Wert haben solche Informationen? HTML gibt es höchstens als Überbegriff für eine Familie von Dokumenttypen. Tatsächlich aber unterscheiden sich die Spezifikationen des W3C nicht unwesentlich und vor allem die Browser unterliegen ständigen Änderungen und Erweiterungen. Die Angabe einer Version ist daher unerläßlich.
In manchen Dokumentationen wird zwar eine Version genannt, dort aber in der Art: ab Version x. Es wird einfach unterstellt, dass Browser oder W3C Quasistandards abwärtskompatibel sind. Das ist längst nicht immer der Fall! So enthält manche (gut gemeinte) Versionsangabe eine falsche Aussage.
Der WebDoc Quick Guide macht eine klare Trennung zwischen den verschiedenen Versionen. Im Fall von HTML nicht nur zwischen einzelnen Versionen sondern auch zwischen den Varianten strict, transitional und frameset.

Das Konzept des WebDoc Quick Guide bringt mit sich, dass viele der Informationen wiederholt vorkommen. Dennoch sind diese nur einmal abgespeichert. Erreicht wird dies durch den verstärkten Einsatz von JavaScript. Die Seiten der Syntax Guides werden fast ausnahmslos durch Skripts generiert. Dadurch bleibt die gesamte Datenmenge relativ gering.
Auch zur Verbesserung des Lesekomforts wird JavaScript eingesetzt, wie z.B. bei der Einstellbarkeit der Diagrammgrößen oder beim automatischen Bildlauf, der Beschreibungen zu Angaben in den Diagrammen in das Blickfeld scrollt. Damit wird natürlich voraussgesetzt, dass der Leser über einen halbwegs aktuellen, JavaScript fähigen Browser verfügt. Angesichts der behandelten Themen kann hierin jedoch keine unzumutbare Hürde gesehen werden. Es gibt daher überhaupt keinen zwingenden Grund, auf die vorhandenen Möglichkeiten von HTML, CSS und JavaScript zu verzichten.

Orientierung an Standards

Die Entwicklung in der EDV und im Bereich Internet macht keine Pause. Wohin die Entwicklung geht, kann niemand vorhersagen. Für einen Zeitraum von wenigen Jahren kann man jedoch davon ausgehen, dass es weiterhin verschiedene Computersysteme und konkurrierende Browser geben wird. Es ist weniger wahrscheinlich, dass ein einzelner Monopolist Standards im Bereich Dokumenttypen, Style Sheets etc. durchsetzt. Dagegen zeichnet sich derzeit schon eher ab, dass einige Browser sich genauer als bisher an die Empfehlungen des W3C halten. Vor diesem Hintergrund kommt den Empfehlungen des W3C eine wachsende Bedeutung zu. Wer Wert darauf legt, dass seine Webseiten von möglichst vielen Internet Besuchern gelesen werden können, tut gut daran, sich an diesen Empfehlungen zu orientieren. Oft ist es besser, auf ein paar ausgefallene Features zu verzichten. Andererseits sollte man neue Möglichkeiten auch nicht gänzlich außer Acht lassen. Es ist deshalb immer abzuwägen, welche Kompromisse zu welchem Zweck eingegangen werden sollen.

Häufig trifft man auf die Einstellung, es reiche aus, wenn ein Browser X eine zusammengebastelte Seite so ausgibt, wie das erwartet wird. Andere Browser machen dann einfach etwas falsch, wofür schließlich ein Seitenentwickler nicht verantwortlich gemacht werden kann! Dass der Kode einige haarsträubende Fehler enthält, berührt manch solchen Bastler - dazu sind auch etliche sog. professionelle WebDesigner zu zählen - nicht weiter. Standards und Validatoren sind nur etwas für Akademiker, die sowieso von der Praxis keine Ahnung haben!
Mit dieser Einstellung wird man in Zukunft nicht mehr weit kommen! Tatsächlich werden mehr und mehr Style Sheets und JavaScript Funktionen des Document Object Models (DOM) verwendet. Beides kann aber nur zuverlässig funktionieren, wenn der zugrunde liegende HTML Kode korrekt ist. Da werden selbst Browser, die sonst einen fehlerhaften HTML Kode tolerieren, ihre Schwierigkeiten haben.
Der WebDoc Quick Guide beschränkt sich u.a. aus den genannten Gründen ausschließlich auf die Darstellung der durch das W3C vorgegebenen Syntax. Nur die Empfehlungen des W3C bieten die derzeit größtmögliche Zukunftssicherheit und unterliegen nicht den schwankenden Launen eines einzelnen Softwareproduzenten.

Übrigens: wer beabsichtigt, sich mit XML zu beschäftigen, wird eine neue, ganz ungewohnte Erfahrung machen: Der Browser gibt plötzlich Fehlermeldungen aus und verweigert die Anzeige eines Dokuments vollständig! Jeder, der die Grundregeln von HTML gründlich beherrscht, wird einige dieser Fehlermeldungen vermeiden können und sich insgesamt mit XML leichter tun!