Skip to content

Commit

Permalink
Squashed commit of the following:
Browse files Browse the repository at this point in the history
commit 063091a
Author: Oliver Kogel <[email protected]>
Date:   Sat Dec 4 22:34:45 2021 +0100

    remove update files (#107)

commit e02e02a
Author: Max <[email protected]>
Date:   Fri Dec 3 13:16:43 2021 +0100

    Toggelbare Vorgaben nach Prof. Kusche: "Kuschemode" (#103)

    * prep work

    * load config before setup

    * adjust page numbering in Kusche Mode

    * document change in Readme

    * Kusche: move InhaltsVZ to bottom

    * add abstracts

    * add section in left footer

    * try new fig counter

    ...and clean some comments

    * fix last commit

    * also kusche-format tables

    * reflect changes; deal with some linter warnings

    * README cleanup

    * unsolicited font recommendation

    * fix and speedup

    * fixed: setnumbering of Anlagen to normal
    * removed some unneded packages in order to speed up the build process and do housekeeping
      for more details, see #78 (not all packages suggested by @photovoltex were removed since some are actually needed)

    * german comments

    WE ARE A VERY DEUTSCHES REPOSITORY AND ZIS IS WHY WE BRAUCHEN DEUTSCHE KOMMENTARE
    (see #5)

    * fixes and documentation

    * fix missing "Anlagen"-Section
    * General Enhancements to improve the user's experience

    Co-authored by: @RvNovae

    * use pretty fonts

    as discussed with @photovoltex and @RvNovae

    I made this a seperate commit to be easily revertable

    * Apply suggestions from code review

    Co-authored-by: Oliver Kogel <[email protected]>

    * fix lost fi

    as pointed out by @photovoltex in #103

    * rename kusche and put him in the tests

    * you know what happened

    * move Anpassungsfortschritt and transform to documentation

    * make fancy fonts toggleable

    * try doing workflow change and move abstract

    * hopefully fix sed syntax

    * maybe capturing whitespaces will work?

    * uhhh i have NO IDEA how this works but let's give it a shot

    * OK, that's how you DONT

    * damn typo

    * i blame regex

    * \a\a\a\a\a\a\h\h\?\?
    \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\

    * dude, who designed that?!?

    * remove debug flag from sed and put something inside the abstract

    * Kusche mode: anlagen after toc

    * hanging indent is in fact working

    * deactivate kusche mode and abstract by default

    * rename artifacts

    * rename fonts readme heading and remove codeblock

    * move abstract docu to its own heading

    * fix 2 template comments

    * Update config.tex

    Co-authored-by: Oliver Kogel <[email protected]>

    * comment for fancy fonts packages

    * Einrückungen

    * refactor to one artifact

    * apply changes from code review oder so

    * fix fonts for mathrm

    * fix cleardoublepage for appendix in Kusche Mode

    Co-authored-by: Oliver Kogel <[email protected]>
  • Loading branch information
photovoltex committed Dec 7, 2021
1 parent 036a71d commit d84663c
Show file tree
Hide file tree
Showing 12 changed files with 295 additions and 176 deletions.
29 changes: 23 additions & 6 deletions .github/workflows/ci-dhge-latex.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,31 +21,48 @@ jobs:
cp -v build/tests/main.tex main.tex
cp -v build/tests/config.tex config.tex
cp -v build/tests/anlagen.tex anlagen.tex
cp -v build/tests/abstract.tex abstract.tex
cp -v build/tests/img.png assets/img/img.png
- name: Rename template.tex
run: mv -v build/template.tex build/example.tex
run: mv -v build/template.tex build/default_example.tex

- name: Compile *.tex
uses: xu-cheng/latex-action@v2
with:
working_directory: build/
root_file: example.tex
root_file: default_example.tex

- name: Upload artifact
- name: Rename default_example.tex
run: mv -v build/default_example.tex build/kusche_example.tex

- name: Set Kusche-Mode and Abstract # matches \def\CKUSCHE <any whitespaces> {0} and replaces it with ...{1}, as well as CHASABSTRACT...
run: |
sed -i 's/\def\\CKUSCHE *{0}/\def\\CKUSCHE {1}/g' config.tex
sed -i 's/\def\\CHASABSTRACT *{0}/\def\\CHASABSTRACT {1}/g' config.tex
- name: Compile *.tex in Kusche mode
uses: xu-cheng/latex-action@v2
with:
working_directory: build/
root_file: kusche_example.tex

- name: Upload artifacts
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-artifact@v2
with:
name: example
path: ./build/example.pdf
path: |
./build/default_example.pdf
./build/kusche_example.pdf
release:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
name: Release artifact
needs: build_artifact
runs-on: ubuntu-latest
steps:
- name: Download artifact
- name: Download artifacts
uses: actions/download-artifact@v2
with:
name: example
Expand All @@ -67,5 +84,5 @@ jobs:
name: dhge-latex-example
body: Automatic example release
gzip: false
files: example/example.pdf
files: example/default_example.pdf example/kusche_example.pdf
allow_override: true
84 changes: 61 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Inoffizielles LaTeX-Template für Projektarbeiten für Technik-Studiengänge an
- ["Variablen"](#variablen)
- [Environment (Umgebung)](#environment-umgebung)
- [Common Environments](#common-environments)
- [Fonts](#fonts)
- [Zitate und Literaturverzeichnis](#zitate-und-literaturverzeichnis)
- [Zitat als Fußnote einfügen](#zitat-als-fußnote-einfügen)
- [Hochgestelltes Zitat einfügen](#hochgestelltes-zitat-einfügen)
Expand All @@ -32,6 +33,9 @@ Inoffizielles LaTeX-Template für Projektarbeiten für Technik-Studiengänge an
- [Spezielle Abschnitte](#spezielle-abschnitte)
- [SubSubSubSection](#subsubsubsection)
- [Unicode Alphabete](#unicode-alphabete)
- [Kusche Mode](#kusche-mode)
- [Probleme im Kusche Mode](#probleme-im-kusche-mode)
- [Abstract](#abstract)

# Installation

Expand Down Expand Up @@ -63,13 +67,7 @@ Für Windows Nutzer empfiehlt sich Strawberry Perl, was [hier](https://strawberr

## Setup

* Das Repository downloaden, clonen, oder die Template Funktion nutzen, um ein eigenes Repository zu erstellen.
* Mit der Update-Datei (OS abhängig .bat/.sh) kann ein bestehendes Template aktualisiert werden

* ### **ACHTUNG** die Update-Datei (entsprechend OS)
* **überschreibt** die Dateien im build Ordner
* eigene Anpassungen sollten über die Dateien im Wurzelverzeichnis des Projektes geschehen
* **löscht** die mit git in Zusammenhang stehenden Ordner und Dateien (.git, .gitignore, .gitkeep)
Das Repository downloaden, clonen, oder die Template Funktion nutzen, um ein eigenes Repository zu erstellen.

Das Projekt sollte sich nun bauen lassen.

Expand Down Expand Up @@ -140,9 +138,18 @@ Ein Codeblock, welcher bestimmte Abläufe vor und nach dem eigenen Code laufen l

### Common Environments

* [itemize/enumerate](https://en.wikibooks.org/wiki/LaTeX/List_Structures)
* [table/tabular](https://en.wikibooks.org/wiki/LaTeX/Tables)
* [figure](https://en.wikibooks.org/wiki/LaTeX/Floats,_Figures_and_Captions)
- [itemize/enumerate](https://en.wikibooks.org/wiki/LaTeX/List_Structures)
- [table/tabular](https://en.wikibooks.org/wiki/LaTeX/Tables)
- [figure](https://en.wikibooks.org/wiki/LaTeX/Floats,_Figures_and_Captions)

## Fonts

> Die Standardfonts sind zwar ganz in Ordnung, aber ich finde, das geht schöner :^)
Die vorgestellte Font-Konfiguration basiert auf [diesem Stackoverflow Thread](https://tex.stackexchange.com/a/114166), wo auch eine Vorschau betrachtet werden kann.
**Die Fonts sind standardmäßig im Template aktiv.**

Wer diese Fonts **nicht** verwenden möchte, kann in ``config.tex`` ``CFANCYFONTS`` auf ``0`` setzen, um den LaTex-Standard wiederherzustellen.

# Zitate und Literaturverzeichnis

Expand Down Expand Up @@ -256,12 +263,12 @@ Beispiel:
kann mit bis zu sechs Argumenten aufgerufen werden:

1. **Optional** Float Position, standardmäßig `h`
1. Relativer Bild-Pfad mit oder ohne Dateiendung (relativ zum `./assets/img` Ordner, kann in `template.tex` angepasst werden)
1. `\includegraphics` Optionen (leer lassen für Standard)
1. Bildunterschrift
1. Label für die Figure/Grafik
1. **Optional:** ID
1. **Optional:** "Postnote", beispielsweise um Seitenzahlen anzugeben
2. Relativer Bild-Pfad mit oder ohne Dateiendung (relativ zum `./assets/img` Ordner, kann in `template.tex` angepasst werden)
3. `\includegraphics` Optionen (leer lassen für Standard)
4. Bildunterschrift
5. Label für die Figure/Grafik
6. **Optional:** ID
7. **Optional:** "Postnote", beispielsweise um Seitenzahlen anzugeben

Beispiel:

Expand Down Expand Up @@ -407,13 +414,13 @@ Für mehr Informationen kann die [Acro Package Documentation](https://mirror.phy
## Verwendung

* Anlagen werden in der anlagen.tex hinterlegt.
* hierbei ist zu beachten:
* die Anlage muss sich in einer Umgebung vom Typ `figure` oder `table` befinden
* die Anlage benötigt eine Beschriftung `\caption{}`
* ein Label ist für eine automatische Verknüpfung im Anlagenverzeichnis nicht nötig
* der vorgefertigte Befehl `\dhgefigure`, kann verwendet werden, da dieser beide Anforderungen erfüllt
* siehe Beispiel `build/tests/anlagen.tex`
- Anlagen werden in der anlagen.tex hinterlegt.
- hierbei ist zu beachten:
- die Anlage muss sich in einer Umgebung vom Typ `figure` oder `table` befinden
- die Anlage benötigt eine Beschriftung `\caption{}`
- ein Label ist für eine automatische Verknüpfung im Anlagenverzeichnis nicht nötig
- der vorgefertigte Befehl `\dhgefigure`, kann verwendet werden, da dieser beide Anforderungen erfüllt
- siehe Beispiel `build/tests/anlagen.tex`

Beispiel:

Expand Down Expand Up @@ -467,3 +474,34 @@ Beispiel:
Falls chinesische, japanische o.ä. Alphabete verwendet werden müssen (bspw. bedingt durch Autoren), ist die einfachste Methode, das `CJKutf8` Package zu laden.

Eine Anleitung finden Sie in [diesem Artikel](https://www.overleaf.com/learn/latex/chinese).

# Kusche Mode

Prof. Dr. Kusche stellt an Praxisarbeiten, die er betreut, andere Anforderungen als Prof. Dr. Dorendorf.
Deshalb wurde der ``CKUSCHE``-Schalter in ``config.tex`` eingeführt: diesen auf ``1`` zu setzen überschreibt einige Standardverhalten vom Template:

- es gibt ein Abstract
- das Abstract wird nicht im Inhaltsverzeichnis geführt
- das Abstract erscheint vor dem Inhaltsverzeichnis
- das Abstract hat keine Kapitelnummer
- Abbildungen, Tabellen, usw. werden zweistufig ``hauptkapitel.lfd`` nummeriert, mit Ausnahme von Anlagen, welche laufend nummeriert werden
- Seitenzahlen erscheinen rechts außen, am Besten unten
- Kapitel steht links im Footer / Header, analog zur Seitenzahl
- Seitenzahlen vor dem Hauptteil sind römisch, ansonsten arabisch
- Serifen-Font 12pt (Times New Roman geht, ist aber "langweilig")
- Literaturverzeichnis erscheint zuletzt
- es gibt kein Anlagenverzeichnis, dafür werden Anlagen im Inhaltsverzeichnis gelistet

## Probleme im Kusche Mode

Leider gibt es Anforderungen von Prof. Dr. Kusche, die bislang nicht umgesetzt werden konnten.
Wir freuen uns natürlich sehr über Ideen, Fixes und Anregungen aus der Community.

- aktuell ist es noch nicht möglich, Anlagen mit Buchstaben zu nummerieren
- das ist glücklicherweise keine zwingende Anforderung

# Abstract

Das Template kann optional ein Abstract vor dem Inhaltsverzeichnis generieren.

Um das zu aktivieren, muss in der ``config.tex`` der ``CHASABSTRACT``-Schalter auf ``1`` gesetzt werden.
1 change: 1 addition & 0 deletions abstract.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
% hier können Sie Ihr Abstract schreiben
94 changes: 58 additions & 36 deletions build/components/package.config.tex
Original file line number Diff line number Diff line change
@@ -1,36 +1,58 @@
\usepackage [a4paper,
inner = 3cm,
outer = 2.5cm,
top = 2.5cm,
bottom = 2.5cm]{geometry}
\usepackage [utf8]{inputenc}
\usepackage {setspace}
\usepackage {titletoc}
\usepackage [hyperfootnotes = false,
hidelinks]{hyperref}
\usepackage {amssymb}
\usepackage {fancyhdr}
\usepackage [version = 3]{acro}
\usepackage {enumitem}
\usepackage [T1]{fontenc}
\usepackage [style=german]{csquotes}
\usepackage [backend=biber,
style = alphabetic,
citestyle = components/alphabetic-ibid,
giveninits = true,
ibidtracker = true,
minbibnames = 3,
minalphanames= 3]{biblatex}
\usepackage [ngerman]{babel}
\usepackage {csquotes,xpatch}
\usepackage {footmisc}
\usepackage {graphicx}
\usepackage {caption}
\usepackage {ifthen}
\usepackage {xparse}
\usepackage {float}
\usepackage {etoolbox}
\usepackage {tocloft}
\usepackage {icomma}
\usepackage {lmodern}
\usepackage {totcount}
\usepackage [a4paper,
inner = 3cm,
outer = 2cm,
top = 2.5cm,
bottom = 2.5cm]{geometry}
\usepackage {setspace}
\usepackage [hyperfootnotes = false,
hidelinks]{hyperref}
\usepackage {amssymb}
\usepackage {fancyhdr}
\usepackage [version = 3]{acro}
\usepackage {enumitem}
\usepackage [style=german]{csquotes}
\usepackage [backend=biber,
style = alphabetic,
citestyle = components/alphabetic-ibid,
giveninits = true,
ibidtracker = true,
minbibnames = 3,
minalphanames= 3]{biblatex}
\usepackage [ngerman]{babel}
\usepackage {footmisc}
\usepackage {graphicx}
\usepackage {caption}
\usepackage {xparse}
\usepackage {float}
\usepackage {tocloft}
\usepackage {lmodern}
\usepackage {totcount}
\usepackage {chngcntr}
\usepackage {icomma} % korrekte Darstellung von Kommas in Formeln

% schönere Fonts, aber optional. Zum deaktivieren CFANCYFONTS in config.tex auf 0 setzen
\if\CFANCYFONTS 1
\usepackage [scaled=0.88]{beraserif} % Bera Serifen Font
\usepackage [scaled=0.85]{berasans} % Bera Sans Font
\usepackage [scaled=0.84]{beramono} % Bera Mono Font
\usepackage [T1]{fontenc}
\usepackage {mathpazo} % Palatino Font
\usepackage [T1,small,euler-digits]{eulervm} % Euler Font
\DeclareMathAlphabet{\mathrm}{OT1}{cmr}{m}{n} % mathrm soll weiter Computer Modern als Font nutzen, siehe #103
\DeclareMathAlphabet{\mathit}{OT1}{cmr}{m}{it}
\usepackage {listings}
\lstset{
basicstyle=\ttfamily,
breaklines=true
}
\fi

% VERALTETE PAKETE
% nicht mehr benötigt, aber für Rückwärtskompatibilität noch enthalten
% einkommentieren, wenn nach einem Template-Update Probleme auftauchen

%\usepackage [utf8]{inputenc}
%\usepackage {titletoc}
%\usepackage {csquotes,xpatch}
%\usepackage {ifthen}
%\usepackage {etoolbox}
Loading

0 comments on commit d84663c

Please sign in to comment.