Prueba v1 nueva plantilla

[jmml97]

He creado una versión preliminar de una nueva plantilla para los apuntes que creo que incorpora mejoras interesantes.

1. Cambia de la clase article a la clase scrartcl, que forma parte de KOMA-Script. Realiza algunos ajustes tipográficos por defecto que nos ahorran tener que gestionar los márgenes y los títulos de secciones por separado (reduciéndose así el código).
2. Aumenta el tamaño de letra a 12, haciendo el documento más legible.
3. Se cambia el formato de párrafos separados a uno de párrafos con la primera línea indentada, técnica más habitual en la composición de libros.
4. Utiliza microtype para realizar pequeños ajustes tipográficos que mejoran la lectura en general.
5. Simplifica el estilo de definiciones, proposiciones, etc., a un estilo más sencillo y convencional, reduciendo el uso de fondos de color pero manteniendo la legibilidad.
6. Elimina los comandos personalizados con la finalidad de hacer el código más portable. Si quieres escribir más rápido utiliza snippets o atajos de teclado.

Subo algunas capturas para comparar y un archivo compilado para que les echéis un vistazo y opinéis sobre posibles mejoras.

Antes:

Después:

Antes:

Después:

[danipozo]

• Respecto de 2), me parece bien, y me pregunto si sería complicado crear una configuración aparte para compilar una versión destinada a ser leída en pantallas pequeñas, como tablets o lectores electrónicos.

• Sobre 5), me parece más legible el uso de fondos de color: separan claramente lo que está dentro de una definición o del enunciado de un teorema; si bien pueden ser peores al imprimir.

• 6), me parece que los comandos personalizados tienen ventajas: hacen más fácil escribir para quien no se para a configurar snippets o a usar atajos de teclado, y hacen más legible el código LaTeX.

[jmml97]

• Respecto de 2), me parece bien, y me pregunto si sería complicado crear una configuración aparte para compilar una versión destinada a ser leída en pantallas pequeñas, como tablets o lectores electrónicos.

Sí, se puede hacer cambiando simplemente el archivo asignatura.tex y puedes encontrar fácilmente plantillas que generan PDFs para leer en lectores electrónicos.

• Sobre 5), me parece más legible el uso de fondos de color: separan claramente lo que está dentro de una definición o del enunciado de un teorema; si bien pueden ser peores al imprimir.

Son peores para imprimir (especialmente en B/N) y quizás el documento queda demasiado sobrecargado si hay varias definiciones en la misma página. Es verdad que queda separado claramente, aunque quizás podría verse si se puede conseguir un efecto parecido con otros recursos tipográficos.

• 6), me parece que los comandos personalizados tienen ventajas: hacen más fácil escribir para quien no se para a configurar snippets o a usar atajos de teclado, y hacen más legible el código LaTeX.

Si bien es cierto que hacen más legible el código LaTeX, reducen la portabilidad del mismo y creo que esto es una desventaja. Cuando usas comandos personalizados no puedes coger una definición y pegarla, por ejemplo, en Anki directamente. También dificultaría crear versiones web de los apuntes (algo que sería interesante pues mejoraría la legibilidad en ordenadores y móviles) pues en MathJax no puedes usar los comandos personalizados.

[danipozo]

Son peores para imprimir (especialmente en B/N) y quizás el documento queda demasiado sobrecargado si hay varias definiciones en la misma página. Es verdad que queda separado claramente, aunque quizás podría verse si se puede conseguir un efecto parecido con otros recursos tipográficos.

Entonces creo que lo mejor es explorar qué recursos tipográficos son buenos para imprimir y cumplen esa función.

Si bien es cierto que hacen más legible el código LaTeX, reducen la portabilidad del mismo y creo que esto es una desventaja. Cuando usas comandos personalizados no puedes coger una definición y pegarla, por ejemplo, en Anki directamente. También dificultaría crear versiones web de los apuntes (algo que sería interesante pues mejoraría la legibilidad en ordenadores y móviles) pues en MathJax no puedes usar los comandos personalizados.

No me he peleado mucho con MathJax, pero aquí dice que funcionan los comandos personalizados, ¿quizá es una adición reciente? En cuanto a Anki, ¿no se puede solucionar de alguna otra forma? Anki funciona con MathJax, ¿no?

[fjsaezm]

Estoy de acuerdo con este punto

* 6), me parece que los comandos personalizados tienen ventajas: hacen más fácil escribir para quien no se para a configurar _snippets_ o a usar atajos de teclado, y hacen más legible el código LaTeX.

Además, respecto a 5) creo que podría intentarse buscar algún estilo intermedio, pues aunque es verdad que los cuadros hacen que se distinga bien cual es el contenido de cada elemento, muchas veces las páginas quedan algo sobrecargadas de color

[jmml97]

Puedo aceptar que algunos comandos personalizados son útiles pues si no algunas expresiones serían absurdamente largas de escribir, por ejemplo en el caso de la restricción o con la chi de la función característica. Pero creo que otros comandos como \R para \mathbb R o \vecX para \boldsymbol X no ahorran demasiado tiempo como para compensar, por un lado la pérdida de portabilidad del código y por otro el hecho de que introducen convenciones a la hora de escribir el texto que pueden acabar haciendo que su uso no sea homogéneo. Casi no me doy cuenta de que se habían introducido estos comandos y si llego a escribir algo habría seguido escribiendo\boldsymbol X.

