generator-latex-template 0.3.0 → 0.6.0

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

@@ -4,11 +4,21 @@
 # Simplified LNCS Template
 
 > Quick start for modern LaTeXing with [LNCS](http://www.springer.com/computer/lncs).
+<% if (texlive == 2020) { -%>
+
+Please be aware that this template is optimized for overleaf, which [is based on TeXLive 2021](https://de.overleaf.com/blog/tex-live-2021-now-available).
+In case you are running a later TeXLive version (or use MiKTeX), please regenerate the template with the help of the [latex template generator].
+<% } -%>
 <% break; case "ieee": -%>
 # Simplified IEEE Template
 
 > Quick start for modern LaTeXing for an IEEE conference, based on the [Manuscript Template for Conference Proceedings](https://www.ieee.org/conferences_events/conferences/publishing/templates.html).
 
+<% if (texlive == 2020) { -%>
+Please be aware that this template is optimized for overleaf, which [is based on TeXLive 2021](https://de.overleaf.com/blog/tex-live-2021-now-available).
+In case you are running a later TeXLive version (or use MiKTeX), please regenerate the template with the help of the [latex template generator].
+<% } -%>
+
 The official template is distributed via CTAN as the [IEEEtran package](https://ctan.org/pkg/ieeetran), which is actively maintained.
 However, de-facto configurations (hyperref) and modern features of latex (microtype) are not configured.
 This template does it.
@@ -16,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; }
@@ -30,15 +60,12 @@ Note that this requires a working perl installation.
 
 In case something goes wrong, you can instruct the LaTeX compiler to stop at the first error:
 
-<% if (latexcompiler == "pdflatex")  { %>
+<% if (latexcompiler == "pdflatex") { -%>
     pdflatex <%= filenames.main %>
-<%
-} else {
-%>
+<% } else { -%>
     lualatex <%= filenames.main %>
-<%
-}
-%>
+<% } -%>
+
 ## Benefits
 
 Following features are enabled in this template:
@@ -141,31 +168,24 @@ Congratulations. You chose to use all available features.
 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>.
 
-> **The class file authored by Springer is needed to get the template working:**
-> `llncs.cls`
-> You get it from inside the ZIP of `llncs2e.zip` available at <ftp://ftp.springernature.com/cs-proceeding/llncs/llncs2e.zip>.
-
-Reason: Licensing restrictions of Springer do not allow distribution outside of springer.
-See [message #47 for debian bug 31897](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=31897#47) for details.
-Therefore, the required file `llncs.cls` has to be downloaded in some way.
-Follow the quick start instructions.
-
 ## Quick start
 
 - Click on `Download ZIP` or [here](https://github.com/latextemplates/LNCS/archive/main.zip).
 - Extract `LNCS-main.zip` in the folder where you want to write your paper.
-- Place `llncs.cls` into the directory
-  - Download `llncs2e.zip` from <ftp://ftp.springernature.com/cs-proceeding/llncs/llncs2e.zip> and extract it in the directory.
-    On Linux, just execute `download-llncs-files-from-springer.sh`.
-  - In case ftp does not work at your side, you can try online ftp services such as http://www.net2ftp.com/ to download the files.
-    Open the connection to `ftp.springernature.com` and navigate to `cs-proceeding`, `llncs`, and download the ZIP archive.
 - 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
@@ -230,7 +250,7 @@ Statement from IEEE:
 
 <% switch (documentclass) { case "lncs": -%>
 There is currently no official biblatex support.
-A first step towards that is done at [biblatex-lncs](https://github.com/mgttlinger/biblatex-lncs).
+A first step towards that is done at [biblatex-lncs](https://ctan.org/pkg/biblatex-lncs).
 <% break; case "ieee": -%>
 There is currently no official biblatex support.
 A first step towards that is done at the [biblatex-ieee package](https://ctan.org/pkg/biblatex-ieee).
@@ -253,7 +273,22 @@ To have minted running properly, you have to do following steps on Windows:
 3. When latexing, use `-shell-escape`: `pdflatex -shell-escape paper`.
    You can also just execute `latexmk paper`.
 <% } -%>
+<% switch (docker) {
+    case "reitzig": -%>
+
+## Usage with docker
+
+The generated `Dockerfile` is based on the [Dockerfile by reitzig](https://github.com/reitzig/texlive-docker).
+The idea of that system is to host the document sources in a directory separated from the output directory.
 
+    docker run --rm -v "c:\users\example\latex-document:/work/src" -v "c:\users\example\latex-document\out:/work/out" ltg work latexmk
+
+Following one-time setup is requried:
+
+    docker build -t ltg .
+
+<% break; default: -%>
+<% break; } -%>
 ## FAQs
 <% switch (documentclass) { case "lncs": -%>
 

package/generators/app/templates/Texlivefile

@@ -0,0 +1,128 @@
+amsmath
+acmart
+atbegshi
+atveryend
+auxhook
+babel
+babel-english
+<%# german needed for some TeX source code input hacks -%>
+babel-german
+<% if (bibtextool == "biblatex") { -%>
+biblatex
+biber
+<% } -%>
+bigintcalc
+bitset
+blindtext
+booktabs
+caption
+catchfile
+cfr-lm
+cleveref
+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
+etoolbox
+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
+latexmk
+letltxmacro
+libertine
+lineno
+linenoamsmath
+lipsum
+listings
+llncs
+ltxcmds
+marginnote
+<% if (documentclass == "scientific-thesis") { -%>
+mfirstuc
+<% } -%>
+microtype
+mindflow
+minted
+mnsymbol
+mwe
+natbib
+ncctools
+newcomputermodern
+newtx
+newtxtt
+nfssext-cfr
+nowidow
+oberdiek
+paralist
+pbalance
+pdfcomment
+pdfescape
+pdftexcmds
+pict2e
+preprint
+refcount
+regexpatch
+rerunfilecheck
+<% if (documentclass == "scientific-thesis") { -%>
+scientific-thesis-cover
+<% } -%>
+siunitx
+snapshot
+soul
+soulpos
+soulutf8
+sttools
+stringenc
+subfig
+svn-prov
+tcolorbox
+texlogsieve
+totpages
+tracklang
+translator
+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/bibliography.bib

@@ -33,5 +33,16 @@
   year   = {2017},
   url    = {http://texdoc.net/mwe},
 }
+<% if ((documentclass == 'acmart') || (documentclass == 'lncs') || (documentclass == 'ieee')) { -%>
+
+@Misc{acmart,
+  author =       {Boris Veytsman},
+  year =         {2021},
+  month =        aug,
+  title =        {LaTeX Class for the Association for Computing Machinery -- Acknowledgement Information},
+  lastaccessed = {September 17, 2021},
+  url =          {https://github.com/borisveytsman/acmart/blob/1704c8bf7eee92a1515ff755f5118b6a22bb1f8e/samples/samples.dtx#L709},
+}
+<% } -%>
 
 @Comment{jabref-meta: databaseType:bibtex;}

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}