generator-latex-template 2026.10.13 → 2026.10.15

package/README.md

@@ -243,7 +243,7 @@ The code is licensed [0BSD](https://choosealicense.com/licenses/0bsd/#), the sni
 See [benbalter/talks#15](https://github.com/benbalter/talks/issues/15#issuecomment-599704662), for a reasoning, why [CC0](https://creativecommons.org/share-your-work/public-domain/cc0/) cannot be used.
 
 - `generators/app/templates/splncs04nat.bst` is taken from [tpavlic/splncs04nat](https://github.com/tpavlic/splncs04nat) and is MIT-licensed.
-- `generators/app/templates/logos/`: This directory contains logos, which have special licenses.
+- `generators/app/templates/logos/`: This directory contains logos, which have special licenses (see [`logos/README.md`](generators/app/templates/logos/README.md)).
 - `generators/app/templates/figures/ulm-minster.jpg` is [Landappbw 79389 1820 Ulmer Münster Ulm.jpg](https://commons.wikimedia.org/w/index.php?curid=131463041) by wkrauth, dedicated to the public domain under [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/).
 
 [hyperref]: https://ctan.org/pkg/hyperref

package/generators/app/CLAUDE.md

@@ -29,7 +29,8 @@ the feature vanishes for some switch combination without any error.
 3. **`Texlivefile`** — add the TeX Live package name, guarded (usually
    `githubpublish || <condition>`; `githubpublish` deliberately bundles everything).
 4. **Shell-escape is derived, never hardcoded.** It is the boolean
-   `requiresShellEscape` in `index.js` (`listings == "minted" || uml == "plantuml"`).
+   `requiresShellEscape` in `index.js` (`uml == "plantuml"`, and minted only up to TeX Live 2024:
+   minted 3 runs `latexminted`, which TeX Live permits in restricted shell escape).
    Extend that expression if the new package needs `\write18`; the `latexmkrc` and the
    `main.*.tex` editor hints read the flag.
 5. **New user switch?** Decide **prompt vs. plain flag** first:

package/generators/app/index.js

@@ -12,7 +12,11 @@ export default class extends Generator {
     this.log(yosay(`Welcome to the ${chalk.red("latex-template")} generator!`));
 
     // See "Development hints" in README.md for help on Inquirer.js
-    const props = await this._optionOrPrompt(options);
+    // yeoman-option-or-prompt mutates the prompts (deletes `when`, replaces `choices`/`default`
+    // functions by their result); pass copies so that runs in one process (the tests) stay independent.
+    const props = await this._optionOrPrompt(
+      options.map((prompt) => ({ ...prompt })),
+    );
 
     // To access props later use this.props.someAnswer;
     this.props = props;
@@ -179,10 +183,16 @@ export default class extends Generator {
       this.props.Vref = "\\zvref[S]";
     }
 
-    // Only minted and the PlantUML UML example need shell-escape; tikz-uml and the
-    // remaining thesis content do not.
+    // The program that processes the bibliography: biber for biblatex, bibtex otherwise.
+    this.props.bibrunner =
+      this.props.bibtextool === "biblatex" ? "biber" : "bibtex";
+
+    // Only the PlantUML UML example needs shell-escape. minted 3 (TeX Live 2025 and later)
+    // runs latexminted, which TeX Live permits in restricted shell escape; minted 2
+    // (TeX Live 2024) still needs shell-escape.
     this.props.requiresShellEscape =
-      this.props.listings == "minted" || this.props.uml == "plantuml";
+      (this.props.listings == "minted" && this.props.texlive < 2025) ||
+      this.props.uml == "plantuml";
 
     // Two-column layouts (IEEE, and the ACM conference/journal formats) cannot use
     // `longtable` ("longtable not in 1-column mode"), so the longtable example must
@@ -310,7 +320,7 @@ export default class extends Generator {
     );
     this.fs.copyTpl(
       this.templatePath("latexmkrc"),
-      this.destinationPath(this.props.overleaf ? "_latexmkrc" : ".latexmkrc"),
+      this.destinationPath(".latexmkrc"),
       this.props,
     );
     this.fs.copyTpl(
@@ -442,6 +452,20 @@ export default class extends Generator {
       );
     }
 
+    if (this.props.documentclass == "scientific-thesis") {
+      const logos = {
+        "university-of-hamburg": "uhh-logo.pdf",
+        thu: "thu-logo.png",
+      };
+      const logo = logos[this.props.thesisvariant];
+      if (logo) {
+        this.fs.copy(
+          this.templatePath("logos/" + logo),
+          this.destinationPath("figures/" + logo),
+        );
+      }
+    }
+
     if (this.props.documentclass == "ustutt") {
       /*
       this.props.documentclass = "ustutt-include";

package/generators/app/options.js

@@ -114,6 +114,10 @@ export const options = [
         name: "Universität Hamburg",
         value: "university-of-hamburg",
       },
+      {
+        name: "Technische Hochschule Ulm",
+        value: "thu",
+      },
     ],
     default: "ustutt",
   },

package/generators/app/templates/.github/dependabot.yml

@@ -4,3 +4,6 @@ updates:
     directory: '/'
     schedule:
       interval: 'weekly'
+    groups:
+      actions:
+        patterns: ["*"]

package/generators/app/templates/.github/workflows/check.yml

@@ -16,14 +16,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Set up Git repository
-        uses: actions/checkout@v7
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 <% if (uml == "tikz-uml") { -%>
         with:
           # Recursive checkout brings in the tikz-uml submodule used by the UML example.
           submodules: recursive
 <% } -%>
       - name: Install TeX Live
-        uses: zauguin/install-texlive@v4
+        uses: zauguin/install-texlive@6671d0c62046c7e349fe154d5208fe746b07e037 # v4.4.0
         with:
           package_file: '${{ github.workspace }}/Texlivefile'
           texlive_version: <%= texlive %>
@@ -37,14 +37,11 @@ jobs:
           updmap -sys
           texhash
           tlmgr generate language --rebuild-sys
-          if [ ! -f "latexmkrc" ]; then
-            cp "_latexmkrc" "latexmkrc"
-          fi
       - run: latexmk <%= filenames.main %>
 <% if (githubpublish || (lang == "en") && (reallatexcompiler.startsWith("lualatex"))) { -%>
 
       # Highlight mis-spelled words in the PDF
-      - uses: awalsh128/cache-apt-pkgs-action@latest
+      - uses: awalsh128/cache-apt-pkgs-action@553a35bb8ebd9fcabcb1c9451aa4c98e1b4ca8a9 # v1.6.3
         with:
           packages: aspell aspell-en<% if (githubpublish || (language == 'de')) { %> aspell-de<% } %>
           version: 1.0
@@ -82,7 +79,7 @@ jobs:
           texlogsieve <%= filenames.main %>.log | tee -a "$GITHUB_STEP_SUMMARY" || true
           echo '```' >> $GITHUB_STEP_SUMMARY
 <% } -%>
-      - uses: actions/upload-artifact@v7
+      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
         with:
           name: test-result
           path: |
@@ -93,9 +90,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Set up Git repository
-        uses: actions/checkout@v7
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
       - name: Install TeX Live
-        uses: zauguin/install-texlive@v4
+        uses: zauguin/install-texlive@6671d0c62046c7e349fe154d5208fe746b07e037 # v4.4.0
         with:
           package_file: '${{ github.workspace }}/Texlivefile'
           texlive_version: <%= texlive %>
@@ -116,7 +113,7 @@ jobs:
           # echo "## TeXcount LaTeX interpretation" >> $GITHUB_STEP_SUMMARY
           # echo "" >> $GITHUB_STEP_SUMMARY
           # cat "texcount.html-body" >> $GITHUB_STEP_SUMMARY
-      - uses: actions/upload-artifact@v7
+      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
         with:
           name: word-count
           path: |
@@ -134,11 +131,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Set up Git repository
-        uses: actions/checkout@v7
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
       # Original action does not work well - see https://github.com/awalsh128/cache-apt-pkgs-action/pull/136
       # The action is not updated - and thus the dictionaries are not updated
-      - uses: awalsh128/cache-apt-pkgs-action@latest
+      - uses: awalsh128/cache-apt-pkgs-action@553a35bb8ebd9fcabcb1c9451aa4c98e1b4ca8a9 # v1.6.3
         with:
           packages: aspell aspell-en<% if (githubpublish || (language == 'de')) { %> aspell-de<% } %>
           version: 1.0
@@ -186,8 +183,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Set up Git repository
-        uses: actions/checkout@v7
-      - uses: actions/setup-node@v7
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
         with:
           node-version: '22'
       - name: Lint English prose with textlint
@@ -215,17 +212,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Set up Git repository
-        uses: actions/checkout@v7
-      - uses: awalsh128/cache-apt-pkgs-action@latest
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: awalsh128/cache-apt-pkgs-action@553a35bb8ebd9fcabcb1c9451aa4c98e1b4ca8a9 # v1.6.3
         with:
           packages: libyaml-tiny-perl libfile-homedir-perl
           version: 1.0
           execute_install_scripts: true
       - name: Install latexindent
-        uses: zauguin/install-texlive@v4
+        uses: zauguin/install-texlive@6671d0c62046c7e349fe154d5208fe746b07e037 # v4.4.0
         with:
           packages: latexindent
           texlive_version: <%= texlive %>
-      - run: make format
+      - run: make format LOCAL=1
       - name: No changes made by latexindent
         run: git diff --exit-code

package/generators/app/templates/.vscode/extensions.json

@@ -1,6 +1,6 @@
 {
     "recommendations": [
-        "manhen.latex-workshop-2",
+        "james-yu.latex-workshop",
         "tecosaur.latex-utilities",
         "ltex-plus.vscode-ltex-plus"
     ]

package/generators/app/templates/Makefile

@@ -3,8 +3,25 @@
 ## Required for thumbpdf as latexmk does not support thumbpdf by itself
 latexcompiler = <%= reallatexcompiler %>
 
-## evince at linux
-viewer = 'C:/Program Files (x86)/SumatraPDF/SumatraPDF.exe'
+## PDF viewer: Sumatra PDF on Windows (reloads the PDF automatically), the default viewer otherwise
+ifeq ($(OS),Windows_NT)
+viewer = 'C:/Program Files/SumatraPDF/SumatraPDF.exe'
+else ifeq ($(shell uname -s),Darwin)
+viewer = open
+else
+viewer = xdg-open
+endif
+<% if (docker == "iot") { -%>
+
+## The LaTeX tools run in the TeX Live Docker image (see README.md); "make LOCAL=1" uses the local LaTeX distribution
+ifeq ($(LOCAL),)
+ifeq ($(OS),Windows_NT)
+RUN = docker run --rm -v "$(CURDIR):/workdir" -w /workdir <%= iotImage %>
+else
+RUN = docker run --rm -u $(shell id -u):$(shell id -g) -e HOME=/tmp -v "$(CURDIR):/workdir" -w /workdir <%= iotImage %>
+endif
+endif
+<% } -%>
 
 ## Editor
 editor = gedit
@@ -18,6 +35,8 @@ LITERATURE = <%= filenames.bib %>.bib
 ## Derived file names
 SRC = $(shell basename $(MASTER_TEX) .tex)
 TEX_FILES = $(wildcard *.tex content/*.tex)
+## All main files, including variants of MASTER_TEX (e.g., other languages): "make format" indents each of them
+MAIN_TEX_FILES = $(wildcard <%= isPaper ? "paper" : ((documentclass == "ustutt") ? "thesis-example" : "main") %>*.tex)
 GFX_FILES = $(wildcard figures/*)
 
 PDF = $(SRC).pdf
@@ -38,16 +57,16 @@ all: $(PDF)
 compile: $(PDF)
 
 $(PDF): $(MASTER_TEX) $(LITERATURE) $(TEX_FILES) $(GFX_FILES)
-	latexmk $(MASTER_TEX)
+	$(RUN) latexmk $(MASTER_TEX)
 
 clean:
-	latexmk -C
+	$(RUN) latexmk -C
 
 ## Endversion - mit eingebauter Seitenvorschau
 ## Mehrere Durchlaeufe, da bei longtable einige runs mehr vonnoeten sind...
 final: $(PDF)
-	thumbpdf $(PDF)
-	$(latexcompiler) $(MASTER_TEX)
+	$(RUN) thumbpdf $(PDF)
+	$(RUN) $(latexcompiler) $(MASTER_TEX)
 
 mrproper: clean
 	rm -f *~
@@ -62,7 +81,7 @@ stand: $(PDF)
 
 html: clean pdf
 	rm $(AUX)
-	htlatex $(SRC) "html,word,charset=utf8" " -utf8"
+	$(RUN) htlatex $(SRC) "html,word,charset=utf8" " -utf8"
 
 
 # Tools
@@ -92,6 +111,10 @@ aspell:
 			aspell --mode=tex <% if (language == 'de') { %>-l de_DE --run-together<% } else { %>-l en_US<% } %> --encoding=utf-8 --conf=./.aspell.conf -p ./.aspell.en.pws -c $$tex;
 		done
 
+## Show only the relevant messages of the last LaTeX run
+log:
+	$(RUN) texlogsieve --no-heartbeat $(SRC).log
+
 showundef:
 	grep undefined $(LOG)
 
@@ -99,10 +122,10 @@ showundef:
 ## Reformatierung
 
 format:
-	latexindent -l -s -sl -w $(SRC)
+	for f in $(MAIN_TEX_FILES); do $(RUN) latexindent -l -s -sl -w "$$f" || exit 1; done
 
 indent:
-	latexindent -y="indentPreamble:1,defaultIndent:'  '" -m -w $(SRC)
+	$(RUN) latexindent -y="indentPreamble:1,defaultIndent:'  '" -m -w $(SRC)
 
 split-sentences:
-	latexindent -m -l -s -sl -w $(SRC)
+	$(RUN) latexindent -m -l -s -sl -w $(SRC)