Apuntes mientras aprendo sobre software y computadoras.

Computación

Cómo hacer notas al pie y referencias utilizando Markdown y Pandoc

En este apunte rápido voy a revisar cómo hacer notas al pie y referencias dentro de un ensayo utilizando Markdown y Pandoc.

Para conseguir nuestro objetivo no necesitamos utilizar ningún plugin o complemento extra. Vamos a realizar nuestras referencias de la forma más rápida y directa que encontremos.

Ahora un poco de auto promoción desvergonzada: esta entrada es parte de mi serie sobre cómo escribir textos largos y ensayos académicos utilizando Neovim.

Aunque realmente no sea necesario utilizar Neovim para todo lo que sigue, cualquier programa para editar Markdown va a servirnos.

Por otra parte puede leerse más extensamente sobre el tema en este otro blog (en inglés).

Ahora sin más interrupciones…

Notas al pie en Markdown

Esta forma de hacer notas al pie en Markdown es la más rápida, y su sintaxis es la siguiente:

Esta es la primera oración que necesita referencia.[^1].
Segunda referencia[^2].

[^1]: Primer pie de página.
[^2]: Segundo pie de página.

Y cada referencia lleva su propio número, así que podemos agregar múltiples de ellas sin perdernos dentro del texto.

Hay algunos detalles más, pero esto es básicamente todo.

Este tipo de notas al pie sirve bastante bien para agregar más información en uno de esos ensayos universitarios que ponen un límite estricto de páginas para responder.

Referencias en Markdown utilizando Pandoc

Esta forma de crear referencias es la más práctica, porque nos permite utilizar bibliografías más grandes con múltiples fuentes.

La realidad es que el tema es bastante extenso, voy a hacer todo lo posible para reducirlo a sus pasos prácticos.

Paso 1: crear un archivo “.bib”

Este tipo de archivo contiene la bibliografía, en mi caso digamos que el archivo se llama:

bibliografia.bib

Y dentro del archivo agrego los datos de los textos a citar. Por un ejemplo posible de esto:

@libro{ensayo:1,
AUTHOR="Gustavo Impensado",
TITLE="Ejemplos para mi Blog",
PUBLISHER="Editorial Apuntes",
YEAR="2005",
}

Paso 2: Crear (o descargar) un archivo “.csl”

La sigla “CSL” viene por “Cytation Style Language” o en mi propia traducción al castellano “Estilo para el lenguaje de cita”.

Es una forma de automatizar y darle formato al estilo de las citas.

Para este ejemplo vamos a usar el tipo “Chicago Manual of Style.” que nos va a dar un resultado similar a este:

Impensado, Gustavo. Ejemplos para mi Blog. Editorial Apuntes, 2005.

Podemos encontrar los estilos siguiendo este enlace.

O también podemos encontrar más estilos en este repositorio del software Zotero.

Descargamos el archivo y lo guardamos en el directorio dónde vamos a usarlo. En mi caso voy a ponerle por nombre al archivo:

chicago_style.csl

Paso 3: Especificar el archivo “.csl” y el “.bib” en el documento de markdown

Dentro de nuestro documento en Markdown agregamos la siguiente cabecera:

---
title: "Título_del_ejemplo"
bibliography: bibliografia.bib
csl: chicago_style.csl
---

Si las referencias de la bibliografía y el archivo de estilo se encuentran en la misma carpeta que nuestro documento, no es necesario señalar completo el camino hacia los directorios.

Paso 4: Hacer la referencia a la bibliografia en el texto

Ahora estoy dentro de mi documento en markdown. De esta forma hago la referencia dentro del texto, de la misma forma que antes:

Esta oración necesita una referencia.[^1].

Pero al final del ensayo ahora hago un llamado a la bibliografía “.bib”, mencionando directamente la referencia en la forma en que la puse en ese archivo. Por ejemplo:

[^1]:  [@ensayo:1]

Puedo de esta forma utilizar muchas referencias, por ejemplo en este caso puedo tener: [@ensayo:1], [@ensayo:2]…

El contenido completo en mi caso para el archivo “ejemplo.md” es de esta forma:

---
tittle: "Título del ejemplo"
bibliography: bibliografia.bib
csl: chicago_style.csl
---

Esta oración necesita una referencia.[^1]

## Bibliografía
[^1]: [@ensayo:1]

Paso 5: Convertir el archivo de Markdown utilizando Pandoc

Para exportar el resultado final tenemos que tener instalado Pandoc en nuestro sistema, una herramienta para convertir archivos desde la terminal de comandos.

Vamos a necesitar instalar tambien la siguiente herramienta:

sudo apt install pandoc-citeproc

Luego para conseguir exportar el archivo por ejemplo a “.odt” puedo utilizar el comando:

pandoc ejemplo.md -f markdown -t odt 
--bibliography=bibliografia.bib --csl=chicago_style.csl -s -o ejemplo.odt

Y con eso voy a exportar mi documento “.odt” (para LibreOffice Writer) completo con la bibliografía al final.

El resultado va a ser que tengo la referencia bibliográfica al final del texto (en su propio “subheading”) y también la referencia más corta en la nota al pie.

Conclusión:

Con esto termino el apunte sobre cómo hacer notas al pie y referencias utilizando Markdown y Pandoc.

¿Te fue útil la información? ¿Encontraste algún error? Podemos escribirme un correo con tu opinión, mi email se encuentra en la página de contacto.

La seguimos en el próximo apunte.

Leave a Reply