Nicolás' blog (Publicaciones sobre escritura)

Usando MixTex con LaTeX Workshop en Windows

Nicolás Guarín-Zapata — Fri, 23 Sep 2022 17:00:00 GMT

Este es un post para mencionar cómo configurar Visual Studio Code para LaTeX—a través de la extensión LaTeX Workshop—.

En el pasado, he utilizado varios editores de texto y para LaTeX. Hace un par de años sustituí TeXstudio por VS Code, y creo que funciona muy bien. Visual Studio Code es uno de los IDE más usados ahora mismo. Una ventaja de usar VS Code para escribir tus documentos es que puedes configurarlo para adaptarse a tu flujo de trabajo y utilizarlo para varios lenguajes/propósitos. También es multiplataforma, no tendrás que preocuparte por tener diferentes flujos de trabajo en Linux o Windows.

Necesitas seguir estos pasos para hacerlo funcionar:

Instala Perl. Puedes utilizar Strawberry Perl en Windows.
Si no tienes privilegios de administrador puedes instalar la versión portable y añadir la ruta al ejecutable a la variable de entorno PATH.
Instala MikTeX. El creador de LaTeX Workshop sugiere usar TeX Live en su lugar porque ya viene con Perl y podrías saltarte un paso de esta lista. Las desventajas de usar TeX Live en lugar de MikTeX son más (vea aquí).
Instala LaTeX Workshop.

Referencias

Cangemi, Denis. “The Reasons Why You Must Use Visual Studio Code.” Medium, 13 de agosto de 2020, https://blog.devgenius.io/the-reasons-why-you-must-use-visual-studio-code-b522f946a849.
Wright, Joseph. “TeX on Windows: TeX Live versus MiKTeX Revisited.” Some TeX Developments, 18 de diciembre de 2016, https://www.texdev.net/2016/12/18/tex-on-windows-tex-live-versus-miktex-revisited/.

Escritura técnica: usando figuras

Nicolás Guarín-Zapata — Wed, 03 Nov 2021 17:53:40 GMT

En una publicación anterior mencioné algunos aspectos generales de la escritura técnica. En este me gustaría hablar sobre la inclusión de figuras en documentos técnicos.

Formatos de gráficos

Primero, debo mencionar que hay dos tipos principales de gráficos, a saber:

gráficos vectoriales; y
gráficos de mapa de bits.

Sirven para diferentes propósitos y deberíamos usarlos teniendo esto en cuenta. Por ejemplo, para diagramas o esquemas es mejor utilizar formatos vectoriales, en general. Por otro lado, los formatos ráster son más adecuados para imágenes como fotografías o ilustraciones.

Gráficos vectoriales

Una imagen vectorial es una imagen que está conformada por entidades geométricas. En este caso, la información almacenada no es punto a punto sino la construcción de las formas que la conforman. Por esta razón, estas imágenes no se pixelan ya que que la información con la que se cuenta es de cómo se construye. Este tipo de imágenes es la mejor opción para esquemas y diagramas, ya que sólo se almacenaría la información de trazos y texto. El estándar de facto para este tipo de imágenes es PDF—este es el tipo que uso en mis documentos de \(\LaTeX\)—. Aunque PDF es el estándar, mi formato preferido es SVG (Scalable Vector Graphics) que es un estándar a través de internet y que se puede renderizar en la mayoría de navegadores modernos.

Gráficos ráster

Una imagen ráster es una imagen que está representada por un arreglo (o rejilla rectangular) de píxeles. En otras palabras, la información del color que hay en cada uno de los puntos de la imagen. Los formatos más populares almacenan la información de forma comprimida. Para gráficos de alto contraste (como esquemas o diagramas) el mejor formato es PNG. Si se tienen animaciones, sería preferible usar GIF. Y en el caso de fotografías es mejor usar JPG.

Resumen para los formatos

Resumiendo, deberíamos usar imágenes JPG (solo) para fotografías y SVG para esquemas/diagramas. Otro atributo que puede resultar útil es la gestión de capas. Tener varias capas brinda la opción de apilar diferentes tipos de información por separado. Por ejemplo, puede tener el fondo, la imagen y las anotaciones en diferentes capas. De esta forma se puede modificar sólo la parte de la figura de interés. Se puede automatizar la traducción de las anotaciones de esta manera sin muchos problemas. Los formatos como SVG permiten tener varias capas. En el caso de los formatos ráster, tenemos la opción de utilizar TIFF.

