Otros documentos y trabajo en equipo: síntesis y desafíos

Resumen

Esta clase cierra la séptima unidad, dedicada a los otros documentos y al trabajo en equipo, y con ella el curso. Reconstruye la cadena de principios y mecanismos que va del marco de Beamer al PDF etiquetado, señalando en cada eslabón qué principio se usa y en qué clase se establece; sitúa lo logrado respecto del plan del curso y señala lo que queda después de él; repite en su evaluación de salida las destrezas de la evaluación de entrada; y termina con seis desafíos, de dificultad superior a la de los problemas de las clases, que exigen combinar varias unidades para componer un artículo breve que reúne todo el curso, convertirlo en una presentación, llevar su figura a un póster, diagnosticar una fusión sin conflicto que cambia una remisión, prepararlo para arXiv y para una revista que compila con pdfLaTeX, y escribir un preámbulo que sirva a la vez a un artículo, a una presentación y a un informe de KOMA-Script.

Objetivos de aprendizaje

Reconstruir el orden de los mecanismos de la unidad, identificando el principio en que se apoya cada uno.
Explicar por qué un mismo contenido cambia de género, de autor y de destino sin reescribirse, y qué decisiones sí deben tomarse en cada cambio.
Predecir lo que producen un marco con capas, una opción de clase, un archivo de exclusiones, una fusión de Git y una declaración de metadatos, y corregir la fuente para que produzca lo que se quería.
Componer un artículo académico breve que reúna los recursos de todo el curso, y adaptarlo a una presentación, a un póster y a los requisitos de un destino de publicación.
Situar lo aprendido en el curso respecto de los cursos de redacción de cada disciplina, que lo tienen por base.

Lo logrado en la unidad

La unidad se propuso que el trabajo académico construido en las seis anteriores cambie de género, se escriba entre varios y llegue a su destino sin rehacerse. El propósito se ha cumplido apoyándose en lo que la introducción declaró por sabido: el marcado lógico, que dice qué es cada cosa y deja su forma a la clase; el preámbulo propio, que decide una vez lo que vale en todo el documento; las medidas relativas de las figuras; y la base bibliográfica, que sirve a cualquier género que cite. Con ello, el camino recorrido puede leerse como una sola cadena en cuatro tramos.

Presentaciones con Beamer

La clase sobre las presentaciones con Beamer mostró que una presentación es un documento como los otros, con su clase: la proporción de la página se elige con aspectratio, el idioma se declara como opción de la clase para que alcance también a los rótulos de los teoremas, y las secciones, escritas entre los marcos, alimentan el índice con el mismo mecanismo de pasadas de las remisiones. Estableció que cada capa de un marco es una página del PDF, de modo que \pause y las especificaciones entre ángulos se cuentan, y que la opción handout compone cada marco una sola vez; presentó los temas, las columnas, los bloques y los teoremas; llevó a la diapositiva la cita breve de biblatex y un marco de referencias; explicó por qué las notas se repiten tras cada capa; y advirtió que Beamer compone con la familia sin remate, de modo que \setmainfont no cambia las diapositivas.

Pósteres, cartas y currículum

La clase sobre los pósteres, las cartas y el currículum dedujo de la distancia de lectura el cuerpo mínimo de un póster, $s \geq 7 \cdot \frac{d}{30}$ , y de las proporciones de la serie A una maqueta a escala que se prueba en una hoja común; compuso el póster como una cuadrícula de bloques con la biblioteca poster de tcolorbox, cuyo cuerpo de base se fija con una sola opción; trató la carta como un conjunto de datos, con letter y con las variables de scrlttr2; presentó moderncv, con su color antes de su estilo y la opción es-lcroman de babel; y compuso un currículum académico cuyas listas de publicaciones salen, filtradas por palabras clave, de la misma base que los artículos. Terminó asignando a cada género la clase que no puede omitir su rasgo propio.

Escribir en equipo

