Accessibility Validator – Überprüfung der Zugänglichkeit von Websites

Validator erstellen

Aspose.HTML for Java stellt das Paket com.aspose.html.accessibility zur Verfügung, das für alle Manipulationen und Prüfungen im Zusammenhang mit der Barrierefreiheit im Web zuständig ist. Die Klasse AccessibilityValidator initialisiert ein Objekt, das zur Validierung des Dokuments anhand der WCAG-Erfolgskriterien verwendet wird. Die Klasse hat keinen internen Konstruktor, daher können Benutzer nicht direkt ein Objekt der Klasse erstellen. Um ein Objekt zu erstellen, müssen Sie den Container WebAccessibility verwenden.

Um einen Validator zu erstellen, initialisieren Sie das Objekt der Klasse WebAccessibility wie folgt:

1    // Initialize webAccessibility container
2    WebAccessibility webAccessibility = new WebAccessibility();

Das webAccessibility-Objekt hat mehrere überladene createValidator() Methoden zur Erstellung einer AccessibilityValidator-Instanz mit unterschiedlichen Anpassungsgraden. Diese Methoden erlauben die Erstellung von Validatoren unter Verwendung aller Standardregeln, einer bestimmten Regel oder einer Liste von Regeln, und können unter Verwendung eines ValidationBuilder Objekts angepasst werden. Dieser flexible Ansatz ermöglicht sowohl einfache als auch stark angepasste Zugänglichkeitsprüfungen.

Die folgenden Java-Beispiele zeigen, wie ein AccessibilityValidator entweder für alle verfügbaren Regeln oder für eine bestimmte Teilmenge auf der Grundlage eines einzelnen Zugänglichkeitsprinzips initialisiert werden kann:

Beispiel 1. Einen Validator erstellen, der alle Regeln prüft

Dieses Beispiel zeigt, wie man einen AccessibilityValidator initialisiert, der alle verfügbaren Zugänglichkeitsregeln enthält, indem man die umfassenden Standardeinstellungen verwendet, die von ValidationBuilder.getAll() bereitgestellt werden:

1// Initialize the webAccessibility container
2WebAccessibility webAccessibility = new WebAccessibility();
3
4// Create an accessibility validator with all rules using the default settings
5AccessibilityValidator validator = webAccessibility.createValidator(ValidationBuilder.getAll());

Beispiel 2. Einen Validator für ein bestimmtes Prinzip erstellen

In diesem Beispiel wird ein bestimmtes Zugänglichkeitsprinzip anhand seines Codes (z. B. “1”) ausgewählt, und ein Validator wird nur für die Regeln dieses Prinzips erstellt:

1// Retrieve a specific principle by its code
2IRule rule = webAccessibility.getRules().getPrinciple("1");
3
4// Create a validator for that principle using the same default settings
5AccessibilityValidator validatorRule = webAccessibility.createValidator(rule, ValidationBuilder.getAll());

ValidationBuilder-Klasse

Die Klasse ValidationBuilder definiert eine Hilfsklasse, die verwendet werden kann, um die Liste der vom Validator zu prüfenden Regeln anzupassen. Der ValidationBuilder definiert Methoden und bietet konkrete Implementierungen der Konfigurationsschritte.

Die Klasse ValidationBuilder bietet drei vordefinierte Sätze von Eigenschaften:

Die Klasse bietet auch Methoden zur Anpassung der Validierung, wie z.B. die Auswahl bestimmter Technologien ( useHTML(), useCSS(), useScript()), die Festlegung von Kriterienstufen (useLowestLevel(), useMiddleLevel(), useHighestLevel(), allLevels()) usw.

Der folgende Java-Code initialisiert zum Beispiel AccessibilityValidator, um Zugänglichkeitsprüfungen auf der Grundlage der Benutzerkonfiguration durchzuführen. Zunächst wird ein WebAccessibility-Container erstellt, der als Hauptzugriffspunkt für die Validierungsfunktionen dient. Dann wird mit ValidationBuilder.getNone() ein Validator ohne vordefinierte Regeln erstellt. Von dort aus werden explizit Prüfungen für HTML- und CSS-Technologien aktiviert und die Validierung auf ein mittleres Konformitätsniveau (normalerweise WCAG Level AA) beschränkt. Diese Konfiguration ermöglicht eine gezielte, standardbasierte Validierung, die nur auf ausgewählte Technologien und eine bestimmte Konformitätsstufe abzielt.

 1// Initialize the WebAccessibility container
 2WebAccessibility webAccessibility = new WebAccessibility();
 3
 4// Create a validator with no predefined filters, enabling HTML and CSS technologies, and selecting the middle conformance levels
 5AccessibilityValidator validatorHTML = webAccessibility.createValidator(
 6    ValidationBuilder.getNone()
 7                     .useHTML()
 8                     .useCSS()
 9                     .useMiddleLevel()
10);

ValidationResult Klasse

