Benutzerdefinierte Regeln verwenden

Übersicht über benutzerdefinierte Regeln in der axe Expert extension

Wenn Sie möchten, dass das axe Expert Tool Webseiten und Anwendungen anhand von Regeln analysiert, die auf die speziellen Anforderungen Ihres Unternehmens zugeschnitten sind, können Sie dies mit der Funktion „Benutzerdefinierte Regeln“ im Rules Bedienfeld tun. Wenn Sie im Hauptmenü von axe Expert (Dropdown-Menü neben dem Logo der axe Expert Extension oben im linken Bereich) auf den Link „Regeln“ klicken, wird ein Rules Panel angezeigt, das eine Schaltfläche „Benutzerdefinierten Regelsatz hinzufügen“ bietet, um im rechten Bereich ein Formular zum Einreichen eines Satzes benutzerdefinierter Regeln anzuzeigen. Das einfache Formular besteht aus zwei Texteingabefeldern und einer Aktionsschaltfläche, mit denen Sie benutzerdefinierte Regeln einrichten können, die zur Ausführung in der automatisierten Engine ausgewählt werden können, wenn eine geladene Seite im Analysefenster analysiert wird.

Genau wie beim Analysieren einer Seite mit den axe Expertenregelsätzen werden in den Ergebnissen alle gefundenen Verstöße gegen Ihre benutzerdefinierten Regeln zusammen mit den Informationen angezeigt, die Sie im benutzerdefinierten Regelsatz angegeben haben (Ziel, HTML-Quelle, Zusammenfassung der Behebung, Hilfelink „Weitere Informationen“ usw.). Alle anderen mit den Standardregeln verfügbaren Aktionsoptionen gelten auch für Ihre benutzerdefinierten Regelverletzungen (Überprüfen, Hervorheben, Exportieren, Hochladen usw.). Es sind maximal fünf benutzerdefinierte Regelsätze gleichzeitig zulässig.

1. Schaltfläche „Regelsatz hinzufügen“: Im Custom rulesets Abschnitt des linken Bereichs des Rules Panelbereichs wird Ihnen ein Formular zum Senden eines benutzerdefinierten Regelsatzes im rechten Bereich präsentiert. +Add a ruleset
2. Name für benutzerdefinierte Regeln (nur alphanumerisch): Dies ist der Name des Regelsets, der im Abschnitt „Standards“ der Registerkarte „Einstellungen“ angezeigt wird. Dabei ist einerseits auf die Einhaltung der Konventionen (alphanumerisch, keine Leerzeichen) zu achten, andererseits ist darauf zu achten, dass der Name aussagekräftig und als Auswahlmöglichkeit gut erkennbar ist.
3. Geben Sie JSON _ ein: JavaScript Object Notation (JSON) ist der textbasierte Standard, dem der Inhalt entsprechen muss, um mit der HTML 2.0-Browsererweiterung von Firefox zu funktionieren. Weitere Informationen finden Sie im Beispiel unten.
4. Schaltfläche „REGELSATZ SPEICHERN UND VERWENDEN“ : Bewirkt, dass die benutzerdefinierten Regeln zu einer auswählbaren Option im Menü des linken Seitenleistenbereichs des Rules Bedienfelds werden. Weitere Informationen finden Sie unter Regelsatz auswählen.

Beispiel für eine benutzerdefinierte Regel

Der folgende Beispielcode kann als funktionierendes Beispiel für eine ordnungsgemäß formatierte axe Expert Custom Rule JSON-Datei dienen.

{
  "checks": [
    {
      "id": "test",
      "options": ["test"],
      "evaluate": "function() { return false; }",
      "metadata": {
        "impact": "minor",
        "messages": {
          "pass": "how did you pass",
          "fail": "there is no way to pass"
        }
      }
    }
  ],
  "rules": [
    {
      "id": "test",
      "metadata": {
        "description": "Will always fail",
        "help": "There is no way to make this pass! It is for testing",
        "helpUrl": "https://foo.com/bar"
      },
      "selector": "html",
      "any": [],
      "all": ["test"],
      "none": [],
      "tags": ["wcag2aa"]
    }
  ]
}

