5.10 Marcas para la generación de índices

La generación eficaz de índices para documentos técnicos puede resultar dificultosa, especialmente para los duchos en la materia técnica pero no en la creación de índices. Gran parte de la dificultad radica en la terminología: no basta con incluir los términos propios de expertos. Resulta bastante difícil encontrar los términos que van a buscar los novatos para un autor que, típicamente, es un experto en la materia sobre la que escribe.

La verdadera dificultad de la generación de índices no es algo en lo que las herramientas de documentación puedan ayudar. Sin embargo, facilitan la producción del índice una vez tomadas las decisiones sobre el contenido es tarea de estas herramientas. Se proporcionan marcas que el software de proceso es capaz de reconocer para generar diversos índices con el mínimo esfuerzo. Además, muchos de los entornos descritos en la sección , ``Unidades de información'', generan elementos correspondientes en el índice general y en el de módulos.

Se puede usar la siguiente macro en le preámbulo del documento para controlar la generación de datos de índice:

\makemodindex: Debe usarse en el preámbulo del documento si se desea obtener un ``Índice de módulos'' que contenga material de referencia de muchos módulos. Provoca la generación de un fichero de datos libjobname.idx a partir de las macros \declaremodule macros. El programa makeindex puede procesar este fichero para generar un fichero del que hacer \input desde el documento en la situación final del índice de módulos.

Existen varias macros útiles para añadir elementos de índice para conceptos particulares, muchos de los cuales son específicos de los lenguajes de programación y hasta exclusivos de Python.

\bifuncindex {nombre}: Añade un elemento de índice que se refiere a una función interna denominada nombre. No se deben incluir los paréntesis tras nombre.

\exindex {excepción}: Añade una referencia a una excepción denominada excepción.

\kwindex {palabra}: Añade una referencia a una palabra reservada del lenguaje (no a un parámetro de tipo clave de una llamada a función o método).

\obindex {tipo de objeto}: Añade un elemento de índice para un tipo de objeto interno.

\opindex {operador}: Añade una referencia a un operador, como "+".

\refmodindex [clave]{módulo}: Añade un elemento de índice para el módulo módulo; si módulo contiene un carácter de subrayado, debe proporcionarse el parámetro opcional clave, con un valor igual a módulo, sin los caracteres de subrayado. Se generará un elemento de índice ``módulo (módulo)''. Esta marca está orientada a su uso con módulos no estándar implementados en Python.

\refexmodindex [clave]{módulo}: Como \refmodindex, pero el elemento de índice será ``módulo (módulo de extensión)''. Esta marca está orientada a su uso con módulos no estándar no implementados en Python.

\refbimodindex [clave]{módulo}: Como \refmodindex, pero el elemento de índice será ``módulo (módulo interno)''. Esta marca está orientada a su uso con módulos estándar no implementados en Python.

\refstmodindex [key]{module}: Como \refmodindex, pero el elemento del índice será ``module (módulo estándar)''. Esta orientado a su uso con módulos estándar implementados en Python.

\stindex {statement}: Añade una entrada de índice para un tipo de sentencia, tal como print o try/finally.
XXX Need better examples of difference from \kwindex.

Se proporcionan más macros útiles para crear fácilmente elementos de índice que aparecerás en muchos lugares del índice rotando una lista de palabras. Éstas son macros simples que usan \index para construir elementos de índice. Los elementos de índice construidos mediante estas macros contienen texto principal y secundario.

\indexii {word1}{word2}: Generar dos elementos del índice. Equivale exactamente a \index{word1!word2} y \index{word2!word1}.

\indexiii {word1}{word2}{word3}: Generar tres elementos del índice. Equivale exactamente a \index{word1!word2 word3}, \index{word2!word3, word1}, y \index{word3!word1 word2}.

\indexiv {word1}{word2}{word3}{word4}: Generar cuatro elementos del índice. Equivale exactamente a \index{word1!word2 word3 word4}, \index{word2!word3 word4, word1}, \index{word3!word4, word1 word2}, y \index{word4!word1 word2 word3}.

Ver Sobre este documento... para obtener información sobre sugerencias.