En cuanto al software para generar/editar este tipo de imágenes debo decir que existe una gran cantidad de programas que permiten exportar a estos formatos: Python/Matplotlib, Matlab, Inkscape, Adobe Illustrator, GIMP, Photoshop, LibreOffice. Si el gráfico se genera a partir de un cálculo o una serie de datos, uso Matplotlib. Si, en cambio, queremos hacer un esquema, mi herramienta de elección es Inkscape. Este programa está destinado a ser una alternativa gratuita a programas como Adobe Illustrator, y lo logra. Obviamente, se puede usar Illustrator o Corel Draw para esto. Si el único uso es hacer esquemas técnicos, creo que sería un desperdicio.

Diseñando figuras para documentos

Mi sugerencia es partir del tamaño nominal de la figura del documento. Para la mayoría de nuestros documentos, las cifras seguirán siendo digitales y esto puede parecer contradictorio. Sin embargo, encuentro este enfoque mucho más fácil. Una de las razones es que todavía incrustamos nuestra figura en un documento con un tamaño nominal. Además, a la hora de pensar en el tamaño de la fuente es habitual que tengamos como referencia el texto impreso. Además de eso, debemos considerar que el ojo humano tiene un límite de resolución, por lo que no podemos simplemente reducir nuestras figuras.

Además, no existe la resolución de una imagen digital. La resolución se refiere a una densidad de píxeles por unidad de longitud. Esto tiene sentido al imprimir imágenes, pero no en el caso digital. Sin embargo, las figuras tienen un tamaño nominal y, por lo tanto, una resolución nominal. Es decir, el número de píxeles en una dirección dividido por su tamaño nominal. Es una buena idea considerar una resolución mínima de 150 ppp (puntos por pulgada). Por ejemplo, una imagen de 6 × 3 pulgadas. Esta imagen tendría un tamaño de (a 150 ppp) de 900 px × 450 px.

El siguiente código de Python crea una figura de tamaño 6 in × 3 in, y grafica la función \(f(x) = \sin(x^2)\) y la guarda como una imagen de tamaño 900 in × 450 in.

import numpy as np
import matplotlib.pyplot as plt
x = np.linspace(0, 2*np.pi, 500, linewidth=2)
y = np.sin(x**2)
plt.figure(figsize=(6, 3))
plt.plot(x, y)
plt.xlabel("x", fontsize=10)
plt.ylabel("y", fontsize=10)
plt.savefig("fig_ex_python.png", dpi)

Y el siguiente código de Matlab.

fig = figure(1);
fig.Units = 'inches';
fig.Position(3:4) =  [6 4];
x = linspace(0, 2*pi, 500);
y = sin(x.^2);
plot(x, y, 'LineWidth', 2);
xlabel('x', 'FontSize', 10)
ylabel('y', 'FontSize', 10)
set(fig, 'PaperSize', [6,4]);
print(fig,'fig_ex_matlab', '-dpng', '-r150');

A continuación resumo algunos tamaños para artículos, pósters y diapositivas.

Artículos

Para un artículo es común usar tamaño carta que es 8.5 in × 11 in (215.9 mm × 279.4 mm). Otro formato común es A4 que es 210 mm × 297 mm (8.27 in × 11.7 in).

Una guía para tamaños comunes es la siguiente:

ancho de 1.0 columna: 90 mm (3.5 in);
ancho de 1.5 columna: 140 mm (5.5 in);
ancho de 2.0 columna: 190 mm (6.5 in);

y se muestra en la siguiente imagen.

Si consideramos una resolución de 300 ppi, tenemos los siguientes números de píxeles horizontalmente

ancho de 1.0 columna: 1050 píxeles;
ancho de 1.5 columna: 1650 píxeles; y
ancho de 2.0 columna: 1950 píxeles.

Tenga en cuenta que un monitor HD tiene 1920 píxeles en la dirección horizontal. Esto significa que se necesita un monitor HD para ser capaz de ver tanto píxeles.

Respecto al tamaño del texto, es común tener tamaños entre 8 y 12 pts para figuras.

Pósters