Benutzerdefinierte Regelsätze aus axe Monitor-Projekten: Nachdem Sie sich bei axe Monitor angemeldet und ein Projekt ausgewählt haben, werden alle mit diesem Projekt verknüpften benutzerdefinierten Regelsätze automatisch in das Rules Panel geladen und zur Auswahl bereitgestellt.

Senden Sie benutzerdefinierte Regeln

Wenn Sie benutzerdefinierte Regeln zur zukünftigen Verwendung in die axe Expert Extension eintragen möchten, befolgen Sie diese einfachen Schritte. Zum Senden benutzerdefinierter Regeln geben Sie einen Namen für das Regelset an, der später als Auswahl verwendet werden kann. Fügen Sie den entsprechend formatierten Inhalt der JSON-Textdatei in die Texteingabefelder ein und klicken Sie anschließend auf einen Button, um die Regeln zu speichern und zu verwenden.

So übermitteln Sie benutzerdefinierte Regeln:

1. Öffnen Sie DevTools und wählen Sie „axe Expert“ aus. Wählen Sie „Regeln“ aus dem Hauptmenü von axe Expert.

2. Wählen Sie im linken Bereich im Abschnitt „Benutzerdefinierte Regelsets“ des Menüs die Option „+ Regelset hinzufügen“ aus. Das Regelsatzformular wird im rechten Bereich angezeigt.

3. Geben Sie im Feld „Name der benutzerdefinierten Regeln“ den gewünschten alphanumerischen Namen ohne Leerzeichen ein, wie gewünscht.

   Dies wird im Abschnitt „Benutzerdefinierte Regelsätze“ im linken Bereich des Rules Bedienfelds angezeigt. Der Name sollte daher aussagekräftig und für die Auswahl leicht erkennbar sein.

4. Fügen Sie in das Feld „JSON eingeben“ den Inhalt Ihrer benutzerdefinierten Regel-JSON-Textdatei aus dem virtuellen Clipboard ein. Greifen und ziehen Sie die untere rechte Ecke des Felds, um den sichtbaren Bereich bei Bedarf zu vergrößern.

5. Wählen Sie SAVE AND USE RULESET.

   

   Der von Ihnen eingegebene Name wird im Abschnitt „Benutzerdefinierte Regelsätze“ im linken Bereich und oben im rechten Bereich im Feld „Regelsatz:“ angezeigt. Darüber hinaus werden unten im Formular im rechten Bereich Schaltflächen zum Löschen oder Verwenden des Regelsatzes angezeigt.

   Wählen Sie im rechten Bereich Analyze now aus.

   

   Der Name des benutzerdefinierten Regelsatzes wird in der linken Seitenleiste im Menü „Regeln“ mit einem vorangestellten Häkchen angezeigt, um anzugeben, dass es sich um den aktuell ausgewählten Regelsatz handelt, der bei der Durchführung der Analyse verwendet wird.

Analysieren Sie eine Seite auf Verstöße gegen Barrierefreiheitsrichtlinien

Um eine Zugänglichkeitsanalyse in der axe Expert Extension zu starten, navigieren Sie zum Fenster „Analysieren“ und klicken dann auf die Schaltfläche „Analysieren“. Der Analysevorgang erzeugt eine Meldung mit der Gesamtzahl der auf der Seite festgestellten Verstöße gegen Barrierefreiheitsregeln sowie einen Ergebnisbereich mit den identifizierten Regelverstößen und der Gesamtzahl der festgestellten Verstöße. Wenn Sie im linken Ergebnisbereich eine Zeile aktivieren, werden im Hauptinhaltsbereich rechts Details angezeigt. Durch diese Aktion werden außerdem die Pfeilschaltflächen „Zurück“ und „Weiter“ für Verletzungen initialisiert. Diese werden oben im Inhaltsbereich angezeigt und ermöglichen Ihnen die Navigation von einer Verletzung zur nächsten für jede ausgewählte Regel.

