Article Boilerplate

Entorno de producción de literatura académica y documentación técnica con Pandoc como interprete y LaTeX como sistema de composición tipográfica.
Generación gráficos, diagramas y notación matemática; gestión de citas, referencias cruzadas y bibliografía.
Evitando el uso de interfaces gráficas y captivas.

Keywords: authoring, plain text, CLI, pandoc.

Contenidos

1. Introducción: Markdown, Pandoc, TUI.
2. Integración: Árbol de sintaxis abstracta. Gráficos y diagramas. Citas, referencias y bibliografía. Notación matemática.
3. Resultados: Pandoc's Markdown. Biblografia y referencias cruzadas.
4. Conclusión: Futuras lineas de trabajo: Entrega Continua y SMS.
5. Agradecimientos.
6. Referencias.

1. Introducción

• Markdown
• Pandoc
• Interfaz Textual de Usuario Interfaces Captivas

Markdow

Sintaxis de formato de texto plano y herramienta de software,
escrita en Perl, que convierte el formato de texto plano en HTML.

Pandoc

..Biblioteca de Haskell (y CLI tool) para convertir de un formato de marcado ligero a otro.

Fuente: Formatting Open Science: agilely creating multiple document formats for academic manuscripts with Pandoc Scholar

Interfaz Textual de Usuario Interfaces Captivas

... nuestro material base no es la madera ni el hierro, es el conocimiento. [...] el mejor formato para almacenar el conocimiento de forma persistente es el texto plano. [...] nos da la posibilidad de manipular el conocimiento, tanto manual como programáticamente, utilizando prácticamente cualquier las herramientas a nuestra disposición.

(Hunt, 1999)

Interfaz de texto (Text User Interface - TUI)

• Ubicuo: Todos los sistemas operativos cuenta con al menos un editor de texto plano.
• Fácil de manipular, mantener y comprobar: Procesos rudimentarios. No presenta dificultades ante la necesidad de actualización. Es sencillo agregar rutinas de testeo sin emplear o desarrollar herramientas especiales.
• Liviano: Determinante cuando los recursos de sistema son limitados.
• No queda obsoleto: Perduran por sobre otros formatos, aun cuando caduquen las aplicaciones que las hayan creado.

2. Integración

• Parser
• Árbol de sintaxis abstracta.
• Escritores
• Gráficos y diagramas. Citas, referencias y bibliografía.
  Notación matemática.

Lectores

AKA Parser

Árbol de sintaxis abstracta

Fuente: twilio.com/blog/abstract-syntax-trees

Escritores

Matplotlib y PlantUML con pandoc-plot.

Ejemplo MatplotLib

Referencias cruzadas, gestion de biblografía y estilo de citado.

Declarar una referencia como @moolenaar2000 o también [@knuth1986texbook p.3-9].

Pandoc convertirá la bibliografia BibLaTeX en una cita, añadirá la referencia bibliográfica al final del documentos.
Estilizadas con el formato predefinido mediante Lenguajes de Estilo de Cita (Citation Style Language - CSL), incluyendo estilos de: nota al pie, numéricos y autoría, fuente y fechas.

Notación matemática

Declarar: $\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$ para mostrar en modo inline o modo bloque: $$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$$ para mostrar:

3. Resultados

Veamos la fuente

Entrada en MarkDown

Veamos el documento

Salida en PDF

4. Conclusión

• Aporte
• Futuras lineas de trabajo
  • Entrega Continua
  • SMS

Aporte

Una cadena de producción de documentos científicos y técnicos sin depender de interfaces gráficas o captivas.

Las características generales de este entorno son:

• Formatos libres y abiertos, componentes aislados, compactos y robustos.
• Amplia compatibilidad con requisitos de estilo, predefinidos por la comunidad o personalizados por el usuario.
• Vinculación a fuentes de datos remotas para publicaciones recurrentes con información dinámica.

Futuras lineas de trabajo