Die Klasse ValidationResult ist die zentrale Komponente der Validierung der Barrierefreiheit im Web. Sie kapselt die Ergebnisse von Zugänglichkeitsprüfungen und bietet eine strukturierte Möglichkeit, die Ergebnisse von Validierungsoperationen zu analysieren, zu verwalten und darauf zu reagieren. Um es zu verwenden, instanziieren Sie ein Validator-Objekt und rufen die Methode validate(document) auf, wobei Sie das zu prüfende Dokument übergeben. Die Methode gibt ein ValidationResult Objekt zurück, das die Ergebnisse des Validierungsprozesses enthält.

Die Klasse ValidationResult fasst die Ergebnisse für alle im Objekt AccessibilityRules definierten Kriterien zusammen und dient als Hauptcontainer für die Berichterstattung über die Validierungsergebnisse. Sie enthält zwei Schlüsseleigenschaften:

Zur Unterstützung des Ergebnisexports und der Berichterstellung bietet die Klasse mehrere Methoden: saveTo(TextWriter) und saveTo(TextWriter, ValidationResultSaveFormat) ermöglichen das Speichern der Ergebnisse im angegebenen Ausgabestrom, während saveToString() die Validierungsergebnisse als formatierten String zurückgibt.

Eine ausführlichere Beschreibung finden Sie in dem Artikel Validierungsergebnisse – Webzugänglichkeit in Java prüfen.

Ein HTML-Dokument validieren

Gehen Sie wie folgt vor, um eine Dokumentenvalidierung durchzuführen:

  1. Verwenden Sie den Konstruktor WebAccessibility(), um eine Instanz der Klasse WebAccessibility zu erstellen.
  2. Rufen Sie eine der Methoden createValidator() auf, um ein validator-Objekt zu erstellen.
  3. Laden Sie ein HTML-Dokument mit einem der HTMLDocument() Konstruktoren.
  4. Verwenden Sie die Methode validate(document), um das Dokument anhand der Regeln für die Barrierefreiheit im Internet zu überprüfen.
  5. Das Ergebnis der Validierung ist eine Instanz der Klasse ValidationResult.
  6. Drucken Sie die Validierungsergebnisse auf der Konsole aus und verwenden Sie sie bei Bedarf für weitere Analysen.

Hier ein Beispiel für den Aufruf einer Dokumentenvalidierung. Der folgende Java-Code schreibt in die Konsole, welche der Regeln den Test bestanden haben und welche nicht:

 1// Initialize a webAccessibility container
 2WebAccessibility webAccessibility = new WebAccessibility();
 3
 4// Create an accessibility validator with static instance for all rules
 5// from repository that match the builder settings
 6AccessibilityValidator validator = webAccessibility.createValidator(ValidationBuilder.getAll());
 7
 8// Prepare a path to a source HTML file
 9String documentPath = "input.html";
10
11// Initialize an object of the HTMLDocument class
12final HTMLDocument document = new HTMLDocument(documentPath);
13ValidationResult validationResult = validator.validate(document);
14
15// Checking for success
16if (!validationResult.getSuccess()) {
17    // Get a list of RuleValidationResult Details
18    for (RuleValidationResult detail : validationResult.getDetails()) {
19        System.out.println(String.format("%s: %s = %s",
20                detail.getRule().getCode(),
21                detail.getRule().getDescription(),
22                detail.getSuccess()));
23    }
24}
Example_ValidationResult hosted with ❤ by GitHub

Siehe auch

  • Hilfreiche Tipps zur Bewertung und Verbesserung der Textsichtbarkeit finden Sie im Artikel Zugänglichkeit von Farbkontrasten, der die Kontrastprüfung auf der Grundlage der WCAG mit Aspose.HTML for Java behandelt.
  • Anleitungen zur Überprüfung der Kompatibilität von Webinhalten mit Bildschirmlesegeräten finden Sie in dem Artikel Zugänglichkeit von Bildschirmlesegeräten. Dort erfahren Sie, wie Sie den Alt-Text und andere wichtige Elemente überprüfen können.
  • Wenn Sie wissen möchten, wie Sie Validierungsergebnisse anzeigen und Probleme mit der Barrierefreiheit erkennen können, lesen Sie den Artikel Validierungsergebnisse.
  • In dem Artikel Zugänglichkeitsprüfung von Websites – Fehler und Warnungen erfahren Sie, wie Sie in Java programmgesteuert Fehler- und Warninformationen bei der Prüfung der Zugänglichkeit einer Website sammeln können.

Aspose.HTML bietet einen kostenlosen Online- Web-Zugänglichkeits Prüfung. Dieses Tool scannt Webseiten, prüft sie auf WCAG-Konformität, identifiziert Probleme und schlägt Verbesserungen vor. Sie erhalten sofortige Einblicke in die Konformität Ihrer Website und können so den Umfang der erforderlichen Korrekturen und die Lücke zwischen dem aktuellen Zustand Ihrer Website oder Ihres HTML-Dokuments und den WCAG-Anforderungen bestimmen.

Text “Web-Zugänglichkeits Prüfung”

Subscribe to Aspose Product Updates

Get monthly newsletters & offers directly delivered to your mailbox.