Uso de reglas personalizadas

Resumen de reglas personalizadas en la extensión axe Expert

Cuando desee que la herramienta axe Expert analice páginas web y aplicaciones según reglas específicas de las necesidades únicas de su organización, es posible hacerlo con la funcionalidad de Reglas Personalizadas en el panel Rules. Hacer clic en el elemento de enlace de Reglas en el menú principal de axe Expert (desplegable cerca del logotipo de la Extensión axe Expert en la parte superior del panel izquierdo) provoca que aparezca un panel Rules que ofrece un botón de Agregar conjunto de reglas personalizadas para mostrar un formulario en el panel derecho para enviar un conjunto de reglas personalizadas. El formulario simple consta de dos campos de entrada de texto y un botón de acción que le permiten configurar reglas personalizadas que pueden ser seleccionadas para ejecutarse en el motor automatizado cuando se analiza una página cargada en el panel Analizar.

Al igual que al analizar una página con los conjuntos de reglas de axe Expert, los resultados mostrarán cualquier violación de sus reglas personalizadas que se encuentren, junto con la información que especificó en el conjunto de reglas personalizadas (Objetivo, fuente HTML, Resumen de remediación, enlace de Más información, etc.). Todas las demás opciones de acción disponibles con las reglas estándar también se aplican a las violaciones de sus reglas personalizadas (Inspeccionar, Resaltar, Exportar, Subir, etc.). Existe un límite de cinco conjuntos de reglas personalizadas permitidos al mismo tiempo.

1. Agregar un botón de conjunto de reglas: En la sección Custom rulesets del panel izquierdo del panel Rules, un comando +Add a ruleset le presenta un formulario en el panel derecho para enviar un conjunto personalizado de reglas.
2. Nombre para reglas personalizadas (solo alfanumérico): Este será el nombre del conjunto de reglas que aparecerá en la sección de Normas de la pestaña de Configuración. Es importante seguir las convenciones (alfanumérico, sin espacios) y asegurarse de que el nombre sea significativo y fácilmente reconocible como una opción de selección.
3. Introducir JSON rules.textareaInstructions: La Notación de Objetos de JavaScript (JSON) es el estándar basado en texto al que el contenido debe ajustarse para trabajar con la extensión del navegador HTML 2.0 de Firefox. Para más información, consulte el Ejemplo a continuación.
4. GUARDAR Y USAR CONJUNTO DE REGLAS botón: Hace que las reglas personalizadas se conviertan en una opción seleccionable en el menú del panel lateral izquierdo del panel Rules. Para más información, consulte Seleccionar un conjunto de reglas.

Ejemplo de regla personalizada

El código de muestra que sigue puede servir como un ejemplo funcional de un archivo JSON de Regla Personalizada de axe Expert correctamente formateado.

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

Conjuntos de reglas personalizadas de proyectos de axe Monitor: Después de iniciar sesión en axe Monitor y seleccionar un proyecto, cualquier conjunto de reglas personalizadas asociado con ese proyecto se carga automáticamente en el panel Rules y se pone a disposición para la selección.

Enviar reglas personalizadas

Cuando desee enviar reglas personalizadas para uso futuro en la Extensión axe Expert, siga estos simples pasos. El envío de reglas personalizadas se realiza especificando un nombre para el conjunto de reglas para fines de selección futura y pegando el contenido del archivo de texto JSON correctamente formateado en los campos de entrada de texto, luego haciendo clic en un botón para guardarlas y usarlas.

Para enviar reglas personalizadas:

1. Abra DevTools y seleccione axe Expert. Seleccione Reglas en el menú principal de axe Expert.

2. En el panel izquierdo, seleccione + Agregar un conjunto de reglas en la sección de Conjuntos de Reglas Personalizadas del menú. El formulario de Conjunto de Reglas se muestra en el panel derecho.

3. En el campo Nombre de las Reglas Personalizadas, ingrese el nombre alfanumérico deseado sin espacios, según lo desee.

   Esto aparecerá en la sección de Conjuntos de Reglas Personalizadas del panel izquierdo del panel Rules, por lo que el nombre debe ser significativo y fácilmente reconocible para la selección.

4. En el campo Introducir JSON, pegue el contenido de su archivo de texto .json de reglas personalizadas desde el portapapeles virtual. Tome y arrastre la esquina inferior derecha del campo para aumentar el área visible, si lo desea.

