Benutzerdefinierte Regeln verwenden

Übersicht über benutzerdefinierte Regeln in der axe Expert Erweiterung

Wenn Sie möchten, dass das axe Expert Tool Webseiten und Anwendungen auf Regeln analysiert, die spezifisch für die einzigartigen Bedürfnisse Ihrer Organisation sind, können Sie dies mit der Funktionalität „Benutzerdefinierte Regeln“ im Rules-Panel tun. Wenn Sie den Link „Regeln“ im Hauptmenü von axe Expert (Dropdown in der Nähe des axe Expert Erweiterungs-Logos oben im linken Bereich) anklicken, erscheint ein Rules-Panel, das eine „Benutzerdefinierte Regelsatz hinzufügen“-Schaltfläche bietet, um ein Formular im rechten Bereich anzuzeigen, mit dem Sie einen Satz benutzerdefinierter Regeln übermitteln können. Das einfache Formular besteht aus zwei Texteingabefeldern und einer Aktionsschaltfläche, mit denen Sie benutzerdefinierte Regeln einrichten können, die bei der Analyse eines geladenen Seitenbrowsers im Analyse-Panel ausgewählt werden können.

Genau wie bei der Analyse einer Seite mit den axe Expert Regelsätzen werden Ergebnisse angezeigt, die Verstöße gegen Ihre benutzerdefinierten Regeln zusammen mit den in Ihrem benutzerdefinierten Regelsatz angegebenen Informationen anzeigen (Ziel, HTML-Quelle, Zusammenfassung der Abhilfemaßnahmen, Mehr Informationen-Hilfelink usw.). Alle anderen Aktionen, die bei Standardregeln verfügbar sind, gelten auch für Verstöße gegen Ihre benutzerdefinierten Regeln (Untersuchen, Hervorheben, Exportieren, Hochladen usw.). Es gibt eine Begrenzung auf fünf benutzerdefinierte Regelsätze, die gleichzeitig erlaubt sind.

1. Eine Regelsatz-Schaltfläche hinzufügen: Im Custom rulesets-Abschnitt des linken Bereichs des Rules-Panels präsentiert Ihnen ein +Add a ruleset-Befehl ein Formular im rechten Bereich, um einen benutzerdefinierten Satz von Regeln zu übermitteln.
2. Name für benutzerdefinierte Regeln (nur alphanumerisch): Dies wird der Name des Regelsatzes sein, der im Standard-Abschnitt des Einstellungen-Tabs angezeigt wird. Es ist wichtig, sowohl den Konventionen (alphanumerisch, keine Leerzeichen) zu folgen, als auch sicherzustellen, dass der Name aussagekräftig und leicht erkennbar als Auswahloption ist.
3. JSON eingeben rules.textareaInstructions: JavaScript Object Notation (JSON) ist der textbasierte Standard, dem der Inhalt entsprechen muss, um mit der HTML 2.0-Browsererweiterung von Firefox zu arbeiten. Für weitere Informationen siehe unten Beispiel.
4. REGELSATZ SPEICHERN UND VERWENDEN-Schaltfläche: Führt dazu, dass die benutzerdefinierten Regeln im linken Seitenbereich-Menü des Rules-Panels auswählbar werden. Für weitere Informationen siehe Einen Regelsatz auswählen.

Beispiel für benutzerdefinierte Regel

Der folgende Beispielcode kann als praktisches Beispiel für eine ordnungsgemäß formatierte axe Expert benutzerdefinierte Regel-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 benutzerdefinierten Regelsätze, die mit diesem Projekt verbunden sind, automatisch in das Rules-Panel geladen und zur Auswahl bereitgestellt.

Benutzerdefinierte Regeln übermitteln

Wenn Sie benutzerdefinierte Regeln zur späteren Verwendung in die axe Expert Erweiterung einreichen möchten, folgen Sie diesen einfachen Schritten. Das Übermitteln von benutzerdefinierten Regeln erfolgt, indem Sie einen Namen für den Regelsatz für zukünftige Auswahlzwecke angeben und den korrekt formatierten JSON-Textdatei-Inhalt in die Texteingabefelder einfügen und dann auf eine Schaltfläche klicken, um sie zu speichern und zu verwenden.

Um benutzerdefinierte Regeln zu übermitteln:

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 + Einen Regelsatz hinzufügen im Abschnitt „Benutzerdefinierte Regelsätze“ des Menüs. Das Regelsatz-Formular 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“ des linken Bereichs des Rules-Panels angezeigt, daher sollte der Name aussagekräftig und leicht erkennbar zur Auswahl sein.

4. Fügen Sie im Feld „JSON eingeben“ den Inhalt Ihrer benutzerdefinierten Regeln aus der .json-Textdatei aus der virtuellen Zwischenablage ein. Ziehen Sie die untere rechte Ecke des Feldes, um den sichtbaren Bereich bei Bedarf zu vergrößern.

