Сохранить результаты – Проверка доступности веб-сайта на C#

Aspose.HTML for .NET предоставляет пространство имен Aspose.Html.Accessibility, которое предназначено для всех манипуляций и проверок, связанных с веб-доступностью. В этой статье мы рассмотрим процесс сохранения результатов проверки с использованием библиотеки Aspose.HTML .NET, уделяя особое внимание параметру ValidationResultSaveFormat.

Как использовать класс AccessibilityValidator для проверки веб-доступности вы можете узнать из статьи Accessibility Validator – Проверка доступности веб-сайта на C#.

Сохранение результатов проверки

Проверка доступности веб-сайтов имеет решающее значение для обеспечения соответствия веб-контента правилам и стандартам WCAG. После завершения процесса проверки вам необходимо сохранить результаты для дальнейшего анализа, документирования и отчетности. Наша библиотека позволяет сохранять результаты проверки в объект System.IO.TextWriter, где параметр типа ValidationResultSaveFormat указывает, в каком формате будет сохранен текст.

ValidationResultSaveFormat

Для сохранения результатов проверки веб-доступности доступны три основных формата:

• Тext
• JSON
• XML

Сохранение результатов проверки в строку

При сохранении результатов проверки в строку используется метод 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);
}

Вывод представляется в простом текстовом формате, четко указывая результат проверки и предоставляя подробную информацию об ошибках с комментариями:

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

...

В тексте указан результат проверки validationResult, а также список ошибок и комментариев:

• technique – код проверенной методики
• criterion – критерии, которым соответствует методика
• type – тип результата
• description – описание ошибки
• source – тег, содержащий ошибку

Сохранение результатов проверки в формате XML

Для тех, кто предпочитает более структурированный и машиночитаемый формат, хранение результатов проверки в XML является подходящим выбором. Давайте посмотрим, как сохранить результаты в формате XML с помощью метода SaveTo(). Этот метод принимает объект System.IO.TextWriter и желаемый ValidationResultSaveFormat, в данном случае 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");
        }
    }
}

Полученное XML-представление представляет собой хорошо организованный формат для удобного анализа и дальнейшей обработки:

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

Сохранение результатов является неотъемлемым этапом проверки доступности веб-сайтов и облегчает последующий анализ, документирование и составление отчетов. Параметр ValidationResultSaveFormat обеспечивает гибкость, позволяя вам выбирать между форматами Text, JSON и XML в зависимости от ваших конкретных потребностей.