generator-latex-template 0.7.0 → 0.8.0

package/generators/app/options.js

@@ -0,0 +1,375 @@
+export const options = [
+  {
+    type: "list",
+    name: "documentclass",
+    message: "Which template should be generated?",
+    choices: [
+      {
+        name: "Scientic Thesis",
+        value: "scientific-thesis",
+      },
+      {
+        name: "Association for Computing Machinery (ACM)",
+        value: "acmart",
+      },
+      {
+        name: "Institute of Electrical and Electronics Engineers (IEEE)",
+        value: "ieee",
+      },
+      {
+        name: "Springer's Lecture Notes in Computer Science (LNCS)",
+        value: "lncs",
+      },
+    ],
+    default: "scientific-thesis",
+  },
+  {
+    type: "list",
+    name: "acmformat",
+    when(response) {
+      return response.documentclass === "acmart";
+    },
+    message: "Which format of ACM?",
+    choices: [
+      {
+        value: "manuscript",
+        name: "A manuscript. This is the default.",
+      },
+      {
+        value: "acmsmall",
+        name: "Small single-column format. Used for CIE, CSUR, JACM, JDIQ, JEA, JERIC, JETC, PACMCGIT, PACMHCI, PACMPL, TAAS, TACCESS, TACO, TALG, TALLIP (formerly TALIP), TCPS, TDS, TEAC, TECS, TELO, THRI, TIIS, TIOT, TISSEC, TIST, TKDD, TMIS, TOCE, TOCHI, TOCL, TOCS, TOCT, TODAES, TODS, TOIS, TOIT, TOMACS, TOMM (formerly TOMCCAP), TOMPECS, TOMS, TOPC, TOPLAS, TOPS, TOS, TOSEM, TOSN, TQC, TRETS, TSAS, TSC, TSLP and TWEB, including special issues.",
+      },
+      {
+        value: "acmlarge",
+        name: "Large single-column format. Used for DTRAP, HEALTH, IMWUT, JOCCH, POMACS and TAP, including special issues.",
+      },
+      {
+        value: "acmtog",
+        name: "Large double-column format. Used for TOG, including annual conference Technical Papers.",
+      },
+      {
+        value: "sigconf",
+        name: "Proceedings format for most ACM conferences (with the exceptionslisted below) and all ICPS volumes.",
+      },
+      {
+        value: "sigplan",
+        name: "Proceedings format for SIGPLAN conferences",
+      },
+    ],
+    default: "sigconf",
+  },
+  {
+    type: "confirm",
+    name: "acmreview",
+    when(response) {
+      return response.documentclass === "acmart";
+    },
+    message: "Format as document to review?",
+    default: true,
+  },
+  {
+    type: "list",
+    name: "ieeevariant",
+    when(response) {
+      return response.documentclass === "ieee";
+    },
+    message: "Which variant of IEEE paper?",
+    choices: [
+      {
+        name: "conference paper",
+        value: "conference",
+      },
+      {
+        name: "journal paper",
+        value: "journal",
+      },
+      {
+        name: 'peerreview paper - similar to journal paper, but additional cover page and on first "real" paper page title without authors',
+        value: "peerreview",
+      },
+    ],
+    default: "conference",
+  },
+  {
+    type: "list",
+    name: "papersize",
+    message: "Which paper size to use?",
+    choices: [
+      {
+        name: "A4",
+        value: "a4",
+      },
+      {
+        name: "US letter",
+        value: "letter",
+      },
+    ],
+    default: "a4",
+  },
+  {
+    type: "list",
+    name: "overleaf",
+    message: "Overleaf compatibility?",
+    choices: [
+      {
+        name: "yes",
+        value: true,
+      },
+      {
+        name: "no",
+        value: false,
+      },
+    ],
+    default: true,
+  },
+  {
+    type: "list",
+    name: "texlive",
+    message: "Which TeXLive compatibility?",
+    choices: function (state) {
+      let res = [
+        {
+          name: "TeXLive 2021",
+          value: 2021,
+        },
+        {
+          name: "TeXLive 2022",
+          value: 2022,
+        },
+      ];
+      if (!state.overleaf) {
+        res.push({
+          name: "TeXLive 2023",
+          value: 2023,
+        });
+      }
+      return res;
+    },
+    default(state) {
+      if (state.overleaf) {
+        return 2022;
+      } else {
+        return 2023;
+      }
+    },
+  },
+  {
+    type: "list",
+    name: "latexcompiler",
+    message: "Which latex compiler should be used?",
+    choices: ["pdflatex", "lualatex"],
+    default: "pdflatex",
+    when(response) {
+      return !(response.documentclass === "ieee");
+    },
+  },
+  {
+    when(response) {
+      return (
+        response.documentclass !== "acmart" && response.documentclass !== "ieee"
+      );
+    },
+    type: "list",
+    name: "bibtextool",
+    message: "Which BibTeX tool should be used?",
+    choices: [
+      {
+        name: "BibTeX",
+        value: "bibtex",
+      },
+      {
+        name: "BibLaTeX + biber",
+        value: "biblatex",
+      },
+    ],
+    default(response) {
+      switch (response.documentclass) {
+        case "acmart":
+        case "ieee":
+        case "lncs":
+          return "bibtex";
+        default:
+          return "biblatex";
+      }
+    },
+  },
+  {
+    type: "list",
+    name: "docker",
+    message: "Should a Dockerfile be generated?",
+    choices: [
+      {
+        name: "no",
+        value: false,
+      },
+      {
+        name: "yes (Island of TeX)",
+        value: "iot",
+      },
+      {
+        name: "yes (Reiztig)",
+        value: "reitzig",
+      },
+      {
+        name: "yes (DANTE e.V.)",
+        value: "dante",
+      },
+    ],
+    default: false,
+  },
+  {
+    type: "list",
+    name: "lang",
+    message: "Which language should the document be?",
+    choices: [
+      {
+        name: "English",
+        value: "en",
+      },
+      {
+        name: "German",
+        value: "de",
+      },
+    ],
+    default: "en",
+  },
+  {
+    type: "list",
+    name: "font",
+    message: "Which font should be used?",
+    choices: (state) => {
+      const res = [];
+      if (state.documentclass === "acmart") {
+        res.push({
+          name: "ACM Default",
+          value: "default",
+        });
+      } else if (state.documentclass === "ieee") {
+        res.push({
+          name: "IEEE Default",
+          value: "default",
+        });
+      } else {
+        res.push({
+          name: "Computer Modern (Default LaTeX font)",
+          value: "default",
+        });
+        if (state.documentclass === "scientific-thesis") {
+          res.push({
+            name: "Arial",
+            value: "arial",
+          });
+        }
+
+        res.push({
+          name: "Times New Roman",
+          value: "times",
+        });
+      }
+
+      return res;
+    },
+    default: "default",
+    when(response) {
+      return response.documentclass !== "ieee";
+    },
+  },
+  {
+    type: "list",
+    name: "listings",
+    message: "Which package to typeset listings?",
+    choices: [
+      {
+        name: "listings",
+        value: "listings",
+      },
+      {
+        name: "minted (requires a working Python installation)",
+        value: "minted",
+      },
+    ],
+    default: "listings",
+  },
+  {
+    type: "list",
+    name: "enquotes",
+    message: 'Which package to use to "enquote" text?',
+    choices: (state) => {
+      const res = [];
+      res.push({
+        name: "csquotes (\\enquote{...} command)",
+        value: "csquotes",
+      });
+      if (state.language === "en") {
+        res.push({
+          name: "textcmds (\\qq{...} command)",
+          value: "textcmds",
+        });
+      }
+
+      if (state.language === "de") {
+        res.push({
+          name: "Plain LaTeX (\\glqq{}text\\grqq{} - not recommended)",
+          value: "plainlatex",
+        });
+      } else {
+        res.push({
+          name: "Plain LaTeX (``text'' - not recommended)",
+          value: "plainlatex",
+        });
+      }
+
+      return res;
+    },
+    default: "csquotes",
+  },
+  {
+    type: "list",
+    name: "tweakouterquote",
+    message:
+      'Enable hyphenation tweak (e.g., application"=specific for app-lication-specific at a linebreak) or enable easy quotation (e.g., "application"; not common in default latex setups)?',
+    choices: [
+      {
+        name: "Hyphenation tweak",
+        value: "babel",
+      },
+      {
+        name: "Easy quotation",
+        value: "outerquote",
+      },
+    ],
+    default: "babel",
+  },
+  {
+    type: "list",
+    name: "todo",
+    message: "Which package to mark TODOs?",
+    choices: [
+      {
+        name: "pdfcomment",
+        value: "pdfcomment",
+      } /*
+      {
+        name: "Plain LaTeX (simple \\commentontext and \\commentatside are defined)",
+        value: "plainlatex"
+      }, */,
+      {
+        name: "None (no support)",
+        value: "none",
+      },
+    ],
+    default: "pdfcomment",
+  },
+  {
+    type: "confirm",
+    name: "howtotext",
+    message: "Include hints on text (e.g., how to write an abstract)?",
+    default: true,
+  },
+  {
+    type: "confirm",
+    name: "examples",
+    message: "Include minimal LaTeX examples?",
+    default: true,
+  },
+];