5. Wählen Sie SAVE AND USE RULESET.

   

   Der eingegebene Name erscheint im Abschnitt „Benutzerdefinierte Regelsätze“ im linken Bereich und am oberen Rand des rechten Bereichs, im Feld „Regelsatz:“. Zusätzlich erscheinen Schaltflächen zum Löschen oder Verwenden des Regelsatzes am unteren Rand des Formulars im rechten Bereich.

   Wählen Sie im rechten Bereich Analyze now.

   

   Der Name des benutzerdefinierten Regelsatzes erscheint im linken Seitenmenü „Regeln“, vorangestellt von einem Häkchen, das anzeigt, dass es der derzeit ausgewählte Regelsatz ist, der bei der Analyse verwendet wird.

Eine Seite auf Verstöße gegen Zugänglichkeitsregeln analysieren

Eine Barrierefreiheitsanalyse in der axe Expert Erweiterung zu starten, erfolgt durch das Navigieren zum Analyse-Panel und dann Klicken auf die Schaltfläche „Analysieren“. Der Analyseprozess erzeugt eine Nachricht, die die Gesamtanzahl der entdeckten Barrierefreiheitsregelverstöße auf der Seite angibt, sowie einen Ergebnisabschnitt, der die identifizierten Regelverstöße und die Gesamtanzahl der identifizierten Verstöße anzeigt. Das Aktivieren einer Zeile im linken Ergebnispanel zeigt Details im Hauptinhaltspanel rechts an. Diese Aktion aktiviert ebenfalls die Vor- und Zurück-Pfeil-Schaltflächen für Verstöße, die oben im Inhaltspanel erscheinen, wodurch Sie von einem Verstoß zum nächsten für eine ausgewählte Regel navigieren können.

Eine Seite auf Regelverstöße analysieren:

1. Wählen Sie im ausgewählten axe Expert-Tab „Analysieren“ im Hauptmenü im linken Bereich rechts neben dem axe Expert Erweiterungs-Logo. Das Analyse-Panel erscheint.

2. Aktivieren Sie im Inhaltsbereich ANALYZE. Je nachdem, wie Sie die Entwicklertools angedockt oder Ihr Browserfenster angepasst haben, befindet sich dies typischerweise in der Mitte des linken Bereichs des Analysepanels.

   Das Analyse-Panel kann vorübergehend eine Statusmeldung anzeigen, die Analyzing...please wait liest, bis die Analyse der Seite in Bezug auf den ausgewählten Regelsatz abgeschlossen ist.

   Unter dem axe Expert Erweiterungs-Logo wird die Gesamtanzahl der gefundenen Verstöße angezeigt, zusammen mit der Anzahl der Probleme, die einer manuellen Überprüfung bedürfen. Zusätzlich wird rechts von den Gesamtsummen ein Dropdown-Menü und ein Run again-Link angezeigt. Eine zweispaltige Tabelle, die den Kurznamen jeder Regel mit der rechten Spalte, die die Anzahl der gefundenen Verstöße jeder Regel anzeigt, unter dem Dropdown-Kontextmenü anzeigt.

   

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. Im Inhaltsbereich sind die Target, HTML und Summary (How to Fix the Problem) Abschnitte der Informationen enthalten, zusammen mit Inspect und Highlight Links, einem Kontextmenü (das Optionen für Export, Scope, Upload und Download enthält) und unten rechts eine nach links erweiterbare Pfeilschaltfläche zur Anzeige der anwendbaren Standards (Regelsätze) für die ausgewählte Regel. Für detailliertere Informationen zu jeder im Regelverletzungsinhaltfenster angezeigten Komponente, beziehen Sie sich auf die Beschreibungen in der Übersicht im Analysieren-Thema. Vorherige < und nächste > Pfeilschaltflächen für Verstöße erscheinen am oberen Rand des Fensters, die es Ihnen ermöglichen, zwischen den Verstößen für die ausgewählte Regel zu navigieren. Zusätzlich wird das relevante HTML, das den Verstoß enthält, automatisch auf der getesteten Seite hervorgehoben.

4. Klicken Sie auf Weiter (>), um zur nächsten Verletzung der derzeit ausgewählten Regel zu navigieren, oder wählen Sie eine andere Regel aus dem links befindlichen Ergebnisbereiches für Regelverstöße, je nach Bedarf.

   

Ein benutzerdefiniertes Regelset entfernen

Entfernen Sie ein benutzerdefiniertes Regelset aus dem Rules-Panel, wenn Sie eine Menge benutzerdefinierter Regeln nicht mehr benötigen. Wählen Sie die zu löschende Regel im Rules-Panel aus und klicken Sie auf eine Schaltfläche, um die Regel zu löschen.

Falls Sie einige der Inhalte in einem zukünftigen benutzerdefinierten Regelset wiederverwenden möchten, sollten Sie sicherzustellen, dass Sie den Inhalt aus der JSON-Datei vor dem Löschen speichern, da dieses Verfahren zu einer dauerhaften, unwiderruflichen Entfernung führt.

Um ein benutzerdefiniertes Regelset zu entfernen:

1. Am unteren Ende der Optionsliste im Custom rulesets-Abschnitt im linken Bereich des Rules-Panels stellen Sie sicher, dass das zu entfernende Set ausgewählt (markiert) ist.
2. Klicken Sie auf DELETE RULESET.

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