Speichern der Ergebnisse der Eingabehilfenvalidierung – Speichern in String, JSON und XML

Aspose.HTML for .NET bietet den Aspose.Html.Accessibility Namespace, der für alle Manipulationen und Überprüfungen im Zusammenhang mit der Barrierefreiheit im Web gedacht ist. In diesem Artikel werden wir den Prozess des Speicherns von Validierungsergebnissen mit Hilfe der Aspose.HTML .NET-Bibliothek untersuchen, wobei wir uns speziell auf den Parameter ValidationResultSaveFormat konzentrieren.

Wie Sie die Klasse AccessibilityValidator zur Überprüfung der Barrierefreiheit im Web verwenden können, erfahren Sie im Artikel Accessibility Validator – Website Accessibility Check in C#.

Speichern von Validierungsergebnissen

Die Validierung der Barrierefreiheit im Web ist entscheidend, um sicherzustellen, dass Webinhalte den WCAG-Regeln und -Standards entsprechen. Sobald der Validierungsprozess abgeschlossen ist, müssen Sie die Ergebnisse für die weitere Analyse, Dokumentation und Berichterstattung speichern. Mit unserer Bibliothek können Sie die Validierungsergebnisse in einem System.IO.TextWriter-Objekt speichern, wobei ein Parameter vom Typ ValidationResultSaveFormat angibt, in welchem Format der Text gespeichert wird.

ValidationResultSaveFormat

Es gibt drei Hauptformate für die Speicherung von Ergebnissen der Barrierefreiheitsprüfung:

• Text
• JSON
• XML

Speichern von Validierungsergebnissen als String

Beim Speichern von Validierungsergebnissen in einer Zeichenkette wird die Methode SaveToString() verwendet:

// Validate HTML for accessibility and export all errors and warnings as a string

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

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

    ValidationResult validationresult = validator.Validate(document);

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

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

Die Ausgabe erfolgt in einem einfachen Textformat, das das Ergebnis der Prüfung klar angibt und detaillierte Informationen über Fehler mit Kommentaren liefert:

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

...

Hier wird das Ergebnis der Prüfung validationResult und eine Liste der Fehler und Kommentare angegeben:

• technique – Code der Technik, die getestet wurde
• criterion – Kriterien, denen die Technik entspricht
• type – Ergebnistyp
• description – Fehlerbeschreibung
• source – Tag, der den Fehler enthält

Speichern von Validierungsergebnissen im XML-Format

Für diejenigen, die ein strukturierteres und maschinenlesbares Format bevorzugen, ist die Speicherung von Validierungsergebnissen im XML-Format eine geeignete Wahl. Schauen wir uns an, wie man die Ergebnisse im XML-Format mit der Methode SaveTo() speichert. Diese Methode nimmt ein System.IO.TextWriter-Objekt und das gewünschte ValidationResultSaveFormat (in diesem Fall XML).

// Validate HTML for accessibility and export all errors and warnings as an XML

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

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

        Console.WriteLine(xml);

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

Die daraus resultierende XML-Darstellung ist ein übersichtliches Format zur einfachen Analyse und Weiterverarbeitung:

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

Das Speichern von Validierungsergebnissen ist ein wesentlicher Schritt bei der Überprüfung der Barrierefreiheit im Web und erleichtert die anschließende Analyse, Dokumentation und Berichterstattung. Der Parameter ValidationResultSaveFormat bietet Flexibilität, indem er Ihnen die Wahl zwischen Text-, JSON- und XML-Formaten je nach Ihren spezifischen Anforderungen ermöglicht.

Siehe auch

• Der Artikel Zugänglichkeit für Bildschirmleser erklärt, wie man eine Website für die Zugänglichkeit für Bildschirmleser in Übereinstimmung mit den WCAG-Richtlinien unter Verwendung der Aspose.HTML for .NET API gestaltet.
• Schauen Sie sich den Artikel Farbkontrast in C# prüfen an, wenn Sie erfahren möchten, wie Sie den Kontrast Ihrer Webinhalte richtig an die WCAG-Standards, die weltweite Autorität für Barrierefreiheit im Web, anpassen können. Sie erfahren, wie Sie die Zugänglichkeit von Farbkontrasten mit C# testen und Ihre Webinhalte für alle Benutzer leicht lesbar machen können.
• Im Artikel Accessibility Validator lernen Sie die Klasse AccessibilityValidator kennen, die zum Testen von Zugänglichkeitsregeln wie Prinzipien, Richtlinien und Kriterien verwendet werden kann.
• In dem Artikel Web-Zugänglichkeitsregeln erfahren Sie, wie Sie die Klasse AccessibilityRules, eine Sammlung von WCAG-2-Anforderungen, Erfolgskriterien und Techniken, für Prüfungen der Barrierefreiheit im Web verwenden können.
• Der Artikel Fehler und Warnungen beschreibt die Klassen und Schnittstellen, mit deren Hilfe Informationen über Fehler und Warnungen während des Testens der Barrierefreiheit von Websites gesammelt werden können. Er konzentriert sich auf die Fehlerkriterien und Methoden, die Fehler melden, und bietet ein C#-Beispiel zum Abrufen von Fehlern bei der Barrierefreiheit nach dem Testen eines HTML-Dokuments.
  

Aspose.HTML bietet einen kostenlosen Online- Web-Zugänglichkeits-Checker. Dieses Tool scannt Webseiten, prüft sie auf WCAG-Konformität, identifiziert Probleme und schlägt Verbesserungen vor. Sie erhalten sofortige Einblicke in die Konformität Ihrer Website und können so den Umfang der notwendigen Korrekturen und die Lücke zwischen dem aktuellen Zustand Ihrer Website oder Ihres HTML-Dokuments und den WCAG-Anforderungen bestimmen.