Ошибки и предупреждения – Проверка веб-доступности на C#

Aspose.HTML for .NET предоставляет пространство имен Aspose.Html.Accessibility, которое предназначено для всех манипуляций и проверок, связанных с веб-доступностью. В этой статье будут рассмотрены классы и интерфейсы, которые помогают собирать информацию об ошибках и предупреждениях при проверке доступности веб-сайта на соответствие требованиям WCAG. Мы уделим особое внимание критериям сбоев и методам, которые сообщают об ошибках, и рассмотрим пример C# получения ошибок веб-доступности после проверки HTML-документа.

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

Обнаружение ошибок помогает выявить препятствия, которые могут помешать людям с ограниченными возможностями эффективно использовать веб-контент и взаимодействовать с ним. Ошибки и предупреждения указывают, что необходимо предпринять для улучшения доступности Интернета. Они служат для разработчиков и дизайнеров дорожной картой для внесения необходимых изменений.

IError

IError – это общедоступный интерфейс, содержащий информацию об ошибке проверки. Это означает ошибочную проверку, т. е. правило не было пройдено – и его результат не соответствует Accessibility.

Property	Description
ErrorMessage	Returns a string message of the error or warning.
Target	Returns an HTML or CSS element where the error was found. The returned object is of type Target.
ErrorTypeName	Description of the presentation of the error object. It has two options “Error” or “Warning”.
ErrorType	Returns error type numeric value.
Success	Result of this object.

Объект IError имеет такие значения:

* ErrorType = 1 and Success = false – это означает, что ошибка критическая и результат проверки не выполнен.
* ErrorType = 2 and Success = true – это означает, что ошибка не критична, а носит информационный характер, отображает подсказки по возможному улучшению.

Тип ошибки определяется типом оборудования; если техника достаточна, то ErrorType = 1, и это Error; в противном случае ErrorType = 2 – предупреждение.

Target

Target – это общедоступный класс, который содержит элемент HTML или CSS документа, в котором была обнаружена ошибка.

Property	Description
Item	Returns Object of html or css element.
TargetType	Returns the type of the contained object. Object type of TargetTypes.

TargetTypes

Перечисление TargetTypes типов элементов из HTML-документа, содержащего ошибку:

Value	Description
HTMLElement	The element containing the HTMLElement from document.
CSSStyleRule	The element containing the CSSStyleRule from document.
CSSStyleSheet	The element containing the CSSStyleSheet from document.

Давайте посмотрим на код C# для перебора результатов проверки веб-доступности, уделив особое внимание критериям сбоя и деталям методов, сообщающих об ошибках. Пример получения сведений об ошибках и элементов HTML-документа:

1. Используйте класс RuleValidationResult и перебирайте объекты RuleResult, содержащиеся в ValidationResult.Details. Они представляют собой разные критерии доступности.
2. Распечатайте код и описание критерия и укажите, был ли он успешным или нет. Для этого используйте свойства Code и Description интерфейса IRule.
3. Используйте свойство Success, чтобы проверить критерии.
4. Используйте объекты ITechniqueResult – result, содержащийся в ruleResult.Errors. Объекты ITechniqueResult представляют результаты отдельных правил для критерия, сообщившего об ошибках.
5. Распечатайте информацию о методе, включая код метода, статус успеха и описание.
6. Используйте свойство IError, чтобы получить объект ошибки из результата. Результат представляет конкретную проблему доступности, а объект ошибки содержит информацию об этой проблеме.
7. Используйте свойство Target для получения целевого объекта, связанного с ошибкой. Целевой объект обычно представляет собой конкретный элемент HTML, правило CSS или другой контент, который вызвал ошибку доступности.
8. Распечатайте информацию об ошибке. Он включает тип ошибки (error.ErrorTypeName) и сообщение об ошибке (error.ErrorMessage).
9. Используйте свойство TargetType класса Target, чтобы проверить тип целевого объекта. В зависимости от типа целевого объекта конкретная информация извлекается и выводится на консоль.

// Initialize a webAccessibility container
var webAccessibility = new WebAccessibility();

// Create an accessibillity validator with static instance for all rules from repository that match the builder settings
var validator = webAccessibility.CreateValidator(ValidationBuilder.All);

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

// Initialize an object of the HTMLDocument class
using (var document = new HTMLDocument(documentPath))
{
    // Check the document
    ValidationResult validationResult = validator.Validate(document);

    foreach (RuleValidationResult ruleResult in validationResult.Details)
    {
        //  list only unsuccessful rule
        if (!ruleResult.Success)
        {
            // print the code and description of the rule
            Console.WriteLine("{0}:{1} = {2}", ruleResult.Rule.Code, ruleResult.Rule.Description, ruleResult.Success);
            // print the results of methods with errors
            foreach (ITechniqueResult ruleDetail in ruleResult.Errors)
            {
                // print the code and description of the method
                StringBuilder str = new StringBuilder(string.Format("\n{0}: {1} - {2}",
                                                           ruleDetail.Rule.Code, ruleDetail.Success,
                                                           ruleDetail.Rule.Description));
                // get an error object 
                var error = ruleDetail.Error;
                // get a target object 
                var target = error.Target;
                // get error type and message 
                str.AppendFormat("\n\n\t{0} : {1}", error.ErrorTypeName, error.ErrorMessage);
                if (target != null)
                {
                    // Checking the type of the contained object for casting and working with it
                    if (target.TargetType == TargetTypes.CSSStyleRule)
                    {
                        var cssRule = (ICSSStyleRule)target.Item;
                        str.AppendFormat("\n\n\t{0}", cssRule.CSSText);
                    }
                    if (ruleDetail.Error.Target.TargetType == TargetTypes.CSSStyleSheet)
                        str.AppendFormat("\n\n\t{0}", ((ICSSStyleSheet)target.Item).Title);

                    if (ruleDetail.Error.Target.TargetType == TargetTypes.HTMLElement)
                        str.AppendFormat("\n\n\t{0}", ((HTMLElement)target.Item).OuterHTML);
                }
                Console.WriteLine(str.ToString());
            }
        }
    }
}