Verwendung der Barrierefreiheitsergebnisse mit Java
Informationen über das Format der Barrierefreiheitsergebnisse
Es gibt nahezu unbegrenzte Möglichkeiten, die Ergebnisse eines Axe DevTools-Scans zu nutzen
Alle durch axe-core gesteuerten Barrierefreiheitsscans können so eingerichtet werden, dass sie ihre Ergebnisse als JSON-Objekt zurückgeben. Dieses Format bedeutet, dass es für Neulinge im Bereich der Web-Barrierefreiheit leicht verständlich ist, die Tiefe der Informationen bietet, die erfahrene Fachexperten benötigen, und die Automatisierung von Berichterstellungs- und individuellen Tests auch außerhalb eines standardmäßigen, auf Behauptungen basierenden Testformats ermöglicht.
Generierung des Ergebnisobjekts
Um das Ergebnisobjekt zu erstellen, siehe Berichte mit Java erstellen
Ergebnisübersicht
Meta
Das Ergebnisobjekt beginnt mit einigen nützlichen Metainformationen. Dazu gehören der Name des Tests, die Webadresse der getesteten Seite, das Datum und die Uhrzeit, zu der der Test durchgeführt wurde, die verwendete axe-core-Regelsatz und mehr.
Ergebnisse
Der Anfang der Ergebnisse wird durch die Überschrift „Ergebnisse“ markiert. Es gibt vier Arten von Ergebnissen, jeweils mit ihrem eigenen Array. Diese Ergebnistypen sind nicht anwendbar, unvollständig, bestanden und Verstoß. Darüber hinaus gibt es einige testspezifische Daten, die sich unmittelbar vor dem Verstöße-Array befinden.
Nicht anwendbar
Nicht anwendbar bedeutet, dass es keine Seiteninhalte gab, die für diesen speziellen Test relevant waren, wie z. B. formularbezogene Tests auf einer Seite ohne Formulare.
Unvollständig
Unvollständigkeiten sind Tests, die durchgeführt wurden, aber deren Ergebnisse eine weitere Überprüfung erfordern, um zu bestimmen, in welche Kategorie die Ergebnisse letztendlich fallen sollten. Ein häufiges unvollständiges Vorkommen sind Farbkontrastprüfungen an Elementen mit variablen Farbhintergründen, bei denen nicht immer klar ist, ob ausreichend Kontrast vorhanden ist. Probleme in dieser Kategorie sollten nicht automatisch als Verstöße behandelt werden, da sie es möglicherweise sind oder auch nicht. Für Benutzer mit mehr Barrierefreiheitskenntnissen kann eine tiefere Untersuchung dieser Ergebnisse helfen, weitere Verstöße zu finden, die nicht automatisch getestet werden können.
Bestanden
Diese Gruppe von Ergebnissen listet die Regeln auf, die überprüft wurden und keine damit verbundenen Barrierefreiheitsverstöße fanden. Zu jeder bestandenen Regel gibt es ein Array von Seitenelementen, die gegen die Regel überprüft wurden und bestanden haben.
Verstöße
Das Verstöße-Array enthält alle in dem Scan gefundenen Barrierefreiheitsverstöße. Dank Deques Keine-Fehlalarme-Richtlinie ist jedes hier gefundene Ergebnis garantiert echt. Jeder Verstoß enthält weitere Informationen darüber, was der Verstoß ist, wo er sich auf der Seite befindet, Vorschläge, wie man ihn beheben kann, und mehr. Weitere Informationen finden Sie im untenstehenden Feldreferenz.
Feldreferenz - Bestanden und Verstöße
- description — Textzeichenfolge, die beschreibt, was die Regel bewirkt
- help — Hilfetext, der den durchgeführten Test beschreibt
- helpUrl — URL, die weitere Informationen zu den Einzelheiten des Verstoßes bietet. Links zu einer Seite auf der Deque University-Website.
- id — Eindeutige Kennung der Regel; siehe die Liste der Regeln.
- impact — Wie ernst der Verstoß ist. Kann einer von minor, moderate, serious oder critical sein, wenn der Test fehlgeschlagen ist, oder null, wenn die Prüfung bestanden wurde
- tags — Array von Tags, die dieser Regel zugewiesen sind. Diese Tags können in der Optionsstruktur verwendet werden, um auszuwählen, welche Regeln ausgeführt werden.
- nodes — Array aller Elemente, die von der Regel getestet wurden
- html — Ausschnitt von HTML des Elements
- impact — Wie ernst der Verstoß ist. Kann einer von minor, moderate, serious oder critical sein, wenn der Test fehlgeschlagen ist, oder null, wenn die Prüfung bestanden wurde
- target — Array von Selektoren, das für jedes Element auf eine Ebene von iframe oder Rahmen korrespondiert. Wenn es ein iframe oder eine Ebene gibt, sollten zwei Einträge im target sein. Wenn es drei iframe-Ebenen gibt, sollten vier Einträge im target sein.
- any — Array von Prüfungen, bei denen mindestens eine bestanden haben muss. Jeder Eintrag im Array enthält:
- id — Eindeutige Kennung für diese Prüfung. Prüfungs-IDs können mit Regel-IDs übereinstimmen
- impact — Wie ernst diese spezielle Prüfung ist. Kann einer von minor, moderate, serious oder critical sein. Jede Prüfung, die Teil einer Regel ist, kann unterschiedliche Auswirkungen haben. Die höchste Auswirkung aller fehlgeschlagenen Prüfungen wird für die Regel gemeldet
- message — Beschreibung, warum diese Prüfung bestanden oder fehlgeschlagen ist
- data — Zusätzliche Informationen, die spezifisch für den Typ der Prüfung optional sind. Beispielsweise würde ein Farbkontrast-Test die Vordergrundfarbe, Hintergrundfarbe, Kontrastverhältnis usw. enthalten.
- relatedNodes — Optionales Array von Informationen über andere Knoten, die mit dieser Prüfung zusammenhängen. Beispielsweise würde ein Duplikat-ID-Prüfungsfehler die anderen Selektoren auflisten, die dieselbe doppelte ID hatten. Jeder Eintrag im Array enthält die folgenden Informationen:
- target — Array von Selektoren für den zugehörigen Knoten
- html — HTML-Quelle des zugehörigen Knotens
- all — Array von Prüfungen, bei denen alle bestanden haben müssen. Jeder Eintrag im Array enthält dieselben Informationen wie das any-Array
- none — Array von Prüfungen, bei denen alle nicht bestanden haben dürfen. Jeder Eintrag im Array enthält dieselben Informationen wie das any-Array
Verwendungszweck der Ergebnisse
Deque macht es einfach, die Ergebnisse Ihrer Scans mit unserem Reporter zu teilen und zu verarbeiten. Er ist konfigurierbar, um HTML-, JUnit-XML- oder CSV-Berichte zu erstellen und gibt, einmal eingerichtet, Berichte automatisch zurück. Siehe den Leitfaden zur Berichterstattung, um zu lernen, wie Sie den Reporter einrichten und verwenden.
Zusätzlich macht es das JSON-Ergebnisobjekt einfach, eigene maßgeschneiderte Tests zu erstellen. Über die standardmäßigen Barrierefreiheitsverletzungs-Assertions hinaus können Sie das Ergebnisobjekt nach Verstößen, deren Schweregrad, deren Auswirkungen, dem zugehörigen Regelsatz oder einem beliebigen Parameter im Ergebnisobjekt aufteilen. Alle im Ergebnisobjekt aufgeführten Daten können daher überprüft werden.
