Etiquetas (labels) de figuras, tableas, equações e afins.

As etiquetas (labels) permitem dar um nome simbólico a um objeto numerado, para mais tarde o poder referenciar.  O exemplo clássico é o de uma figura:
\begin{figure}
  \centering
  \includegraphics{blah}
  \caption{A blah figure.}
  \label{fig:terra}
\end{figure}
Mas também podemos associar etiquetas aos items de um enumerate:
\begin{enumerate}
  \item Um cão;\label{it:cao}
  \item Um gato;\labe{it:gato}
  \item E um leopardo.\label{it:leopardo}
\end{enumerate}
Em ambos os casos, podemos sempre referenciar os objetos (ou os items do enumerate) com “\ref{…}” e “\pageref{…}”, e.g.:
Com se pode ver na figura~\ref{fig:terra} (página~\pageref{fig:terra}) e comprovado pelos items~\ref{it:cao},~\ref{it:gato} e~\ref{it:leopardo}, a variedade animal é enorme.

É verdade que as etiquetas só são relevantes para o autor do texto (o LaTeX substitui-as por números, letras, ou o que for relevante).  Mas ainda assim é importante uma boa escolha das etiquetas.  Claro que se temos duas figuras e uma tabela, não faz diferença nenhuma.  Mas se tivermos 20 figuras, 10 tabelas, 30 equações e 20 listagens de código, a boa escolha das etiquetas pode evitar dúvidas sobre qual etiqueta corresponde a qual objeto.

Assim, as etiquetas devem sempre cumprir alguas regras, da quais saliento:
  1. Devem ter um prefixo a indicar o tipo de objeto:
    Objecto Prefixo Pref. Alternativo
    Figura fig: f:
    Tabela tab: t:
    Equação eq: e:
    Capítulo chap: c:
    Secção sec: s:
    Sub-secção ssec: ss:
    Sub-sub-secção sssec: sss:
    • • • • • • • • •
  2. Devem conter um sufixo que seja um bom indicador do conteúdo do objeto e, por exemplo, não fazer qualquer referência à numeração esperada do objeto. Deve-se também evitar caracteres não convencionais e acentuados. Por exemplo:
    Objecto Certo Errado
    Figura planeta_terra figura1
    Tabela relacao_custo_beneficio jshfhjeruehru
    Equação sin_x_plus_two cap1eq3
    Capítulo introducao introdução
    Secção problema _G_€_@_º_
    Sub-secção contribuicoes $%&/"()=#$
    Sub-sub-secção contribuicao_principal [vazio / não dar etiqueta]
    • • • • • • • • •

  3. O que restultará em etiquetas significativas e claras como:
    Objecto Etiqueta
    Figura fig:planeta_terra
    Tabela tab:relacao_custo_beneficio
    Equação eq:sin_x_plus_two
    Capítulo chap:introducao
    Secção sec:problema
    Sub-secção ssec:contribuicoes
    Sub-sub-secção sssec:contribuicao_principal
    • • • • • •
A generalidade dos editores de texto para LaTeX ajudam a completar o nome das etiquetas, i.e., quando escrevemos “\ref{” eles apresentam uma listas das etiquetas definidas, que pode ser bastante longa. Se tivermos uma boa política de prefixos para as etiquetas, ao escrever apenas o prefixo, limitamos imediatamente a lista ao universo dos objetos desse tipo.

Comentários

Mensagens populares deste blogue

Gráfico ou Tabela?

Capas de tese sem menção do júri

Modo 'draft' vs 'final'