En el caso de papel tamaño A0 (841 mm × 1189 mm, 33 in × 47 in) los tamaños serían algo como:

ancho de 1.0 columna: 360 mm (14 in);
ancho de 1.5 columna: 560 mm (22 in); y
ancho de 2.0 columna: 760 mm (26 in).

Tenga en cuenta que un póster puede que no encaje tan bien en el formato de dos columans. Sin embargo, creo que la referencia sigue siendo útil.

Respecto al tamaño dl texto en pósters es una buena idea mantenerlo por encima de 24 pts (ver referencia 3).

Diapositivas

En el caso de diapositivas hay dos relaciones de aspecto comunes 16:9 y 4:3. Además, diferentes programas usan diferentes tamaños nominales. La siguiente tabla muestra los tamaños nomiales para LibreOffice Impress, MS Power Point y LaTeX usando Beamer.

	16:9	4:3
LibreOffice Impress	11.02 in × 6.20 in	11.02 in × 8.00 in
MS Power Point	13.32 in × 7.50 in	10.00 in × 7.50 in
LaTeX (Beamer)	16.00 cm × 9.00 cm	12.80 cm × 9.60 cm

Historial de actualizaciones

[Mayo 20, 2025]: Añadir tamaños nominales de LaTeX.

Referencias

Matthew Butterick (2019). Butterick's Practical Typography. Segunda edición, Matthew Butterick.
Rougier, Nicolas P., Michael Droettboom, y Philip E. Bourne (2014). “Ten Simple Rules for Better Figures.” PLOS Computational Biology 10(9):e1003833. DOI: 10.1371/journal.pcbi.1003833.
Erren, Thomas C., y Philip E. Bourne. 2007. “Ten Simple Rules for a Good Poster Presentation.” PLOS Computational Biology 3(5):e102. DOI: 10.1371/journal.pcbi.0030102
Elsevier. (n.d.). "Artwork Overview." Fecha de acceso: Noviembre 1, 2021, de https://www.elsevier.com/authors/policies-and-guidelines/artwork-and-media-instructions/artwork-overview
Elsevier. (n.d.). "Artwork sizing." Fecha de acceso: Noviembre 1, 2021, de https://www.elsevier.com/authors/policies-and-guidelines/artwork-and-media-instructions/artwork-sizing
Journal of applied physics (n.d.). "Preparing Your Manuscript: Authors Instruction." Fecha de acceso: Noviembre 1, 2021, de https://aip.scitation.org/jap/authors/manuscript
Werner. (2012). Respuesta a «Proper page size for slides» [En línea]. TeX - LaTeX Stack Exchange. https://tex.stackexchange.com/a/75651

Escritura técnica

Nicolás Guarín-Zapata — Thu, 28 May 2020 20:53:40 GMT

Esta es la primera publicación sobre redacción técnica [*] de una serie que crearé poco a poco. La escritura técnica es algo con lo que la mayoría de nosotros tenemos que lidiar en diferentes contextos. Por ejemplo, en cursos universitarios, publicaciones de investigación, documentación de software. La idea principal de la serie es mencionar algunos de los trucos que he aprendido a lo largo de los años y algunas herramientas que pueden ser útiles.

Las publicaciones futuras serán (probablemente) sobre:

Uso de ecuaciones;
Uso de figuras;
Uso de tablas; y
Gestión de referencias bibliográficas.

Esta publicación

Como se mencionó anteriormente, la escritura técnica es algo con lo que muchas personas tienen que lidiar. Esta es una habilidad que a veces se pasa por alto, pero no debería. De acuerdo con la U.S. Bureau of Labor Statistics

Los redactores técnicos preparan manuales, guías prácticas, artículos de revistas y otros documentos de respaldo para comunicar información compleja y técnica con mayor facilidad.

Y es una habilidad deseada en el lugar de trabajo. Se espera que su demanda crezca alrededor del 10% en la década actual.

Tipografía

Lo primero que debo mencionar es que escribir documentos es tipografía ya que estamos diseñando con texto (Butterick, 2019). Por lo tanto, deberíamos considerarnos tipógrafos, ya que constantemente diseñamos documentos.

Sugeriría echar un vistazo a "Butterick's Practical Typography" ya que es un libro muy bueno sobre el tema y es fácil de leer. Voy a mencionar algunos puntos importantes de acuerdo con la sección "Tipografía en diez minutos":