package/generators/app/templates/Dockerfile.dante

@@ -1,5 +1,7 @@
 FROM danteev/texlive:<% switch (texlive) {
-  case 2021: %>edge<% break;
+  case 2023: %>edge<% break;
+  // 2022 does not exist - see https://github.com/dante-ev/docker-texlive/blob/main/CHANGELOG.md
+  case 2021: %>2021-D<% break;
 } -%>
 
 WORKDIR /workdir

package/generators/app/templates/Dockerfile.iot

@@ -0,0 +1,14 @@
+FROM registry.gitlab.com/islandoftex/images/texlive:<% switch (texlive) {
+  case 2023: %>latest-basic<% break;
+  case 2022: %>TL2022-historic<% break;
+} -%>
+
+WORKDIR /workdir
+
+COPY Texlivefile /workdir/
+<% if (texlive == 2023) { -%>
+
+RUN xargs tlmgr install --repository https://mirror.mwt.me/ctan/systems/texlive/tlnet < /workdir/Texlivefile
+
+RUN tlmgr path add
+<% } -%>

package/generators/app/templates/Dockerfile.reitzig

@@ -3,35 +3,36 @@ FROM reitzig/texlive-<% switch (latexcompiler) {
   case "lualatex": %>base-luatex<% break;
   default: %>base<% break;
 } -%>:<% switch (texlive) {
-  case 2022: %>2022.2<% break;
-  case 2021: %>2021.10<% break;
+  case 2023: %>2023.1<% break;
+  case 2022: %>2022.8<% break;
+  case 2021: %>2021.9<% break;
 } -%>
 
 RUN apk update && apk add --no-cache bash perl python3 py3-pip
 RUN pip3 install pygments
 
 # Emulate "Install dependencies" of "entrypoint work ..."
