Validierungsergebnisse – Prüfen der Barrierefreiheit im Web und Speichern der Ergebnisse

Aspose.HTML for Java enthält das Paket com.aspose.html.accessibility, das für die Durchführung und Verwaltung von Prüfungen der Barrierefreiheit im Web vorgesehen ist.

In diesem Artikel wird erklärt, wie man die Validierungsergebnisse anhand der WCAG-Normen überprüft, die getesteten Kriterien angibt und spezifische Probleme, die während der Validierung aufgetreten sind, detailliert beschreibt.

Wenn Sie wissen möchten, wie Sie die Zugänglichkeit einer Website programmatisch überprüfen können, lesen Sie den Artikel Accessibility Validator – Website Accessibility Check in Java und erhalten Sie eine schrittweise Anleitung.

ValidationResult Klasse

Das Paket com.aspose.html.accessibility.results enthält Klassen, die die Ergebnisse der Validierung von Webzugänglichkeitsregeln beschreiben. Die Klasse ValidationResult ist die Hauptklasse, die Ergebnisse für die Überprüfung aller Kriterien des AccessibilityRules-Objekts enthält.

Hier ist ein Java-Codeausschnitt für eine Überprüfung der Barrierefreiheit im Web. Es richtet einen Validator mit spezifischen Einstellungen ein, validiert ein HTML-Dokument und gibt die Ergebnisse in der Konsole aus, so dass Sie die spezifischen Probleme in Ihrem HTML-Dokument identifizieren und beheben können:

// Validate HTML against WCAG rules using Java

// Initialize a webAccessibility container
WebAccessibility webAccessibility = new WebAccessibility();

// Create an accessibility validator with static instance for all rules
// from repository that match the builder settings
AccessibilityValidator validator = webAccessibility.createValidator(ValidationBuilder.getAll());

// Prepare a path to a source HTML file
String documentPath = "input.html";

// Initialize an object of the HTMLDocument class
final HTMLDocument document = new HTMLDocument(documentPath);
ValidationResult validationResult = validator.validate(document);

// Checking for success
if (!validationResult.getSuccess()) {
    // Get a list of RuleValidationResult Details
    for (RuleValidationResult detail : validationResult.getDetails()) {
        System.out.println(String.format("%s: %s = %s",
                detail.getRule().getCode(),
                detail.getRule().getDescription(),
                detail.getSuccess()));
    }
}

RuleValidationResult-Klasse

Die Klasse RuleValidationResult stellt das Validierungsergebnis einer bestimmten Zugänglichkeitsregel dar. Sie liefert detaillierte Informationen darüber, wie die Regel bewertet wurde, einschließlich einer Sammlung von ITechniqueResult-Elementen, die jeweils die zur Erfüllung der Erfolgskriterien verwendete Methode darstellen.

Die Klasse zeigt mehrere Schlüsseleigenschaften (Methoden):

• getRule() identifiziert die zu prüfende Regel;
• getSuccess() gibt an, ob die Regel bestanden hat oder nicht;
• getResults() enthält den vollständigen Satz der Methodenergebnisse;
• getErrors() und getWarnings() bieten Sammlungen von Problemen oder potenziellen Problemen, die während der Validierung aufgetreten sind, was diese Klasse für die Analyse von regelspezifischen Zugänglichkeitsergebnissen unerlässlich macht.

Der folgende Code durchläuft die Liste der RuleValidationResult-Objekte in der Eigenschaft Details eines ValidationResult-Objekts. Jedes RuleValidationResult stellt das Ergebnis einer bestimmten Zugänglichkeitsregelprüfung während des Validierungsprozesses dar:

    // Get a list of RuleValidationResult Details
    for (RuleValidationResult result : validationResult.getDetails())
    {
        System.out.println(String.format("%s: %s = %s",
            result.getRule().getCode(), result.getRule().getDescription(), result.getSuccess()));
    }

Angenommen, die Details enthalten Ergebnisse für zwei Regeln – H37 und H67. Die Ausgabe wird sein:

H37:Check alt attributes for images = True
H67:Check that all forms have labels = False

ITechniqueResult

ITechniqueResult ist eine öffentliche Schnittstelle, die Informationen über das Ergebnis der Überprüfung einer bestimmten Zugänglichkeitstechnik enthält, die verwendet wurde, um das Erfolgskriterium einer Regel zu erfüllen. Sie enthält eine Methode getRule(), um die zugehörige Regel zu identifizieren, getSuccess(), um anzuzeigen, ob die Technik bestanden hat, und getError(), das ein IError-Objekt zurückgibt, das Einzelheiten über alle während der Prüfung aufgetretenen Probleme enthält. Diese Schnittstelle hilft dabei, die Regelprüfung für eine detailliertere Analyse in einzelne Verfahrensergebnisse aufzuschlüsseln.

Im Folgenden finden Sie ein Beispiel für die Ausgabe von Ergebnissen, die den Test der Erfolgskriterien nicht bestanden haben. Wir drucken auf der Konsole Code Beschreibung der Kriterien, sowie alle Details der Ausführung der Methoden dieser Kriterien sowohl erfolgreich und mit Fehlern:

// Validate HTML accessibility using Java and get detailed failed rule results

// Initialize a webAccessibility container
WebAccessibility webAccessibility = new WebAccessibility();

// Create an accessibility validator with static instance for all rules
// from repository that match the builder settings
AccessibilityValidator validator = webAccessibility.createValidator(ValidationBuilder.getAll());

String documentPath = "input.html";

