Tutorial de DocBook: Un enfoque integrado y a través de ejemplos | ||
---|---|---|
Anterior | Capítulo 4. Usando opciones más avanzadas | Siguiente |
Un glosario es una parte del documento en la cuál se dá la definición de algunos de los conceptos usados en él. Usualmente los glosarios se ubican al final del documento, por ello la marquilla glossary va usualmente después del último capítulo. A continuación presentamos un ejemplo de un glosario.
<glossary> <glossentry id="doc"> <glossterm><acronym>DocBook</acronym></glossterm> <glossdef> <para>Lenguaje de marcado definido en <acronym>SGML</acronym>que permite escribir documentación técnica</para> </glossdef> </glossentry> <glossentry id="em"> <glossterm>emacs</glossterm> <glossdef> <para>Editor de amplio uso en <acronym>unix</acronym>. Su nombre proviene de Editor MACroS (Macros de Edición). </para> </glossdef> </glossentry> </glossary> |
Aquí básicamente declaramos declaramos un glosario usando la marquilla glossary y cada una de los items de dicho glosario se declara usando glossentry, dichos items consisten en esencia de un término (glossterm) y una definición (glossdef). Notemos que cada una de los items de este ejemplo tienen un identificador, esto es útil en caso de que uno quiera remitir al glosario para la definición de algún termino.
Adicionalmente a la definición del glosario es usual denotar cuando una palabra está en un glosario o cuando es la primera ocurrencia de un término en una obra, para ello son útiles las marquillas firstterm y glossterm respectivamente. Dichas marquillas pueden contener o no un enlace a su respectiva definición, utilizándose para ello el atributo linkend. En este caso dicho atributo se hace igual al identificador correspondiente a la definición del término en el glosario. A continuación presentamos dos ejemplos de dicha situación, el primero con enlace y el segundo sin él.
<para><firstterm linkend="doc"><acronym>DocBook</acronym></firstterm> es un lenguaje de marcado, que permite escribir documentación técnica, nacido en 1991.</para> |
<para>Para invocar a <glossterm><acronym>emacs</acronym></glossterm>, basta hacer lo siguiente desde una línea de comandos</para> |
Un índice contiene un conjunto de referencias a las ocurrencias de palabras claves dentro de un documento, por ende el paso básico en la creación de un índice corresponde en señalar los sitios donde se encuentran dichas palabras através de la marquilla indexterm, como lo muestra el siguiente ejemplo
<para>A continuación mostramos una tabla con algunas de las marquillas <indexterm> <primary>marquillas</primary> </indexterm> más usadas </para> |
Es de notar el uso de primary que indica que la primer palabra clave del índice es en este caso marquillas. Uno puede usar secondary en caso de querer refinar mejor la clasificación del índice como a continuación
... </table> <indexterm> <primary>marquilla</primary> <secondary>book</secondary> </indexterm> <indexterm> <primary>marquilla</primary> <secondary>chapter</secondary> </indexterm> |
Un atajo de teclado que puede ser útil a la hora de generar índices, es mientras se señala la palabra clave que uno quiera incluir en el índice usar Control+c x. Esto generará una entrada de índice como la descrita en el primer ejemplo de índices
La generación de dichos índices se describe con detalles extensos en este página de Norman Walsh, sin embargo si usted quiere saltarse un poco los detalles técnicos puede seguir las instrucciones que se dan en la sección de nombre Automatización usando Makefiles