Addaw, ir a inicio Donar

Técnica Técnicas generales WCAG 2.2

G64Incluir una tabla de contenidos en los documentos largos

Nombre oficial en el W3C: Proporcionar una tabla de contenidos

En pocas palabras

Un documento largo, como una guía, un reglamento o un informe, debe tener una tabla de contenidos (índice). Es una lista de enlaces a sus apartados, con los mismos nombres y en el mismo orden. Sirve para ver de un vistazo cómo está organizado y saltar directamente a la parte que interesa.

Por qué es importante

Recorrer un texto largo de arriba abajo cuesta mucho con un lector de pantalla (programa que lee en voz alta lo que hay en la pantalla) o con el teclado. Con un índice enlazado, la persona va directa al apartado que busca.

También ayuda a quien tiene dificultades de atención o de memoria, porque ve la estructura completa antes de empezar. Es especialmente útil cuando el documento está repartido en varias páginas.

Cómo se hace

  1. Divida el documento en apartados con encabezados claros.
  2. Ponga al principio una lista con un enlace a cada apartado. Use los mismos nombres y el mismo orden que los encabezados.
  3. Si hay subapartados, use listas dentro de la lista para reflejar los niveles.
  4. Si el documento ocupa varias páginas, enlace el índice desde todas ellas.
  5. Revise el índice cada vez que un apartado cambie de nombre o de sitio.

Cómo comprobarlo

  1. Confirme que el documento tiene una tabla de contenidos o un enlace a ella.
  2. Compare cada entrada con los encabezados: deben coincidir el nombre y el orden.
  3. Active cada enlace y compruebe que lleva al apartado correcto.

Ejemplo

Índice al principio de las bases de una convocatoria de ayudas.

<nav aria-label="Índice">
  <ol>
    <li><a href="#objeto">Objeto de la convocatoria</a></li>
    <li><a href="#requisitos">Requisitos</a>
      <ol><li><a href="#documentacion">Documentación</a></li></ol>
    </li>
    <li><a href="#plazos">Plazos</a></li>
  </ol>
</nav>
<h2 id="objeto">Objeto de la convocatoria</h2>
Ver el texto completo del W3C (traducción al español)

Esta es una traducción no oficial al español de la técnica G64 de Techniques for WCAG 2.2, del W3C. Puede contener errores. El único documento oficial y normativo es la versión original en inglés, publicada en el sitio web del W3C.

Aplicabilidad

Todas las tecnologías.

Descripción

Esta es una de las técnicas de una serie para localizar contenido que son suficientes para cumplir el criterio de conformidad 2.4.5. Una tabla de contenidos proporciona enlaces a las secciones y subsecciones de un mismo documento. La información del documento suele estar organizada jerárquicamente y está pensada para leerse de forma secuencial. Del mismo modo que en una biblioteca puede haber muchos libros, cada uno con su propia tabla de contenidos, un sitio web puede contener muchos documentos, cada uno con su propia tabla de contenidos.

La tabla de contenidos cumple dos funciones:

  • Ofrece a los usuarios una visión general del contenido y la organización del documento.
  • Permite a los lectores ir directamente a una sección concreta de un documento en línea.

La tabla de contenidos normalmente incluye solo las secciones principales del documento, aunque en algunos casos puede ser conveniente una tabla de contenidos ampliada que ofrezca una vista más detallada de un documento complejo.

Las secciones del documento pueden estar en la misma página web o repartidas en varias páginas web. Una tabla de contenidos resulta especialmente útil cuando un documento está dividido en varias páginas web.

Existe una distinción entre una tabla de contenidos y otros elementos de navegación, como una barra de navegación o un mapa del sitio. Una tabla de contenidos proporciona enlaces a las secciones de un mismo documento. Esas secciones pueden estar en la misma página web o repartidas en varias páginas web. Pero, en conjunto, forman una idea completa. Para entenderlo mejor, piense en un libro impreso que tiene secciones. Cada sección pertenece al libro. En una biblioteca puede haber muchos libros. En este ejemplo, la «biblioteca» es el sitio web completo.

Ejemplos

Las Web Content Accessibility Guidelines 2.0 contienen una tabla de contenidos que es una lista jerárquica de enlaces a las secciones y subsecciones del documento. La jerarquía de la tabla de contenidos refleja la organización de las secciones, y cada entrada de la tabla de contenidos es un enlace que lleva al usuario directamente a esa sección.

La tabla de contenidos de Accessing PDF Documents with Assistive Technology: A Screen Reader User's Guide (acceso a documentos PDF con tecnología de asistencia: guía para usuarios de lectores de pantalla) empieza en la segunda página.

Pruebas

Procedimiento

  1. Comprobar que en el documento existe una tabla de contenidos o un enlace a una tabla de contenidos.
  2. Comprobar que los valores y el orden de las entradas de la tabla de contenidos se corresponden con los nombres y el orden de las secciones del documento.
  3. Comprobar que las entradas de la tabla de contenidos enlazan a las secciones correctas del documento.

Resultados esperados

  • Todas las comprobaciones anteriores son verdaderas.

Cómo lo comprobamos en ADDAW

En cada auditoría de ADDAW revisamos esta técnica página a página y le entregamos los errores con capturas y la forma de corregirlos.

Solicitar una auditoría

Basado en la técnica G64 del W3C (WCAG 2.2). Explicación y ejemplos: ADDAW. Traducción no oficial del texto del W3C © W3C, licencia de documentos del W3C. ¿Ha visto un error? Escríbanos.