Outros documentos e trabalho em equipe: síntese e desafios

Resumo

Esta aula encerra a sétima unidade, dedicada aos outros documentos e ao trabalho em equipe, e com ela o curso. Reconstrói a cadeia de princípios e mecanismos que vai do quadro do Beamer ao PDF etiquetado, indicando em cada elo que princípio se usa e em que aula ele se estabelece; situa o que foi alcançado em relação ao plano do curso e indica o que fica depois dele; repete em sua avaliação de saída as habilidades da avaliação de entrada; e termina com seis desafios, de dificuldade superior à dos problemas das aulas, que exigem combinar várias unidades para compor um artigo breve que reúne todo o curso, convertê-lo numa apresentação, levar sua figura a um pôster, diagnosticar uma fusão sem conflito que altera uma remissão, prepará-lo para o arXiv e para uma revista que compila com pdfLaTeX, e escrever um preâmbulo que sirva ao mesmo tempo a um artigo, a uma apresentação e a um relatório do KOMA-Script.

Objetivos de aprendizagem

Reconstruir a ordem dos mecanismos da unidade, identificando o princípio em que cada um se apoia.
Explicar por que um mesmo conteúdo muda de gênero, de autor e de destino sem ser reescrito, e que decisões precisam, no entanto, ser tomadas em cada mudança.
Prever o que produzem um quadro com camadas, uma opção de classe, um arquivo de exclusões, uma fusão do Git e uma declaração de metadados, e corrigir o código-fonte para que produza o que se queria.
Compor um artigo acadêmico breve que reúna os recursos de todo o curso, e adaptá-lo a uma apresentação, a um pôster e às exigências de um destino de publicação.
Situar o que se aprendeu no curso em relação aos cursos de redação de cada disciplina, que o têm por base.

O que a unidade alcançou

A unidade propôs-se a que o trabalho acadêmico construído nas seis anteriores mude de gênero, seja escrito por várias pessoas e chegue a seu destino sem ser refeito. O propósito foi cumprido apoiando-se no que a introdução declarou como sabido: a marcação lógica, que diz o que é cada coisa e deixa sua forma à classe; o preâmbulo próprio, que decide uma vez o que vale em todo o documento; as medidas relativas das figuras; e a base bibliográfica, que serve a qualquer gênero que cite. Com isso, o caminho percorrido pode ser lido como uma só cadeia em quatro trechos.

Apresentações com Beamer

A aula sobre as apresentações com Beamer mostrou que uma apresentação é um documento como os outros, com sua classe: a proporção da página se escolhe com aspectratio, o idioma se declara como opção da classe para que alcance também os rótulos dos teoremas, e as seções, escritas entre os quadros, alimentam o sumário com o mesmo mecanismo de passagens das remissões. Estabeleceu que cada camada de um quadro é uma página do PDF, de modo que \pause e as especificações entre sinais de menor e maior se contam, e que a opção handout compõe cada quadro uma só vez; apresentou os temas, as colunas, os blocos e os teoremas; levou ao slide a citação breve do biblatex e um quadro de referências; explicou por que as notas se repetem após cada camada; e advertiu que o Beamer compõe com a família sem serifa, de modo que \setmainfont não muda os slides.

Pôsteres, cartas e currículo

A aula sobre os pôsteres, as cartas e o currículo deduziu da distância de leitura o corpo mínimo de um pôster, $s \geq 7 \cdot \frac{d}{30}$ , e das proporções da série A uma maquete em escala que se testa numa folha comum; compôs o pôster como uma grade de blocos com a biblioteca poster do tcolorbox, cujo corpo de base se fixa com uma só opção; tratou a carta como um conjunto de dados, com letter e com as variáveis da scrlttr2; apresentou o moderncv, com sua cor antes de seu estilo e, com o babel em espanhol, a opção es-lcroman; e compôs um currículo acadêmico cujas listas de publicações saem, filtradas por palavras-chave, da mesma base que os artigos. Terminou atribuindo a cada gênero a classe que não pode omitir seu traço próprio.

Escrever em equipe

