Résultats de la validation – Comment vérifier l'accessibilité du web et enregistrer les résultats

Aspose.HTML for Java comprend le paquet com.aspose.html.accessibility, destiné à effectuer et à gérer les contrôles d’accessibilité du web.

Cet article explique comment examiner les résultats de la validation par rapport aux normes WCAG, signaler les critères testés et détailler les problèmes spécifiques rencontrés au cours de la validation.

Pour apprendre à vérifier par programmation l’accessibilité d’un site web et obtenir un guide étape par étape, lisez l’article Accessibility Validator – Vérification de l’accessibilité des sites web.

Classe ValidationResult

Le paquet com.aspose.html.accessibility.results contient des classes décrivant les résultats de la validation des règles d’accessibilité du web. La classe ValidationResult est la classe principale qui contient les résultats de la vérification de tous les critères de l’objet AccessibilityRules.

Voici un extrait de code Java pour un contrôle de l’accessibilité du web. Il configure un validateur avec des paramètres spécifiques, valide un document HTML et affiche les résultats dans la console, ce qui vous permet d’identifier et de résoudre les problèmes spécifiques de votre document HTML :

// 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()));
    }
}

Classe RuleValidationResult

La classe RuleValidationResult représente le résultat de la validation d’une règle d’accessibilité particulière. Elle fournit des informations détaillées sur la manière dont la règle a été évaluée, y compris une collection d’éléments ITechniqueResult, chacun représentant la méthode utilisée pour satisfaire aux critères de réussite.

La classe révèle plusieurs propriétés clés (méthodes) :

• getRule() identifie la règle testée ;
• getSuccess() indique si la règle a réussi ou échoué ;
• getResults() contient l’ensemble des résultats de la méthode ;
• getErrors() et getWarnings() fournissent des collections de problèmes ou de problèmes potentiels rencontrés lors de la validation, ce qui rend cette classe essentielle pour l’analyse des résultats d’accessibilité spécifiques aux règles.

Le code suivant parcourt la liste des objets RuleValidationResult dans la propriété Details d’un objet validationResult. Chaque RuleValidationResult représente le résultat de la vérification d’une règle d’accessibilité spécifique au cours du processus de validation :

    // 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()));
    }

Supposons que le fichier Details contienne des résultats pour deux règles – H37 et H67. La sortie sera :

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

ITechniqueResult

L’interface ITechniqueResult est une interface publique qui contient des informations sur le résultat de la vérification d’une technique d’accessibilité particulière utilisée pour satisfaire le critère de réussite d’une règle. Elle comprend une méthode getRule() pour identifier la règle associée, getSuccess() pour indiquer si la technique a réussi, et getError(), qui renvoie un objet IError contenant les détails de tout problème rencontré au cours de la vérification. Cette interface permet de décomposer le contrôle des règles en résultats de techniques individuelles pour une analyse plus détaillée.

Voici un exemple de sortie des résultats qui n’ont pas passé le test des critères de réussite. Nous imprimons sur la console le code de description des critères, ainsi que tous les détails de l’exécution des méthodes de ces critères aussi bien avec succès qu’avec des erreurs :

// 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);
        }
    }
}

Sauvegarder les résultats de la validation

Une fois le processus de validation terminé, vous pouvez enregistrer les résultats en vue d’une analyse, d’une documentation et d’un rapport ultérieurs. La bibliothèque Aspose.HTML for Java vous permet d’enregistrer les résultats de la validation dans un objet TextWriter, où un paramètre de type ValidationResultSaveFormat spécifie le format dans lequel le texte sera enregistré.

Trois formats principaux sont disponibles pour enregistrer les résultats de la validation de l’accessibilité du web :

• Text
• JSON
• XML

Enregistrer les résultats de la validation dans une chaîne de caractères

La méthode saveToString() est utilisée pour enregistrer les résultats de la validation dans une chaîne de caractères :

// 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);

Le résultat est présenté sous forme de texte simple, indiquant clairement le résultat de la vérification et fournissant des informations détaillées sur les erreurs, accompagnées de commentaires :

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">;
%%

...

Le résultat du contrôle est indiqué validationResult et une liste d’erreurs et de commentaires :

• technique – code de la technique testée
• criterion – critères auxquels la technique correspond
• type – type de résultat
• description – description de l’erreur
• source – balise contenant l’erreur

Enregistrer les résultats de la validation au format XML

Pour ceux qui préfèrent un format plus structuré et lisible par une machine, le stockage des résultats de validation au format XML est un choix approprié. Voyons comment sauvegarder les résultats au format XML en utilisant la méthode saveTo(writer, format). Cette méthode prend un objet TextWriter et le ValidationResultSaveFormat désiré (dans ce cas, XML).

// 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()));

La représentation XML qui en résulte est un format bien organisé qui facilite l’analyse et le traitement ultérieur :

<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>

Voir aussi

• Vous trouverez des conseils utiles sur l’évaluation et l’amélioration de la visibilité du texte dans l’article Accessibilité du contraste des couleurs, qui couvre la vérification du contraste basée sur les WCAG à l’aide d’Aspose.HTML for Java.
• L’article Accessibilité des lecteurs d’écran contient des instructions sur la manière de vérifier que le contenu web est compatible avec les lecteurs d’écran. Vous y apprendrez comment vérifier le texte alt et d’autres éléments clés.
• Dans l’article Vérification de l’accessibilité du web – Erreurs et avertissements, vous apprendrez comment collecter par programmation en Java des informations sur les erreurs et les avertissements lors de la vérification de l’accessibilité d’un site web.
  

Aspose.HTML propose gratuitement en ligne Vérificateur d’accessibilité Web. Cet outil analyse les pages web, valide leur conformité aux WCAG, identifie les problèmes et suggère des améliorations. Il vous permet de déterminer l’ampleur des corrections nécessaires et l’écart entre l’état actuel de votre site web ou de votre document HTML et les exigences des WCAG.