Analysieren Sie eine Seite auf Regelverstöße:

1. Wählen Sie bei ausgewählter Registerkarte „Axe Expert“ im Hauptmenü im linken Bereich rechts neben dem Logo der Axe Expert-Erweiterung die Option „Analyse“ aus. Das Fenster „Analysieren“ wird angezeigt.

2. Aktivieren Sie im Inhaltsbereich das Element ANALYZE. Je nachdem, wie Sie die Entwicklertools angedockt oder die Größe Ihres Browserfensters geändert haben, befindet sich dies normalerweise in der Mitte des linken Bereichs des Analysebereichs.

   Im Analysebereich wird möglicherweise vorübergehend eine Statusmeldung mit dem Text Analyzing...please wait angezeigt, bis die Analyse der Seite anhand des ausgewählten Regelsatzes abgeschlossen ist.

   Unter dem Logo der Axe Expert Extension wird die Gesamtzahl der festgestellten Verstöße sowie die Anzahl der Probleme angezeigt, die einer manuellen Überprüfung bedürfen. Darüber hinaus werden rechts neben den Gesamtzählungen ein Anzeige-Dropdown-Kontextmenü und ein Run again Link angezeigt. Unter dem Dropdown-Kontextmenü wird eine zweispaltige Tabelle angezeigt. Der Kurzname jeder Regel wird in der linken Spalte und die Anzahl der festgestellten Verstöße in der rechten Spalte aufgeführt.

   

3. Klicken Sie im rules violated Abschnitt (linker Bereich) auf eine rule Zeile.

   

   Der Inhaltsbereich rechts wird aktualisiert, um den ersten Verstoß gegen diese Regel anzuzeigen. In der Inhaltsanzeige sind die Informationsabschnitte Target, HTML und Summary (How to Fix the Problem) sowie die Links Inspect und Highlight , ein Kontextmenü (mit Optionen für Export, Scope, Upload und Download) und eine nach links ausfahrbare Pfeilschaltfläche unten rechts zum Anzeigen der geltenden Standards (Regelsätze) für die ausgewählte Regel enthalten. Ausführlichere Informationen zu den einzelnen Komponenten, die im Inhaltsbereich „Regelverletzung“ angezeigt werden, finden Sie in den Beschreibungen in der Übersicht im Thema Analysieren . Oben im Bereich werden die Schaltflächen „Zurück“ < und „Weiter“ > für die Verstoßnavigation angezeigt, mit denen Sie zwischen den Verstößen für die ausgewählte Regel navigieren können. Darüber hinaus wird das relevante HTML, das den Verstoß enthält, auf der getesteten Seite automatisch hervorgehoben.

4. Klicken Sie auf „Weiter“ (>), um zur nächsten Verletzung der aktuell ausgewählten Regel zu navigieren, oder wählen Sie nach Wunsch eine andere Regel aus dem linken Ergebnisbereich für Verletzungen von Regeln aus.

   

Entfernen eines benutzerdefinierten Regelsatzes

Entfernen Sie einen benutzerdefinierten Regelsatz aus dem Rules Panel, wenn Sie einen Satz benutzerdefinierter Regeln nicht mehr benötigen. Wählen Sie im Rules Panel die zu löschende Regel aus und klicken Sie zum Löschen auf eine Schaltfläche.

Wenn Sie einen Teil des Inhalts in einem zukünftigen benutzerdefinierten Regelsatz wiederverwenden möchten, sollten Sie vor dem Löschen unbedingt den Inhalt der JSON-Datei speichern, da dieser Vorgang zu einer dauerhaften, irreversiblen Entfernung führt.

So entfernen Sie einen benutzerdefinierten Regelsatz:

1. Stellen Sie sicher, dass unten in der Optionsliste im Abschnitt Custom rulesets im linken Bereich des Rules Bedienfelds das Set, das Sie entfernen möchten, aktiviert (ausgewählt) ist.
2. Klicken Sie DELETE RULESET.

Das Set wird aus dem Menü im linken Bereich entfernt und steht nicht mehr zur Auswahl.