-<% if (texlive < 2022) { -%>
+<% if (texlive < 2023) { -%>
 RUN tlmgr update --self --repository http://ftp.math.utah.edu/pub/tex/historic/systems/texlive/<%= texlive %>/tlnet-final
 COPY Texlivefile /work/src
-RUN xargs tlmgr install --repository http://ftp.math.utah.edu/pub/tex/historic/systems/texlive/<%= texlive %>/tlnet-final < "/work/src/Texlivefile" && \
+RUN xargs tlmgr install --repository http://ftp.math.utah.edu/pub/tex/historic/systems/texlive/<%= texlive %>/tlnet-final < "/work/src/Texlivefile"
 <% } else { -%>
 RUN tlmgr update --self --repository https://mirror.mwt.me/ctan/systems/texlive/tlnet
 COPY Texlivefile /work/src
-RUN xargs tlmgr install --repository https://mirror.mwt.me/ctan/systems/texlive/tlnet < "/work/src/Texlivefile" && \
+RUN xargs tlmgr install --repository https://mirror.mwt.me/ctan/systems/texlive/tlnet < "/work/src/Texlivefile"
 <% } -%>
-    sha256sum "/work/src/Texlivefile" > "/work/tmp/Texlivefile.sha" && \
+RUN sha256sum "/work/src/Texlivefile" > "/work/tmp/Texlivefile.sha"
 #
 # make <% if (bibtextool == "biblatex") { %>biber, <% } %>latexmk and texlogsieve available
 <% if (bibtextool == "biblatex") { -%>
-    cp /usr/local/texlive/<%= texlive %>/bin/x86_64-linuxmusl/biber /usr/local/bin && \
+RUN cp /usr/local/texlive/<%= texlive %>/bin/x86_64-linuxmusl/biber /usr/local/bin
 <% } -%>
-    cp /usr/local/texlive/<%= texlive %>/bin/x86_64-linuxmusl/latexmk /usr/local/bin && \
-    cp /usr/local/texlive/<%= texlive %>/bin/x86_64-linuxmusl/texlogsieve /usr/local/bin && \
+RUN cp /usr/local/texlive/<%= texlive %>/bin/x86_64-linuxmusl/latexmk /usr/local/bin
+RUN cp /usr/local/texlive/<%= texlive %>/bin/x86_64-linuxmusl/texlogsieve /usr/local/bin
 <% if (latexcompiler === "lualatex") { -%>
 #
 # update font index
-    luaotfload-tool --update && \
+RUN luaotfload-tool --update
 <% } -%>
 # use latest texlogsieve
-    cd /usr/local/bin && wget https://gitlab.com/lago/texlogsieve/-/raw/main/texlogsieve?inline=false
+# RUN cd /usr/local/bin && wget https://gitlab.com/lago/texlogsieve/-/raw/main/texlogsieve?inline=false

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

@@ -159,7 +159,6 @@ Congratulations. You chose to use all available features.
 ## Background
 
 The official template is available at <https://www.springer.com/gp/computer-science/lncs/conference-proceedings-guidelines> --> "Templates, samples files & useful links" --> "LaTeX2e Proceedings Templates (zip)"
-Deep link: <ftp://ftp.springernature.com/cs-proceeding/llncs/llncs2e.zip>.
 
 ## Quick start
 
@@ -168,12 +167,7 @@ Deep link: <ftp://ftp.springernature.com/cs-proceeding/llncs/llncs2e.zip>.
 - Edit [paper.tex](paper.tex).
 - `latexmk paper`.
 
-When using on overleaf, you have to add the file `llncs.cls` manually:
-
-1. Navigate to "Add Files"
-2. Select "From External URL"
-3. Paste <https://latextemplates.github.io/stys-for-overleaf/llncs.cls> into the field "URL to fetch the file from"
-4. Click "Create"
+When using on overleaf, you have to switch Overleaf to use TeXLive 2022 (or later).
 
 As you see on GitHub actions, the paper compiles out of the box.
 There is no need to adjust the packages or to remove some of them.
@@ -294,8 +288,8 @@ ShareLaTeX might output following warning:
 > LaTeX document class for Lecture Notes in Computer Science'
 > is available.
 
-The reason is that you did not use `llncs.cls` from a recent llncs2e.zip (which can be downloaded from <ftp://ftp.springernature.com/cs-proceeding/llncs/llncs2e.zip>), but a copy from somewhere else.
-Please use the latest version offered by Springer.
+The reason is that you did not use `llncs.cls` (included in your LaTeX distribution).
+Please remove the file and update your LaTeX distribution.
 <% break; case "ieee": -%>
 
 ### Q: I have questions on the IEEEtran class itself.
@@ -328,7 +322,7 @@ A: You have activated `\MakeOuterQuote{"}` and used some special babel command t
 Now, you have to decide whether you want keep using plain quotes to enquote a word or use the special hyphenation command.
 In other words: Do you want `"quote"` and `app\-lication\-specific` or `\enquote{quote} and  application"=specific`?
 
-Note that this should not happen when the template is generated as the setting `tweak_outerquote` ensures that these two options are mutually exclusive.
+Note that this should not happen when the template is generated as the setting `tweakouterquote` ensures that these two options are mutually exclusive.
 
 ### Q: I need more space. What can I do?
 

package/generators/app/templates/Texlivefile

@@ -19,6 +19,7 @@ caption
 catchfile
 cfr-lm
 cleveref
+cmap
 comment
 csquotes
 currfile
@@ -37,7 +38,11 @@ diagbox
 environ
 etexcmds
 etoolbox
+filehook
 floatflt
+<% if (latexcompiler == "lualatex") { -%>
+fontspec
+<% } -%>
 framed
 fvextra
 gettitlestring
@@ -67,11 +72,15 @@ latexmk
 letltxmacro
 libertine
 lineno
-linenoamsmath
 lipsum
 listings
 llncs
 ltxcmds
+<% if (latexcompiler == "lualatex") { -%>
+luatexbase
+luacode
+lualatex-math
+<% } -%>
 marginnote
 <% if (documentclass == "scientific-thesis") { -%>
 mfirstuc
@@ -84,16 +93,20 @@ mwe
 natbib
 ncctools
 newcomputermodern
+newfloat
 newtx
 newtxtt
 nfssext-cfr
 nowidow
 oberdiek
 paralist
-pbalance
 pdfcomment
+luatex85
 pdfescape
 pdftexcmds
+<% if (examples) { -%>
+pgf
+<% } -%>
 pict2e
 preprint
 refcount
@@ -102,20 +115,32 @@ rerunfilecheck
 <% if (documentclass == "scientific-thesis") { -%>
 scientific-thesis-cover
 <% } -%>
+<% if (latexcompiler == "lualatex") { -%>
+selnolig
+<% } -%>
+<% if (documentclass == "acmart" || documentclass == 'scientific-thesis') { -%>
+setspace
+<% } -%>
 siunitx
 snapshot
 soul
 soulpos
-soulutf8
 sttools
 stringenc
 subfig
 svn-prov
 tcolorbox
 texlogsieve
+textcase
+<% if ((documentclass == "ieee") || (font == "times")) { -%>
+tex-gyre
+times
+<% } -%>
 totpages
 tracklang
 translator
+txfonts
+unicode-math
 uniquecounter
 upquote
 url

package/generators/app/templates/babel.preamble.de.tex

@@ -1,6 +1,8 @@
 % Setze Deutsch als Sprache
 \usepackage[english,main=ngerman]{babel}
-<% if (tweak_outerquote == "babel")  { -%>
+% Neue deutsche Trennmuster
+\babelprovide[hyphenrules=ngerman-x-latest]{german}
+<% if (tweakouterquote == "babel")  { -%>
 %
 % Hinweis von http://tex.stackexchange.com/a/321066/9075
 % Ermögliche die Benutzung von "= als Trennstriche

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

@@ -3,7 +3,7 @@
 % Even though `american`, `english` and `USenglish` are synonyms for babel package (according to https://tex.stackexchange.com/questions/12775/babel-english-american-usenglish), the llncs document class is prepared to avoid the overriding of certain names (such as "Abstract." -> "Abstract" or "Fig." -> "Figure") when using `english`, but not when using the other 2.
 % english has to go last to set it as default language
 \usepackage[ngerman,main=english]{babel}
-<% if (tweak_outerquote == "babel")  { -%>
+<% if (tweakouterquote == "babel")  { -%>
 %
 % Hint by http://tex.stackexchange.com/a/321066/9075 -> enable "= as dashes
 \addto\extrasenglish{\languageshorthands{ngerman}\useshorthands{"}}

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

@@ -4,7 +4,7 @@
 Bitte das \enquote{enquote-Makro} verwenden, um etwas in Anführungszeichen zu setzen.
 Alternativ ist es auch über "`möglich"', Wörter in Anführungszeichen zu setzen.
 
-<% if (tweak_outerquote == "outerquote")  { -%>
+<% if (tweakouterquote == "outerquote")  { -%>
 Das Feature "MakeOuterQuote" wurde auch aktiviert, weshalb "einfache" Anführungszeichen auch genutzt werden können.
 Achtung! Dieses Feature ist weitgehend unbekannt, so dass man ab und an falsche Anführungszeichen in \LaTeX-Dokumenten sieht.
 Siehe \url{https://tex.stackexchange.com/a/150958/9075} für Details bezüglich dieser Lösung.

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

@@ -4,7 +4,7 @@
 Please use the \enquote{enquote command} to quote something.
 Quoting with "`quote"' or ``quote'' also works.
 
-<% if (tweak_outerquote == "outerquote")  { -%>
+<% if (tweakouterquote == "outerquote")  { -%>
 The feature "MakeOuterQuote" is also enabled, which enables "plain" double quotes to correctly enquote.
 See \url{https://tex.stackexchange.com/a/150958/9075} for details on that solution.
 <% } -%>

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

@@ -1,7 +1,7 @@
 % For easy quotations: \enquote{text}
 % This package is very smart when nesting is applied, otherwise textcmds (see below) provides a shorter command
 \usepackage[autostyle=true]{csquotes}
-<% if (tweak_outerquote == "outerquote")  { -%>
+<% if (tweakouterquote == "outerquote")  { -%>
 
 % Enable "quote" - see https://tex.stackexchange.com/a/150958/9075
 \MakeOuterQuote{"}

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

@@ -11,3 +11,21 @@
 \end{figure}
 <%- eexample %>
 <%- include('floatflt.example.en.tex', this); %>
+<% if (documentclass == 'ieee') { -%>
+
+One can span a figure across multiple columns by using \verb+\begin{figure*}+.
+See \cref{fig:16x9} as an example.
+
+<%- bexample %>
+\begin{figure*}
+  \centering
+  % note that \textwidth is used instead of \linewidth
+  % This ensures that the graphics width is 60% of the "page" (text block), and not just 60% of the current text column
+  % See https://tex.stackexchange.com/a/17085/9075 for details
+  \includegraphics[width=.6\textwidth]{example-image-16x9}
+  \caption{16x9 Figure}
+  \label{fig:16x9}
+\end{figure*}
+<%- eexample %>
+
+<% } -%>

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

@@ -9,7 +9,7 @@ Here are some hints:
 In case you write <%- bquote %>application-specific<%- equote %>, then the word will only be hyphenated at the dash.
 You can also write \verb1applica\allowbreak{}tion-specific1 (result: applica\allowbreak{}tion-specific), but this is much more effort.
 
-<% if (tweak_outerquote == "outerquote")  { -%>
+<% if (tweakouterquote == "outerquote")  { -%>
 In the net, you will read about that one can use a normal quote sign followed by an equal sign (\verb1"=1) to specify that hyphenation is allowed at other places in the word.
 Since we use the quote sign for automatic quoation, this is not possible anymore.
 Please use the command \verb1\hydash1 for the same purpose.

package/generators/app/templates/latexmkrc

@@ -1,6 +1,4 @@
-# `-file-line-error` is similar to `--interaction nonstopmode`, but shows the concrete line number
-# Remove it, it you want lualatex to stop on errors
-$pdflatex = '<%= latexcompiler %> <% if (requiresShellEscape) { %>--shell-escape <% } %>--interaction nonstopmode --synctex=-1 %O %S | texlogsieve';
+$pdflatex = '<%= latexcompiler %> <% if (requiresShellEscape) { %>--shell-escape <% } %>--file-line-error --synctex=-1 %O %S | texlogsieve';
 
 #Use SumatraPDF instead of the default PDF viewer
 $pdf_previewer = 'start "C:\Program Files\SumatraPDF\SumatraPDF.exe"';