// Initialize an object of the HTMLDocument class
final HTMLDocument document = new HTMLDocument(documentPath);
ValidationResult validationResult = validator.validate(document);

// Take a list of rules results
for (RuleValidationResult ruleResult : validationResult.getDetails()) {
    // List only unsuccessful rule
    if (!ruleResult.getSuccess()) {
        // Print the code and description of the rule
        System.out.println(String.format("%s: %s",
                ruleResult.getRule().getCode(),
                ruleResult.getRule().getDescription()
        ));

        // Print the results of all methods
        for (ITechniqueResult ruleDetail : ruleResult.getResults()) {
            // Print the code and description of the criterions
            StringBuilder str = new StringBuilder(String.format("\n{0}: {1} - {2}",
                    ruleDetail.getRule().getCode(),
                    ruleDetail.getSuccess(),
                    ruleDetail.getRule().getDescription()
            ));
            System.out.println(str);
        }
    }
}

Validierungsergebnisse speichern

Sobald der Validierungsprozess abgeschlossen ist, können Sie die Ergebnisse zur weiteren Analyse, Dokumentation und Berichterstattung speichern. Die Aspose.HTML for Java-Bibliothek ermöglicht es Ihnen, die Validierungsergebnisse in einem TextWriter-Objekt zu speichern, wobei ein Parameter vom Typ ValidationResultSaveFormat angibt, in welchem Format der Text gespeichert werden soll.

Es gibt drei Hauptformate für die Speicherung von Ergebnissen der Barrierefreiheitsprüfung:

• Text
• JSON
• XML

Validierungsergebnisse in einer Zeichenkette speichern

Beim Speichern von Validierungsergebnissen in einer Zeichenkette wird die Methode saveToString() verwendet:

// Validate HTML for accessibility in Java and export all errors and warnings as a string

String htmlPath = "input.html";

final HTMLDocument document = new HTMLDocument(htmlPath);
AccessibilityValidator validator = new WebAccessibility().createValidator();
ValidationResult validationresult = validator.validate(document);

// get rules errors in string format
String content = validationresult.saveToString();

// SaveToString - return only errors and warnings
// if everything is ok, it will return "validationResult:true"
System.out.println(content);

Die Ausgabe erfolgt in einem einfachen Textformat, das das Ergebnis der Prüfung klar angibt und detaillierte Informationen über Fehler mit Kommentaren liefert:

validationResult:False;
%%
technique: H35;
criterion: 1.1.1;
type: Error;
description: Check that the applet element contains an alt attribute with a text alternative for the applet. ;
source: <applet code="tictactoe.class" width="250" height="250">tic-tac-toe game</applet>;
%%
technique: H37;
criterion: 1.1.1;
type: Error;
description: Img element missing an alt attribute. The value of this attribute is referred to as "alt text".;
source: <img src="image1.jpeg">;
%%

...

Hier wird das Ergebnis der Prüfung validationResult und eine Liste der Fehler und Kommentare angegeben:

• technique – Code der Technik, die getestet wurde
• criterion – Kriterien, denen die Technik entspricht
• type – Ergebnistyp
• description – Fehlerbeschreibung
• source – Tag, der den Fehler enthält

Validierungsergebnisse im XML-Format speichern

Für diejenigen, die ein strukturierteres und maschinenlesbares Format bevorzugen, ist die Speicherung der Validierungsergebnisse im XML-Format eine geeignete Wahl. Schauen wir uns an, wie man die Ergebnisse im XML-Format mit der Methode saveTo(writer, format) speichert. Diese Methode nimmt ein TextWriter-Objekt und das gewünschte ValidationResultSaveFormat (in diesem Fall XML) an.

// Validate HTML for accessibility in Java and export all errors and warnings as an XML

String htmlPath = "input.html";

final HTMLDocument document = new HTMLDocument(htmlPath);
AccessibilityValidator validator = new WebAccessibility().createValidator();
ValidationResult validationresult = validator.validate(document);

final java.io.StringWriter sw = new java.io.StringWriter();
validationresult.saveTo(sw, ValidationResultSaveFormat.XML);

String xml = sw.toString();
System.out.println(xml);

DocumentBuilderFactory documentBuildFactory = DocumentBuilderFactory.newInstance();
DocumentBuilder documentBuilder = documentBuildFactory.newDocumentBuilder();
documentBuilder.parse(new java.io.ByteArrayInputStream(xml.getBytes()));

Die daraus resultierende XML-Darstellung ist ein übersichtliches Format zur einfachen Analyse und Weiterverarbeitung:

<validationResult>
<isValid>false</isValid>
<details>
  <techniqueResult>
    <technique>H35</technique>
    <criterion>1.1.1</criterion>
    <type>Error</type>
    <description>Check that the applet element contains an alt attribute with a text alternative for the applet. </description>
    <source><![CDATA[<applet code="tictactoe.class" width="250" height="250">tic-tac-toe game</applet>]]>
    </source>
  </techniqueResult>
  <techniqueResult>
    <technique>H37</technique>
    <criterion>1.1.1</criterion>
    <type>Error</type>
    <description>Img element missing an alt attribute. The value of this attribute is referred to as "alt text".</description>
    <source><![CDATA[<img src="image1.jpeg">]]>
    </source>
  </techniqueResult>
  
   ...

 </details>
</validationResult>

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.
• 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-Checker. 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 notwendigen Korrekturen und die Lücke zwischen dem aktuellen Zustand Ihrer Website oder Ihres HTML-Dokuments und den WCAG-Anforderungen bestimmen.