La clase sobre escribir en equipo presentó la colaboración en Overleaf, con sus comentarios, su control de cambios y su historial, y el control de versiones con Git. De que Git compare y fusione los archivos línea por línea dedujo la convención de escribir una oración por línea, que no cambia el PDF y hace que dos correcciones en oraciones no vecinas se unan solas; excluyó con un .gitignore los archivos que la compilación regenera, nombrando el PDF del documento en lugar de todos los PDF, que pueden ser figuras; enseñó a resolver un conflicto y a comprobar la resolución compilando, porque una fusión sin conflicto puede romper una remisión; mostró los cambios en el PDF con latexdiff; y reunió las convenciones del equipo: un preámbulo común, una base común, un archivo por capítulo y etiquetas con prefijo.

Plantillas y publicación

La clase sobre plantillas y publicación llevó el documento a su destino. Adaptó un artículo a la clase de una revista quitando lo que la clase decide y conservando las instrucciones con sentido, y advirtió los choques, como el de natbib, que carga elsarticle, con biblatex; preparó una carpeta de envío que compila por sí sola; explicó que arXiv compila la fuente y no ofrece LuaLaTeX, de modo que el documento del curso se envía con XeLaTeX o se adapta a pdfLaTeX; produjo un PDF/A con \DocumentMetadata, escrita antes de la clase y con la versión del PDF que la norma admite; y etiquetó el PDF, con tagging=on, el texto alternativo de las figuras y el idioma, para que lo lea también quien no ve.

La figura siguiente reúne los cuatro tramos en una sola cadena. Cada nudo de la columna es un mecanismo o una regla, numerado según el orden en que se apoyan unos en otros y unido por un arco a los eslabones anteriores que usa; alrededor flotan los apoyos, es decir, los principios a los que la cadena recurre una y otra vez, cada uno unido con un trazo firme a los eslabones que se apoyan en él y con uno punteado al eslabón donde se establece, salvo los que se establecieron en unidades anteriores, que se dibujan como anillos. Al pulsar un apoyo se destacan todos los eslabones que lo usan, y cada eslabón remite a la clase en que se estudia.

Apoyos de la cadena

AQué es, no cómo se ve. El marcado dice qué es cada elemento, y la clase y sus opciones deciden su forma; por eso el contenido cambia de género al cambiar de clase. Se establece en las unidades segunda y tercera. Se admite sin demostración en esta unidad.
BDecidir una vez. Lo que se decide en un solo lugar (una opción, una instrucción propia, un preámbulo común) cambia en todo el documento al cambiarlo allí; lo que se copia a mano deja de concordar. Se establece en las unidades anteriores. Se admite sin demostración en esta unidad.
CPasadas. El motor anota en los archivos auxiliares lo que calcula en una pasada y lo usa en la siguiente; esos archivos se regeneran en cada compilación. Se establece en la primera unidad y se precisa en la tercera. Se admite sin demostración en esta unidad.
DMedidas relativas. Una medida expresada respecto del texto, como \linewidth o los tamaños \large y \Huge, se adapta al lugar donde se usa. Se establece en las unidades segunda y quinta. Se admite sin demostración en esta unidad.
EUna base, muchos usos. Las fuentes se describen una vez en la base bibliográfica, y cada género las cita o las lista con el estilo y los filtros que le convienen. Se establece en la unidad sexta. Se admite sin demostración en esta unidad.
FLo válido no avisa. El motor y sus programas solo avisan de lo que no pueden procesar; una fuente válida que no dice lo que el autor quería compila sin aviso, y el defecto solo se ve en el resultado. Se establece en las unidades quinta y sexta. Se admite sin demostración en esta unidad.
GLa distancia decide. El ángulo que ocupa una letra disminuye en proporción a la distancia; el cuerpo mínimo crece con ella. Se establece en: 6. El cuerpo por la distancia.
HGit compara líneas. Git compara y fusiona los archivos línea por línea: une solo los cambios en líneas no vecinas, y declara un conflicto si dos cambios tocan la misma línea o líneas contiguas. Se establece en: 11. Diferencias y fusiones por líneas.

