Utilisation de règles personnalisées

Vue d'ensemble des règles personnalisées dans l'extension axe Expert

Lorsque vous souhaitez que l'outil axe Expert analyse des pages web et des applications selon des règles spécifiques aux besoins uniques de votre organisation, il est possible de le faire grâce à la fonctionnalité Règles personnalisées sur le panneau Rules. En cliquant sur l'élément de menu Règles dans le menu principal d'axe Expert (menu déroulant près du logo de l'extension axe Expert en haut du volet gauche), un panneau Rules apparaît qui offre un bouton Ajouter un ensemble de règles personnalisées pour afficher un formulaire dans le volet droit pour soumettre un ensemble de règles personnalisées. Le formulaire simple est composé de deux champs de saisie de texte et d'un bouton d'action qui vous permettent de configurer des règles personnalisées pouvant être sélectionnées pour être exécutées dans le moteur automatique lorsqu'une page chargée est analysée sur le panneau Analyser.

Tout comme analyser une page avec les ensembles de règles d'axe Expert, les résultats afficheront toutes les violations de vos règles personnalisées trouvées, ainsi que les informations que vous avez spécifiées dans l'ensemble de règles personnalisées (Cible, source HTML, résumé de la correction, lien d'aide Informations supplémentaires, etc.). Toutes les autres options d'action disponibles avec les règles standard s'appliquent également à vos violations de règles personnalisées (Inspecter, Surligner, Exporter, Télécharger, etc.). Il y a une limite de cinq ensembles de règles personnalisées autorisées à la fois.

1. Ajouter un bouton d'ensemble de règles : Dans la section Custom rulesets du volet gauche du panneau Rules, une commande +Add a ruleset vous présente un formulaire dans le volet droit pour soumettre un ensemble de règles personnalisées.
2. Nom pour les règles personnalisées (alphanumérique uniquement) : Ce sera le nom de l'ensemble de règles qui apparaîtra dans la section Normes de l'onglet Paramètres. Il est important de respecter à la fois les conventions (alphanumérique, sans espaces) et de s'assurer que le nom sera significatif et facilement reconnaissable comme option de sélection.
3. Entrer JSON instructions.textarea.règles : JavaScript Object Notation (JSON) est le standard basé sur du texte auquel le contenu doit se conformer pour fonctionner avec l'extension du navigateur HTML 2.0 de Firefox. Pour plus d'informations, voir l'Exemple ci-dessous.
4. Bouton SAUVEGARDER ET UTILISER L'ENSEMBLE DE RÈGLES : Permet aux règles personnalisées de devenir une option sélectionnable dans le menu du volet latéral gauche du panneau Rules. Pour plus d'informations, voir Sélectionner un ensemble de règles.

Exemple de règle personnalisée

Le code d'exemple qui suit peut servir d'exemple fonctionnel d'un fichier JSON de règle personnalisée axe Expert correctement formaté.

{
  "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"]
    }
  ]
}

Ensembles de règles personnalisées des projets axe Monitor : Après vous être connecté à axe Monitor et avoir sélectionné un projet, tous les ensembles de règles personnalisées associés à ce projet sont automatiquement chargés dans le panneau Rules et mis à disposition pour la sélection.

Soumettre des règles personnalisées

Lorsque vous souhaitez soumettre des règles personnalisées pour une utilisation future dans l'extension axe Expert, suivez ces étapes simples. La soumission de règles personnalisées se fait en spécifiant un nom pour l'ensemble de règles à des fins de sélection future, et en collant le contenu du fichier texte JSON correctement formaté dans les champs de saisie de texte, puis en cliquant sur un bouton pour les enregistrer et les utiliser.

Pour soumettre des règles personnalisées :

1. Ouvrez les outils de développement et sélectionnez axe Expert. Sélectionnez Règles dans le menu principal d'axe Expert.

2. Dans le volet gauche, sélectionnez + Ajouter un ensemble de règles dans la section Ensembles de règles personnalisées du menu. Le formulaire Ensemble de règles s'affiche dans le volet droit.

3. Dans le champ Nom des règles personnalisées, entrez le nom alphanumérique souhaité sans espaces, selon votre désir.

   Cela apparaîtra dans la section Ensembles de règles personnalisées du volet gauche du panneau Rules, donc le nom doit être significatif et facilement reconnaissable pour la sélection.

4. Dans le champ Entrer JSON, collez le contenu de votre fichier texte .json de règles personnalisées depuis le presse-papiers virtuel. Saisissez et faites glisser le coin inférieur droit du champ pour augmenter la zone visible, si désiré.

