5.9 Referencia de marcas de listas
Muchas secciones incluyen una lista de referencias a documentación de módulos
o a documentos externos. Estas listas se crean mediante el entorno
\seealso. Este entorno define varias macros más para permitir crear
referencias de manera razonable.
El entorno \seealso se coloca típicamente en una sección inmediatamente
anterior a las subsecciones. Se hace así para asegurar que los enlaces que
hagan referencia a esa sección no quedan ocultos en una subsección
en la salida en formato hipertexto de la documentación.
- \begin{seealso}
\end{seealso}
-
Este entorno genera un encabezado ``Consultar también:'' y define las marcas
utilizadas para describir referencias individuales.
En las macros a continuación, why debe ser una frase completa o más,
con la primera letra mayúscula (salvo que empiece por un identificador,
que no debería modificarse) y acabada en punto (o lo que corresponda).
Estas macros sólo están definidas dentro del contexto del entorno
\seealso.
- \seemodule
[key]{nombre}{why}
-
Referencia a otro módulo. why es una breve explicación
del interés de la referencia. El nombre del módulo viene dado por
name, con la clave del enlace, si ha lugar, en key.
En las conversiones a HTML y PDF, el nombre del módulo será un hipervínculo
al módulo aludido.
Nota: El módulo debe estar documentado en el mismo documento
(es necesario el \declaremodule correspondiente).
- \seepep
{número}{título}{why}
-
Referencia a una Propuesta de mejora de Python (PEP). número
debe ser el número oficial otorgado por el editor del PEP,
título es el título
legible de la PEP, tal como se encuentra en el original del documento.
why es una breve explicación del interés de la referencia.
Se debe usar para referir al lector a PEPs que especifican interfaces
o características del lenguaje relevantes.
- \seerfc
{number}{title}{why}
-
Referencia a una RFC del IETF. Análogo a \seepep.
Se usa para dirigir al lector a RFCs que especifican protocolos o formatos
de datos relevantes.
- \seetext
{texto}
-
Añade un texto arbitrario a la lista ``Consultar también:''.
Se puede usar para hacer referencia a materiales no electrónicos (o
electrónicos mediante la macro \url. Debe contener una o más
frases completas.
- \seetitle
[url]{título}{why}
-
Hace referencia a un documento externo denominado título.
Si se indica url, el título será un hipervínculo en la versión
en HTML del documento y se mostrará bajo el título en las versiones
en papel.
- \seeurl
{url}{why}
-
Las referencias a recursos electrónicos específicos deben hacerse
mediante la macro \seeurl. No se asocia un título a la referencia,
pero el texto why puede incluir un título marcado con
la macro \citetitle.
Ver Sobre este documento... para obtener información sobre sugerencias.