Tramo 1 Presentaciones con Beamer
- Componer marcos con título, bloques, columnas y teoremas.
- Predecir las páginas que producen las capas, la copia y las notas.
- Citar en la diapositiva con la misma base.
- Elegir la tipografía de una presentación sabiendo qué familia usa Beamer.
1. Marco y capa como página. Cada marco produce una página por capa: \pause y las especificaciones como <3-> o \only<2> fijan cuántas; handout compone una por marco, y una nota se repite tras cada capa.
  Se apoya en: A (Qué es, no cómo se ve). Se demuestra en: Presentaciones con Beamer.
2. Secciones e índice. \section se escribe entre los marcos, no produce página y alimenta \tableofcontents, que se completa en la segunda compilación.
  Usa: 1. Marco y capa como página. Se apoya en: C (Pasadas). Se demuestra en: Presentaciones con Beamer.
3. El idioma en la clase. spanish como opción de la clase alcanza a babel y al traductor de Beamer; dado solo a babel, los teoremas se rotulan en inglés, sin aviso.
  Usa: 1. Marco y capa como página. Se apoya en: B (Decidir una vez), F (Lo válido no avisa). Se demuestra en: Presentaciones con Beamer.
4. La cita breve. En la diapositiva se cita con la forma breve de biblatex, desde la misma base, y la referencia completa va en un marco final.
  Usa: 1. Marco y capa como página. Se apoya en: E (Una base, muchos usos). Se demuestra en: Presentaciones con Beamer.
5. La familia sin remate. Beamer compone con la familia sin remate: \setmainfont no cambia las diapositivas; se cambia la familia sin remate o se pide el tema de tipografías con remate, y professionalfonts deja intacta la matemática.
  Usa: 1. Marco y capa como página. Se apoya en: A (Qué es, no cómo se ve), F (Lo válido no avisa). Se demuestra en: Presentaciones con Beamer.
Tramo 2 Pósteres, cartas y currículum
- Calcular el cuerpo de un póster por la distancia y probarlo en una maqueta.
- Componer un póster como una cuadrícula de bloques.
- Escribir cartas con letter y scrlttr2.
- Componer un currículum profesional y uno académico desde la base.
1. El cuerpo por la distancia. A 30 cm el mínimo cómodo es de unos 7 puntos; a una distancia $d$ , en centímetros, el cuerpo $s$ debe cumplir $s \geq 7 \cdot \frac{d}{30}$ .
  Se demuestra en: Pósteres, cartas y currículum.
2. La maqueta a escala. Los formatos de la serie A tienen la misma forma, y cada lado se divide por $\sqrt{2}$ en cada paso: un A0 reducido a A4 se lee a la cuarta parte de la distancia prevista.
  Usa: 6. El cuerpo por la distancia. Se apoya en: G (La distancia decide). Se demuestra en: Pósteres, cartas y currículum.
3. Una cuadrícula de bloques. tcbposter divide la página en columnas y filas, cada \posterbox ocupa un lugar en ellas, y fontsize fija el cuerpo de base, del que dependen todos los tamaños relativos.
  Usa: 6. El cuerpo por la distancia. Se apoya en: B (Decidir una vez), D (Medidas relativas), G (La distancia decide). Se demuestra en: Pósteres, cartas y currículum.
4. La carta como datos. letter y scrlttr2 reciben el remitente, el destinatario, la fecha y la firma como datos; scrlttr2 los guarda en variables, como place, y decide su lugar con sus opciones.
  Se apoya en: A (Qué es, no cómo se ve). Se demuestra en: Pósteres, cartas y currículum.
5. El currículum desde la base. moderncv pide el color antes del estilo y es-lcroman en babel; el currículum académico lista las publicaciones con \nocite{*} y filtros de palabras clave que combinan sus condiciones.
  Usa: 9. La carta como datos, 4. La cita breve. Se apoya en: E (Una base, muchos usos), F (Lo válido no avisa). Se demuestra en: Pósteres, cartas y currículum.
Tramo 3 Escribir en equipo
- Compartir un proyecto en Overleaf o en un repositorio de Git.
- Escribir de modo que los cambios ajenos no choquen.
- Excluir lo que se genera sin perder lo que no se genera.
- Resolver un conflicto, comprobarlo compilando y mostrar los cambios.
1. Diferencias y fusiones por líneas. Git registra los cambios de cada confirmación como líneas quitadas y añadidas, y une dos ramas sin intervención cuando sus cambios tocan líneas separadas.
  Se demuestra en: Escribir en equipo.
