generator-latex-template 0.4.0 → 0.7.0

package/README.md

@@ -1,6 +1,6 @@
-# generator-latex-template [![npm version](http://img.shields.io/npm/v/generator-latex-template.svg?style=flat)](https://npmjs.org/package/generator-latex-template "View this project on npm")
+# LaTeX Template Generator [![npm version](http://img.shields.io/npm/v/generator-latex-template.svg?style=flat)](https://npmjs.org/package/generator-latex-template "View this project on npm")
 
-> Generates latextemplates (e.g., for thesis, workshops, conferences, IEEEtran, LNCS, ...) out of "micro-templates"
+> Generates latex templates (e.g., for thesis, workshops, conferences, IEEEtran, LNCS, ...) out of "micro-templates"
 
 See the **[talk about the generator](https://github.com/dante-ev/Vortraege_Tagungen/blob/master/2019-Herbst/Oliver%20Kopp%20-%20The%20LaTeX%20Template%20Generator%20-%20dante2019-herbst.pdf)** for an overview on the aims and the general concept.
 
@@ -40,7 +40,7 @@ npx -p yo -p generator-latex-template -c 'yo latex-template'
 
 ### Installing `generator-latex-template`
 
-In case one wants to have the generator installed permanently or `npx` does work as exepcted, one can install `generator-latex-template` using following command:
+In case one wants to have the generator installed permanently or `npx` does work as expected, one can install `generator-latex-template` using following command:
 
 ```bash
 npm install -g generator-latex-template
@@ -108,16 +108,16 @@ In the long run, the contents of the `paper.tex` (and similar) files in reposito
   - Run `npx yo <path-to-git-repository>`
     - Windows: `npx yo c:\git-repositories\latextemplates\generator-latex-template`
   - Parameters can be set using command line
-    - Linux: `npx yo /tmp/repo --documentclass=lncs --texlive=2021 --latexcompiler=pdflatex --bibtextool=bibtex --docker=false --language=en --font=default --listings=listings --cleveref=true --enquotes=csquotes --tweak_outerquote=babel --todo=pdfcomment --howtotext=true --examples=true`
-    - Windows: `npx yo c:\git-repositories\latextemplates\generator-latex-template --documentclass=scientific-thesis --texlive=2021 --latexcompiler=pdflatex --bibtextool=bibtex --docker=false --language=en --font=default --listings=listings --cleveref=true --enquotes=csquotes --tweak_outerquote=babel --todo=pdfcomment  --howtotext=true --examples=true`
-    - Windows automatic generation of a LNCS template (with pdflatex and bibtex): `npx yo c:\git-repositories\latextemplates\generator-latex-template --documentclass=lncs --texlive=2021 --latexcompiler=pdflatex --bibtextool=bibtex --docker=false --language=en --font=default --listings=listings --cleveref=true --enquotes=csquotes --tweak_outerquote=babel --todo=pdfcomment --howtotext=true --examples=true`
+    - Linux: `npx yo /tmp/repo --documentclass=lncs --papersize=a4 --latexcompiler=pdflatex --bibtextool=bibtex --overleaf=false --texlive=2022 --docker=false --language=en --font=default --listings=listings --enquotes=csquotes --tweak_outerquote=babel --todo=pdfcomment --examples=true --howtotext=true`
+    - Windows: `npx yo c:\git-repositories\latextemplates\generator-latex-template --documentclass=scientific-thesis --papersize=a4 --latexcompiler=pdflatex --bibtextool=bibtex --overleaf=false --texlive=2022 --language=en --font=default --listings=listings --enquotes=csquotes --tweak_outerquote=babel --todo=pdfcomment --examples=true --howtotext=true`
+    - Windows automatic generation of a LNCS template (with pdflatex and bibtex): `npx yo c:\git-repositories\latextemplates\generator-latex-template --documentclass=lncs ---papersize=a4 --latexcompiler=pdflatex --bibtextool=bibtex --overleaf=false --texlive=2022 --docker=false --language=en --font=default --listings=listings --enquotes=csquotes --tweak_outerquote=babel --todo=pdfcomment --examples=true --howtotext=true`
   - Run `latexmk` to build the PDF
 - Update npm dependencies
   - `npx npm-update-all`. See [FreeCodeCamp](https://www.freecodecamp.org/news/10-npm-tricks-that-will-make-you-a-pro-a945982afb25/) for more details.
   - `npx npm-check-updates -u`. [[Source](https://www.carlrippon.com/upgrading-npm-dependencies/)]
   - See <https://github.com/yeoman/generator/releases> for changes in the generator.
 - When one encounters `Cannot find module 'yeoman-generator'`, please update the npm dependencies.
-  That error ocurred when using version `4.13.0` and `5.4.2` was available.
+  That error occurred when using version `4.13.0` and `5.4.2` was available.
 - In case of the error "Error: EACCES, permission denied '/root/.config/configstore/insight-yo.json'", one needs to execute `chmod g+rwx /root /root/.config /root/.config/configstore`
 - Check GitHub actions
   - Use [actionlint](https://github.com/rhysd/actionlint#readme)
@@ -144,10 +144,6 @@ In the long run, the contents of the `paper.tex` (and similar) files in reposito
 <% break; } -%>
 ```
 
-```ejs
-<% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~<% } else { %>Section~<% } %>{sec:relatedwork}
-```
-
 ### Debugging
 
 A `launch.json` configured for Windows and Visual Studio Code is included.
@@ -171,6 +167,8 @@ ejslint.cmd c:\git-repositories\latextemplates\generator-latex-template\generato
 The code is licensed [0BSD](https://choosealicense.com/licenses/0bsd/#), the snippets (both LaTeX and text) 0BSD, too.
 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.
+
 [hyperref]: https://ctan.org/pkg/hyperref
 [listings]: https://ctan.org/pkg/listings
 [minted]: https://ctan.org/pkg/minted

package/generators/app/index.js

@@ -130,9 +130,6 @@ module.exports = class extends Generator {
       {
         type: 'list',
         name: 'papersize',
-        when: function(response) {
-          return response.documentclass === 'ieee';
-        },
         message: 'Which paper size to use?',
         choices: [
           {
@@ -144,19 +141,42 @@ module.exports = class extends Generator {
             value: "letter"
           }
         ],
-        default: "a4paper"
+        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 compatiblity?',
+        when: function(response) {
+          return (!response.overleaf || (response.overleaf == "false"));
+        },
+        message: 'Which TeXLive compatibility?',
         choices: [
           {
             name: "TeXLive 2021",
             value: 2021
+          },
+          {
+            name: "TeXLive 2022",
+            value: 2022
           }
         ],
-        default: 2021
+        default: 2022
       },
       {
         type: 'list',
@@ -165,7 +185,7 @@ module.exports = class extends Generator {
         choices: ["pdflatex", "lualatex"],
         default: "pdflatex",
         when: function(response) {
-          return !((response.documentclass === 'ieee') && (response.texlive == 2021));
+          return !(response.documentclass === 'ieee');
         }
       },
       {
@@ -290,12 +310,6 @@ module.exports = class extends Generator {
         ],
         default: "listings"
       },
-      {
-        type: 'confirm',
-        name: 'cleveref',
-        message: 'Use cleveref?',
-        default: true
-      },
       {
         type: 'list',
         name: 'enquotes',
@@ -394,6 +408,11 @@ module.exports = class extends Generator {
       // To access props later use this.props.someAnswer;
       this.props = props;
 
+      if (this.props.overleaf) {
+        // we do not prompt for texlive version in case of overleaf
+        this.props.texlive = 2021;
+      }
+
       // somehow texlive is not routed through
       // special handling
       if (this.params.options.texlive) {
@@ -428,6 +447,7 @@ module.exports = class extends Generator {
       this.props.cleveref = (this.props.cleveref === true) || (this.props.cleveref === 'true')
       this.props.examples = (this.props.examples === true) || (this.props.examples === 'true')
       this.props.howtotext = (this.props.howtotext === true) || (this.props.howtotext === 'true')
+      this.props.overleaf = (this.props.overleaf === true) || (this.props.overleaf === 'true')
 
       if (this.props.examples) {
         this.props.useExampleEnvironment = true;
@@ -455,6 +475,9 @@ module.exports = class extends Generator {
 
       this.props.requiresShellEscape = (this.props.listings === 'minted');
 
+      this.props.feature = {};
+      this.props.feature.acronyms = (this.props.documentclass === 'scientific-thesis');
+
       this.props.isPaper = (this.props.documentclass === 'acmart') || (this.props.documentclass === 'ieee') || (this.props.documentclass === 'lncs');
       if (this.props.isPaper) {
         // this sets filenames.main and filenames.bib
@@ -510,7 +533,7 @@ module.exports = class extends Generator {
     );
     global.fs.copyTpl(
       global.templatePath('latexmkrc'),
-      global.destinationPath('latexmkrc'),
+      global.destinationPath(global.props.overleaf ? '_latexmkrc' : 'latexmkrc'),
       global.props
     );
     global.fs.copyTpl(
@@ -530,8 +553,8 @@ module.exports = class extends Generator {
     );
     if (global.props.documentclass === 'lncs') {
       global.fs.copy(
-        global.templatePath('splncsnat.bst'),
-        global.destinationPath('splncsnat.bst')
+        global.templatePath('splncs04nat.bst'),
+        global.destinationPath('splncs04nat.bst')
       );
     }
     if (global.props.language === 'de') {
@@ -540,6 +563,12 @@ module.exports = class extends Generator {
         global.destinationPath(global.props.filenames.main + ".tex"),
         global.props
       );
+      if (global.props.documentclass === 'scientific-thesis') {
+        global.fs.copy(
+          global.templatePath('acronyms.de.tex'),
+          global.destinationPath('acronyms.tex')
+        );
+      }
       if (!global.props.githubpublish) {
         // we keep the English README.md in case of GitHub publish
         global.fs.copyTpl(
@@ -554,6 +583,12 @@ module.exports = class extends Generator {
         global.destinationPath(global.props.filenames.main + ".tex"),
         global.props
       );
+      if (global.props.documentclass === 'scientific-thesis') {
+        global.fs.copy(
+          global.templatePath('acronyms.en.tex'),
+          global.destinationPath('acronyms.tex')
+        );
+      }
       global.fs.copyTpl(
         global.templatePath('README.en.md'),
         global.destinationPath('README.md'),
@@ -589,6 +624,13 @@ module.exports = class extends Generator {
         );
         break;
     }
+    if (global.props.docker) {
+      global.fs.copyTpl(
+        global.templatePath('.github/workflows/check.yml'),
+        global.destinationPath('.github/workflows/check.yml'),
+        global.props
+      );
+    }
   }
 
   install() {

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

@@ -0,0 +1,43 @@
+on:
+  push:
+  workflow_dispatch:
+concurrency:
+  group: check
+  cancel-in-progress: true
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    services:
+      registry:
+        image: registry:2
+        ports:
+          - 5000:5000
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        with:
+          driver-opts: network=host
+      - name: Cache Docker layers
+        uses: actions/cache@v2
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx
+      - name: Build Docker image
+        uses: docker/build-push-action@v3
+        with:
+          push: true
+          tags: localhost:5000/name/app:latest
+      - name: Set up Git repository
+        uses: actions/checkout@v3
+      - run: |
+          mkdir /tmp/out
+          mkdir /tmp/res
+      - run: docker run -v $(pwd):/work/src -v /tmp/out:/work/out localhost:5000/name/app:latest work "latexmk -pdf -pdflatex='<% if ((latexcompiler == "pdflatex") || githubpublish) { %>pdflatex<% } else { %>lualatex<% } %> --interaction=nonstopmode' <%= filenames.main %>"
+      - run: mv /tmp/out/*.pdf /tmp/res
+      - uses: actions/upload-artifact@v2
+        with:
+          name: test-result
+          path: |
+            /tmp/res/*.pdf

package/generators/app/templates/Dockerfile.reitzig

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

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

@@ -26,6 +26,26 @@ This template does it.
 This template is for the conferences.
 It is based on the `bare_conf_compsoc.tex` distributed by IEEE.
 In case you need other configurations, please adapt `paper-conference.tex` or run the [latex template generator].
+<% break; case "scientific-thesis": -%>
+# LaTeX Template for a Scientific Thesis
+
+This template is a general template for scientific theses.
+Currently, it is the unofficial LaTeX template for Master, Bachelor, Diploma, and Student Theses at following institutions:
+
+- University of Stuttgart, Computer Science
+  - [English example](https://latextemplates.github.io/scientific-thesis-template/main-english.pdf)
+  - [German example](https://latextemplates.github.io/scientific-thesis-template/main-german.pdf)
+  - [German example with minted and PlantUML](https://latextemplates.github.io/scientific-thesis-template/main-minted-german.pdf)
+<!--
+- Paderborn University, Computer Science - to be confirmed.
+  - [English example](https://latextemplates.github.io/scientific-thesis-template/main-paderborn-english.pdf)
+  - [German example](https://latextemplates.github.io/scientific-thesis-template/main-paderborn-german.pdf)
+-->
+
+The template will be extended to support theses from different institutions.
+
+For [architectural decision records](https://adr.github.io) see [docs/adr](https://latextemplates.github.io/scientific-thesis-template/adr/).
+
 <%  break; default: -%>
 # LaTeX Document
 <% break; }
@@ -65,11 +85,9 @@ Following features are enabled in this template:
 <% if (howtotext) { -%>
 - Hints on writing an abstract and thesis by Dirk Fahland.
 <% } -%>
-<% if (cleveref || githubpublish) { -%>
-- <% if (githubpublish) { -%>(Optional) <% } %>Automatic setting of "Fig." and "Section"/"Sect." according to the LNCS style.
+- 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].
-<% } -%>
 <% if (font == "default" || githubpublish) { -%>
 - Sharper font (still compatible with Springer's requirements).
 <% } -%>
@@ -88,7 +106,7 @@ Following features are enabled in this template:
 - <% if (githubpublish) { -%>(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]<% if (cleveref || githubpublish) { %>, [cleveref]<% } %><% if (enquotes == "csquotes" || githubpublish) { %>, [csquotes]<% } %><% if (documentclass != 'lncs') { %>, [paralist]<% } %>, [hyperref], [hypcap], [upquote]<% if (documentclass == 'lncs') { %>, [natbib]<% } %>, [booktabs].
+- Modern packages such as [microtype], [cleveref]<% if (enquotes == "csquotes" || githubpublish) { %>, [csquotes]<% } %><% if (documentclass != 'lncs') { %>, [paralist]<% } %>, [hyperref], [hypcap], [upquote]<% if (documentclass == 'lncs') { %>, [natbib]<% } %>, [booktabs].
 <% if (latexcompiler == "lualatex" || githubpublish) { -%>
 - <% if (githubpublish) { -%>(Optional) <% } %>LaTeX compilation using the modern lualatex compiler.
 <% } -%>
@@ -110,11 +128,6 @@ You can <% if (!githubpublish) { %>re<% } %>run the [latex template generator] t
   Contains a fix to increase compatibility with Babel.
   See <https://tex.stackexchange.com/a/441701/9075> for details.
 <% } -%>
-<% if (cleveref) { missingFeatures = true; -%>
-- 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].
-<% } -%>
 <% } -%>
 <% if (listings != "minted") { missingFeatures = true; -%>
 - Typesetting of listings using advanced highlighting powered by the [minted] package.
@@ -122,8 +135,8 @@ You can <% if (!githubpublish) { %>re<% } %>run the [latex template generator] t
 <% if (todo == "none") { missingFeatures = true; -%>
 - Support todos as pdf annotations. This is enabled by the [pdfcomment] package.
 <% } -%>
-<% if (!cleveref || enquotes == "plainlatex") { -%>
-- Modern packages such as <% if (!cleveref) { missingFeatures = true; %>, [cleveref]<% } %><% if (enquotes == "plainlatex") { missingFeatures = true; %>, [csquotes]<% } %>.
+<% if (enquotes == "plainlatex") { -%>
+- Modern packages such as <% if (enquotes == "plainlatex") { missingFeatures = true; %>[csquotes]<% } %>.
 <% } -%>
 <% if (latexcompiler != "lualatex") { -%>
 - LaTeX compilation using the modern lualatex compiler.
@@ -155,10 +168,17 @@ Deep link: <ftp://ftp.springernature.com/cs-proceeding/llncs/llncs2e.zip>.
 - Edit [paper.tex](paper.tex).
 - `latexmk paper`.
 
- 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.
- This might lead to undesiered results such as hyperlinks not working any more or no good microtypographic features.
- In case you think, a package needs to be altered or added, feel free to open an issue.
+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"
+
+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.
+This might lead to undesiered results such as hyperlinks not working any more or no good microtypographic features.
+In case you think, a package needs to be altered or added, feel free to open an issue.
 <% break; case "ieee": -%>
 
 ## Examples

package/generators/app/templates/Texlivefile

@@ -5,8 +5,12 @@ atveryend
 auxhook
 babel
 babel-english
+<%# german needed for some TeX source code input hacks -%>
 babel-german
+<% if (bibtextool == "biblatex") { -%>
+biblatex
 biber
+<% } -%>
 bigintcalc
 bitset
 blindtext
@@ -19,9 +23,16 @@ comment
 csquotes
 currfile
 datetime2
+<% if (githubpublish || (language == "de")) { -%>
 datetime2-german
+<% } -%>
 datetime2-english
+<% if (documentclass == "scientific-thesis") { -%>
+datatool
+<% } -%>
+<% if (githubpublish || (language == "de")) { -%>
 dehyph-exptl
+<% } -%>
 diagbox
 environ
 etexcmds
@@ -30,15 +41,25 @@ floatflt
 framed
 fvextra
 gettitlestring
+glossaries
+glossaries-extra
 graphics
 hyperref
 hyperxmp
 hyph-utf8
+hyphen-english
+<% if (githubpublish || (language == "de")) { -%>
+hyphen-german
+<% } -%>
+hyphenex
 inconsolata
 ieeetran
 ifmtarg
 infwarerr
 intcalc
+<% if (documentclass == "scientific-thesis") { -%>
+koma-script
+<% } -%>
 kvdefinekeys
 kvoptions
 kvsetkeys
@@ -52,6 +73,9 @@ listings
 llncs
 ltxcmds
 marginnote
+<% if (documentclass == "scientific-thesis") { -%>
+mfirstuc
+<% } -%>
 microtype
 mindflow
 minted
@@ -75,6 +99,9 @@ preprint
 refcount
 regexpatch
 rerunfilecheck
+<% if (documentclass == "scientific-thesis") { -%>
+scientific-thesis-cover
+<% } -%>
 siunitx
 snapshot
 soul
@@ -93,6 +120,9 @@ uniquecounter
 upquote
 url
 xcolor
+<% if (documentclass == "scientific-thesis") { -%>
+xfor
+<% } -%>
 xkeyval
 xstring
 zref

package/generators/app/templates/acronyms.de.tex

@@ -0,0 +1,6 @@
+% Hier stehen alle Abkürzungen
+\newabbreviation{er}{ER}{error rate}
+\newabbreviation{fr}{FR}{Fehlerrate}
+\newabbreviation[shortplural={RDBMS},longplural={RDBMS}]{rdbms}{RDBMS}{Relational Database Management System}
+\newabbreviation[category=abbreviationdot]{dante}{DANTE e.V.}{Deutschsprachige Anwendervereinigung \TeX\ e.V.}
+\newabbreviation{gp}{G.P.}{General Practitioner}

package/generators/app/templates/acronyms.en.tex

@@ -0,0 +1,5 @@
+\newabbreviation{er}{ER}{error rate}
+\newabbreviation{fr}{FR}{Fehlerrate}
+\newabbreviation[shortplural={RDBMS},longplural={RDBMS}]{rdbms}{RDBMS}{Relational Database Management System}
+\newabbreviation[category=abbreviationdot]{dante}{DANTE e.V.}{Deutschsprachige Anwendervereinigung \TeX\ e.V.}
+\newabbreviation{gp}{G.P.}{General Practitioner}

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

@@ -0,0 +1,24 @@
+<%= heading2 %>{Abkürzungen}
+
+Mit \verb+\gls{...}+ können Abkürzungen eingebaut werden, beim ersten Aufrufen wird die lange Form eingesetzt.
+Beim wiederholten Verwenden von \verb+\gls{...}+ wird automatisch die Kurzform angezeigt.
+Außerdem wird die Abkürzung automatisch in die Abkürzungsliste eingefügt.
+Mit \verb+\glspl{...}+ wird die Pluralform verwendet.
+Möchte man, dass bei der ersten Verwendung direkt die Kurzform erscheint, so kann man mit \verb+\glsunset{...}+ eine Abkürzung als bereits verwendet markieren.
+Das Gegenteil erreicht man mit \verb+\glsreset{...}+.
+
+Definiert werden Abkürzungen in der Datei \textit{acronyms.tex} mithilfe von \verb+\newacronym{...}{...}{...}+.
+
+Mehr Infos unter: \url{https://ctan.org/pkg/bib2gls}.
+
+<%- bexample %>
+Beim ersten Durchlauf betrug die \gls{fr} 5.
+Beim zweiten Durchlauf war die \gls{fr} 3.
+Die Pluralform sieht man hier: \glspl{er}.
+Um zu demonstrieren, wie das Abkürzungsverzeichnis bei längeren Beschreibungstexten aussieht, muss hier noch \glspl{rdbms} erwähnt werden.
+
+\gls{dante} is a local \TeX\ user group.
+The German-speaking local \TeX\ user group is \gls{dante}.
+A \gls{gp} is a medical doctor.
+I went to my surgery to see the \gls{gp}.
+<%- eexample %>

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

@@ -0,0 +1,24 @@
+<%= heading2 %>{Abbreviations}
+
+With \verb+\gls{...}+ you can enter abbreviations, the first time you call it, the long form is used.
+When reusing \verb+\gls{..}+ the short form is automatically displayed.
+The abbreviation is also automatically inserted in the abbreviation list.
+With \verb+\glspl{...}+ the plural form is used.
+If you want the short form to appear directly at the first use, you can use \verb+\glsunset{..}+ to mark an abbreviation as already used.
+The opposite is achieved with \verb+\glsreset{..}+.
+
+Abbreviations are defined in \verb+\content\ausarbeitung.tex+ by means of \verb+\newacronym{...}{...}{...}+.
+
+More information at: \url{https://ctan.org/pkg/bib2gls}.
+
+<%- bexample %>
+At the first pass the \gls{fr} was 5.
+At the second pass was \gls{fr} 3.
+The plural form can be seen here: \glspl{er}.
+To demonstrate what the list of abbreviations looks like for longer description texts, \glspl{rdbms} must be mentioned here.
+
+\gls{dante} is a local \TeX\ user group.
+The German-speaking local \TeX\ user group is \gls{dante}.
+A \gls{gp} is a medical doctor.
+I went to my surgery to see the \gls{gp}.
+<%- eexample %>

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

@@ -0,0 +1,15 @@
+\usepackage[
+  abbreviations,         % create "abbreviations" glossary
+  nomain,                % don't create "main" glossary
+  stylemods=longbooktabs % do the adjustments for the longbooktabs styles
+]{glossaries-extra}
+\setglossarystyle{long3col-booktabs}
+
+% Hint by https://tex.stackexchange.com/a/463188/9075
+% \usepackage{glossary-longextra}
+
+% Following is required if the abbreviation list should be sorted automatically (\printglossary)
+% Not required, if we printed the entries in-order (using \printunsrtglossaries)
+\makeglossaries
+
+\input{acronyms}

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

@@ -0,0 +1,9 @@
+<%- include('biblatex.preamble.en.tex', this); -%>
+
+\DefineBibliographyStrings{ngerman}{
+  backrefpage  = {zitiert auf S\adddot},
+  backrefpages = {zitiert auf S\adddot},
+  andothers    = {et\ \addabbrvspace al\adddot},
+%Tipp von http://www.mrunix.de/forums/showthread.php?64665-biblatex-Kann-%DCberschrift-vom-Inhaltsverzeichnis-nicht-%E4ndern&p=293656&viewfull=1#post293656
+  bibliography = {Literaturverzeichnis}
+}

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

@@ -0,0 +1,61 @@
+\usepackage[
+  backend       = biber, %biber does not work with 64x versions alternative: bibtex8
+%minalphanames only works with biber backend
+  sortcites     = true,
+  bibstyle      = alphabetic,
+  citestyle     = alphabetic,
+  giveninits    = true,
+  useprefix     = false, %"von, van, etc." will be printed, too. See below.
+  minnames      = 1,
+  minalphanames = 3,
+  maxalphanames = 4,
+  maxbibnames   = 99,
+  maxcitenames  = 2,
+  natbib        = true,
+  eprint        = true,
+  url           = true,
+  doi           = true,
+  isbn          = true,
+  backref       = true]{biblatex}
+
+% enable more breaks at URLs. See https://tex.stackexchange.com/a/134281.
+\setcounter{biburllcpenalty}{7000}
+\setcounter{biburlucpenalty}{8000}
+
+\bibliography{<%= filenames.bib %>}
+%\addbibresource[datatype=bibtex]{\bibliography{<%= filenames.bib %>}}
+
+% Do not put "vd" in the label, but put it at "\citeauthor"
+% Source: http://tex.stackexchange.com/a/30277/9075
+\makeatletter
+\AtBeginDocument{\toggletrue{blx@useprefix}}
+\AtBeginBibliography{\togglefalse{blx@useprefix}}
+\makeatother
+
+% Thin spaces between initials
+% http://tex.stackexchange.com/a/11083/9075
+\renewrobustcmd*{\bibinitdelim}{\,}
+
+% Keep first and last name together in the bibliography
+% http://tex.stackexchange.com/a/196192/9075
+\renewcommand*\bibnamedelimc{\addnbspace}
+\renewcommand*\bibnamedelimd{\addnbspace}
+
+% Replace last "and" by comma in bibliography
+% See http://tex.stackexchange.com/a/41532/9075
+\AtBeginBibliography{%
+  \renewcommand*{\finalnamedelim}{\addcomma\space}%
+}
+
+% enable hyperlinked author names when using \citeauthor
+% source: http://tex.stackexchange.com/a/75916/9075
+\DeclareCiteCommand{\citeauthor}
+{\boolfalse{citetracker}%
+\boolfalse{pagetracker}%
+\usebibmacro{prenote}}
+{\ifciteindex
+{\indexnames{labelname}}
+{}%
+\printtext[bibhyperref]{\printnames{labelname}}}
+{\multicitedelim}
+{\usebibmacro{postnote}}

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

@@ -5,7 +5,7 @@ Cleveref demonstration: Cref at beginning of sentence, cref in all other cases.
 
 \begin{figure}
     \centering
-    \includegraphics[width=.75\columnwidth]{example-image-a}
+    \includegraphics[width=.75\linewidth]{example-image-a}
     \caption{Example figure for cref demo}
     \label{fig:ex:cref}
 \end{figure}