A aula sobre escrever em equipe apresentou a colaboração no Overleaf, com seus comentários, seu controle de alterações e seu histórico, e o controle de versões com o Git. Do fato de o Git comparar e fundir os arquivos linha por linha deduziu a convenção de escrever uma frase por linha, que não muda o PDF e faz que duas correções em frases não vizinhas se unam sozinhas; excluiu com um .gitignore os arquivos que a compilação regenera, nomeando o PDF do documento em vez de todos os PDF, que podem ser figuras; ensinou a resolver um conflito e a comprovar a resolução compilando, porque uma fusão sem conflito pode quebrar uma remissão; mostrou as alterações no PDF com o latexdiff; e reuniu as convenções da equipe: um preâmbulo comum, uma base comum, um arquivo por capítulo e rótulos com prefixo.

Modelos e publicação

A aula sobre modelos e publicação levou o documento a seu destino. Adaptou um artigo à classe de uma revista tirando o que a classe decide e conservando os comandos com sentido, e advertiu os choques, como o do natbib, que a elsarticle carrega, com o biblatex; preparou uma pasta de envio que compila por si só; explicou que o arXiv compila o código-fonte e não oferece LuaLaTeX, de modo que o documento do curso se envia com XeLaTeX ou se adapta ao pdfLaTeX; produziu um PDF/A com \DocumentMetadata, escrito antes da classe e com a versão do PDF que a norma admite; e etiquetou o PDF, com tagging=on, o texto alternativo das figuras e o idioma, para que também quem não vê possa lê-lo.

A figura seguinte reúne os quatro trechos numa só cadeia. Cada nó da coluna é um mecanismo ou uma regra, numerado segundo a ordem em que se apoiam uns nos outros e unido por um arco aos elos anteriores que usa; ao redor flutuam os apoios, isto é, os princípios a que a cadeia recorre uma e outra vez, cada um unido por um traço firme aos elos que se apoiam nele e por um pontilhado ao elo onde se estabelece, salvo os que se estabeleceram em unidades anteriores, que se desenham como anéis. Ao clicar num apoio destacam-se todos os elos que o usam, e cada elo remete à aula em que é estudado.

Apoios da cadeia

AO que é, não como se vê. A marcação diz o que é cada elemento, e a classe e suas opções decidem sua forma; por isso o conteúdo muda de gênero ao mudar de classe. Estabelece-se na segunda e na terceira unidade. Admitido sem demonstração nesta unidade.
BDecidir uma vez. O que se decide num só lugar (uma opção, um comando próprio, um preâmbulo comum) muda em todo o documento ao ser mudado ali; o que se copia à mão deixa de concordar. Estabelece-se nas unidades anteriores. Admitido sem demonstração nesta unidade.
CPassagens. O motor anota nos arquivos auxiliares o que calcula numa passagem e o usa na seguinte; esses arquivos se regeneram a cada compilação. Estabelece-se na primeira unidade e se precisa na terceira. Admitido sem demonstração nesta unidade.
DMedidas relativas. Uma medida expressa em relação ao texto, como \linewidth ou os tamanhos \large e \Huge, adapta-se ao lugar onde se usa. Estabelece-se na segunda e na quinta unidade. Admitido sem demonstração nesta unidade.
EUma base, muitos usos. As fontes se descrevem uma vez na base bibliográfica, e cada gênero as cita ou as lista com o estilo e os filtros que lhe convêm. Estabelece-se na sexta unidade. Admitido sem demonstração nesta unidade.
FO válido não avisa. O motor e seus programas só avisam do que não podem processar; um código-fonte válido que não diz o que o autor queria compila sem aviso, e o defeito só se vê no resultado. Estabelece-se na quinta e na sexta unidade. Admitido sem demonstração nesta unidade.
GA distância decide. O ângulo que uma letra ocupa diminui em proporção à distância; o corpo mínimo cresce com ela. Estabelecido em: 6. O corpo pela distância.
HO Git compara linhas. O Git compara e funde os arquivos linha por linha: une só as alterações em linhas não vizinhas, e declara um conflito se duas alterações tocam a mesma linha ou linhas contíguas. Estabelecido em: 11. Diferenças e fusões por linhas.

