HTML abbr: explicar abreviações e usar o atributo title

HTML <abbr> identifica uma abreviação ou sigla. Seu atributo opcional title pode fornecer o termo completo, mas explicações essenciais também devem aparecer no texto visível para que os leitores possam entendê-las sem um mouse.

Marque uma abreviação e explique seu termo completo

Quando um termo técnico aparece pela primeira vez, escrever o termo completo junto com sua abreviação ajuda os leitores a entendê-lo. O elemento abbr identifica o texto como uma abreviação; ele não procura automaticamente nem traduz o termo completo. Você não precisa envolver toda abreviação que seu público já conhece neste elemento.

Salve o seguinte documento como abbreviation.html e abra-o em um navegador. A primeira frase mantém a explicação visível, enquanto a segunda demonstra o atributo title.

<!doctype html>
<html lang="pt">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>Abreviações e termos completos</title>
</head>
<body>
  <p>Documentos web usam HyperText Markup Language
    (<abbr>HTML</abbr>) para definir sua estrutura.</p>
  <p>Outra abreviação: <abbr title="World Wide Web">WWW</abbr></p>
</body>
</html>

A primeira frase exibe o termo completo ao lado de HTML. Dependendo do navegador, WWW na segunda frase pode ter um sublinhado pontilhado, e ao passar o mouse sobre ele pode exibir World Wide Web em uma dica de ferramenta. O navegador determina a aparência padrão do sublinhado e da dica de ferramenta, portanto, isso não é um recurso de design que garante um resultado visual consistente.

O que deve estar no atributo title?

O atributo title em abbr é opcional. Se você usá-lo, inclua o termo completo representado por essa abreviação, sem texto promocional ou explicações não relacionadas. Um valor de title em um elemento abbr não se aplica automaticamente a outros elementos abbr no mesmo artigo. Se você remover o title do exemplo, a abreviação visível WWW permanece.

Não confunda o atributo global title com o elemento title do documento. O atributo title em abbr fornece informações suplementares sobre aquela abreviação; o elemento title no elemento head do documento fornece o título da página.

Não confie apenas em um tooltip

Telas sensíveis ao toque não fornecem o recurso de passar o mouse por cima, e o acesso às informações do title também varia com a navegação por teclado e tecnologia assistiva. Se uma explicação for necessária para entender uma abreviação, torne-a visível no texto, como na primeira frase do exemplo. Torne o próprio conteúdo legível em vez de transformar abbr em um ponto de tabulação desnecessário ou botão apenas para exibir um tooltip.

Se a explicação for longa, escreva-a perto da primeira ocorrência ou adicione um link para uma definição. Considere o fluxo da leitura antes de repetir o termo completo no atributo title quando o mesmo parágrafo já o explica. A referência de abbr na MDN aborda as condições de uso e a acessibilidade.