adjust template to master + main file and add preamble

This commit is contained in:
Maximilian Keßler 2023-10-07 13:32:20 +02:00
parent d7fc254ede
commit e95d0b1343
Signed by: max
GPG key ID: BCC5A619923C0BA5
8 changed files with 115 additions and 7 deletions

18
config
View file

@ -1,7 +1,25 @@
#!/bin/bash
# Main LaTeX file (without .tex extension) e.g. '2022_My_Course')
mainfile=''
# Name of course. THis will be the title of the document
course=''
# Lecturer, also shown in title
lecturer=''
# Name of the stylefile where the header will be located (without .sty) extension
stylefile=''
# Name of GitLab instance you will host this repository at
gitlab='gitlab.com'
# Namespace of repository. This will be either your username or the top level group of the repository.
namespace=''
# Rest of the repostiory path. In case of user-repositories, this will just be the repository name. In case of a repository in a (sub)group, this will be the subgroups + the repository name (without the toplvl group)
repo=''
# term when the lecture is held (shown in README)
term=''

View file

@ -55,7 +55,11 @@ find -type f | xargs sed -i "s/\$mainfile/$(printf '%s\n' "$mainfile" | sed -e '
find -type f | xargs sed -i "s/\$course/$(printf '%s\n' "$course" | sed -e 's/[\/&]/\\&/g')/g"
find -type f | xargs sed -i "s/\$stylefile/$(printf '%s\n' "$stylefile" | sed -e 's/[\/&]/\\&/g')/g"
find -type f | xargs sed -i "s/\$repo/$(printf '%s\n' "$repo" | sed -e 's/[\/&]/\\&/g')/g"
find -type f | xargs sed -i "s/\$namespace/$(printf '%s\n' "$namespace" | sed -e 's/[\/&]/\\&/g')/g"
find -type f | xargs sed -i "s/\$term/$(printf '%s\n' "$term" | sed -e 's/[\/&]/\\&/g')/g"
find -type f | xargs sed -i "s/\$lecturer/$(printf '%s\n' "$lecturer" | sed -e 's/[\/&]/\\&/g')/g"
find -type f | xargs sed -i "s/\$assistant/$(printf '%s\n' "$assistant" | sed -e 's/[\/&]/\\&/g')/g"
find -type f | xargs sed -i "s/\$author/$(printf '%s\n' "$author" | sed -e 's/[\/&]/\\&/g')/g"
# init new repo
git init

View file

@ -6,6 +6,6 @@ The [latest version][1] is availabe as a pdf download via GitLab runner.
You can also have a look at the generated [log files][2] or visit the
[gl pages][3] index directly.
[1]: $repo/$mainfile.pdf
[2]: $repo/$mainfile.log
[3]: $repo/
[1]: https://$namespace.$gitlab/$repo/$mainfile.pdf
[2]: https://$namespace.$gitlab/$repo/$mainfile.log
[3]: https://$namespace.$gitlab/$repo/

View file

View file

View file

@ -1,18 +1,37 @@
\documentclass[10pt,ngerman,a4paper, fancyfoot, git]{mkessler-script}
\course{$course}
\lecturer{}
\author{}
\lecturer{$lecturer}
\assistant{$assistant}
\author{$author}
\usepackage{$stylefile}
\usepackage{stylefile}
\setuptodonotes{disable}
\begin{document}
\maketitle
\vfill
\doclicenseThis
Visit the
\href{https://$gitlab/$namespace/$repo}{GitLab page}
for the source code of this document.
\cleardoublepage
\tableofcontents
\cleardoublepage
\listoflecture
\cleardoublepage
\tableofcontents
% \start lectures
% end lectures
\appendix
\cleardoublepage
\printbibliography
\end{document}

23
template/master.tex Normal file
View file

@ -0,0 +1,23 @@
\documentclass[10pt,ngerman,a4paper, fancyfoot, git]{mkessler-script}
\course{$course}
\lecturer{$lecturer}
\assistant{$assistant}
\author{$author}
\usepackage{stylefile}
\begin{document}
\maketitle
\cleardoublepage
\tableofcontents
\cleardoublepage
% \start lectures
% end lectures
\end{document}

View file

@ -1 +1,45 @@
\ProvidesPackage{$stylefile}[2022/02/10 - Style file for notes of $course]
%%% Custom packages from https://gitlab.com/latexci/packages/latex-packages
% see the corresponding documentation there for details
% Basic math package including lots of utility definitions and operators
\usepackage{mkessler-math}
% Fancy theorem environments
\usepackage[number in = section]{fanycthm}
% Set up of different types of todonotes
\usepackage{mkessler-todo}
% Set up hyperref and useful colors
\usepackage{mkessler-hypersetup}
% \vocab command to highlight + index definitions
\usepackage[index]{mkessler-vocab}
% \lecture command for margin notes indicating the current lecture
% as well as summary of lectures in table of content
\usepackage[fancyhead]{mkessler-lectures}
% Inclusion of inkscape figures in Gilles Castel style
\usepackage{mkessler-incfig}
% Dumping of theorem counters to aux file, to be parsed and compile parts of the document
\usepackage{mkessler-counters}
% Custom enumeration options in {enumerate} environment
\usepackage{mkessler-enumerate}
%%% General useful packages
\usepackage{csquotes}
\usepackage{import}
\usepackage[bibfile=bibliography/references.bib]{mkessler-bibliography}
\usepackage[
type={CC},
modifier={by-sa},
version={4.0},
]{doclicense}