Trecho 1 Apresentações com Beamer
- Compor quadros com título, blocos, colunas e teoremas.
- Prever as páginas que produzem as camadas, a cópia e as notas.
- Citar no slide com a mesma base.
- Escolher a fonte de uma apresentação sabendo que família o Beamer usa.
1. Quadro e camada como página. Cada quadro produz uma página por camada: \pause e as especificações como <3-> ou \only<2> fixam quantas; handout compõe uma por quadro, e uma nota se repete após cada camada.
  Apoia-se em: A (O que é, não como se vê). Demonstrado em: Apresentações com Beamer.
2. Seções e sumário. \section se escreve entre os quadros, não produz página e alimenta \tableofcontents, que se completa na segunda compilação.
  Usa: 1. Quadro e camada como página. Apoia-se em: C (Passagens). Demonstrado em: Apresentações com Beamer.
3. O idioma na classe. brazilian como opção da classe alcança o babel e o tradutor do Beamer; dado só ao babel, os teoremas são rotulados em inglês, sem aviso.
  Usa: 1. Quadro e camada como página. Apoia-se em: B (Decidir uma vez), F (O válido não avisa). Demonstrado em: Apresentações com Beamer.
4. A citação breve. No slide se cita com a forma breve do biblatex, a partir da mesma base, e a referência completa vai num quadro final.
  Usa: 1. Quadro e camada como página. Apoia-se em: E (Uma base, muitos usos). Demonstrado em: Apresentações com Beamer.
5. A família sem serifa. O Beamer compõe com a família sem serifa: \setmainfont não muda os slides; muda-se a família sem serifa ou pede-se o tema de fontes com serifa, e professionalfonts deixa intacta a matemática.
  Usa: 1. Quadro e camada como página. Apoia-se em: A (O que é, não como se vê), F (O válido não avisa). Demonstrado em: Apresentações com Beamer.
Trecho 2 Pôsteres, cartas e currículo
- Calcular o corpo de um pôster pela distância e testá-lo numa maquete.
- Compor um pôster como uma grade de blocos.
- Escrever cartas com letter e scrlttr2.
- Compor um currículo profissional e um acadêmico a partir da base.
1. O corpo pela distância. A 30 cm o mínimo confortável é de uns 7 pontos; a uma distância $d$ , em centímetros, o corpo $s$ deve cumprir $s \geq 7 \cdot \frac{d}{30}$ .
  Demonstrado em: Pôsteres, cartas e currículo.
2. A maquete em escala. Os formatos da série A têm a mesma forma, e cada lado se divide por $\sqrt{2}$ a cada passo: um A0 reduzido a A4 se lê à quarta parte da distância prevista.
  Usa: 6. O corpo pela distância. Apoia-se em: G (A distância decide). Demonstrado em: Pôsteres, cartas e currículo.
3. Uma grade de blocos. tcbposter divide a página em colunas e linhas, cada \posterbox ocupa um lugar nelas, e fontsize fixa o corpo de base, do qual dependem todos os tamanhos relativos.
  Usa: 6. O corpo pela distância. Apoia-se em: B (Decidir uma vez), D (Medidas relativas), G (A distância decide). Demonstrado em: Pôsteres, cartas e currículo.
4. A carta como dados. letter e scrlttr2 recebem o remetente, o destinatário, a data e a assinatura como dados; a scrlttr2 os guarda em variáveis, como place, e decide seu lugar com suas opções.
  Apoia-se em: A (O que é, não como se vê). Demonstrado em: Pôsteres, cartas e currículo.
5. O currículo a partir da base. O moderncv pede a cor antes do estilo e, com o babel em espanhol, es-lcroman; o currículo acadêmico lista as publicações com \nocite{*} e filtros de palavras-chave que combinam suas condições.
  Usa: 9. A carta como dados, 4. A citação breve. Apoia-se em: E (Uma base, muitos usos), F (O válido não avisa). Demonstrado em: Pôsteres, cartas e currículo.
Trecho 3 Escrever em equipe
- Compartilhar um projeto no Overleaf ou num repositório do Git.
- Escrever de modo que as alterações alheias não colidam.
- Excluir o que se gera sem perder o que não se gera.
- Resolver um conflito, comprová-lo compilando e mostrar as alterações.
1. Diferenças e fusões por linhas. O Git registra as alterações de cada confirmação como linhas retiradas e acrescentadas, e une dois ramos sem intervenção quando suas alterações tocam linhas separadas.
  Demonstrado em: Escrever em equipe.