2. Una oración por línea. Un salto de línea simple es un espacio, de modo que escribir una oración por línea no cambia el PDF; la diferencia señala la oración que cambió, y dos correcciones en oraciones no vecinas se unen solas.
  Usa: 11. Diferencias y fusiones por líneas. Se apoya en: H (Git compara líneas). Se demuestra en: Escribir en equipo.
3. Lo generado no se guarda. El .gitignore excluye los auxiliares y el PDF del documento por su nombre; *.pdf excluiría también las figuras en PDF, sin aviso, y el documento no compilaría en otro computador.
  Usa: 11. Diferencias y fusiones por líneas. Se apoya en: C (Pasadas), F (Lo válido no avisa). Se demuestra en: Escribir en equipo.
4. Resolver y compilar. Un conflicto deja marcas en el archivo, que se resuelven a mano; una fusión sin conflicto puede romper una remisión, y por eso toda fusión se comprueba compilando.
  Usa: 12. Una oración por línea, 13. Lo generado no se guarda. Se apoya en: H (Git compara líneas), F (Lo válido no avisa). Se demuestra en: Escribir en equipo.
5. Los cambios en el PDF. latexdiff compara dos versiones de la fuente y escribe una tercera que, compilada, muestra lo quitado y lo añadido; las convenciones del equipo (preámbulo y base comunes, etiquetas con prefijo) evitan que la comparación se llene de diferencias de forma.
  Usa: 14. Resolver y compilar. Se apoya en: B (Decidir una vez). Se demuestra en: Escribir en equipo.
Tramo 4 Plantillas y publicación
- Adaptar un artículo a la clase de una revista.
- Preparar una carpeta de envío que compile sola.
- Elegir el motor y la bibliografía que el destino admite.
- Producir un PDF de archivo y etiquetado.
1. Adaptar a la plantilla. Se quita lo que la clase de la revista decide (página, tipografía, títulos) y se conservan las instrucciones con sentido; los paquetes que la clase ya carga, como natbib en elsarticle, pueden chocar con los propios.
  Usa: 3. El idioma en la clase. Se apoya en: A (Qué es, no cómo se ve), B (Decidir una vez). Se demuestra en: Plantillas y publicación.
2. Una fuente que compila sola. La carpeta del envío contiene todo lo que el documento lee y nada más: fuentes, figuras, la base o el .bbl, y ningún auxiliar.
  Usa: 16. Adaptar a la plantilla, 13. Lo generado no se guarda. Se apoya en: C (Pasadas). Se demuestra en: Plantillas y publicación.
3. El destino decide el motor. arXiv compila la fuente con LaTeX, pdfLaTeX o XeLaTeX, no con LuaLaTeX: el documento del curso se envía con XeLaTeX o se adapta a pdfLaTeX, y se compila antes con ese motor; un .bbl enviado debe ser compatible con su versión de biblatex.
  Usa: 17. Una fuente que compila sola, 4. La cita breve. Se apoya en: E (Una base, muchos usos), F (Lo válido no avisa). Se demuestra en: Plantillas y publicación.
4. PDF/A y su versión. \DocumentMetadata va antes de \documentclass; con pdfstandard=a-2b se añade pdfversion=1.7, porque la versión 2.0 no es admisible para esa parte de la norma.
  Usa: 17. Una fuente que compila sola. Se apoya en: F (Lo válido no avisa). Se demuestra en: Plantillas y publicación.
5. Etiquetas, texto alternativo e idioma. tagging=on deriva la estructura del PDF del marcado con sentido; alt da a cada figura lo que oirá quien no la ve, y lang declara el idioma.
  Usa: 19. PDF/A y su versión. Se apoya en: A (Qué es, no cómo se ve). Se demuestra en: Plantillas y publicación.

El fin del curso. La cadena termina donde el documento sale de las manos de su autor: escrito con otros, presentado en varios géneros y entregado en la forma que su destino exige. Con ella termina el curso.