generator-latex-template 2026.7.29 → 2026.9.23

package/generators/app/index.js

@@ -157,6 +157,23 @@ export default class extends Generator {
       this.props.bibtextool = "biblatex";
     }
 
+    // `crossref` is a plain CLI flag (no prompt): zref-clever (default, works
+    // with PDF tagging) or the legacy cleveref. Templates write references as
+    // <%- cref %>{…} / <%- Cref %>{…} (sentence start) and <%- vref %>/<%- Vref %>.
+    this.props.crossref =
+      this.options.crossref === "cleveref" ? "cleveref" : "zref-clever";
+    if (this.props.crossref === "cleveref") {
+      this.props.cref = "\\cref";
+      this.props.Cref = "\\Cref";
+      this.props.vref = "\\vref";
+      this.props.Vref = "\\Vref";
+    } else {
+      this.props.cref = "\\zcref";
+      this.props.Cref = "\\Zcref";
+      this.props.vref = "\\zvref";
+      this.props.Vref = "\\zvref[S]";
+    }
+
     // Only minted and the PlantUML UML example need shell-escape; tikz-uml and the
     // remaining thesis content do not.
     this.props.requiresShellEscape =
@@ -304,6 +321,13 @@ export default class extends Generator {
       this.templatePath("dot.aspell.conf"),
       this.destinationPath(".aspell.conf"),
     );
+    // The mwe quick start lints Markdown with its own (template-managed) config
+    if (this.props.documentclass !== "mwe") {
+      this.fs.copy(
+        this.templatePath("dot.textlintrc.json"),
+        this.destinationPath(".textlintrc.json"),
+      );
+    }
     if (this.props.language == "de" || this.props.githubpublish) {
       this.fs.copy(
         this.templatePath("dot.aspell.de.pws"),

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

@@ -182,6 +182,34 @@ jobs:
              echo 'If you want to ignore words, add them to `.aspell.<%= language %>.pws` (your personal aspell dictionary)' >> $GITHUB_STEP_SUMMARY
             exit 1
           fi
+  textlint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Git repository
+        uses: actions/checkout@v7
+      - uses: actions/setup-node@v7
+        with:
+          node-version: '22'
+      - name: Lint English prose with textlint
+        run: |
+          # Report-only: findings show up as annotations, the job does not fail.
+          # Rules come from .textlintrc.json. Only English documents (marked by
+          # "% !TeX spellcheck = en-US") are linted: write-good targets English.
+          files=$(grep -l '^% !TeX spellcheck = en' *.tex || true)
+          if [ -z "$files" ]; then
+            echo "No English .tex files to lint." >> "$GITHUB_STEP_SUMMARY"
+            exit 0
+          fi
+          npx --yes \
+            --package textlint \
+            --package textlint-plugin-latex2e \
+            --package textlint-filter-rule-allowlist \
+            --package textlint-rule-terminology \
+            --package textlint-rule-write-good \
+            textlint --format github $files \
+            | sed "s|${GITHUB_WORKSPACE}/||g" | tee annotations.txt || true
+          count=$(grep -c '^::\(error\|warning\)' annotations.txt || true)
+          echo "textlint reported ${count} finding(s) in: ${files//$'\n'/, }" >> "$GITHUB_STEP_SUMMARY"
 <% } -%>
   indent:
     runs-on: ubuntu-latest

package/generators/app/templates/README.en.md

@@ -135,6 +135,14 @@ The LaTeX snippets this template is assembled from can be inspected at <https://
 - [paper-minted.pdf](https://latextemplates.github.io/acm-enhanced/paper-minted.pdf) - conference paper showing minted in action.
 <% break; default: -%>
 <% break; } } -%>
