Die Erweiterung erlaubt die Einbindung eines Konformitätstests in eine Webseite. Die Tests werden mit dem HTML-Validator des W3C (World Wide Web Consortium) ausgeführt und die Ergebnisse aufbereitet dem Ausgabe-Template zur Verfügung gestellt.

Installation der Erweiterung

Installation über die Erweiterungsverwaltung

In der Erweiterungsverwaltung im installierten Contao geht die Installation der Erweiterung mit nur wenigen Klicks. Die Datenbank wird bei dieser Installation automatisch erweitert. Die Erweiterung html_validator hat keine Abhängigkeiten von anderen Contao-Erweiterungen.

Manuelle Installation

Für eine manuelle Installation lädt man aus der Contao Erweiterungsliste die ZIP-Datei und überträgt die ausgepackten Dateien so, dass im Pfad system/modules/html_validator die Dateien dieser Erweiterung zu finden sind. Die Struktur ist in dem ZIP leicht erkennbar.

Update der Datenbank

Wenn alle Dateien manuell hochgeladen sind, muss ein Datenbankupdate erfolgen. Es genügt, wenn man in der Erweiterungsverwaltung den Link „Datenbank aktualisieren“ anklickt. Steht die Erweiterungsverwaltung nicht zur Verfügung, kann alternativ das Installtool aufgerufen werden um die Datenbank zu aktualisieren.

Einbau in die Webseite

Aufbau der Seitenstruktur

Es wird eine Seite für die Eingabe und eine zweite Seite für die Ergebnisanzeige angelegt.

Eingabeformular erstellen

Im Formulargenerator erstellen wir ein einfaches Eingabeformular. Das Formular leitet die Eingaben per POST-Variablen weiter an die Ergebnisseite.

Es sollten folgende Felder angelegt werden:

• ein verstecktes Feld mit dem Feldnamen referer, damit wir auf der Ergebnisseite den Referer von der Eingabeseite zur Verfügung haben und nicht nur immer die Eingabeseite selbst.
• Ein Textfeld (Pflichtfeld) mit dem Feldnamen url, einer Eingabeprüfung auf URL-Format und gleich einer Absendefläche „Start“

___________

Ergebnis-Modul erzeugen

Das Ergebnismodul vom Modultyp „HTML-Validator Ergebnisse“ führt die eigentliche Prüfung durch. Man muss es auf der Weiterleitungsseite des Formulars platzieren.

Anfrageseite einrichten

Auf der Anfrageseite setzt man das erstellte Formular ein. Das Beispiel ist mit Absicht minimalistisch gehalten, der Text und das Layout um diese Anfrage ist natürlich frei gestaltbar.

Ergebnisseite einrichten

Die Ergebnisseite muss in erster Linie das Ergebnismodul enthalten. Schön macht es sich für weitere Abfragen, wenn man zusätzlich das Anfrageformular auch hier verwendet.

Nicht mit fremden Federn schmücken!

Der begleitende Text auf der Ergebnisseite sollte klar zu erkennen geben, dass der Test bei der W3C mit dem HTML-Validator durchgeführt wird. Auch ein Link direkt auf den Validator http://validator.w3.org kann nicht schaden.

HTML-Validator Log

Neueste Tests auf der Startseite

Auf der Startseite findet sich nach dem Einloggen im Backend eine kurze Übersicht über die 5 neuesten Tests und deren Ergebnisse.

komplettes Log im Menü erreichbar

Im Menü im Systembereich gibt es einen Menüpunkt „HTML-Validator Log“ unter dem die komplette Test-Historie eingesehen werden kann.
Um die Privatsphäre der Tester zu schützen, wird keine IP-Adresse zu den Tests gespeichert. Es werden zu der Anzahl der HTML-Fehler und -Warnungen lediglich Daten erfasst und gespeichert, die auch in jeder besseren Statistik enthalten sind.

--do_while 14. Juni 2012