From dab1be34c501da13afc12f28054a9ce3f5eaad11 Mon Sep 17 00:00:00 2001 From: Benjamin Mako Hill Date: Sun, 26 Apr 2026 12:34:19 -0700 Subject: [PATCH] README: reflect memo template, drop memoir incompatibility note - Replace assignment_template references with memo_template. - Update the type list in the new_tex_document section. - Update the aliases section (new_tex_assignment -> new_tex_memo). - Drop the migration entry for the assignment script. - Rewrite the Accessibility section: now all four templates are PDF/UA-2 compliant (paper and memo were ported off memoir to the article class with custom .sty files), so the memoir-blocked caveat no longer applies. - Add poster to the master-branch templates list. Co-Authored-By: Claude Sonnet 4.6 --- README | 47 +++++++++++++++++++++-------------------------- 1 file changed, 21 insertions(+), 26 deletions(-) diff --git a/README b/README index 1b0b75a..3682b11 100644 --- a/README +++ b/README @@ -5,8 +5,8 @@ Copyright (c) 2009-2026 Benjamin Mako Hill / This repository contains LaTeX configuration files and templates used to -format papers, assignments, and letters. All files are released under the -GNU GPL version 3 or later. +format papers, memos, letters, and posters. All files are released under +the GNU GPL version 3 or later. The latest version can be found in git at: https://gitea.communitydata.science/collective/cdsc_tex @@ -54,17 +54,15 @@ Heros. === Accessibility ============== ================================ -The letter and poster templates produce PDF/UA-2 compliant tagged PDFs -via the LaTeX tagging project (\DocumentMetadata + tagpdf). You can -verify compliance with verapdf: https://verapdf.org/ +All four templates produce PDF/UA-2 compliant tagged PDFs via the +LaTeX tagging project (\DocumentMetadata + tagpdf). You can verify +compliance with verapdf: https://verapdf.org/ -The paper and assignment templates are based on the memoir class, which -is not yet compatible with the LaTeX tagged-PDF code. They load the -pdfmanagement-testphase layer for PDF metadata only. When memoir gains -tagging support upstream, the commented-out \DocumentMetadata and tagpdf -lines in each template can be re-enabled. See: - - https://github.com/latex3/tagging-project/issues/910 +The paper and memo templates were originally built on the memoir +class, which is incompatible with the LaTeX tagged-PDF code. They now +use the standard article class with custom styling (cdsc-paper.sty +and cdsc-memo.sty) to keep their previous look while supporting full +tagging. ================================ === Branches =================== @@ -72,7 +70,7 @@ lines in each template can be re-enabled. See: This repository has two main branches: - master Standard LaTeX templates (paper, assignment, letter) + master Standard LaTeX templates (paper, memo, letter, poster) knitr Knitr/R template for reproducible research documents ================================ @@ -88,10 +86,10 @@ and destination directory as arguments: Available types: - paper LaTeX paper template (master branch) - assignment LaTeX assignment template (master branch) - knitr Knitr/R paper template (knitr branch) - letter LaTeX letter template (master branch) + paper LaTeX paper template (master branch) + memo LaTeX memo template (master branch) + knitr Knitr/R paper template (knitr branch) + letter LaTeX letter template (master branch) Example: @@ -121,26 +119,23 @@ following to your .bashrc or .zshrc: This defines the following aliases (only if new_tex_document is in PATH): - new_tex_assignment → new_tex_document assignment - new_knitr_document → new_tex_document knitr - new_tex_letter → new_tex_document letter + new_tex_memo → new_tex_document memo + new_knitr_document → new_tex_document knitr + new_tex_letter → new_tex_document letter ================================ === Migration ================== ================================ -The individual scripts new_knitr_document, new_tex_assignment, and -new_tex_letter have been consolidated into new_tex_document. The old -scripts remain in the repository but are superseded. +The individual scripts new_knitr_document and new_tex_letter have +been consolidated into new_tex_document. The old scripts remain in +the repository but are superseded. To migrate, replace calls to the old scripts with new_tex_document: Old: new_knitr_document mydir New: new_tex_document knitr mydir - Old: new_tex_assignment mydir - New: new_tex_document assignment mydir - Old: new_tex_letter mydir New: new_tex_document letter mydir