5. Sélectionnez SAVE AND USE RULESET.

   

   Le nom que vous avez entré apparaît dans la section des ensembles de règles personnalisées dans le volet gauche, et il apparaît en haut du volet droit, dans le champ Ensemble de règles : . De plus, des boutons permettant soit de supprimer l'ensemble de règles soit de l'utiliser apparaissent en bas du formulaire dans le volet droit.

   Dans le volet droit, sélectionnez Analyze now.

   

   Le nom de l'ensemble de règles personnalisées apparaît dans le menu des règles de la barre latérale gauche précédé d'une coche pour indiquer qu'il s'agit de l'ensemble de règles actuellement sélectionné qui sera utilisé lors de l'analyse.

Analyser une page pour les violations des règles d'accessibilité

Initier une analyse d'accessibilité dans l'extension axe Expert se fait en naviguant vers le panneau Analyser puis en cliquant sur le bouton Analyser. Le processus d'analyse produit un message indiquant le nombre total de violations des règles d'accessibilité trouvées sur la page, ainsi qu'une section de résultats affichant les violations de règles identifiées et le nombre total de violations identifiées. Activer une ligne dans le volet des résultats à gauche affiche des détails dans le volet de contenu principal à droite. Cette action initialise également les boutons de navigation des violations Précédent et Suivant pour apparaître en haut du volet de contenu vous permettant de naviguer d'une violation à l'autre pour toute règle sélectionnée.

Analyser une page pour les violations de règles :

1. Avec l'onglet axe Expert sélectionné, sélectionnez Analyser dans le menu principal sur le volet gauche à droite du logo de l'extension axe Expert. Le panneau Analyser s'affiche.

2. Dans le volet de contenu, activez ANALYZE. En fonction de la façon dont vous avez ancré les outils de développement ou redimensionné votre fenêtre de navigateur, il se trouve généralement au centre du volet gauche du panneau Analyser.

   Le volet Analyser peut temporairement afficher un message de statut indiquant Analyzing...please wait jusqu'à ce que l'analyse de la page par rapport à l'ensemble de règles sélectionné soit terminée.

   Sous le logo de l'extension axe Expert, le nombre total de violations trouvées s'affiche, ainsi que le nombre de problèmes nécessitant une revue manuelle. De plus, un menu contextuel déroulant et un lien Run again s'affichent à droite des comptages totaux. Un tableau à deux colonnes affichant le nom court de chaque règle avec la colonne de droite affichant le nombre de violations trouvées de chacune s'affiche sous le menu déroulant contextuel.

   

3. Dans la section rules violated (volet gauche), cliquez sur une ligne rule.

   

   Le volet de contenu à droite est rafraîchi pour afficher la première violation de cette règle. Inclus dans l'affichage du contenu sont les sections Target, HTML et Summary (How to Fix the Problem) d'informations, ainsi que les liens Inspect et Highlight, un menu contextuel (qui inclut des options pour Export, Scope, Upload et Download), et en bas à droite, un bouton flèche s'étendant vers la gauche pour afficher les Normes applicables (ensembles de règles) pour la règle sélectionnée. Pour plus d'informations détaillées sur chaque composant affiché dans le volet de contenu des violations de règles, référez-vous aux descriptions dans la vue d'ensemble fournie dans le sujet Analyser. Les boutons de navigation précédente < et suivante > apparaissent en haut du volet vous permettant de naviguer entre les violations pour la règle sélectionnée. De plus, le HTML pertinent contenant la violation est automatiquement surligné sur la page testée.

4. Cliquez sur Suivant (>) pour naviguer vers la prochaine violation de la règle actuellement sélectionnée, ou sélectionnez une autre règle dans le volet des résultats des règles violées à gauche, selon vos besoins.

   

Supprimer un ensemble de règles personnalisé

Supprimez un ensemble de règles personnalisé du panneau Rules lorsque vous n'avez plus besoin d'un ensemble de règles personnalisé. Sélectionnez la règle à supprimer dans le panneau Rules et cliquez sur un bouton pour supprimer.

Si vous souhaitez éventuellement réutiliser certains contenus dans un futur ensemble de règles personnalisé, vous voudrez peut-être vous assurer de sauvegarder le contenu du fichier JSON avant la suppression, car cette procédure entraîne une suppression permanente et irréversible.

Pour supprimer un ensemble de règles personnalisé :

1. En bas de la liste des options dans la section Custom rulesets du panneau gauche du panneau Rules, assurez-vous que l'ensemble que vous souhaitez supprimer est coché (sélectionné).
2. Cliquez sur DELETE RULESET.

L'ensemble est supprimé du menu du panneau gauche et n'est plus disponible pour la sélection.