Enregistrer les résultats de la validation de l'accessibilité – Enregistrer sous forme de chaîne, JSON et XML

Aspose.HTML for .NET fournit l’espace de noms Aspose.Html.Accessibility, qui est destiné à toutes les manipulations et vérifications liées à l’accessibilité du Web. Dans cet article, nous allons explorer le processus d’enregistrement des résultats de validation à l’aide de la bibliothèque Aspose.HTML .NET, en nous concentrant plus particulièrement sur le paramètre ValidationResultSaveFormat.

Vous pouvez apprendre à utiliser la classe AccessibilityValidator pour vérifier l’accessibilité du web dans l’article Accessibility Validator.

Sauvegarde des résultats de la validation

La validation de l’accessibilité du web est essentielle pour garantir que le contenu web respecte les règles et les normes WCAG. Une fois le processus de validation terminé, vous devez enregistrer les résultats pour une analyse, une documentation et un rapport ultérieurs. Notre bibliothèque vous permet d’enregistrer les résultats de la validation dans un objet System.IO.TextWriter, où un paramètre de type ValidationResultSaveFormat spécifie le format dans lequel le texte sera enregistré.

ValidationResultSaveFormat

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

• Texte
• JSON
• XML

Enregistrement des 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 and export all errors and warnings as a string

string htmlPath = Path.Combine(DataDir, "input.html");

using (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"
    Console.WriteLine(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

Enregistrement des résultats de la validation au format XML

Pour ceux qui préfèrent un format plus structuré et lisible par les machines, 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(). Cette méthode prend un objet System.IO.TextWriter et le ValidationResultSaveFormat souhaité (dans ce cas, XML).

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

string htmlPath = Path.Combine(DataDir, "input.html");

using (HTMLDocument document = new HTMLDocument(htmlPath))
{
    AccessibilityValidator validator = new WebAccessibility().CreateValidator();
    ValidationResult validationresult = validator.Validate(document);
    
    using (StringWriter sw = new StringWriter())
    {
        validationresult.SaveTo(sw, ValidationResultSaveFormat.XML);
        string xml = sw.ToString();

        Console.WriteLine(xml);

        try
        {
            XmlDocument doc = new XmlDocument();
            doc.LoadXml(xml);
        }
        catch (Exception)
        {
            Console.WriteLine("Wrong xml format");
        }
    }
}

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>

L’enregistrement des résultats de validation fait partie intégrante du contrôle de l’accessibilité du web et facilite l’analyse, la documentation et la création de rapports. Le paramètre ValidationResultSaveFormat offre de la flexibilité en vous permettant de choisir entre les formats Texte, JSON et XML en fonction de vos besoins spécifiques.

Voir aussi

• L’article Accessibilité aux lecteurs d’écran explique comment concevoir un site web pour l’accessibilité aux lecteurs d’écran conformément aux directives WCAG à l’aide de l’API Aspose.HTML for .NET.
• Consultez l’article Vérifier le contraste des couleurs en C# si vous souhaitez apprendre à ajuster correctement le contraste de votre contenu web conformément aux normes WCAG, l’autorité mondiale en matière d’accessibilité du web. Vous découvrirez comment tester l’accessibilité du contraste des couleurs à l’aide de C# et rendre votre contenu web facile à lire pour tous les utilisateurs.
• Dans l’article Accessibility Validator, vous découvrirez la classe AccessibilityValidator qui peut être utilisée pour tester les règles d’accessibilité du web telles que les principes, les lignes directrices et les critères.
• Dans l’article Règles d’accessibilité du web, vous apprendrez à utiliser la classe AccessibilityRules, qui est un référentiel d’exigences, de critères de réussite et de techniques WCAG 2, pour les contrôles d’accessibilité du web.
• L’article Erreurs et avertissements traite des classes et des interfaces qui permettent de collecter des informations sur les erreurs et les avertissements lors des tests d’accessibilité des sites web. Il se concentre sur les critères d’échec et les méthodes qui signalent les erreurs, et fournit un exemple en C# pour récupérer les erreurs d’accessibilité du web après avoir testé un document HTML.
  

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.