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 →

Hacktibista

Estaba yo pasando el rato en las redes libres cuando vi un mensaje que captó mi atención:

Cuando en tu ska en vasco hay un intro con Richard Stallman 😂
https://youtu.be/XDhsPgh16WM?t=41m55s
— @piks3l@pouet.it

La canción en cuestión es Hacktibista de Gorka Suaia y Kimo Soundz:

Aparte de que hable Stallman en la intro, la letra merece mucho la pena así que decidí traducirla para que llegase a más gente. Hurgué un poco por ahí, me descargué el disco y vi que tenía licencia Creative Commons – Atribución – Compartir Igual (CC BY SA), lo que me pareció fantástico. ¡Pero no venía la letra! Así que se la pedí al artista por email y muy amablemente me la mandó en cuestión de minutos (Mila esker!)

¡Aquí tenéis la letra original y mi traducción!

Notas a la traducción

  • Quería que se entendiese el sentido más que nada, puede que no sea muy exacta en algunas partes.
  • El infinitivo y el imperativo son iguales en euskera lo cual es un lío. En general he traducido como imperativo para la segunda persona del singular porque entiendo que la canción va dedicada al hacktivista en cuestión.

  • La canción tiene muchas referencias, algunas no las he captado, si hay alguien con mayor cultura que nos ilumine le estaré eternamente agradecida (Ver nota 2)

Seguir leyendo →

Lo que he aprendido: registro de cambios en un documento LaTeX con git

Estoy echando una mano a mi hermano con una documentación to guapa para un tema que mejor os cuenta él y me preguntó cómo incluir un registro de cambios en el documento. Un registro de cambios no puede ser muy complejo de hacer si estamos usando git, pensé, así que me puse a investigar las diferentes alternativas, empezando por la opción evidente: git log.

Jugando con git log

Empecemos por los inicios, como todos los que usáis git sabéis mejor que yo, git log nos permite dar un formato al historial de commits con las opciones --pretty y --format. Por ejemplo, podemos mostrar la fecha y la descripción del commit haciendo:

git log --pretty=format:"%ad%x09%s" --date=short > cambios.log

Seguir leyendo →

Lo que he aprendido: la resolución y elementaryOS Freya

Hace tiempo que no la liaba petarda en el ordenador pero he vuelto a las andadas y todo por el programa de la renta. Menos mal que me sale (en teoría) a devolver que si no me iban a oír.

La cuestión es que mi portátil (¡el Slimbook!) tiene una pantalla muy pequeña (13.3″) para su resolución (1920 × 1080) y esto provocaba que el programa se viera enano. Muy enano, como se puede ver en la imagen, y no tiene ninguna opción de zoom:

zergabidea

Seguir leyendo →

Un estudio dice que

Un estudio dice que es bueno tomar un vaso de cerveza después de hacer ejercicio. Otro que el chocolate adelgaza. Resulta que han descubierto vida fuera del Sistema Solar. Y que se pierde la mayor parte del calor por la cabeza. Las típicas cosas que se oyen por ahí, que comenzaron siendo un titular que decía un estudio dice que y que han ido derivando. Pero, ¿fue eso que circula por ahí alguna vez verdad? En esta charlilla nos hablan de esas cosas, del publish or perish, de los programas gubernamentales y del papel de los medios en todo el asunto.

Tenemos que ser más escépticos, hermanos.

Más

Ni la cerveza cura ni el vino adelgaza en El Comidista

Cochrane

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 →

Camino a la panificación: otro pan integral

He hecho otro pan integral, muy parecido al pan de molde anterior pero en versión boliche. Lo principal es que cambiado las proporciones del prefermento porque el último era demasiado duro y, por lo tanto, he aumentado la harina de la masa final. ¡Por algún motivo creció una barbaridad!

Pan 100% integral

Se volvió gigantesco

Ingredientes


Direcciones

  1. Mezclé los ingredientes del prefermento y lo dejé unas 7h
  2. Le añadí el yogur, 150g de agua y la miel al prefermento, mezclé todo e incorporé la harina y la sal.
  3. Amasé y fui añadiendo poco a poco los 50g de agua adicional
  4. Dejé 2h 30′ fermentando, con un pliegue a la mitad
  5. Formé en bola y dejé fermentando otras 2h 30′
  6. Horneé en horno precalentado a 250º los 10 primeros minutos solo abajo. Luego, puse la resistencia superior, bajé la temperatura a 200ºC y lo tuve 20′ por último bajé a 180º y lo tuve otros 20′.