+<% if (isThesis) { -%>
+
+## Writing your thesis
+
+- Read [Student Thesis Projects](https://vdf.ch/product/student-thesis-projects-en.html) by Lichter, Ludewig, Deininger, and Schneider.
+  The open-access book explains how to organize, conduct, write, and present a thesis.
+- Before handing in, work through the [thesis checklist](docs/thesis-checklist.md).
+<% } -%>
 
 ## Usage
 
@@ -196,6 +204,15 @@ On the command line, there are additional features:
 - `make stand`: Creates a new PDF with the current status of the document.
 - `make view`: Opens the configured viewer
 - `make mrproper`: Cleans up and removes also editor backup files.
+<% if (documentclass != "mwe") { -%>
+
+The `textlint` job of the `Check` workflow reports weakening words (e.g., "clearly", "just") in the English `.tex` files as annotations.
+Run it locally with `npx` (needs Node.js; rules come from `.textlintrc.json`):
+
+```bash
+npx --yes --package textlint --package textlint-plugin-latex2e --package textlint-filter-rule-allowlist --package textlint-rule-terminology --package textlint-rule-write-good textlint <%= filenames.main %>.tex
+```
+<% } -%>
 <% if (documentclass == "mwe") { -%>
 
 ### Linting your Markdown
@@ -239,8 +256,8 @@ Following features are enabled in this template:
   See <https://tex.stackexchange.com/a/441701/9075> for details.
 <% } -%>
 - Automatic setting of "Fig." and "Section"/"Sect." according to the LNCS style.
-  Just use `\Cref{sec:xy}` at the beginning of a sentence and `\cref{sec:xy}` in the middle of a sentence.
-  Thanx to [cleveref].
+  Just use `<%- Cref %>{sec:xy}` at the beginning of a sentence and `<%- cref %>{sec:xy}` in the middle of a sentence.
+  Thanx to [<%= crossref %>].
 <% if (font == "default" || githubpublish) { -%>
 - Sharper font (still compatible with Springer's requirements).
 <% } -%>
@@ -264,7 +281,7 @@ Following features are enabled in this template:
 - <% if (githubpublish && !isThesis) { -%>(Optional) <% } %>Support todos as pdf annotations. This is enabled by the [pdfcomment] package.
 <% } -%>
 - [microtypographic extensions](https://www.ctan.org/pkg/microtype) for a better look of the paper.
-- Modern packages such as [microtype], [cleveref]<% if (enquotes == "csquotes" || githubpublish) { %>, [csquotes]<% } %><% if (documentclass != 'lncs') { %>, [paralist]<% } %>, [hyperref], [hypcap], [upquote]<% if (documentclass == 'lncs') { %>, [natbib]<% } %>, [booktabs].
+- Modern packages such as [microtype], [<%= crossref %>]<% if (enquotes == "csquotes" || githubpublish) { %>, [csquotes]<% } %><% if (documentclass != 'lncs') { %>, [paralist]<% } %>, [hyperref], [hypcap], [upquote]<% if (documentclass == 'lncs') { %>, [natbib]<% } %>, [booktabs].
 <% if ((reallatexcompiler.startsWith("lualatex")) || githubpublish) { -%>
 - <% if (githubpublish && !isThesis) { -%>(Optional) <% } %>LaTeX compilation using the modern [lualatex] compiler.
   For older systems, [pdflatex](https://en.wikipedia.org/wiki/PdfTeX) is still supported.
@@ -901,7 +918,7 @@ Any derived work can freely be relicensed and can omit original copyright and li
 [biblatex]: http://tex.stackexchange.com/tags/biblatex/info
 [bibtex]: https://www.ctan.org/pkg/bibtex
 [booktabs]: https://ctan.org/pkg/booktabs
-[cleveref]: https://ctan.org/pkg/cleveref
+[<%= crossref %>]: https://ctan.org/pkg/<%= crossref %>
 [csquotes]: https://www.ctan.org/pkg/csquotes
 [hypcap]: https://www.ctan.org/pkg/hypcap
 [hyperref]: https://ctan.org/pkg/hyperref

package/generators/app/templates/Texlivefile

@@ -48,7 +48,9 @@ cfr-lm
 <% if (githubpublish || (documentclass == "ustutt")) { -%>
 charter<%# required by mathdesign-charter%>
 <% } -%>
+<% if (githubpublish || (crossref == "cleveref")) { -%>
 cleveref
+<% } -%>
 cm-super
 <% if (githubpublish || (documentclass == "acmart")) { -%>
 cmap
@@ -341,6 +343,9 @@ xpatch
 <% } -%>
 xstring<%# this includes stfloats; required by textcomp %>
 zref
-<% if (githubpublish || (documentclass == "mwe")) { -%>
-zref-clever<%# smart \zcref cross-references in the mwe quick-start %>
+<% if (githubpublish || (documentclass == "mwe") || (crossref == "zref-clever")) { -%>
+zref-clever
+<% } -%>
+<% if (githubpublish || (isThesis && (crossref == "zref-clever"))) { -%>
+zref-vario
 <% } -%>

package/generators/app/templates/biblatex.example.en.tex

@@ -11,4 +11,4 @@ In case one wants to name the author: \textcite{mwe} shows a minimal \LaTeX{} ex
 Note that \texttt{\textbackslash textcite\{mwe\}} prints both the author and the reference to the bibliography entry.
 
 Remember that you have to call \texttt{biber <%= filenames.main %>} to generate the bibliography data for \texttt{<%= reallatexcompiler %>}.
-You will need to run \texttt{<%= reallatexcompiler %>} twice to ensure that the page numbers are updated correctly.
+You will need to run \texttt{<%= reallatexcompiler %>} twice so that the page numbers are up to date.

package/generators/app/templates/bibliography.bib

@@ -45,4 +45,17 @@
 }
 <% } -%>
 
+@Book{Lichter2026,
+  author    = {Horst Lichter and Jochen Ludewig and Marcus Deininger and Kurt Schneider},
+  title     = {{Student Thesis Projects}: A Guide to Organizing, Conducting, and Presenting Student Thesis Projects Using the Example of Computer Science},
+  year      = {2026},
+  edition   = {7},
+  publisher = {vdf Hochschulverlag},
+  address   = {Zollikon},
+  isbn      = {978-3-7281-4241-2},
+  doi       = {10.3218/4241-2},
+  url       = {https://vdf.ch/product/student-thesis-projects-en.html},
+  urldate   = {2026-09-23},
+}
+
 @Comment{jabref-meta: databaseType:<%= bibtextool %>;}

package/generators/app/templates/docs/thesis-checklist.md

@@ -0,0 +1,51 @@
+# Thesis checklist
+
+Work through this list before you hand in your thesis.
+It is not part of the PDF, so there is nothing to remove afterwards.
+For much more advice on organizing, conducting, writing, and presenting a thesis, read [Student Thesis Projects](https://vdf.ch/product/student-thesis-projects-en.html) by Lichter, Ludewig, Deininger, and Schneider (open access).
+
+## Readable from beginning to end
+
+- [ ] Every term, concept, and abbreviation is introduced before it is used.
+- [ ] References to earlier parts are fine; references to later parts are rare in the running text.
+- [ ] Each chapter ends in a way that leads to the next one.
+
+## Readable in ten minutes
+
+A reader who opens the thesis anywhere and has ten minutes must find their way.
+
+- [ ] No heading is directly followed by another heading: there is always text after a heading.
+- [ ] After a chapter heading, this text is an introductory paragraph that outlines the chapter's sections.
+- [ ] This paragraph refers back to what the chapter builds on and forward to where its results are used.
+- [ ] The introduction alone summarizes the whole argument: problem, method, results, and their interpretation.
+
+## Scientific argument
+
+- [ ] The research question is stated precisely.
+- [ ] The method is described so that someone else could reproduce your steps.
+- [ ] Results are reported first and interpreted separately.
+- [ ] The conclusion answers the research question and names limitations and future work.
+- [ ] The abstract was written last and matches the thesis.
+
+## Sources
+
+- [ ] Every statement that is not your own has a citation; direct quotes are marked as such.
+- [ ] Bibliography entries are complete (authors, title, venue, year, DOI where available).
+- [ ] Every cited web page states when you last accessed it (`urldate` field, printed as "visited on …").
+- [ ] The library is cleaned up with [JabRef's cleanup entries](https://docs.jabref.org/finding-sorting-and-cleaning-entries/cleanupentries) (consistent formatting, e.g., of dates, page ranges, and DOIs).
+- [ ] The use of AI tools is declared as your examination regulations require.
+
+## Figures, tables, and listings
+
+- [ ] Each one is referenced and discussed in the text.
+- [ ] Each caption is understandable on its own.
+- [ ] Text in figures is legible, also when printed.
+
+## Form
+
+- [ ] The PDF shows no `??` (undefined references or citations).
+- [ ] All TODO notes are resolved.
+- [ ] All hints and examples of this template are removed.
+- [ ] The text is spell-checked and grammar-checked (see the README for tools).
+- [ ] The title page is correct: title, your name, supervisors, dates.
+- [ ] The formal requirements of your examination office are met (page limit, signed declaration, number of copies, file format).

package/generators/app/templates/dot.aspell.conf

@@ -48,3 +48,9 @@ add-tex-command usebibmacro p
 add-tex-command usemintedstyle p
 add-tex-command usepackage oooooop
 add-tex-command usetikzlibrary p
+add-tex-command zcLanguageSetup pp
+add-tex-command zcref op
+add-tex-command zcRefTypeSetup pp
+add-tex-command zcsetup p
+add-tex-command zvref op
+add-tex-command Zcref op

package/generators/app/templates/dot.aspell.de.pws

@@ -1,5 +1,6 @@
-personal_ws-1.1 de 122 utf-8
+personal_ws-1.1 de 134 utf-8
 ACM
+Access
 Atlantic
 BPEL
 BPMN
@@ -9,6 +10,7 @@ Das
 Database
 Diag
 Firstname
+Fließtext
 Geänderter
 Hier
 IEEEtran
@@ -25,15 +27,21 @@ North
 OMG
 ORCID
 OldStyle
+Open
 Organization
 Practitioner
+Projects
 RDBMS
 RGB
+Rückverweise
 TODOs
 Textfarbe
+Thesis
 Treaty
 UML
+Vorwärtsverweise
 Worten
+Zcref
 abbreviationdot
 aboveskip
 acmnumeric
@@ -116,8 +124,12 @@ subfigure
 subfigures
 tion
 tt
+vorausverweist
 werden
 wird
 wurde
 xleftmargin
+zcref
+zref
+zvref
 œ

package/generators/app/templates/dot.aspell.en.pws

@@ -1,4 +1,4 @@
-personal_ws-1.1 en 128 utf-8
+personal_ws-1.1 en 132 utf-8
 ACM
 Atlantic
 BPEL
@@ -34,6 +34,7 @@ Textfarbe
 Treaty
 UML
 Worten
+Zcref
 abbreviationdot
 aboveskip
 acmnumeric
@@ -126,4 +127,7 @@ werden
 wird
 wurde
 xleftmargin
+zcref
+zref
+zvref
 œ

package/generators/app/templates/dot.textlintrc.json

@@ -0,0 +1,17 @@
+{
+  "plugins": {
+    "latex2e": true
+  },
+  "filters": {
+    "allowlist": {
+      "allow": ["/\\bonly\\b/i"]
+    }
+  },
+  "rules": {
+    "terminology": true,
+    "write-good": {
+      "tooWordy": false,
+      "whitelist": ["only"]
+    }
+  }
+}

package/generators/app/templates/floats.example.de.tex

@@ -1,7 +1,7 @@
 <%= heading2 %>{Abbildungen}
 
 <%- bexample %>
-\Cref{fig:label} zeigt etwas Interessantes
+<%- Cref %>{fig:label} zeigt etwas Interessantes
 
 \begin{figure}
   \centering
@@ -14,7 +14,7 @@
 <% if (documentclass == 'ieee') { -%>
 
 One can span a figure across multiple columns by using \verb+\begin{figure*}+.
-See \cref{fig:16x9} as an example.
+See <%- cref %>{fig:16x9} as an example.
 
 <%- bexample %>
 \begin{figure*}

package/generators/app/templates/floats.example.en.tex

@@ -1,7 +1,7 @@
 <%= heading2 %>{Figures}
 
 <%- bexample %>
-\Cref{fig:label} shows something interesting.
+<%- Cref %>{fig:label} shows something interesting.
 
 \begin{figure}
   \centering
@@ -17,7 +17,7 @@
 <% if (documentclass == 'ieee') { -%>
 
 One can span a figure across multiple columns by using \verb+\begin{figure*}+.
-See \cref{fig:16x9} as an example.
+See <%- cref %>{fig:16x9} as an example.
 
 <%- bexample %>
 \begin{figure*}

package/generators/app/templates/hyperref.preamble.en.tex

@@ -1,4 +1,4 @@
-% Enable that parameters of \cref{}, \ref{}, \cite{}, ... are linked so that a reader can click on the number an jump to the target in the document
+% Enable that parameters of \zcref{}, \ref{}, \cite{}, ... are linked so that a reader can click on the number an jump to the target in the document
 \usepackage{hyperref}
 
 <% if (documentclass != "ustutt") { -%>

package/generators/app/templates/hyphenation.example.en.tex

@@ -2,7 +2,7 @@
 
 \LaTeX{} automatically hyphenates words.
 When using \href{https://ctan.org/pkg/microtype}{microtype}, there should be fewer hyphenations than in other settings.
-It might be necessary to tweak the hyphenations nevertheless.
+You might still need to tweak the hyphenation.
 Here are some hints:
 
 <%- bexample %>

package/generators/app/templates/listings.example.de.tex

@@ -1,8 +1,8 @@
 <%= heading2 %>{Quellcode}
 
 <%- bexample %>
-\Cref{lst:XML} zeigt XML-Quelltext.
-\Cref{line:comment} enthält einen Kommentar.
+<%- Cref %>{lst:XML} zeigt XML-Quelltext.
+<%- Cref %>{line:comment} enthält einen Kommentar.
 
 \begin{lstlisting}[
   language=XML,
@@ -16,7 +16,7 @@
 <%- eexample %>
 
 Der zusätzliche Paramter \verb+float+ führt dazu, dass das Listing auch floated.
-\Cref{lst:flXML} zeigt das gleitendede Listing.
+<%- Cref %>{lst:flXML} zeigt das gleitendede Listing.
 
 <%- bexample %>
 \begin{lstlisting}[
@@ -33,7 +33,7 @@ Der zusätzliche Paramter \verb+float+ führt dazu, dass das Listing auch floate
 \end{lstlisting}
 <%- eexample %>
 
-Es ist möglich auch JSON zu setzen, wie in \cref{lst:json} gezeigt.
+Es ist möglich auch JSON zu setzen, wie in <%- cref %>{lst:json} gezeigt.
 
 <%- bexample %>
 \begin{lstlisting}[
@@ -47,7 +47,7 @@ Es ist möglich auch JSON zu setzen, wie in \cref{lst:json} gezeigt.
 \end{lstlisting}
 <%- eexample %>
 
-Java ist auch möglich -- \cref{lst:java}.
+Java ist auch möglich -- <%- cref %>{lst:java}.
 
 <%- bexample %>
 \begin{lstlisting}[

package/generators/app/templates/listings.example.en.tex

@@ -1,8 +1,8 @@
 <%= heading2 %>{Source Code}
 
 <%- bexample %>
-\Cref{lst:XML} shows source code written in XML.
-\Cref{line:comment} contains a comment.
+<%- Cref %>{lst:XML} shows source code written in XML.
+<%- Cref %>{line:comment} contains a comment.
 
 \begin{lstlisting}[
   language=XML,
@@ -16,7 +16,7 @@
 <%- eexample %>
 
 One can also add \verb+float+ as parameter to have the listing floating.
-\Cref{lst:flXML} shows the floating listing.
+<%- Cref %>{lst:flXML} shows the floating listing.
 
 <%- bexample %>
 \begin{lstlisting}[
@@ -33,7 +33,7 @@ One can also add \verb+float+ as parameter to have the listing floating.
 \end{lstlisting}
 <%- eexample %>
 
-One can also typeset JSON as shown in \cref{lst:json}.
+One can also typeset JSON as shown in <%- cref %>{lst:json}.
 
 <%- bexample %>
 \begin{lstlisting}[
@@ -47,7 +47,7 @@ One can also typeset JSON as shown in \cref{lst:json}.
 \end{lstlisting}
 <%- eexample %>
 
-Java is also possible as shown in \cref{lst:java}.
+Java is also possible as shown in <%- cref %>{lst:java}.
 
 <%- bexample %>
 \begin{lstlisting}[