La selección tipográfica más importante está en el cuerpo del texto. Esto se debe al hecho de que es la mayor parte del documento.
Elija un tamaño de texto entre 10-12 puntos para documentos impresos y 15-25 píxeles para documentos digitales.
El espacio entre líneas debe estar entre 120-145% del tamaño de la letra.
La longitud de la línea debe tener entre 45 y 90 caracteres. Esto es aproximadamente 2 o 3 alfabetos en minúsculas:

abcdefghijklmnñopqrstuvwxyzabcdefghijklmnñopqrstuvwxyzabcd
Cuidado con la selección de su fuente. Intente evitar las fuentes predeterminadas como Arial, Calibri o Times New Roman.

Editores

Otro punto que quiero tocar en esta publicación es el de los editores. La primera pregunta que surge es "¿qué editor debo usar?". La respuesta corta es: usa lo que tus colegas estén usando. Ese es mi mejor consejo; de esa manera tienes personas con quienes hablar sobre tus dudas.

La respuesta larga ... es que cada editor tiene sus puntos débiles y fuertes. Yo he escrito artículos científicos en LaTeX, LibreOffice Writer y MS Word; todos se ven profesionales. Entonces, al final, puedes escribir tu documentos de varias maneras y lograr un resultado similar. Yo prefiero usar LaTeX para documentos largos, ya que se centra en la estructura del documento en lugar de la apariencia y esta es la forma en que uno debe administrar un documento largo como una disertación, en mi opinión.

Si solo quieres que elija un editor y te lo sugiera, diría que LibreOffice. Una buena referencia es "Designing with LibreOffice". Una vez que aprendas cómo usar estilos, preguntarás cómo has estado escribiendo todos los documentos hasta ahora.

Hay dos grupos de editores que voy a discutir: WYSIWYG (siglas en inglés para "Lo que ves es lo que obtienes") y editores basados en marcado.

WYSIWYG. Esta categoría es la que la mayoría de la gente conoce. Dos ejemplos son:
- LibreOffice Writer; y
- Microsoft Word.
Los editores basados en marcado dependen de las marcas en el "texto" para diferenciar secciones y estilos. En este caso, su texto parece código, como se ve en la siguiente imagen

Algunos ejemplos son:
- LaTeX;
- Markdown; y
- reStructuredtext.

Independientemente de cuál sea tu editor principal, sugiero utilizar Pandoc. Te permite convertir entre varios formatos, haciendo el proceso un poco más fácil. Incluso hay un editor basado completamente en él llamado Panwriter.

References

Matthew Butterick (2019). Butterick's Practical Typography. Segunda edición, Matthew Butterick.
Wikibooks contributors. (2020). LaTeX. Wikibooks, The Free Textbook Project.
Bruce Byfield (2016). Designing with LibreOffice. Friends of OpenDocument, Inc.
Deville, S. (2015). Writing academic papers in plain text with Markdown and Jupyter notebook. Sylvain Deville.
Eric Holscher (2016). An introduction to Sphinx and Read the Docs for Technical Writers.

Escritura técnica: usando matemáticas

Nicolás Guarín-Zapata — Thu, 28 May 2020 20:53:40 GMT

En una publicación anterior mencioné algunos aspectos generales de la escritura técnica. En este me gustaría hablar sobre la inclusión de expresiones matemáticas en documentos técnicos.

Hay dos formas principales de incluir matemáticas en documentos:

utilizando texto; y
utilizando una interfaz gráfica.

Usar una interfaz gráfica, como el editor de ecuaciones en LibreOffice Writer o MS Word, o MathType es conveniente. No es necesario memorizar nada y se pueden mirar las expresiones mientras se crean. Sin embargo, puede ser algo lento en comparación con el uso de entrada de texto —una vez que se está cómodo con la sintaxis—.

Hay dos tipos de ecuaciones utilizadas en Internet:

MathML es un estándar W3C para ecuaciones y está incluido en HTML5, por lo que funcionaría en todos los navegadores modernos. El problema con este es que no está diseñado para ser escrito a mano. Por tanto, uno puede usarlo si tiene alguna forma automática de generar el código.
LaTeX es mi forma sugerida de escribir ecuaciones. La curva de aprendizaje podría ser un un poco empinada al principio pero vale la pena.

