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

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

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

Класс ValidationResult

Пространство имен Aspose.Html.Accessibility.Results содержит классы, описывающие результаты проверки правил. Класс ValidationResult – это основной класс, содержащий результаты для всех критериев. Объект ValidationResult включает описание результатов проверки документа и имеет свойства:

Property	Description
Success	Returns a boolean that says whether the validation succeeded.
Details	Returns IList< RuleValidationResult> containing objects of RuleValidationResult with information about validation results.
SaveToString()	Save validation results to string
SaveTo(TextWriter writer)	Saves the validation results in a System.IO.TextWriter object in text format.
SaveTo(TextWriter writer, ValidationResultSaveFormat format)	Saves the validation results to the System.IO.TextWriter object, where the ValidationResultSaveFormat type parameter specifies in what format the text will be saved.

Вот фрагмент кода C# для проверки веб-доступности. Он устанавливает валидатор с определенными настройками, проверяет HTML-документ и выводит результаты проверки на консоль:

// 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);

// Prepare a path to a source HTML file
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);

    // Checking for success
    if (!validationResult.Success)
    {
        // Get a list of RuleValidationResult Details
        foreach (var detail in validationResult.Details)
        {
            Console.WriteLine("{0}:{1} = {2}", detail.Rule.Code, detail.Rule.Description, detail.Success);
        }
    }
}

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

Класс RuleValidationResult

Класс RuleValidationResult – результат проверки правила, содержит список результатов методов ITechniqueResult, которые являются способами удовлетворения критериев успеха.

Property	Description
Success	Returns a boolean that says whether the validation succeeded.
Rule	Returns the checked rule. The rule has a type that implements the IRule interface.
Results	Returns a collection of all results, both successful and not. Returns type is IList< ITechniqueResult>.
Errors	Returns a collection of results with Errors. Returns type is IList< ITechniqueResult>.
Warnings	Returns a collection of results with Warnings. Returns type is IList< ITechniqueResult>.

Следующий код выполняет итерацию по списку объектов RuleValidationResult в свойстве Details объекта validationResult. Каждый RuleValidationResult представляет результат проверки определенного правила доступности во время процесса проверки:

    // Get a list of RuleValidationResult Details
    foreach (RuleValidationResult result in validationResult.Details)
    {
        Output.WriteLine("{0}:{1} = {2}", result.Rule.Code, result.Rule.Description, result.Success);
    }

Предположим, Details содержит результаты для двух правил - H37 и H67. Вывод будет следующим:

H37:Check alt attributes for images = True
H67:Check that all forms have labels = False

ITechniqueResult

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

Property	Description
Success	Returns a boolean that says whether the validation succeeded.
Rule	Returns the checked technique with type of IRule.
Error	Returns the object with error. Returns type is IError.

Ниже приведен пример C# вывода результатов, которые не прошли проверку критериев успеха. Выводим на консоль описание кода критериев, а также все подробности выполнения методов этих критериев как успешно, так и с ошибками:

1. Каждый RuleValidationResult представляет собой конкретный критерий доступности, оцениваемый во время проверки. Код перебирает объекты RuleValidationResult, содержащиеся в validationResult.Details.
2. Проверьте, не был ли критерий неудачным – !criterionResult.Success. Если критерий не выполнен, код сообщает информацию о неудовлетворительном критерии.
3. Используйте Console.WriteLine, чтобы распечатать код и описание критерия сбоя.
4. Затем выполните итерацию по объектам ITechniqueResult. Эти объекты ITechniqueResult представляют результаты отдельных правил для критерия, сообщившего об ошибках.
5. Для каждого результата правила создайте объект StringBuilder для форматирования информации о методе, включая код метода, успех метода и описание метода.
6. Распечатайте информацию о результате каждого правила, включая код метода, статус успеха и описание.

// 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);

    // Take a list of rules results
    foreach (var ruleResult in validationResult.Details)
    {
        // List only unsuccessful rule
        if (!ruleResult.Success)
        {
            // Print the code and description of the rule
            Console.WriteLine("{0}:{1}", ruleResult.Rule.Code, ruleResult.Rule.Description);

            // Print the results of all methods
            foreach (ITechniqueResult ruleDetail in ruleResult.Results)
            {
                // Print the code and description of the criterions
                StringBuilder str = new StringBuilder(string.Format("\n{0}: {1} - {2}",
                    ruleDetail.Rule.Code, ruleDetail.Success,
                    ruleDetail.Rule.Description));
                Console.WriteLine(str.ToString());
            }
        }
    }
}

Использование Aspose.HTML for .NET позволяет систематически просматривать результаты проверок веб-доступности, сообщать о проверенных критериях и подробно описывать конкретные проблемы, возникшие в процессе проверки. Это полезно для понимания природы проблем с доступностью вашего веб-контента и принятия соответствующих мер для их решения.