Guardar resultados de validación – verificación de accesibilidad web en C#

Aspose.HTML for .NET proporciona el espacio de nombres Aspose.Html.Accessibility, que está destinado a todas las manipulaciones y comprobaciones relacionadas con la accesibilidad web. En este artículo, exploraremos el proceso de guardar los resultados de la validación utilizando la biblioteca Aspose.HTML .NET, centrándonos específicamente en el parámetro ValidationResultSaveFormat.

Puede aprender a utilizar la clase AccessibilityValidator para verificar la accesibilidad web en el artículo Validador de accesibilidad.

Guardar resultados de validación

La validación de la accesibilidad web es fundamental para garantizar que el contenido web cumpla con las reglas y estándares WCAG. Una vez que se completa el proceso de validación, debe guardar los resultados para realizar análisis, documentación e informes adicionales. Nuestra biblioteca le permite guardar los resultados de la validación en un objeto System.IO.TextWriter, donde un parámetro de tipo ValidationResultSaveFormat especifica en qué formato se guardará el texto.

ValidationResultSaveFormat

Hay tres formatos principales disponibles para guardar los resultados de la validación de accesibilidad web:

• Text
• JSON
• XML

Guardar los resultados de la validación en una cadena

Al guardar los resultados de la validación en una cadena, se utiliza el método SaveToString():

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

using (var document = new HTMLDocument(htmlPath))
{
    var validator = new WebAccessibility().CreateValidator();

    var validationresult = validator.Validate(document);

    // get rules errors in string format 
    var content = validationresult.SaveToString();

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

El resultado se presenta en un formato de texto simple, indicando claramente el resultado de la verificación y proporcionando información detallada sobre los errores con comentarios:

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

...

Donde se indica el resultado de la verificación validationResult y una lista de errores y comentarios:

• technique – código de la técnica que se probó
• criterion – criterio al que corresponde la técnica
• type – tipo de resultado
• description – descripción del error
• source – etiqueta que contiene el error

Guardar los resultados de la validación en formato XML

Para aquellos que prefieren un formato más estructurado y legible por máquina, almacenar los resultados de la validación en XML es una opción adecuada. Veamos cómo guardar los resultados en formato XML usando el método SaveTo(). Este método toma un objeto System.IO.TextWriter y el ValidationResultSaveFormat deseado (en este caso, XML).

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

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

        Console.WriteLine(xml);

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

La representación XML resultante es un formato bien organizado para facilitar el análisis y el procesamiento posterior:

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

Guardar los resultados de la validación es un paso integral en la verificación de la accesibilidad web y facilita el análisis, la documentación y la generación de informes posteriores. El parámetro ValidationResultSaveFormat proporciona flexibilidad al permitirle elegir entre formatos de texto, JSON y XML según sus necesidades específicas.