Una herramienta que ayuda con las ecuaciones es MathPix Snip que genera automáticamente código LaTeX o MathML a partir de una imagen, incluso una escrita a mano. Otra herramienta que es realmente útil es Detexify que permite dibujar un símbolo y proporciona la sintaxis de LaTeX de este.

En el resto de la publicación mostraré mis sugerencias para trabajar con ecuaciones en LibreOffice y MS Word. Si estás utilizando LaTeX o MarkDown/ReStructuredText para tus documentos ya estás utilizando LaTeX para tus ecuaciones.

LibreOffice

LibreOffice tiene su propio editor de ecuaciones con su propia sintaxis y funciona bien para expresiones pequeñas, pero se complica para ecuaciones grandes o largas manipulaciones algebraicas. Para LibreOffice sugeriría usar TexMaths, es fácil de usar y funciona para el procesador de textos (Writer) y presentaciones (Impress). Supongo que también funciona para hojas de cálculo (Calc), pero no recuerdo haber usado ecuaciones en una.

MS Office

MS Office también tiene su propio editor de ecuaciones, funciona bien y es fácil de usar. Sin embargo, el mismo problema aparece cuando quieres expresiones largas. Una opción es usar directamente LaTeX en Office pero prefiero usar IguanaTex. Es un complemento que permite ingresar ecuaciones de forma similar a TexMaths en LibreOffice.

También puede pegar directamente las ecuaciones MathML en MS Word (>2013 y Windows).

Usa SymPy

Independientemente de la herramienta que use para escribir sus documentos, sugiero usar un CAS (del inglés Computer Algebra System), como Mathematica o SymPy. Estos programas permiten la generación automática de LaTeX y MathML a partir de expresiones y esto facilita mucho el proceso.

Veamos un ejemplo. Supongamos que tenemos la función

\begin{equation*} f(x) = \exp(-x^2) \sin(3*x) \end{equation*}

y queremos calcular su segunda derivada

\begin{equation*} f''(x) = \left(- 12 x \cos{\left(3 x \right)} + 2 \left(2 x^{2} - 1\right) \sin{\left(3 x \right)} - 9 \sin{\left(3 x \right)}\right) e^{- x^{2}} \end{equation*}

El siguiente bloque de código nos da el código LaTex

from sympy import *
init_session()
f = exp(-x**2)*sin(3*x)
fxx = diff(f, x, 2)
print(latex(fxx))

que es

\left(- 12 x \cos{\left(3 x \right)} + 2 \left(2 x^{2} - 1\right) \sin{\left(3 x \right)} - 9 \sin{\left(3 x \right)}\right) e^{- x^{2}}

Este corresponde con el código que usé arriba para representar la ecuación.

Si quisiéramos el código MathML de esa expresión podríamos usar el siguiente fragmento de código

from sympy import *
init_session()
f = exp(-x**2)*sin(3*x)
fxx = diff(f, x, 2)
print(mathml(fxx, printer="presentation"))

observe el argumento opcional printer = "presentation". Si queremos agregar esto a MS Word, por ejemplo, podríamos agregar la salida (que no voy a mostrar porque es realmente larga) dentro del siguiente código

<math xmlns = "http://www.w3.org/1998/Math/MathML">
</math>

Cuando se usa Jupyter Notebook, esto se puede hacer gráficamente con un clic derecho sobre la expresión. Y se muestra el siguiente menú.

Referencias

“How to Insert Equations in Microsoft Word.” WikiHow, https://www.wikihow.com/Insert-Equations-in-Microsoft-Word. Fecha de acceso: Agosto 3, 2020.
“Copy MathML into Word to Use as Equation.” Stack Overflow, https://stackoverflow.com/questions/25430775/copy-mathml-into-word-to-use-as-equation. Fecha de acceso: Agosto 3, 2020.
“Python - Output Sympy Equation to Word Using Mathml.” Stack Overflow, https://stackoverflow.com/questions/40921128/output-sympy-equation-to-word-using-mathml. Fecha de acceso: Agosto 3, 2020.
OERPUB (2016), “Mathconverter”, https://github.com/oerpub/mathconverter, Fecha de acceso: Agosto 3, 2020.