[jmml97]

Por otro lado creo que los enunciados de definiciones, teoremas o proposiciones pueden seguir el estilo que recomienda la AMS y distinguirse lo suficiente del resto del texto. La recomendación sería utilizar cursiva para el texto de los teoremas, proposiciones, corolarios, etc., y redonda para definiciones, notas, etc (ref: https://www.ams.org/publications/authors/AMS-StyleGuide-online.pdf). Además, incluir espacio en blanco encima y debajo del enunciado para separarlo más del texto.

[danipozo]

comandos como \R para \mathbb R o \vecX para \boldsymbol X [...] introducen convenciones a la hora de escribir el texto que pueden acabar haciendo que su uso no sea homogéneo.

A este respecto, creo que lo peor que ha pasado es que no se usen estos comandos y se siga escribiendo el LaTeX original directamente, pero nunca se han introducido varias convenciones para lo mismo. Por esto, se puede arreglar fácilmente. Otra cosa que se puede hacer es incluir una lista de comandos y para qué se deben usar en el README de cada asignatura.

En cuanto a la pérdida de portabilidad del código, creo que toda vez que aceptamos que algunos comandos son difícilmente eliminables, se puede intentar conseguir con un pequeño programa que sustituya todas las apariciones de los comandos, y se puede copiar y pegar de la salida de este programa si hiciera falta. Eso si descartamos introducir las definiciones de los comandos en el documento donde queramos pegar.

Por otro lado creo que los enunciados de definiciones, teoremas o proposiciones pueden seguir el estilo que recomienda la AMS y distinguirse lo suficiente del resto del texto. La recomendación sería utilizar cursiva para el texto de los teoremas, proposiciones, corolarios, etc., y redonda para definiciones, notas, etc (ref: https://www.ams.org/publications/authors/AMS-StyleGuide-online.pdf). Además, incluir espacio en blanco encima y debajo del enunciado para separarlo más del texto.

Me sigue gustando algún elemento (como una caja) que separe claramente lo que se incluye en el enunciado de lo que no.

[jmml97]

Bueno, he cambiado la fuente del texto a Charter, restaurado los comandos personalizados y dejado los marcos para los teoremas, aunque no me acaban de convencer cómo quedan. Aquí podéis ver un archivo compilado y abajo un par de capturas.

[danipozo]

La mayoría de los cambios me parecen acertados, no obstante, creo que habría que dejar también los marcos de las definiciones, proposiciones y corolarios.

[jmml97]

En el último commit vuelven los recuadros para contentar a @danipozo.

[jmml97]

He cambiado los recuadros de mdframed a tcolorbox, paquete con más opciones, mejor documentado, más simple y más actualizado. He cambiado la indentación de los párrafos de 18pt a 12pt para que coincida con la indentación de las cajas. Aunque no es un valor ideal queda mucho mejor así en conjunto porque si no el texto parecía una escalera.

[danipozo]

Entiendo que este PR está listo para mezclarse.

[jmml97]

Todavía quiero darle una vuelta a la disposición de página y tengo que revisar los comentarios de toda la plantilla.

Además si se aprueba el PR #77 habrá que implementar la plantilla nueva según la nueva estructura.

[jmml97]

Uy, en el último commit he cambiado la licencia para poner CC BY-SA 4.0 y quitar NC a la plantilla porque técnicamente la plantilla es una obra nueva, pero no estoy seguro de:

• poder hacerlo,
• que no sea demasiado lioso todo.

Así que no sé si es mejor volver a poner CC BY-NC-SA 4.0.

[danipozo]

quitar NC a la plantilla porque técnicamente la plantilla es una obra nueva

No veo ningún problema con esto.

[jmml97]

Todos los apuntes que compilan porque no tienen errores compilan correctamente con la nueva plantilla. Se puede proceder a hacer merge del pull request si estáis de acuerdo con los cambios.

Resumen final de los cambios (posiblemente incompleto):

• Aumenta el tamaño de letra a 12pt.
• Se ha cambiado la fuente de Palatino a Charter.
• Ahora las fuentes funcionan tambien con xelatex/lualatex (necesario para los apuntes en md).
• Se cambia el formato de párrafos separados a uno de párrafos con la primera línea indentada.
• Se ha modificado el espaciado vertical de las listas.
• Se han ajustado los márgenes.
• Se ha cambiado la clase article por scrartcl de KOMA Script (que en general tiene una configuración por defecto mejor que la de article)
• El paquete de los recuadros ha pasado de mdframed a tcolorbox que usar Tikz y en general es más sencillo y funciona mejor.
  • Los recuadros se han revisado y se han hecho más compactos.
• Se ha quitado el color de los enlaces del índice
• Se ha cambiado la licencia de la plantilla de CC-BY-NC-SA a AGPLv3

Gracias a que los apuntes se compilan ahora mismo utilizando un único archivo para matemáticas y un único archivo para informática hacer cualquier cambio en el futuro será bastante sencillo.