• Entrega Continua
• Revisión sistemática de literatura

Entrega Continua

La salida puede ser producido mediante operaciones remotas automáticas.

Los servicios de entrega continua compilan los cambios incrementales en el contenido de los autores, los enlazan, los empaquetan y los ejecutan en un entorno remoto preconfigurado.Servicios como estos acortan las brecha entre las actividades y los equipos de producción, al imponer la automatización en la construcción y entrega de documentos.

Reutilizar este trabajo

Despues de "forkear" el proyecto:

Modificar el contenido y realizar un commit.

Revisión sistemática de literatura

Este proceder promueve capacidades como: ordenación personalizable, bibliografías jerarquizadas por sección, soporte de poliglosia para el cambio automático de idioma de las entradas y citas bibliográficas; modelo de datos bibliograficos personalizable para que los usuarios puedan definir sus propios y validar con respecto a un modelo.

En revisiones de literatura tipo estudio de mapeo sistemático, donde se involucran múltiples cuerpos bibliográficos con diferente ordenación y exposición, enfoques como el desarrollado simplifican el trabajo y asisten en el proceso.

¡Gracias!

¿Preguntas?

Pull Requests bienvenidos: github.com/lifofernandez/article-boilerplate

5. Referencias

• W. Caleb McDaniel, «Why (and how) I wrote my academic book in plain text», W. Caleb McDaniel. Disponible en: http://wcaleb.org/blog/myacademic-book-in-plain-text
• J. MacFarlane, «Pandoc - a universal document converter», Pandoc - a universal document converter. 2022. Accedido: 14 de septiembre de 2022.
  .En línea. Disponible en: https://pandoc.org/
• D. E. Knuth, D. Knuth, y D. Bibby, The TeXbook. Addison-Wesley, 1986. Disponible en: www-cs-faculty.stanford.edu/~knuth/abcde.html
• M. Gancarz, Linux and the Unix Philosophy. Elsevier Science, 2003. Disponible en: https://books.google.com.ar/books?id=qqstCSlk5MIC
• A. Hunt y D. Thomas, The Pragmatic Programmer: From Journeyman to Master. Pearson Education, 1999. Disponible en: https://books.google
  .com.ar/books?id=5wBQEp6ruIAC
• D. A. S. U. Harvard, «Use plain language», Digital Accessibility. Digital Accessibility Services. Disponible en: https://accessibility.huit.harvard.edu/use-plain-language
• B. Moolenaar, «Seven habits of effective text editing». moolenaar.net, 2000. Disponible en: moolenaar.net/habits.html
• B. Baumer y D. Udwin, «R Markdown», Wiley Interdisciplinary Reviews: Computational Statistics, vol. 7. Wiley, pp. 167-177, febrero de 2015. doi:
  10.1002/wics.1348.
• R. Scape, «Text Is the Universal Interface». 2022. Disponible en: https: //scale.com/blog/text-universal-interface
• 10 S. Marlow et al., «Haskell 2010 language report». 2010. Disponible en: http://www.haskell.org
• J. Jones, «Abstract Syntax Tree Implementation Idioms», Pattern Languages of Program Design, 2003, Disponible en: http://hillside.net/plop/plop2003/Papers/Jones-ImplementingASTs.pdf
• I. Neamtiu y I. Bind, «Understanding source code evolution using abstract syntax tree matching», 2005, pp. 2-6.
• J. Gruber, «Markdown: Syntax», Daring Fireball: Markdown Syntax Documentation. Disponible en: https://daringfireball.net/projects/markdown/syntax#philosophy
• L. R. de Cotret, «Pandoc Plot». 2019. Disponible en: https://laurentrdc .github.io/pandoc-plot
• D. F. Hunter John; Dale y T. M. development team, «Matplotlib: Visualization with Python». 2013. Disponible en: https://matplotlib.org/
• A. Roques, «PlantUML Generate UML diagram from textual description». 2013. Disponible en: https://plantuml.com/