5. Seleccione SAVE AND USE RULESET.

   

   El nombre que ingresó aparece en la sección de conjuntos de reglas personalizadas del panel izquierdo, y aparece en la parte superior del panel derecho, en el campo Conjunto de Reglas:. Además, al final del formulario en el panel derecho aparecen botones para eliminar o usar el conjunto de reglas.

   En el panel derecho, seleccione Analyze now.

   

   El nombre del conjunto de reglas personalizadas aparece en el menú de Reglas de la barra lateral izquierda precedido por un indicador de verificación para indicar que es el conjunto de reglas actualmente seleccionado que se utilizará al realizar análisis.

Analizar una página por violaciones de reglas de accesibilidad

Iniciar un análisis de accesibilidad en la Extensión axe Expert se realiza navegando al panel Analizar y luego haciendo clic en el botón Analizar. El proceso de análisis produce un mensaje que indica el número total de violaciones de reglas de accesibilidad encontradas en la página, así como una sección de resultados que muestra las violaciones de reglas identificadas y el número total de violaciones identificadas. Activar una fila en el panel de resultados a la izquierda muestra detalles en el panel de contenido principal a la derecha. Esta acción también inicializa las flechas de navegación de Violación Anterior y Siguiente que aparecen en la parte superior del panel, permitiéndole navegar de una violación a otra para cualquier regla seleccionada.

Analizar una página por violaciones de reglas:

1. Con la pestaña axe Expert seleccionada, seleccione Analizar en el menú principal en el panel izquierdo a la derecha del logotipo de la Extensión axe Expert. Aparece el panel Analizar.

2. En el panel de contenido, active ANALYZE. Dependiendo de cómo haya acoplado las herramientas de desarrollo o redimensionado la ventana de su navegador, esto se encuentra típicamente en el centro del panel izquierdo del panel Analizar.

   El panel Analizar puede mostrar temporalmente un mensaje de estado que dice Analyzing...please wait hasta que se complete el análisis de la página contra el conjunto de reglas seleccionado.

   Bajo el logotipo de la Extensión axe Expert, se muestra el número total de violaciones encontradas, junto con el número de problemas que requieren revisión manual. Además, a la derecha de los conteos totales se muestra un menú contextual desplegable de mostrar y un enlace Run again. Debajo del menú contextual desplegable de mostrar se muestra una tabla de dos columnas que exhibe el nombre corto de cada regla con la columna derecha mostrando el número de violaciones encontradas de cada una.

   

3. En la sección rules violated (panel izquierdo), haga clic en una fila rule.

   

   El panel de contenido a la derecha se actualiza para mostrar la primera violación de esa regla. En la visualización del contenido se incluyen las secciones Target, HTML y Summary (How to Fix the Problem) de información, junto con enlaces Inspect y Highlight, un menú contextual (que incluye opciones para Export, Scope, Upload y Download), y en la parte inferior, a la derecha, un botón de flecha que se expande a la izquierda para mostrar las Normas aplicables (conjuntos de reglas) para la regla seleccionada. Para obtener información más detallada sobre cada componente mostrado en el panel de contenido de violación de reglas, consulte las descripciones en el resumen proporcionado en el tema Analizar. Los botones de navegación de violación anterior < y siguiente > aparecen en la parte superior del panel permitiéndole navegar entre las violaciones para la regla seleccionada. Además, el HTML relevante que contiene la violación se resalta automáticamente en la página probada.

4. Haga clic en Siguiente (>) para navegar a la siguiente violación de la regla actualmente seleccionada, o seleccione una regla diferente del panel de resultados de reglas violadas a la izquierda, según lo desee.

   

Eliminar un conjunto de reglas personalizadas

Eliminar un conjunto de reglas personalizadas del panel Rules cuando ya no necesites un conjunto de reglas personalizadas. Selecciona la regla para eliminar en el panel Rules y haz clic en un botón para eliminar.

Si crees que podrías querer reutilizar parte del contenido en un futuro conjunto de reglas personalizadas, asegúrate de guardar el contenido del archivo JSON antes de eliminarlo, ya que este procedimiento resulta en una eliminación permanente e irreversible.

Para eliminar un conjunto de reglas personalizadas:

1. Al final de la lista de opciones en la sección Custom rulesets en el panel izquierdo del panel Rules, asegúrate de que el conjunto que deseas eliminar esté marcado (seleccionado).
2. Haz clic en DELETE RULESET.

El conjunto se elimina del menú del panel izquierdo y ya no está disponible para su selección.