collective/cdsc_tex
18
0
Fork 0
Code Activity

README: reflect memo template, drop memoir incompatibility note

Browse Source 
- 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 <noreply@anthropic.com>
This commit is contained in:
Benjamin Mako Hill
2026-04-26 12:34:19 -07:00
parent 0aee418e2a
commit dab1be34c5
1 changed files with 21 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
README
View File

@@ -5,8 +5,8 @@
Copyright (c) 2009-2026 Benjamin Mako Hill <mako@atdot.cc> / <makohill@uw.edu> Copyright (c) 2009-2026 Benjamin Mako Hill <mako@atdot.cc> / <makohill@uw.edu>
This repository contains LaTeX configuration files and templates used to This repository contains LaTeX configuration files and templates used to
format papers, assignments, and letters. All files are released under the format papers, memos, letters, and posters. All files are released under
GNU GPL version 3 or later. the GNU GPL version 3 or later.
The latest version can be found in git at: The latest version can be found in git at:
https://gitea.communitydata.science/collective/cdsc_tex https://gitea.communitydata.science/collective/cdsc_tex
@@ -54,17 +54,15 @@ Heros.
=== Accessibility ============== === Accessibility ==============
================================ ================================
The letter and poster templates produce PDF/UA-2 compliant tagged PDFs All four templates produce PDF/UA-2 compliant tagged PDFs via the
via the LaTeX tagging project (\DocumentMetadata + tagpdf). You can LaTeX tagging project (\DocumentMetadata + tagpdf). You can verify
verify compliance with verapdf: https://verapdf.org/ compliance with verapdf: https://verapdf.org/
The paper and assignment templates are based on the memoir class, which The paper and memo templates were originally built on the memoir
is not yet compatible with the LaTeX tagged-PDF code. They load the class, which is incompatible with the LaTeX tagged-PDF code. They now
pdfmanagement-testphase layer for PDF metadata only. When memoir gains use the standard article class with custom styling (cdsc-paper.sty
tagging support upstream, the commented-out \DocumentMetadata and tagpdf and cdsc-memo.sty) to keep their previous look while supporting full
lines in each template can be re-enabled. See: tagging.
https://github.com/latex3/tagging-project/issues/910
================================ ================================
=== Branches =================== === Branches ===================
@@ -72,7 +70,7 @@ lines in each template can be re-enabled. See:
This repository has two main branches: 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 knitr Knitr/R template for reproducible research documents
================================ ================================
@@ -88,10 +86,10 @@ and destination directory as arguments:
Available types: Available types:
paper LaTeX paper template (master branch) paper LaTeX paper template (master branch)
assignment LaTeX assignment template (master branch) memo LaTeX memo template (master branch)
knitr Knitr/R paper template (knitr branch) knitr Knitr/R paper template (knitr branch)
letter LaTeX letter template (master branch) letter LaTeX letter template (master branch)
Example: Example:
@@ -121,26 +119,23 @@ following to your .bashrc or .zshrc:
This defines the following aliases (only if new_tex_document is in PATH): This defines the following aliases (only if new_tex_document is in PATH):
new_tex_assignment → new_tex_document assignment new_tex_memo → new_tex_document memo
new_knitr_document → new_tex_document knitr new_knitr_document → new_tex_document knitr
new_tex_letter → new_tex_document letter new_tex_letter → new_tex_document letter
================================ ================================
=== Migration ================== === Migration ==================
================================ ================================
The individual scripts new_knitr_document, new_tex_assignment, and The individual scripts new_knitr_document and new_tex_letter have
new_tex_letter have been consolidated into new_tex_document. The old been consolidated into new_tex_document. The old scripts remain in
scripts remain in the repository but are superseded. the repository but are superseded.
To migrate, replace calls to the old scripts with new_tex_document: To migrate, replace calls to the old scripts with new_tex_document:
Old: new_knitr_document mydir Old: new_knitr_document mydir
New: new_tex_document knitr mydir New: new_tex_document knitr mydir
Old: new_tex_assignment mydir
New: new_tex_document assignment mydir
Old: new_tex_letter mydir Old: new_tex_letter mydir
New: new_tex_document letter mydir New: new_tex_document letter mydir