2. Uma frase por linha. Uma quebra de linha simples é um espaço, de modo que escrever uma frase por linha não muda o PDF; a diferença indica a frase que mudou, e duas correções em frases não vizinhas se unem sozinhas.
  Usa: 11. Diferenças e fusões por linhas. Apoia-se em: H (O Git compara linhas). Demonstrado em: Escrever em equipe.
3. O gerado não se guarda. O .gitignore exclui os auxiliares e o PDF do documento pelo nome; *.pdf excluiria também as figuras em PDF, sem aviso, e o documento não compilaria em outro computador.
  Usa: 11. Diferenças e fusões por linhas. Apoia-se em: C (Passagens), F (O válido não avisa). Demonstrado em: Escrever em equipe.
4. Resolver e compilar. Um conflito deixa marcas no arquivo, que se resolvem à mão; uma fusão sem conflito pode quebrar uma remissão, e por isso toda fusão se comprova compilando.
  Usa: 12. Uma frase por linha, 13. O gerado não se guarda. Apoia-se em: H (O Git compara linhas), F (O válido não avisa). Demonstrado em: Escrever em equipe.
5. As alterações no PDF. O latexdiff compara duas versões do código-fonte e escreve uma terceira que, compilada, mostra o retirado e o acrescentado; as convenções da equipe (preâmbulo e base comuns, rótulos com prefixo) evitam que a comparação se encha de diferenças de forma.
  Usa: 14. Resolver e compilar. Apoia-se em: B (Decidir uma vez). Demonstrado em: Escrever em equipe.
Trecho 4 Modelos e publicação
- Adaptar um artigo à classe de uma revista.
- Preparar uma pasta de envio que compile sozinha.
- Escolher o motor e a bibliografia que o destino admite.
- Produzir um PDF de arquivamento e etiquetado.
1. Adaptar ao modelo. Retira-se o que a classe da revista decide (página, fonte, títulos) e conservam-se os comandos com sentido; os pacotes que a classe já carrega, como o natbib na elsarticle, podem chocar-se com os próprios.
  Usa: 3. O idioma na classe. Apoia-se em: A (O que é, não como se vê), B (Decidir uma vez). Demonstrado em: Modelos e publicação.
2. Um código-fonte que compila sozinho. A pasta do envio contém tudo o que o documento lê e nada mais: fontes, figuras, a base ou o .bbl, e nenhum auxiliar.
  Usa: 16. Adaptar ao modelo, 13. O gerado não se guarda. Apoia-se em: C (Passagens). Demonstrado em: Modelos e publicação.
3. O destino decide o motor. O arXiv compila o código-fonte com LaTeX, pdfLaTeX ou XeLaTeX, não com LuaLaTeX: o documento do curso se envia com XeLaTeX ou se adapta ao pdfLaTeX, e se compila antes com esse motor; um .bbl enviado deve ser compatível com a versão do biblatex do arXiv.
  Usa: 17. Um código-fonte que compila sozinho, 4. A citação breve. Apoia-se em: E (Uma base, muitos usos), F (O válido não avisa). Demonstrado em: Modelos e publicação.
4. PDF/A e sua versão. \DocumentMetadata vai antes de \documentclass; com pdfstandard=a-2b acrescenta-se pdfversion=1.7, porque a versão 2.0 não é admissível para essa parte da norma.
  Usa: 17. Um código-fonte que compila sozinho. Apoia-se em: F (O válido não avisa). Demonstrado em: Modelos e publicação.
5. Etiquetas, texto alternativo e idioma. tagging=on deriva a estrutura do PDF da marcação com sentido; alt dá a cada figura o que ouvirá quem não a vê, e lang declara o idioma.
  Usa: 19. PDF/A e sua versão. Apoia-se em: A (O que é, não como se vê). Demonstrado em: Modelos e publicação.

O fim do curso. A cadeia termina onde o documento sai das mãos de seu autor: escrito com outros, apresentado em vários gêneros e entregue na forma que seu destino exige. Com ela termina o curso.