Kommentare auf statischen Websites
Mit Server Side Includes lassen sich auch vorwiegend statisch aufgebaute Internetseiten mit einem Kommentarfilter versehen. Damit bleiben die für die Website Pflege interessanten Dokumentationsblöcke direkt im Quellcode und helfen dem Entwickler auf die Sprünge, wenn er sich nach einiger Zeit wieder einmal mit der Seitenstruktur auseinander setzen muss.
Ein ähnlicher Ansatz wie bei der dynamischen Website ist übrigens auch mit statischen Internetseiten möglich. Das gilt zumindest dann, wenn wenigstens die Verarbeitung von SSI unterstützt wird. Bringt man einen Kommentar in einem SSI-Block unter, so kann die Ausgabe unterdrückt werden, indem eine stets falsche Abfrage herangezogen wird. Auch kann die Ausgabe auf eine bestimmte Umgebung beschränkt werden. Die im folgenden Script-Block angedeuteten Beispiele sollen einen kurzen Einblick in diese Technik geben. Statt des Textes kann innerhalb der If-Else-Blöcke auch beliebiger Quellcode – so eben auch ein normaler HTML Kommentar – stehen.
<!--#if expr="${raus}" -->
Hier kann irgendein Hinweis zur umliegenden Seitenstruktur
stehen, die aber nicht ausgegeben wird, da der Webserver
die obere Bedingung immer als Falsch wertet.
<!--#endif -->
...
<!--#if expr="${SERVER_NAME} = /^localhost/" -->
Diesen Text wird der Webserver nur ausgeben, wenn er Anfragen
unter der URL http://localhost/... gestellt bekommt.
<!--#endif -->
...
Zwar kosten die Abfragen ein wenig Rechenzeit, allerdings erleichtert es die Website Pflege enorm, wenn Informationen zur Struktur der Internetseite direkt in der Stelle zu finden sind, an der sie auch benötigt werden. Erfolgt die Trennung durch die zweite der hier angesprochenen Varianten, so wird der Webserver des Produktivsystems nicht weiter belastet und der schnellen Auslieferung der Internetseiten steht nichts im Wege. Diese Lösung kann auch auf recht günstigen Hosting-Paketen zum Einsatz kommen, die mit dem Apache Server laufen.
Mit der richtigen Aufteilung lassen sich mittels SSI sogar in einem beschränkten Maße dynamische Strukturen nachbilden, die auch größere Projekte mit relativ geringem Aufwand im Hinblick auf die Website Pflege ermöglichen. Lagert man etwa die Navigation und andere zentrale Seitenelemente aus den eigentlichen Seitenquellen aus, so können seitenübergreifende Änderungen zentral gepflegt werden und es müssen nicht immer gleich alle Elemente der Website erneut hochgeladen werden. Das bringt letztlich auch bei der Aktualisierung der Seiteninhalte einen entscheidenden Vorteil: Ist die Website mit starkem Besucheraufkommen gesegnet, so ist die Wahrscheinlichkeit, dass während des Uploads Phasen auftreten, bei denen es auf den einzelnen Seiten Unstimmigkeiten bei den dargestellten Navigationselementen gibt, recht gering.
Neben HTML Kommentaren sollten natürlich auch Dokumentationsblöcke aus clientseitig laufenden Scripten entfernt werden. Hier stehen zahlreiche JavaScript Packer im Internet bereit, die diese Aufgabe erledigen. Da die Scripte in den meisten Fällen nicht dynamisch erzeugt werden müssen und diese nicht allzu häufig durch neue Versionen ersetzt werden müssen, sollten die Dateien vor Veröffentlichung des Codes auf dem Produktivsystem entsprechend zurechtgestutzt werden. Gerade bei größeren Frameworks, welche ausführlich dokumentiert sind, lohnt sich das: Hier werden die Dateien oft auf einen Bruchteil ihrer ursprünglichen Größe zusammengeschrumft.
Auch lohnt es sich Stylesheets zu komprimieren, da auch hier die Ünertragung von Dateien mit den für den Seitenbesucher unnötigen Informationen nur zusätzlichen Traffic verursachen. Unser Stylesheet Packer filtert übrigens nicht nur die in einem CSS-File enthaltenen Kommentare heraus, sondern sorgt – etwa durch Entfernen von Dubletten und Whitespaces – für kompaktere Stylesheets.