Archivo de la categoría: Proyecto friki

Documentación para un proyecto con Markdown y Pandoc

Hablé el otro día de una plantilla para documentación que había ayudado a crear a mi hermano para su nuevo proyecto. Como me parece que hicimos un buen curro voy a hablar un poco más de ella, de las características que tiene y de cómo se usa.

La idea

La idea principal es separar el contenido del formato, de tal manera que se pueda escribir en un lenguaje de marcado ligero como es Markdown desentendiéndose por completo del aspecto, que se gestiona en una plantilla para Pandoc. Como la salida es un pdf, la plantilla está escrita en LaTeX, el paso intermedio mediante el cual Pandoc pasa de Markdown a pdf.

Otro tema es el de los metadatos, es decir, el autor, la licencia y otras opciones de control. Este tipo de datos los introducimos en un archivo aparte o en un bloque YAML al inicio del contenido. Así, también se desacoplan tanto del contenido como del formato.

Por último, Ekaitz quería poder crear un documento corto (al que llamaré artículo de ahora en adelante) o uno largo (libro) con la misma plantilla, cosa que hemos conseguido con unos $if$ estratégicamente colocados.

Seguir leyendo →

Curso no convencional de LaTeX: píntame ese código

En este episodio vamos a hablar de resaltado de sintaxis, es decir, vamos a aprender a darle formato al código fuente que hayamos insertado en nuestro documento con la idea de que sea más fácil de leer.

Hay varios paquetes que nos permiten pintar de colorines nuestro código, está listings que he usado bastante, minted que tenía ganas de aprender a usar y LGrind que descubrí al escribir esto. Voy a hablar de los dos primeros que son los que controlo y sobre LGrind investigáis si os gusta, igual hasta hay más por ahí.

Lo fácil: listings

El paquete listings se utiliza de manera similar al resto de paquetes que hemos visto hasta ahora: lo cargamos, establecemos sus opciones y luego utilizamos los comandos que nos proporciona en el cuerpo del documento.

Seguir leyendo →

Proyecto friki: ¡frikilibro secreto!

Os he hablado alguna vez de que tenía un proyecto secreto con mi señor hermano y ¿sabéis qué? ¡Hoy llega el día de desvelarlo! Redoble de tambores, por favor. Estamos escribiendo un libro. La idea es acercar las herramientas informáticas de las que solemos hablar en nuestros respectivos blogs a la gente. Pensad en Vim y Emacs, git, Markdown, regexp… este tipo de movidas. Que parece que no pero te hacen mucho más productivo. Os lo ilustro con un ejemplo personal: cuando envié mi artículo científico a la revista, descubrí que la plataforma no funcionaba bien si las imágenes no estaban en eps. Ahí tenía dos opciones, transformarlas una a una (me negaba rotundamente) o escribir un script1. Pues el script ese que escribí con mi hermano sirvió para que otra doctoranda en la misma situación no tuviera que transformar las imágenes una a una ¡Media hora de vida libre de trabajo repetitivo e inútil!

En fin, me centro. El libro está dividido en capítulos que se componen de artículos relativamente independientes sobre diferentes herramientas, libres todas ellas aunque en algún caso me temo que tendremos que citar alguna no libre. Como somos supermolones, estamos escribiendo el propio libro usando las técnicas y trucos que contamos para demostrar que funcionan. Evidentemente, liberaremos la fuente. Y para financiarnos probablemente cobraremos por la versión compilada.

Seguir leyendo →

Curso no convencional de LaTeX: un documento científico

Vamos a hablar del caso en el que LaTeX da lo mejor de sí mismo: un documento científico. Con esto me refiero a libros técnicos, tesis, artículos… ya me entendéis. No tienen por qué hablar necesariamente de ciencia, si me centro más en ellos es porque es mi campo.

La característica esencial de un documento científico es su formato rígido que en muchas ocasiones nos viene impuesto, ya sea por una revista o universidad o por las propias costumbres de nuestra disciplina. Por ejemplo, una tesis suele estar dividida en capítulos, debe tener referencias bibliográficas con un estilo determinado y se inicia con un índice general, uno de tablas y otro de figuras así como con un glosario de términos. También suele llevar un resumen del contenido al principio y se separa el trabajo adicional en apéndices. Todo esto implica diferentes formatos para las partes (numeración de las páginas y secciones, estilo de los encabezados…) y cierta planificación. Sin planificar se puede uno volver completamente tarumba, lo digo conocimiento de causa, el control de versiones me salvó más de una vez de romper la tesis sin remedio.

Es por ello que primero veremos cómo organizar el documento en cuestión y luego haremos un índice, un glosario y hasta unas lista de referencias.

Seguir leyendo →

Curso no convencional de LaTeX: el espacio en blanco

Seguimos investigando el formato en LaTeX. ¡Hoy moveremos las cosas por la página!


Como hemos visto en anteriores entregas, LaTeX gestiona el espacio en blanco él solito. Esto tiene varias implicaciones:

  • Le da igual que pongamos un espacio o sesenta y cuatro entre dos palabras, para él serán un único espacio.
  • Partirá las líneas donde mejor le venga a no ser que nosotros le obliguemos a hacerlo en un sitio determinado, dónde hayamos saltado de línea en el editor le da absolutamente igual. Lo mismo puede decirse de las páginas.

  • Dos trozos de texto que no estén separados por una línea en blanco pertenecerán al mismo párrafo a no ser que le digamos expresamente que no es así.

  • No pintará una línea en blanco a no ser que le digamos expresamente que lo haga por muchas líneas en blanco que tengamos en el editor.

Así visto parece que es malvado y que le gusta fastidiarnos, pero que él tome las decisiones de formato tiene la grandísima ventaja de que obtenemos un documento con pinta profesional con muy poco esfuerzo.

Seguir leyendo →

El porqué del curso de LaTeX

Hoy os voy a contar un poco del trasfondo del Curso no convencional de LaTeX, por qué empecé a escribirlo y qué supone para mí. No os preocupéis que pronto llegará la siguiente entrada, no todo va a ser hablar sobre mi vida.

Publiqué la idea de escribir un cursete de LaTeX el 13 de noviembre del año pasado, un mes después de terminar de escribir la tesis y un mes antes de defenderla. Fue un tiempo muy raro ese, estaba preparando la presentación, el ambiente en el trabajo era horrible y no sabía qué iba a hacer con mi vida. Es fácil entender que muy motivada no estaba.

Seguir leyendo →

Curso no convencional de LaTeX: la página

En el capítulo anterior estuvimos hablando de los diferentes estilos que le podemos dar al texto, ahora nos centraremos en el formato de la propia página.

La página

Vamos a ver cómo configurar cuatro cosas que los que venimos de editores tipo Libre Office echamos de menos: la alineación, el interlineado, los márgenes y la sangría. Va un spoiler:

There is a LaTeX package for it

Seguir leyendo →