Addaw, anar a la pàgina d'inici Donar

Tècnica HTML WCAG 2.2

H40Marcar glossaris i definicions amb llistes de descripció

Nom oficial al W3C: Utilitzar llistes de descripció

Versión en castellano

En poques paraules

Un glossari és una llista de paraules difícils amb el seu significat. En HTML es marca amb una llista de descripció: dl per a la llista, dt per a cada terme i dd per a la seva explicació. Així la relació entre la paraula i la definició queda en el codi, no només en l'aspecte.

Per què és important

Molts webs utilitzen paraules tècniques o poc comunes: «IPREM», «empadronament», «silenci administratiu». Un glossari ajuda a entendre-les. És útil per a persones amb dificultats de comprensió i per a qualsevol que no conegui el tema.

Un lector de pantalla és un programa que llegeix en veu alta el que hi ha a la pantalla. Si el glossari es maqueta només amb negretes i salts de línia, el lector no sap quin text és el terme i quin la definició. Amb <dl>, el lector anuncia una llista i el seu nombre d'elements.

Com es fa

  1. Emboliqueu el glossari en un element <dl>.
  2. Poseu cada paraula o expressió en un <dt>.
  3. Poseu-ne l'explicació just després, en un o diversos <dd>.
  4. Escriviu definicions clares i curtes, sense fer servir altres paraules difícils.
  5. Doneu l'aspecte desitjat amb CSS: negreta, sagnat o columnes. El marcatge no canvia.

Com comprovar-ho

  1. Localitzeu els glossaris i les llistes de termes de la pàgina.
  2. Amb les eines del navegador (F12), comproveu que utilitzen <dl>, <dt> i <dd>.
  3. Verifiqueu que cada <dt> va seguit de la seva definició en <dd>.
  4. Passeu el validador HTML del W3C per detectar llistes mal construïdes.

Exemple

Glossari al final d'una convocatòria d'ajudes.

<dl>
  <dt>IPREM</dt>
  <dd>Indicador que s'utilitza per calcular el límit d'ingressos de moltes ajudes.</dd>
  <dt>Empadronament</dt>
  <dd>Inscripció en el registre d'habitants del municipi.</dd>
</dl>
Veure el text complet del W3C (traducció al català)

Aquesta és una traducció no oficial al català de la tècnica H40 de Techniques for WCAG 2.2, del W3C. Pot contenir errors. L'únic document oficial i normatiu és la versió original en anglès, publicada al lloc web del W3C.

Aplicabilitat

HTML

Descripció

L'objectiu d'aquesta tècnica és proporcionar la descripció de noms o termes presentant-los en una llista de descripció. La llista es marca amb l'element dl. Dins de la llista, cada terme es col·loca en un element dt independent i la seva descripció va a l'element dd que el segueix immediatament. Es poden associar diversos termes a una sola descripció, així com un sol terme a diverses descripcions, sempre que es mantingui la seqüència semàntica. L'atribut title es pot utilitzar per proporcionar informació addicional sobre la llista de descripció. L'ús de llistes de descripció garanteix que els termes i les seves descripcions estiguin relacionats semànticament encara que canviï el format de presentació, a més de garantir que aquests termes i descripcions quedin agrupats semànticament com una unitat.

Les llistes de descripció són més fàcils d'utilitzar quan les descripcions estan ordenades alfabèticament. Un ús habitual de les llistes de descripció és el glossari de termes.

Exemples

Una llista de descripcions de termes nàutics utilitzats en un lloc web sobre navegació a vela.

<dl title="Nautical Terms">
  <dt>Knot</dt>
  <dd>
    A <i>knot</i> is a unit of speed equaling 1 
    nautical mile per hour (1.15 miles per hour or 1.852 
    kilometers per hour).
  </dd>
  <dt>Port</dt>
  <dd>
    <i>Port</i> is the nautical term (used on 
    boats and ships) that refers to the left side
    of a ship, as perceived by a person facing towards 
    the bow (the front of the vessel).
  </dd>
  <dt>Starboard</dt>
  <dd>
    <i>Starboard</i> is the nautical term (used 
    on boats and ships) that refers to the right 
    side of a vessel, as perceived by a person 
    facing towards the bow (the front of the vessel).
  </dd>
</dl>

Proves

Procediment

Per a qualsevol conjunt de termes i les seves descripcions associades:

  1. Comprovar que la llista està continguda en un element dl.
  2. Comprovar que cada terme descrit a la llista està contingut en un element dt.
  3. Comprovar que, quan hi ha més d'un terme que comparteix la mateixa descripció, els elements dt se succeeixen immediatament els uns als altres.
  4. Comprovar que la descripció de cada terme està continguda en un o més elements dd.
  5. Comprovar que l'element o els elements dd segueixen immediatament l'element o els elements dt que contenen el terme descrit.

Resultats esperats

  • Totes les comprovacions anteriors són certes.

Recursos

Com ho comprovem a ADDAW

En cada auditoria d'ADDAW revisem aquesta tècnica pàgina per pàgina i us lliurem els errors amb captures i la manera de corregir-los.

Sol·licitar una auditoria

Basat en la tècnica H40 del W3C (WCAG 2.2). Explicació i exemples: ADDAW. Traducció no oficial del text del W3C © W3C, llicència de documents del W3C. Heu vist un error? Escriviu-nos.