Сохранить результаты – Проверка доступности веб-сайта на C#
Aspose.HTML для .NET предоставляет пространство имен
Aspose.Html.Accessibility, которое предназначено для всех манипуляций и проверок, связанных с веб-доступностью. В этой статье мы рассмотрим процесс сохранения результатов проверки с использованием библиотеки Aspose.HTML .NET, уделяя особое внимание параметру ValidationResultSaveFormat
.
Как использовать класс AccessibilityValidator для проверки веб-доступности вы можете узнать из статьи Accessibility Validator – Проверка доступности веб-сайта на C#.
Сохранение результатов проверки
Проверка доступности веб-сайтов имеет решающее значение для обеспечения соответствия веб-контента правилам и стандартам WCAG. После завершения процесса проверки вам необходимо сохранить результаты для дальнейшего анализа, документирования и отчетности. Наша библиотека позволяет сохранять результаты проверки в объект System.IO.TextWriter, где параметр типа ValidationResultSaveFormat указывает, в каком формате будет сохранен текст.
ValidationResultSaveFormat
Для сохранения результатов проверки веб-доступности доступны три основных формата:
- Тext
- JSON
- XML
Сохранение результатов проверки в строку
При сохранении результатов проверки в строку используется метод SaveToString()
:
1string htmlFile = "input.html";
2using (var document = new Aspose.Html.HTMLDocument(filePath))
3{
4 var result = RulesValidate(document, ValidationBuilder.All);
5 var str = result.SaveToString();
6 Console.WriteLine(str);
7}
Вывод представляется в простом текстовом формате, четко указывая результат проверки и предоставляя подробную информацию об ошибках с комментариями:
1validationResult:False;
2%%
3technique: H35;
4criterion: 1.1.1;
5type: Error;
6description: Check that the applet element contains an alt attribute with a text alternative for the applet. ;
7source: <applet code="tictactoe.class" width="250" height="250">tic-tac-toe game</applet>;
8%%
9technique: H37;
10criterion: 1.1.1;
11type: Error;
12description: Img element missing an alt attribute. The value of this attribute is referred to as "alt text".;
13source: <img src="image1.jpeg">;
14%%
15
16...
В тексте указан результат проверки validationResult, а также список ошибок и комментариев:
- technique – код проверенной методики
- criterion – критерии, которым соответствует методика
- type – тип результата
- description – описание ошибки
- source – тег, содержащий ошибку
Сохранение результатов проверки в формате XML
Для тех, кто предпочитает более структурированный и машиночитаемый формат, хранение результатов проверки в XML является подходящим выбором. Давайте посмотрим, как сохранить результаты в формате XML с помощью метода SaveTo()
. Этот метод принимает объект System.IO.TextWriter
и желаемый
ValidationResultSaveFormat, в данном случае XML.
1 string htmlFile = "input.html";
2 using (var document = new Aspose.Html.HTMLDocument(htmlFile))
3 {
4 var result = RulesValidate(document, ValidationBuilder.All);
5 using (var sw = new StringWriter())
6 {
7 result.SaveTo(sw, ValidationResultSaveFormat.XML);
8 var xml = sw.ToString();
9
10 Console.WriteLine(xml);
11
12 try
13 {
14 XmlDocument doc = new XmlDocument();
15 doc.LoadXml(xml);
16 }
17 catch (Exception)
18 {
19 Console.WriteLine("Wrong xml format");
20 }
21 }
22 }
Полученное XML-представление представляет собой хорошо организованный формат для удобного анализа и дальнейшей обработки:
1<validationResult>
2<isValid>false</isValid>
3<details>
4 <techniqueResult>
5 <technique>H35</technique>
6 <criterion>1.1.1</criterion>
7 <type>Error</type>
8 <description>Check that the applet element contains an alt attribute with a text alternative for the applet. </description>
9 <source><![CDATA[<applet code="tictactoe.class" width="250" height="250">tic-tac-toe game</applet>]]>
10 </source>
11 </techniqueResult>
12 <techniqueResult>
13 <technique>H37</technique>
14 <criterion>1.1.1</criterion>
15 <type>Error</type>
16 <description>Img element missing an alt attribute. The value of this attribute is referred to as "alt text".</description>
17 <source><![CDATA[<img src="image1.jpeg">]]>
18 </source>
19 </techniqueResult>
20
21 ...
22
23 </details>
24</validationResult>
Сохранение результатов является неотъемлемым этапом проверки доступности веб-сайтов и облегчает последующий анализ, документирование и составление отчетов. Параметр ValidationResultSaveFormat
обеспечивает гибкость, позволяя вам выбирать между форматами Text, JSON и XML в зависимости от ваших конкретных потребностей.