Lección 16

Accediendo a la documentación y buscando ayuda

Esta lección muestra las principales fuentes de documentación relacionadas con el software y los paquetes de LaTeX, y cómo encontrar la solución a sus problemas.

Existen varias formas de acceder a la documentación de los paquetes y tipos de documento.

texdoc

Si ha instalado una distribution de TeX (por ejemplo TeXLive o MikTeX) y ha incluido la documentación durante la instalación, podrá acceder a la documentación guardada en su ordenador usando el comando texdoc en la línea de comandos. Por ejemplo:

texdoc < pkg >

le permitirá acceder a la documentación del paquete <pkg>. Esta herramienta buscará la documentación disponible y le mostrará la información de lo que más se aproxima a su búsqueda. Puede obtener la lista y elegir entre el conjunto de resultados posibles utilizando el comando de la siguiente forma:

texdoc -l < pkg >

texdoc.org

Éste es un sitio web que funciona de forma similar al comando textdoc. Puede buscar la documentación disponible tal y como lo haría usando el comando texdoc -l y elegir entre los resultados obtenidos.

CTAN (Comprehensive TeX Archive Network)

CTAN es una Red Integral de Achivos de TeX. La mayoría de paquetes de LaTeX se publican en este sitio web. Puede buscar un paquete y acceder a su documentación. Normalmente los paquetes se guardan en la dirección ctan.org/pkg/<pkg-name> y puede acceder al archivo README y a la documentación de los paquetes guardados en CTAN utiliando esta dirección.

Libros sobre LaTeX

Existen varios libros disponibles que pueden ayudarle a aprendar más sobre LaTeX. En principio, le será muy útil un manual pensado para principintes, ya que le dará muchós más detalles de los aspectos abordados aquí. Querrá igualmente tener acceso a un manual de referencia más detallado y a más recomendaciones.

El equipo de LaTeX dispone de una lista de libros escritos fundamentalmente por los miembros del equipo. Los más destacados son Lamport’s official guide y el detallado LaTeX Companion 3rd edition.

Otros libros dedicados al aprendizaje de LaTeX:

Obteniendo ayuda

Existen varios foros en línea en los que hacer preguntas sobre LaTeX; quizás el más popular actualmente es TeX - LaTeX StackExchange. Siempre que haga una pregunta, es mejor que primero clarifique su ejemplo: a esto se le conoce como un «mínimo ejemplo funcional» (MWE, «minimal working exemple»). Esto no significa que el código funcione (¡si así fuese, usted no haría la pregunta!), sino más bien que usted ha hecho lo posible por clarificarlo, debe ser completo y conciso. Este último termino significa mostrar unicamente el contenido necesario para entender el problema.

¿Como hacer un MWE? Normalmente, lo más fácil es empezar por:

\documentclass{article}
\usepackage[T1]{fontenc}
\begin{document}
Text
\end{document}

y añadir línea a línea hasta que muestre el problema encontrado. Puede intentar «recortar» o «reducir» su documento, pero esto puede ser un proceso largo.

Si necesita texto para mostrar saltos de página y otros efectos, use paquetes como lipsum con el fin de generar párrafos de texto de relleno, esto le permitirá mostrar un documento pequeño.

Una de las cosas que debe estar presente es el archivo log; este es creado por LaTeX cada vez que se ejecuta. Tiene el mismo nombre que su documento pero con la extensión .log. En función del sistema que utilice, quizás tenga que «mostrar las extensiones» de los archivos para encontrarlo.