Merge pull request 'removed: install of package sudo in github action' (#59) from fix/ci-failing-on-github into main

Reviewed-on: #59

.gitea/workflows/ci.yml

@@ -5,13 +5,16 @@ on: [push]
 jobs:
   run-ci-linux:
     runs-on: ubuntu-latest
-    env:
-      TYPST_INSTALL: /usr/local
-      TYPST_VERSION: 0.11.1
     steps:
       - name: Check out repository code
         uses: actions/checkout@v3
-      - name: Install Typst CLI
+      - name: Install dependencies for Nix setup action
-        run: curl -fsSL https://typst.community/typst-install/install.sh | sh -s "$TYPST_VERSION"
+        run: |
+          apt update -y
+          apt install sudo -y
+      - name: Setup Nix
+        uses: cachix/install-nix-action@v27
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
       - name: Run CI
-        run: bash -c ./run-ci.sh
+        run: nix-shell --run ./run-ci.sh

.gitea/workflows/release.yml

@@ -3,19 +3,24 @@ name: release
 on:
   push:
     tags:
-      - '*'
+      - 'v*.*.*'
 
 jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - name: Install dependencies for Nix setup action
+        run: |
+          apt update -y
+          apt install sudo -y
+      - name: Setup Nix
+        uses: cachix/install-nix-action@v27
         with:
-          fetch-depth: 0
+          nix_path: nixpkgs=channel:nixos-unstable
-      - name: Install Typst CLI
-        run: curl -fsSL https://typst.community/typst-install/install.sh | sh -s "$TYPST_VERSION"
       - name: Run CI
-        run: bash -c ./run-ci.sh
+        run: nix-shell --run ./run-ci.sh
       - name: Setup go
         uses: https://github.com/actions/setup-go@v4
         with:

.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+name: GitHub Action for checking typst compilation
+run-name: Performing Typst compilation
+on: [push]
+
+jobs:
+  run-ci-linux:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - name: Setup Nix
+        uses: cachix/install-nix-action@v27
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+      - name: Run CI
+        run: nix-shell --run ./run-ci.sh

.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - name: Setup Nix
+        uses: cachix/install-nix-action@v27
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+      - name: Run CI
+        run: nix-shell --run ./run-ci.sh
+      - name: Setup go
+        uses: https://github.com/actions/setup-go@v4
+        with:
+          go-version: '>=1.20.1'
+      - name: Create release
+        id: create-release
+        uses: https://gitea.com/actions/release-action@main
+        with:
+          files: |-
+            example.pdf
+          api_key: '${{secrets.RELEASE_TOKEN}}'

README.md

@@ -1,15 +1,41 @@
 
-# DHBW-ABB Typst template 📃
+<div align="center">
+    <h1>DHBW-ABB template for Typst</h1>
+    <img src="https://img.shields.io/gitea/last-commit/dhbw/dhbw-abb-typst-template?gitea_url=https%3A%2F%2Fgit.montehaselino.de">
+    <img src="https://img.shields.io/github/actions/workflow/status/Servostar/dhbw-abb-typst-template/ci.yml?label=build">
+    <img src="https://img.shields.io/gitea/v/release/dhbw/dhbw-abb-typst-template?gitea_url=https%3A%2F%2Fgit.montehaselino.de&display_name=release">
+    <img src="https://img.shields.io/badge/license-MIT-ff0000">
+    <img src="https://img.shields.io/badge/Typst-2B9CB0">
+    <img src="https://img.shields.io/gitea/languages/count/dhbw/dhbw-abb-typst-template?gitea_url=https%3A%2F%2Fgit.montehaselino.de">
+    <br>
+    <br>
+    <b>Unofficial</b> but feature rich Typst template for writing a thesis or report at DHBW<br>
+    with according ABB AG branding in mind.
+    <br>
+    <br>
+    <img width="1000pt" src="./assets/banner.png">
+</div>
 
-![last-commit-bade](https://img.shields.io/gitea/last-commit/dhbw/dhbw-abb-typst-template?gitea_url=https%3A%2F%2Fgit.montehaselino.de)
+## Table of Contents
-![release-badge](https://img.shields.io/gitea/v/release/dhbw/dhbw-abb-typst-template?gitea_url=https%3A%2F%2Fgit.montehaselino.de&display_name=release)
-![typst-badge](https://img.shields.io/badge/Typst-2B9CB0)
-![language-count-badge](https://img.shields.io/gitea/languages/count/dhbw/dhbw-abb-typst-template?gitea_url=https%3A%2F%2Fgit.montehaselino.de)
-![license-badge](https://img.shields.io/badge/license-MIT-ff0000)
 
-**Unofficial** but feature rich Typst template for writing a thesis or report at DHBW with according ABB AG branding in mind.
+1. [Contribution](#contribution)
+1. [Features](#features)
+2. [Usage](#usage)
+2. [Preview of pages](#preview)
+3. [Relation to DHBW docx template](#dhbw-docx-template)
+4. [Format and branding conformance](#format)
+5. [Fonts](#fonts)
+6. [Legal](#legal)
+7. [For LaTeX users](#for-users-jumping-over-from-latex)
+8. [FAQ](#faq)
+    1. [Typst vs LaTeX](#why-typst-instead-of-latex)
+    2. [Source of logos](#where-are-the-logos-from)
 
-![thumbnail](https://git.montehaselino.de/DHBW/dhbw-abb-typst-template/raw/commit/cd325b7076da91e58849512539460a481e48ef4e/assets/thumbnail.png)
+## Contribution
+
+> ⚠️ **Important** <br>
+> Development happens at an external site [here](https://git.montehaselino.de/DHBW/dhbw-abb-typst-template).
+> The GitHub repository is only a push mirror, but issues are still welcome at any time!
 
 ## Features
 
@@ -19,6 +45,78 @@
 This template includes designs for a titlepage, confidantiality statement, declaration of authorship and more with a consistent design inspired by various unofficial works made by students at DHBW. Layout and the choise fonts are based on the unofficial [supercharged-dhbw](https://github.com/DannySeidel/typst-dhbw-template) Typst template. It comes with automatic generation of outlines for figures, tables, code snippets and appendices.
 The template can generate sections for a glossary, combinging acronyms and technical terms into a singular section.
 
+A short overview of all features the template is capable of:
+- Acronyms
+- Glossary
+- Table of Contents for: headings, figures, tables and listings and appendecis
+- Appendix
+- Extra page for:
+    - Declaration of Authorship
+    - Confidentiality Statement
+    - Preleminary notice
+- Watermark for draft versions
+- Automatic form filling for data provided via configuration
+- Styles for captions, tables and equations
+- ABB branding inspired code theme 
+
+## Preview
+
+![](./assets/page-preview.png)
+
+## Usage
+
+### Without Typst package manager
+
+Clone the repository into a subfolder of your project or add it a git submodule. The you can import the `lib.typ` file from `src`.
+Once thats done calling the following snippet `#show: dhbw-template.with(conf)` will setup the template. You can provide a configuration for the template to use.
+The default configuration can be found in `src/conf.typ`.
+
+```typst
+#import "src/lib.typ": *
+
+#show: dhbw-template.with((
+  lang: "en",
+  region: "en",
+  author: (
+    name: "Sven Vogel",
+    semester: 4,
+    program: "Informationtechnology",
+    course: "TINF19IT1",
+    faculty: "Technik",
+    university: "DHBW Mannheim",
+    company: "ABB AG",
+    supervisor: "Benny Goodman",
+    matriculation-number: 123456789),
+  thesis: (
+    title: "Unofficial ABB/DHBW Typst template",
+    subtitle: "for reports and thesises",
+    submission-date: "23rd march 2020",
+    timeframe: "1st january 2020 - 20th march 2020",
+    kind: "T2000",
+    summary: summary,
+    abstract: abstract,
+    preface: include "preface.typ",
+    keywords: ( "IT", "other stuff" ),
+    bibliography: bibliography("refs.bib"),
+    glossary: yaml("glossary.yml"),
+    appendices: include "appendix.typ")))
+
+// Your document code goes here!
+
+= Introduction
+
+lorem(50)
+
+= Chapter 1
+
+#lorem(230)
+
+```
+
+## DHBW DOCX template
+
+The official [DHBW template for Word](https://blog.fakultaet-technik.de/wp-content/uploads/2015/06/Studienarbeitsvorlage.docx) was used a strong inspiration but not as base template.
+
 ## Format
 All pages have a margin of 2.5cm between header/footer/content and the page border.
 Header and footer do not overlap into this margin in order to conform to university requirements.
@@ -26,6 +124,11 @@ Header and footer do not overlap into this margin in order to conform to univers
 Bibliography is formated with the IEEE style. <br>
 Appendecies make use of an abbreviation of APA style.
 
+Complies with ABB branding guidelines such as:
+- proper usage of the logo
+- respecting the logo safe area
+- brand colors (in syntax highlightning)
+
 ## Fonts
 
 Both fonts used in the document are licensed under the [Open Font License](https://openfontlicense.org/) and can be used for non-commercial as well as commercial purposes. They can be downloaded from google fonts:

generate-theme.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+pip install -r base16/requirements.txt
+python base16/generator.py base16/abb.yml base16/template.tmTheme src/res/abb.tmTheme

run-ci.sh

@@ -25,18 +25,29 @@ function enter-section() {
   printf "\\n"
 
   eval "$2"
-  if [ $? -neq $3 ]; then
+  exit_status=$?
-    abort "command: $2 failed in section: $1"
+
+  if [ "$3" == "should fail" ]; then
+    log "INFO" "expected to fail..."
+    if [ $exit_status -eq 0 ]; then
+      abort "command: $2 failed in section: $1 with: $exit_status"
+    fi
+  else
+    log "INFO" "expected to pass..."
+    if [ ! $exit_status -eq 0 ]; then
+      abort "command: $2 failed in section: $1 with: $exit_status"
+    fi
   fi
 
   printf "\\n"
   log "INFO" "section $1 completed successfully"
 }
 
-enter-section "Compiling template..." "typst compile template/main.typ --root . example.pdf" 0
+enter-section "Typstyle checking" "./run-fmt.sh --check src/lib.typ" 0
-enter-section "TEST: local template import" "typst compile tests/local-import/main.typ --root ." 0
+enter-section "Compiling template..." "typst compile template/main.typ --root . example.pdf"
-enter-section "TEST: invalid config case 1" "typst compile tests/invalid-config/test-case-1.typ --root ." 1
+enter-section "TEST: local template import" "typst compile tests/local-import/main.typ --root ."
-enter-section "TEST: invalid config case 2" "compile tests/invalid-config/test-case-2.typ" 0
+enter-section "TEST: invalid config case 1" "typst compile tests/invalid-config/test-case-1.typ --root ." "should fail"
-enter-section "TEST: invalid config case 3" "typst compile tests/invalid-config/test-case-3.typ --root ." 1
+enter-section "TEST: invalid config case 2" "typst compile tests/invalid-config/test-case-2.typ --root ."
+enter-section "TEST: invalid config case 3" "typst compile tests/invalid-config/test-case-3.typ --root ." "should fail"
 
 log "INFO" "CI completed successfully"

run-fmt.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+
+function format() {
+    # format file
+    # typstyle --format $1
+
+    if [ -z "$1" ]; then
+        return
+    fi
+
+    local wd=$(dirname $(realpath "$1"))
+
+    echo "processing file $1..."
+    typstyle "$2" "$1" > /dev/null
+    if [ $? -eq 1 ]; then
+        echo "failed format validation: $1"
+        exit 1
+    fi
+
+    local imports=$(rg "#import \"([a-z0-9/\-]+\.typ)\"" -Nor '$1' "$1")
+
+    # format all included files
+    while IFS= read -r line; do
+        if [ -z "$line" ]; then
+            continue
+        fi
+        format "$wd/$line" "$2"
+    done <<< "$imports"
+}
+
+case $1 in
+  "--format")
+    format "$2" "--inplace"
+    ;;
+  "--check")
+    format "$2" "--check"
+    ;;
+  *)
+    echo "unknown option: $1"
+    exit 1
+    ;;
+esac

shell.nix

@@ -0,0 +1,13 @@
+let
+  nixpkgs = fetchTarball "https://github.com/NixOS/nixpkgs/tarball/nixos-unstable";
+  pkgs = import nixpkgs { config = {}; overlays = []; };
+in
+
+pkgs.mkShellNoCC {
+  packages = with pkgs; [
+    python312
+    python312Packages.pyyaml
+    typst
+    typstyle
+  ];
+}

src/branding.typ

@@ -0,0 +1,18 @@
+
+// Reference color scheme can be found here:
+//  https://brand.abb/portal/en/branding-principles/basic-brand-elements/color
+
+// ABB branding colors
+#let ABB-RED = cmyk(0%, 100%, 95%, 0%)
+#let ABB-BLACK = cmyk(0%, 0%, 0%, 100%)
+#let ABB-GRAY-01 = cmyk(0%, 0%, 0%, 90%)
+#let ABB-GRAY-02 = cmyk(0%, 0%, 0%, 75%)
+#let ABB-GRAY-03 = cmyk(0%, 0%, 0%, 55%)
+#let ABB-GRAY-04 = cmyk(0%, 0%, 0%, 35%)
+#let ABB-GRAY-05 = cmyk(0%, 0%, 0%, 15%)
+#let ABB-GRAY-06 = cmyk(0%, 0%, 0%, 5%)
+#let ABB-WHITE = cmyk(0%, 0%, 0%, 0%)
+// ABB branding functinal colors
+#let ABB-BLUE = cmyk(100%, 53%, 2%, 16%)
+#let ABB-GREEN = cmyk(91%, 4%, 100%, 25%)
+#let ABB-YELLOW = cmyk(0%, 9%, 100%, 0%)

src/conf.typ

@@ -7,11 +7,17 @@
 // Edited: 27.06.2024
 // License: MIT
 
+#import "branding.typ": *
+
 // default configuration
 #let default-config = (
-    lang: "en",
+    // language settings used to make decisions about hyphenation and others
-    region: "en",
+    lang: "en",       // ISO 3166 language code of text: "de", "en"
+    region: "en",     // region code
+    // mark this thesis as draft
+    // Adds preleminarry note page and watermark
     draft: true,
+    // information about author(s)
     author: (
       name: "Sven Vogel",
       semester: 4,
@@ -22,12 +28,14 @@
       company: "ABB AG",
       supervisor: "Benny Goodman",
       matriculation-number: 123456789),
+    // information about thesis
     thesis: (
       title: "Unofficial ABB/DHBW Typst template",
-      subtitle: "for reports and thesises",
+      subtitle: "for reports and thesises",            // subtitle may be none
       submission-date: "23rd march 2020",
       timeframe: "1st january 2020 - 20th march 2020",
       kind: "T2000",
+      // translated version of abstract, only used in case language is not english
       summary: none,
       abstract: none,
       preface: none,
@@ -37,9 +45,11 @@
       appendices: none),
     style: (
       header: (
-        bottom-padding: 1.5em,
+        content-padding: 1.5em,
         underline-top-padding: 0pt,
         logo-height: 3em),
+      footer: (
+        content-padding: 1.5em),
       page: (
         format: "a4",
         margin: (
@@ -52,8 +62,14 @@
         font: "Open Sans"),
       heading: (
         font: "Montserrat"),
+      code: (
+        theme: "res/abb.tmTheme",
+        font: "FiraCode Nerd Font",
+        lines: false,
+        size: 10pt,
+        tab-size: 4),
       link: (
-        color: red.darken(15%))))
+        color: ABB-GRAY-02)))
 
 // Insert a dictionary `update` into `base` but only the entries of update that also exist in base
 // Runs recursively on all sub dictionaries

src/glossarium.typ

@@ -0,0 +1,255 @@
+// .--------------------------------------------------------------------------.
+// |                   Glossarium@4.1.0 with custom format                    |
+// '--------------------------------------------------------------------------'
+
+// Authors: ENIB-Community
+// Changed: Sven Vogel
+// Edited: 08.07.2024
+// License: MIT
+
+// Customized version of https://github.com/ENIB-Community/glossarium/tree/release-0.4.1
+// in order to conform to DHBW requirements in terms of format
+
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.*/
+
+// glossarium figure kind
+#let __glossarium_figure = "glossarium_entry"
+// prefix of label for references query
+#let __glossary_label_prefix = "glossary:"
+// global state containing the glossary entry and their location
+#let __glossary_entries = state("__glossary_entries", (:))
+
+#let __glossarium_error_prefix = "glossarium error : "
+
+#let __query_labels_with_key(loc, key, before: false) = {
+  if before {
+    query(
+      selector(label(__glossary_label_prefix + key)).before(
+        loc,
+        inclusive: false,
+      ),
+      loc,
+    )
+  } else {
+    query(selector(label(__glossary_label_prefix + key)), loc)
+  }
+}
+
+// key not found error
+#let __not-found-panic-error-msg(key) = {
+  __glossarium_error_prefix + "key '" + key + "' not found"
+}
+
+// Reference a term
+#let gls(key, suffix: none, long: none, display: none) = {
+  context {
+    let __glossary_entries = __glossary_entries.final(here())
+    if key in __glossary_entries {
+      let entry = __glossary_entries.at(key)
+
+      let gloss = __query_labels_with_key(here(), key, before: true)
+
+      let is_first = gloss == ()
+      let entlong = entry.at("long", default: "")
+      let textLink = if display != none {
+        [#display]
+      } else if (
+        is_first or long == true
+      ) and entlong != [] and entlong != "" and long != false {
+        [#entlong (#entry.short#suffix)]
+      } else {
+        [#entry.short#suffix]
+      }
+
+      [#link(
+          label(entry.key),
+          textLink,
+        )#label(__glossary_label_prefix + entry.key)]
+    } else {
+      panic(__not-found-panic-error-msg(key))
+    }
+  }
+}
+
+// Reference to term with pluralisation
+#let glspl(key, long: none) = {
+  let suffix = "s"
+  context {
+    let __glossary_entries = __glossary_entries.final(here())
+    if key in __glossary_entries {
+      let entry = __glossary_entries.at(key)
+
+      let gloss = __query_labels_with_key(here(), key, before: true)
+
+      let is_first = gloss == ()
+      let entlongplural = entry.at("longplural", default: "")
+      let entlong = if entlongplural == [] or entlongplural == "" {
+        // if the entry long plural is not provided, then fallback to adding 's' suffix
+        let entlong = entry.at("long", default: "")
+        if entlong != [] and entlong != "" {
+          [#entlong#suffix]
+        } else {
+          entlong
+        }
+      } else {
+        [#entlongplural]
+      }
+
+      let entplural = entry.at("plural", default: "")
+      let short = if entplural == [] or entplural == "" {
+        [#entry.short#suffix]
+      } else {
+        [#entplural]
+      }
+
+      let textLink = if (
+        is_first or long == true
+      ) and entlong != [] and entlong != "" and long != false {
+        [#entlong (#short)]
+      } else {
+        [#short]
+      }
+
+      [#link(
+          label(entry.key),
+          textLink,
+        )#label(__glossary_label_prefix + entry.key)]
+    } else {
+      panic(__not-found-panic-error-msg(key))
+    }
+  }
+}
+
+// show rule to make the references for glossarium
+#let make-glossary(body) = {
+  show ref: r => {
+    if r.element != none and r.element.func() == figure and r
+      .element
+      .kind == __glossarium_figure {
+      // call to the general citing function
+      gls(str(r.target), suffix: r.citation.supplement)
+    } else {
+      r
+    }
+  }
+  body
+}
+
+#let __normalize-entry-list(entry_list) = {
+  let new-list = ()
+  for entry in entry_list {
+    new-list.push((
+      key: entry.key,
+      short: entry.short,
+      plural: entry.at("plural", default: ""),
+      long: entry.at("long", default: ""),
+      longplural: entry.at("longplural", default: ""),
+      desc: entry.at("desc", default: ""),
+      group: entry.at("group", default: ""),
+    ))
+  }
+  return new-list
+}
+#let print-glossary(
+  entry_list,
+  show-all: false,
+  disable-back-references: false,
+  enable-group-pagebreak: false,
+) = {
+  let entries = __normalize-entry-list(entry_list)
+  __glossary_entries.update(x => {
+    for entry in entry_list {
+      x.insert(entry.key, entry)
+    }
+
+    x
+  })
+
+  let groups = entries.map(x => x.at("group")).dedup()
+
+  for group in groups.sorted() {
+    if group != "" [#heading(group, level: 1, outlined: false) ]
+    for entry in entries.sorted(key: x => x.key) {
+      if entry.group == group {
+        [
+          #show figure.where(kind: __glossarium_figure): it => it.caption
+          #figure(
+            supplement: "",
+            kind: __glossarium_figure,
+            numbering: none,
+            caption: {
+              context {
+                let key = if entry.key.ends-with("__glossary_entry") {
+                  entry.key.replace("__glossary_entry", "")
+                } else {
+                  entry.key
+                }
+
+                let term_references = __query_labels_with_key(here(), key)
+                if term_references.len() != 0 or show-all [
+                  #let desc = entry.at("desc", default: "")
+                  #let long = entry.at("long", default: "")
+                  #let hasLong = long != "" and long != []
+                  #let hasDesc = desc != "" and desc != []
+
+                  #block(
+                    below: 1.5em,
+                    par(hanging-indent: 1em)[
+                      #text(weight: "bold", entry.short)
+                      #if hasLong and hasDesc [
+                        (#text(entry.long))
+                      ] else if hasLong {
+                        text(entry.long)
+                      }
+                      #if hasDesc [ #sym.dash.en ]
+                      #if hasDesc [ #desc ]
+                      #if disable-back-references != true {
+                        term_references
+                          .map(x => x.location())
+                          .sorted(key: x => x.page())
+                          .fold(
+                            (values: (), pages: ()),
+                            ((values, pages), x) => if pages.contains(
+                              x.page(),
+                            ) {
+                              (values: values, pages: pages)
+                            } else {
+                              values.push(x)
+                              pages.push(x.page())
+                              (values: values, pages: pages)
+                            },
+                          )
+                          .values
+                          .map(x => {
+                              let page-numbering = x.page-numbering()
+                              if page-numbering == none {
+                                page-numbering = "1"
+                              }
+                              link(x)[#numbering(
+                                  page-numbering,
+                                  ..counter(page).at(x),
+                                )]
+                            }
+                          )
+                          .join(", ")
+                      }
+                    ],
+                  )
+                ]
+              }
+            },
+          )[] #label(entry.key)
+        ]
+      }
+    }
+    if enable-group-pagebreak {
+      pagebreak(weak: true)
+    }
+  }
+};

src/glossary.typ

@@ -0,0 +1,100 @@
+
+// .--------------------------------------------------------------------------.
+// |                           Glossary Utilities                             |
+// '--------------------------------------------------------------------------'
+
+// Author: Sven Vogel
+// Edited: 08.07.2024
+// License: MIT
+
+#let glossary(entries, config) = {
+
+  assert(
+    type(entries) == dictionary,
+    message: "The glossary is not a dictionary",
+  )
+
+  let processed_glossary = (:)
+
+  for (k, v) in entries.pairs() {
+    assert(
+      type(v) == dictionary,
+      message: "The glossary entry `" + k + "` is not a dictionary",
+    )
+
+    for key in v.keys() {
+      assert(
+        key in ("short", "long", "desc", "group"),
+        message: "Found unexpected key `" + key + "` in glossary entry `" + k,
+      )
+    }
+
+    assert(
+      type(v.short) == str,
+      message: "The short form of glossary entry `" + k + "` is not a string",
+    )
+
+    if "long" in v {
+      assert(
+        type(v.long) == str,
+        message: "The long form of glossary entry `" + k + "` is not a string",
+      )
+    }
+
+    if "desc" in v {
+      assert(
+        type(v.desc) == str,
+        message: "The description of glossary entry `" + k + "` is not a string",
+      )
+    }
+
+    if "group" in v {
+      assert(
+        type(v.group) == str,
+        message: "The optional group of glossary entry `" + k + "` is not a string",
+      )
+    } else {
+      let acronym_group = if config.lang == "de" {
+        "Abkürzungsverzeichnis"
+      } else {
+        "List of Acronyms"
+      }
+
+      let glossary_group = if config.lang == "de" {
+        "Begriffe"
+      } else {
+        "Glossary"
+      }
+
+      let group = if "long" in v {
+        acronym_group
+      } else {
+        glossary_group
+      }
+
+      // create dedicated entries for
+      // acronym and glossary
+      if "long" in v and "desc" in v {
+        processed_glossary.insert(
+          k,
+          (short: v.short, long: v.long, group: acronym_group),
+        )
+        processed_glossary.insert(
+          k + "__glossary_entry",
+          (short: v.short, desc: v.desc, long: v.long, group: glossary_group),
+        )
+      } else {
+        processed_glossary.insert(k, v)
+        processed_glossary.at(k).group = group
+      }
+    }
+  }
+
+  return processed_glossary.pairs().map(((key, entry)) => (
+    key: key,
+    short: entry.short,
+    long: eval(entry.at("long", default: ""), mode: "markup"),
+    desc: eval(entry.at("desc", default: ""), mode: "markup"),
+    group: entry.at("group", default: ""),
+  ))
+}

src/lib.typ

@@ -7,37 +7,78 @@
 // Edited: 27.06.2024
 // License: MIT
 
+#import "conf.typ": validate-config, default-config
+#import "branding.typ": *
+#import "style.typ": global_styled_doc, content_styled, end_styled
+#import "glossary.typ": glossary
+#import "pages/titlepage.typ": new_title_page
+#import "pages/declaration-of-authorship.typ": new_declaration_of_authorship
+#import "pages/confidentiality-statement.typ": new_confidentiality_statement_page
+#import "pages/prerelease-note.typ": new_prerelease_note
+#import "pages/outline.typ": new_outline
+#import "pages/abstract.typ": new_abstract
+#import "pages/preface.typ": new-preface
+#import "pages/appendix.typ": show-appendix
+
+#let group-break() = {
+  [#pagebreak()]
+}
+
+#let inline-color(color, content) = {
+  box(
+    stroke: 1pt + ABB-GRAY-05,
+    radius: 2pt,
+    inset: (left: 2pt, right: 2pt),
+    outset: (top: 4pt, bottom: 4pt),
+    fill: ABB-GRAY-06,
+    [#box(
+        fill: rgb(color),
+        radius: 2pt,
+        inset: 0pt,
+        width: 0.75em,
+        height: 0.75em,
+      ) #text(
+        font: default-config.style.code.font,
+        size: default-config.style.code.size,
+        content,
+      )],
+  )
+}
+
+#let url(label, content) = {
+  link(label)[#underline(
+      offset: 2pt,
+      stroke: 0.5pt + blue,
+      text(fill: blue)[
+        #content
+        #let domain = label.find(regex("\w+\.\w+(?:\.\w+)*"))
+        #if domain.len() > 0 [
+          (#domain)
+        ]
+      ],
+    )]
+}
+
 // start of template pages and styles
-#let dhbw-template(config: dictionary, body) = [
+#let dhbw-template(config, body) = [
-
-  #import "conf.typ": validate-config
-  #import "style.typ": global_styled_doc, content_styled, end_styled
-  #import "pages/titlepage.typ": new_title_page
-  #import "pages/declaration-of-authorship.typ": new_declaration_of_authorship
-  #import "pages/confidentiality-statement.typ": new_confidentiality_statement_page
-  #import "pages/prerelease-note.typ": new_prerelease_note
-  #import "pages/outline.typ": new_outline
-  #import "pages/abstract.typ": new_abstract
-  #import "pages/preface.typ": new-preface
-  #import "pages/appendix.typ": show-appendix
-
   #let config = validate-config(config)
-
   #let doc = body
 
+  // apply global style to every element in the argument content
+  #global_styled_doc(config)[
+
     // set document properties
     #set document(
       author: config.author.name,
       keywords: config.thesis.keywords,
-    title: config.thesis.title)
+      title: config.thesis.title,
-
+    )
-  // apply global style to every element in the argument content
-  #global_styled_doc(config: config, body: [
 
     // configure text locale
     #set text(
       lang: config.lang,
-      region: config.region)
+      region: config.region,
+    )
 
     // preppend title page
     #new_title_page(config)
@@ -55,15 +96,18 @@
 
     // glossary is built inline here because the links must be
     // exposed to the entire document
-    #import "@preview/glossarium:0.4.1": make-glossary, print-glossary
+    #import "glossarium.typ": *
     #show: make-glossary
 
     #pagebreak(weak: true)
 
     #if "glossary" in config.thesis and config.thesis.glossary != none {
-      heading(supplement: [outline], "Glossar")
+      print-glossary(
-
+        show-all: false,
-      print-glossary(config.thesis.glossary)
+        disable-back-references: true,
+        enable-group-pagebreak: true,
+        glossary(config.thesis.glossary, config),
+      )
 
       pagebreak(weak: true)
     }
@@ -72,11 +116,11 @@
     // mark end of prelude
     #metadata("prelude terminate") <end-of-prelude>
 
-    #content_styled(config: config, body: doc)
+    #content_styled(config, doc)
 
     #metadata("content terminate") <end-of-content>
 
-    #end_styled(config: config, body: [
+    #end_styled(config)[
       // add bibliography if set
       #if "bibliography" in config.thesis and config.thesis.bibliography != none {
         pagebreak(weak: true)
@@ -87,6 +131,6 @@
 
       // appendix
       #show-appendix(config: config)
-    ])
+    ]
-  ])
+  ]
 ]

src/pages/abstract.typ

@@ -6,23 +6,24 @@
 // Edited: 28.06.2024
 // License: MIT
 
-#let new_abstract(config) = context [
+#let new_abstract(config) = (
+  context {
 
+    set align(center + horizon)
+
+    // only include summary when a language other than english is used
+    if text.lang == "de" [
+      // Summary is supposed to be on separate page
       #pagebreak(weak: true)
 
-  #let thesis = config.thesis
-
-  #pagebreak(weak: true)
-  #align(center + horizon)[
-    #if text.lang == "de" [
       = Zusammenfassung
-
+      #config.thesis.summary
-      #thesis.summary
     ]
 
-    #pagebreak(weak: true)
+    // abstract is supposed to be on separate page
-    = Abstract
+    pagebreak(weak: true)
 
-    #thesis.abstract
+    heading("Abstract")
-  ]
+    config.thesis.abstract
-]
+  }
+)

src/pages/appendix.typ

@@ -1,5 +1,13 @@
+// .--------------------------------------------------------------------------.
+// |                                Appendix                                  |
+// '--------------------------------------------------------------------------'
 
-#let show-appendix(config: dictionary) = context {
+// Author: Sven Vogel
+// Edited: 28.06.2024
+// License: MIT
+
+#let show-appendix(config: dictionary) = (
+  context {
     counter(heading).update(0)
 
     let title = if text.lang == "en" {
@@ -11,8 +19,10 @@
     if "appendices" in config.thesis {
       pagebreak(weak: true)
 
+      // appendix will be invisible on the appendecies page
+      // but still listed in the ToC
+      show heading: it => []
       heading(level: 1, numbering: none, title)
-    v(-2em)
 
       // APA style appendix
       show heading: it => {
@@ -32,4 +42,5 @@
 
       config.thesis.appendices
     }
-}
+  }
+)

src/pages/confidentiality-statement.typ

@@ -1,53 +1,64 @@
+// .--------------------------------------------------------------------------.
+// |                        Confidentiality Statement                         |
+// '--------------------------------------------------------------------------'
 
-#let new_confidentiality_statement_page(config) = context [
+// Author: Sven Vogel
+// Edited: 28.06.2024
+// License: MIT
 
-  #pagebreak(weak: true)
+#let new_confidentiality_statement_page(config) = (
+  context {
 
-  #let thesis = config.thesis
+    pagebreak(weak: true)
-  #let author = config.author
 
-  #v(2em)
+    let thesis = config.thesis
-  #if text.lang == "de" [
+    let author = config.author
-    #text(size: 20pt, weight: "semibold", font: "Montserrat", "Sperrvermerk")
+
+    if text.lang == "de" [
+      #heading(level: 1, "Sperrvermerk")
     ] else if text.lang == "en" [
-    #text(size: 20pt, weight: "semibold", font: "Montserrat", "Confidentiality statement")
+      #heading(level: 1, "Confidentiality Statement")
     ]
 
-  #if text.lang == "de" [
+    if text.lang == "de" [
-    Der Inhalt der dieser Arbeit mit dem Thema
+      Der Inhalt dieser Arbeit mit dem Thema
     ] else if text.lang == "en" [
       The content of this work with the topic
     ]
 
-  #v(1em)
+    v(1em)
 
-  #set align(center)
+    set align(center)
 
-  *#thesis.title*
+    text(weight: "bold", thesis.title)
 
-  #thesis.subtitle
+    if thesis.subtitle != none {
+      linebreak()
+      thesis.subtitle
+    }
 
-  #set align(left)
+    set align(left)
 
-  #v(1em)
+    v(1em)
 
-  #set par(justify: true)
+    set par(justify: true)
 
-  #if text.lang == "de" [
+    if text.lang == "de" [
-    darf weder als Ganzes noch in Auszügen Personen außerhalb des Prüfungsprozesses und des Evalua-tionsverfahrens zugänglich gemacht werden, sofern keine anderslautende Genehmigung der Ausbildungsstätte vorliegt.
+      darf weder als Ganzes noch in Auszügen Personen außerhalb des Prüfungsprozesses und des Evaluationsverfahrens zugänglich gemacht werden, sofern keine anderslautende Genehmigung der Ausbildungsstätte vorliegt.
     ] else if text.lang == "en" [
       may not be made accessible to persons outside the examination process and the evaluation procedure, either as a whole or in excerpts, unless otherwise authorized by the training institution.
     ]
 
-  #v(25%)
+    set align(horizon)
 
-  #grid(
+    grid(
     // set width of columns
     // we need two, so make both half the page width
     columns: (50%, 50%),
     row-gutter: 0.75em,
     align(left, {line(length: 6cm)}),
     align(left, {line(length: 6cm)}),
-    align(left, if text.lang == "de" [ Ort, Datum ] else if text.lang == "en" [ place, date ] else { panic("no translation for language: ", text.lang) }),
+    align(left, if text.lang == "de" [ Ort, Datum ] else if text.lang == "en" [ Place, Date ] else { panic("no translation for language: ", text.lang) }),
     align(left, if text.lang == "de" [ Unterschrift ] else if text.lang == "en" [ Signature ] else { panic("no translation for language: ", text.lang) }))
-]
+  }
+)

src/pages/declaration-of-authorship.typ

@@ -1,52 +1,66 @@
+// .--------------------------------------------------------------------------.
+// |                        Declaration of Authorship                         |
+// '--------------------------------------------------------------------------'
 
-#let new_declaration_of_authorship(config) = context [
+// Author: Sven Vogel
+// Edited: 28.06.2024
+// License: MIT
 
-  #pagebreak(weak: true)
+#let new_declaration_of_authorship(config) = (
+  context {
 
-  #let thesis = config.thesis
+    pagebreak(weak: true)
-  #let author = config.author
 
-  #v(2em)
+    let thesis = config.thesis
-  #if text.lang == "de" [
+    let author = config.author
-    #text(size: 20pt, weight: "semibold", font: "Montserrat", "Selbständigkeitserklärung")
+
+    if text.lang == "de" [
+      #heading("Selbständigkeitserklärung")
     ] else if text.lang == "en" [
-    #text(size: 20pt, weight: "semibold", font: "Montserrat", "Declaration of authorship")
+      #heading("Declaration of Authorship")
     ]
 
-  #v(1em)
+    v(1em)
 
-  #if text.lang == "de" [
+    if text.lang == "de" [
       Ich versichere hiermit, dass ich meine Prüfung mit dem Thema
     ] else if text.lang == "en" [
-    I hereby certify that I have passed my examination with the subject
+      I hereby confirm that I have written this thesis with the subject
     ]
 
-  #v(1em)
+    v(1em)
 
-  #set align(center)
+    set align(center)
 
-  *#thesis.title*
+    text(weight: "bold", thesis.title)
 
-  #thesis.subtitle
+    if thesis.subtitle != none {
+      linebreak()
+      thesis.subtitle
+    }
 
-  #set align(left)
+    set align(left)
 
-  #v(1em)
+    v(1em)
 
-  #set par(justify: true)
+    set par(justify: true)
 
+    if text.lang == "de" [
       selbständig verfasst und keine anderen als die angegebenen Quellen und Hilfsmittel benutzt habe. Ich versichere zudem, dass die eingereichte elektronische Fassung mit der gedruckten Fassung übereinstimmt.
+    ] else if text.lang == "en" [
+      independently and have not used any sources or aids other than those specified. I also confirm that the electronic version submitted is identical to the printed version.
+    ]
 
-  #v(25%)
+    set align(horizon)
 
-  #grid(
+    grid(
     // set width of columns
     // we need two, so make both half the page width
     columns: (50%, 50%),
     row-gutter: 0.75em,
     align(left, {line(length: 6cm)}),
     align(left, {line(length: 6cm)}),
-    align(left, if text.lang == "de" [ Ort, Datum ] else if text.lang == "en" [ place, date ] else { panic("no translation for language: ", text.lang) }),
+    align(left, if text.lang == "de" [ Ort, Datum ] else if text.lang == "en" [ Place, Date ] else { panic("no translation for language: ", text.lang) }),
     align(left, if text.lang == "de" [ Unterschrift ] else if text.lang == "en" [ Signature ] else { panic("no translation for language: ", text.lang) }))
-
+  }
-]
+)

src/pages/outline.typ

@@ -1,23 +1,43 @@
+// .--------------------------------------------------------------------------.
+// |                            Document Outline                              |
+// '--------------------------------------------------------------------------'
+
+// Author: Sven Vogel
+// Edited: 28.06.2024
+// License: MIT
 
 // render an outline of figures
 // with a specific title and filter by a specifc kind of figure
 // can optionally insert a pagebreak after the outline
 // NOTE: will not render in case the listing is empty
-#let render_filtered_outline(title: str, kind: selector) = context {
+#let render_filtered_outline(title: str, kind: selector) = (
+  context {
 
     let elems = query(figure.where(kind: kind), here())
     let count = elems.len()
 
+    show outline.entry: it => {
+      link(it.element.location())[
+        #v(12pt, weak: true)
+        #text(weight: "regular", it.body)
+        #box(width: 1fr, it.fill)
+        #[ #it.page]
+      ]
+    }
+
     // only show outline if there is something to list
     if count > 0 {
       pagebreak(weak: true)
       outline(
-      title: heading(level: 3, title),
+        title: title,
-      target: figure.where(kind: kind))
+        target: figure.where(kind: kind),
+      )
     }
-}
+  }
+)
 
-#let render_figures_outline() = context {
+#let render_figures_outline() = (
+  context {
     let title = if (text.lang == "de") {
       "Abbildungsverzeichnis"
     } else if text.lang == "en" {
@@ -25,9 +45,11 @@
     }
 
     render_filtered_outline(title: title, kind: image)
-}
+  }
+)
 
-#let render_table_outline() = context {
+#let render_table_outline() = (
+  context {
     let title = if (text.lang == "de") {
       "Tabellenverzeichnis"
     } else if text.lang == "en" {
@@ -35,9 +57,11 @@
     }
 
     render_filtered_outline(title: title, kind: table)
-}
+  }
+)
 
-#let render_raw_outline() = context {
+#let render_raw_outline() = (
+  context {
     let title = if (text.lang == "de") {
       "Quelltextverzeichnis"
     } else if text.lang == "en" {
@@ -45,23 +69,34 @@
     }
 
     render_filtered_outline(title: title, kind: raw)
-}
+  }
+)
 
-#let render_heading_outline() = context {
+#let render_heading_outline() = (
+  context {
     let title = if (text.lang == "de") {
       "Inhaltsverzeichnis"
     } else if text.lang == "en" {
       "Table of Contents"
     }
 
+    let header-supplement = if (text.lang == "de") {
+      "Kapitel"
+    } else {
+      "chapter"
+    }
+
     pagebreak(weak: true)
     outline(
-      target: heading.where(supplement: [chapter]),
+      target: heading.where(supplement: [#header-supplement]),
-      title: heading(level: 3, title),
+      title: title,
-      indent: auto)
+      indent: auto,
-}
+    )
+  }
+)
 
-#let render_appendix_outline() = context {
+#let render_appendix_outline() = (
+  context {
     let supplement = if text.lang == "en" {
       [Appendix]
     } else {
@@ -78,21 +113,23 @@
       pagebreak(weak: true)
       outline(
         target: heading.where(supplement: supplement),
-        title: heading(level: 3, title),
+        title: title,
-        indent: auto)
+        indent: auto,
+      )
     }
-}
+  }
+)
 
 #let new_outline() = {
   pagebreak(weak: true)
 
-  show outline.entry.where(
+  show outline.entry.where(level: 1): it => {
-    level: 1,
+    v(1.5em, weak: true)
-  ): it => {
-    v(18pt, weak: true)
     strong(it)
   }
 
+  render_heading_outline()
+
   render_figures_outline()
 
   render_table_outline()
@@ -100,6 +137,4 @@
   render_raw_outline()
 
   render_appendix_outline()
-
-  render_heading_outline()
 }

src/pages/preface.typ

@@ -1,3 +1,10 @@
+// .--------------------------------------------------------------------------.
+// |                                   Preface                                |
+// '--------------------------------------------------------------------------'
+
+// Author: Sven Vogel
+// Edited: 28.06.2024
+// License: MIT
 
 #let new-preface(config) = {
   if config.thesis.preface != none {

src/pages/prerelease-note.typ

@@ -1,47 +1,58 @@
+// .--------------------------------------------------------------------------.
+// |                      Preleminary release Notice                          |
+// '--------------------------------------------------------------------------'
 
-#let new_prerelease_note(config) = context [
+// Author: Sven Vogel
+// Edited: 28.06.2024
+// License: MIT
 
-  #pagebreak(weak: true)
+#let new_prerelease_note(config) = (
+  context {
 
-  #let thesis = config.thesis
+    pagebreak(weak: true)
-  #let author = config.author
 
-  #v(2em)
+    let thesis = config.thesis
-  #if text.lang == "de" [
+    let author = config.author
-    #text(size: 20pt, weight: "semibold", font: "Montserrat", "Vorabfassung")
+
+    if text.lang == "de" [
+      #heading("Vorabfassung")
     ] else if text.lang == "en" [
-    #text(size: 20pt, weight: "semibold", font: "Montserrat", "Preliminary version")
+      #heading("Preliminary Version")
     ]
 
-  #v(1em)
+    v(1em)
 
-  #if text.lang == "de" [
+    if text.lang == "de" [
       Bei dieser Ausgabe der Arbeit mit dem Thema
     ] else if text.lang == "en" [
       This edition of the work with the subject
     ]
 
-  #v(1em)
+    v(1em)
 
-  #set align(center)
+    set align(center)
 
-  *#thesis.title*
+    text(weight: "bold", thesis.title)
 
-  #thesis.subtitle
+    if thesis.subtitle != none {
+      linebreak()
+      thesis.subtitle
+    }
 
-  #set align(left)
+    set align(left)
 
-  #v(1em)
+    v(1em)
 
-  #set par(justify: true)
+    set par(justify: true)
 
-  #if text.lang == "de" [
+    if text.lang == "de" [
       handelt es sich _nicht_ um die fertige Fassung. Das Dokument kann Inhaltliche-, Grammatikalische- sowie Format-Fehler enthalten. Das Dokument ist im Rahmen der Aufgabenstellung von Seiten der #author.university nicht zur Bewertung freigegeben und ein anderer Verwendungszweck als eine Vorschau ist nicht gestattet.
     ] else if text.lang == "en" [
       is not the final version. The document may contain errors in content, grammar and formatting. The document may not be released for evaluation to #author.university as part of the assignment, and any use other than a preview is not permitted.
     ]
 
-  #v(1em)
+    v(1em)
-  #h(1em) #author.name, #datetime.today().display()
+    h(1em)
-
+    [#author.name, #datetime.today().display()]
-]
+  }
+)

src/pages/titlepage.typ

@@ -1,5 +1,13 @@
+// .--------------------------------------------------------------------------.
+// |                                Titlepage                                 |
+// '--------------------------------------------------------------------------'
 
-#let new_title_page(config) = context [
+// Author: Sven Vogel
+// Edited: 28.06.2024
+// License: MIT
+
+#let new_title_page(config) = (
+  context [
 
     #let thesis = config.thesis
     #let author = config.author
@@ -8,7 +16,8 @@
 
     // title
     #v(2cm)
-  #text(size: 2em, weight: "semibold", thesis.title)
+    #set par(justify: false)
+    #text(size: 2em, weight: "semibold", hyphenate: false, thesis.title)
 
     // subtitle
     #text(size: 1.5em, thesis.subtitle)
@@ -20,11 +29,11 @@
     // faculty
     #pad(top: 0.5cm)[
       #if text.lang == "de" [
-      Praxisphase des #author.semester Studienjahrs an der Fakultät für #author.faculty
+        Praxisphase des #author.semester Semesters an der Fakultät für #author.faculty
         #linebreak()
         im Studiengang #author.program
       ] else if text.lang == "en" [
-      Practical phase of the #author.semester academic year at the Faculty of #author.faculty
+        Practical phase of the #author.semester semester at the Faculty of #author.faculty
         #linebreak()
         in the degree program #author.program
       ] else [
@@ -45,7 +54,7 @@
       #author.university
     ]
 
-  #set align(bottom + left)
+    #set align(horizon + left)
 
     #if text.lang == "de" [
       #table(
@@ -53,24 +62,14 @@
         column-gutter: 1cm,
         align: left,
         stroke: none,
-      
+        [*Verfasser:*], author.name,
-      [*Verfasser:*],
+        [*Bearbeitungszeitraum:*], thesis.timeframe,
-      author.name,
-
-      [*Bearbeitungszeitraum:*],
-      thesis.timeframe,
-
         [*Matrikelnummer, Kurs:*],
         str(author.matriculation-number) + ", " + author.course,
 
-      [*Ausbildungsbetrieb:*],
+        [*Ausbildungsbetrieb:*], author.company,
-      author.company,
+        [*Betrieblicher Betreuer:*], author.supervisor,
-
+        [*Abgabedatum:*], thesis.submission-date,
-      [*Betrieblicher Betreuer:*],
-      author.supervisor,
-
-      [*Abgabedatum:*],
-      thesis.submission-date
       )
     ] else if text.lang == "en" [
       #table(
@@ -78,31 +77,21 @@
         column-gutter: 1cm,
         align: left,
         stroke: none,
-      
+        [*Author:*], author.name,
-      [*Author:*],
+        [*Editing period:*], thesis.timeframe,
-      author.name,
-
-      [*Editing period:*],
-      thesis.timeframe,
-
         [*Matriculation number, course:*],
         str(author.matriculation-number) + ", " + author.course,
 
-      [*Training company:*],
+        [*Training company:*], author.company,
-      author.company,
+        [*Company supervisor:*], author.supervisor,
-
+        [*Submission date:*], thesis.submission-date,
-      [*Company supervisor:*],
-      author.supervisor,
-
-      [*Submission date:*],
-      thesis.submission-date
       )
     ] else [
       #context panic("no translation for language: ", text.lang)
     ]
 
-  #pad(
+    #align(
-    top: 1cm,
+      bottom,
       grid(
       // set width of columns
       // we need two, so make both half the page width
@@ -115,9 +104,9 @@
           #context panic("no translation for language: ", text.lang)
         ]
       ),
-      align(right, {line(length: 6cm)})
+      align(right, {line(length: 6cm)})),
-    )
     )
 
     #counter(page).update(0)
-]
+  ]
+)

src/requirements.typ

@@ -1 +1,10 @@
-#import "@preview/glossarium:0.4.1": *
+
+// .--------------------------------------------------------------------------.
+// |                    Required packages for template use                    |
+// '--------------------------------------------------------------------------'
+
+// Author: Sven Vogel
+// Edited: 05.07.2024
+// License: MIT
+
+#import "glossary.typ": *

src/res/ABB.svg

@@ -1,5 +1,18 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<!--
+.~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~.
+|                                 ABB logo                                 |
+'~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~'
+
+Author: N/A
+Changed: Sven Vogel
+Edited: 05.07.2024
+License: MIT
+
+Source: https://commons.wikimedia.org/wiki/File:ABB_logo.svg
+
+   Created with Inkscape (http://www.inkscape.org/)
+-->
 
 <svg
    width="385.80621mm"

src/res/DHBW.svg

@@ -1,5 +1,18 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<!--
+.~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~.
+|                                DHBW logo                                 |
+'~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~'
+
+Author: N/A
+Changed: Sven Vogel
+Edited: 05.07.2024
+License: MIT
+
+Source: https://upload.wikimedia.org/wikipedia/de/1/1d/DHBW-Logo.svg
+
+     Created with Inkscape (http://www.inkscape.org/)
+-->
 
 <svg
    width="353.7124mm"

src/res/abb.tmTheme

@@ -0,0 +1,561 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>author</key>
+	<string>Template: Chris Kempson, Scheme: Sven Vogel</string>
+	<key>name</key>
+	<string>Base16 ABB Base16</string>
+	<key>semanticClass</key>
+	<string>theme.base16.abb-base16</string>
+	<key>colorSpaceName</key>
+	<string>sRGB</string>
+	<key>gutterSettings</key>
+	<dict>
+		<key>background</key>
+		<string>#fafafa</string>
+		<key>divider</key>
+		<string>#fafafa</string>
+		<key>foreground</key>
+		<string>#6e6e6e</string>
+		<key>selectionBackground</key>
+		<string>#f0f0f0</string>
+		<key>selectionForeground</key>
+		<string>#000000</string>
+	</dict>
+	<key>settings</key>
+	<array>
+		<dict>
+			<key>settings</key>
+			<dict>
+				<key>background</key>
+				<string>#ffffff</string>
+				<key>caret</key>
+				<string>#000000</string>
+				<key>foreground</key>
+				<string>#000000</string>
+				<key>invisibles</key>
+				<string>#6e6e6e</string>
+				<key>lineHighlight</key>
+				<string>#6e6e6e55</string>
+				<key>selection</key>
+				<string>#f0f0f0</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Text</string>
+			<key>scope</key>
+			<string>variable.parameter.function</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#000000</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Comments</string>
+			<key>scope</key>
+			<string>comment, punctuation.definition.comment</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#6e6e6e</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Punctuation</string>
+			<key>scope</key>
+			<string>punctuation.definition.string, punctuation.definition.variable, punctuation.definition.string, punctuation.definition.parameters, punctuation.definition.string, punctuation.definition.array</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#000000</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Delimiters</string>
+			<key>scope</key>
+			<string>none</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#000000</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Operators</string>
+			<key>scope</key>
+			<string>keyword.operator</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#000000</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Keywords</string>
+			<key>scope</key>
+			<string>keyword</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#ff000f</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Variables</string>
+			<key>scope</key>
+			<string>variable</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#262626</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Functions</string>
+			<key>scope</key>
+			<string>entity.name.function, meta.require, support.function.any-method, variable.function, variable.annotation, support.macro</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#007a33</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Labels</string>
+			<key>scope</key>
+			<string>entity.name.label</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#6e6e6e</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Classes</string>
+			<key>scope</key>
+			<string>support.class, entity.name.class, entity.name.type.class</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#ff000f</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Classes</string>
+			<key>scope</key>
+			<string>meta.class</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#fafafa</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Methods</string>
+			<key>scope</key>
+			<string>keyword.other.special-method</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#007a33</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Storage</string>
+			<key>scope</key>
+			<string>storage</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#ff000f</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Support</string>
+			<key>scope</key>
+			<string>support.function</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#262626</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Strings, Inherited Class</string>
+			<key>scope</key>
+			<string>string, constant.other.symbol, entity.other.inherited-class</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#004c97</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Integers</string>
+			<key>scope</key>
+			<string>constant.numeric</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#004c97</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Floats</string>
+			<key>scope</key>
+			<string>none</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#004c97</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Boolean</string>
+			<key>scope</key>
+			<string>none</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#004c97</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Constants</string>
+			<key>scope</key>
+			<string>constant</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#004c97</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Tags</string>
+			<key>scope</key>
+			<string>entity.name.tag</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#262626</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Attributes</string>
+			<key>scope</key>
+			<string>entity.other.attribute-name</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#004c97</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Attribute IDs</string>
+			<key>scope</key>
+			<string>entity.other.attribute-name.id, punctuation.definition.entity</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#007a33</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Selector</string>
+			<key>scope</key>
+			<string>meta.selector</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#ff000f</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Values</string>
+			<key>scope</key>
+			<string>none</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#004c97</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Headings</string>
+			<key>scope</key>
+			<string>markup.heading punctuation.definition.heading, entity.name.section</string>
+			<key>settings</key>
+			<dict>
+				<key>fontStyle</key>
+				<string></string>
+				<key>foreground</key>
+				<string>#007a33</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Units</string>
+			<key>scope</key>
+			<string>keyword.other.unit</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#004c97</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Bold</string>
+			<key>scope</key>
+			<string>markup.bold, punctuation.definition.bold</string>
+			<key>settings</key>
+			<dict>
+				<key>fontStyle</key>
+				<string>bold</string>
+				<key>foreground</key>
+				<string>#ff000f</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Italic</string>
+			<key>scope</key>
+			<string>markup.italic, punctuation.definition.italic</string>
+			<key>settings</key>
+			<dict>
+				<key>fontStyle</key>
+				<string>italic</string>
+				<key>foreground</key>
+				<string>#ff000f</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Code</string>
+			<key>scope</key>
+			<string>markup.raw.inline</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#004c97</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Link Text</string>
+			<key>scope</key>
+      <string>string.other.link, punctuation.definition.string.end.markdown, punctuation.definition.string.begin.markdown</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#262626</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Link Url</string>
+			<key>scope</key>
+			<string>meta.link</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#004c97</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Lists</string>
+			<key>scope</key>
+			<string>markup.list</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#262626</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Quotes</string>
+			<key>scope</key>
+			<string>markup.quote</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#004c97</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Separator</string>
+			<key>scope</key>
+			<string>meta.separator</string>
+			<key>settings</key>
+			<dict>
+				<key>background</key>
+				<string>#f0f0f0</string>
+				<key>foreground</key>
+				<string>#000000</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Inserted</string>
+			<key>scope</key>
+			<string>markup.inserted</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#004c97</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Deleted</string>
+			<key>scope</key>
+			<string>markup.deleted</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#262626</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Changed</string>
+			<key>scope</key>
+			<string>markup.changed</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#ff000f</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Colors</string>
+			<key>scope</key>
+			<string>constant.other.color</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#262626</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Regular Expressions</string>
+			<key>scope</key>
+			<string>string.regexp</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#262626</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Escape Characters</string>
+			<key>scope</key>
+			<string>constant.character.escape</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#262626</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Embedded</string>
+			<key>scope</key>
+			<string>punctuation.section.embedded, variable.interpolation</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#ff000f</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Illegal</string>
+			<key>scope</key>
+			<string>invalid.illegal</string>
+			<key>settings</key>
+			<dict>
+				<key>background</key>
+				<string>#262626</string>
+				<key>foreground</key>
+				<string>#fafafa</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Broken</string>
+			<key>scope</key>
+			<string>invalid.broken</string>
+			<key>settings</key>
+			<dict>
+				<key>background</key>
+				<string>#004c97</string>
+				<key>foreground</key>
+				<string>#ffffff</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Deprecated</string>
+			<key>scope</key>
+			<string>invalid.deprecated</string>
+			<key>settings</key>
+			<dict>
+				<key>background</key>
+				<string>#6e6e6e</string>
+				<key>foreground</key>
+				<string>#fafafa</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Unimplemented</string>
+			<key>scope</key>
+			<string>invalid.unimplemented</string>
+			<key>settings</key>
+			<dict>
+				<key>background</key>
+				<string>#6e6e6e</string>
+				<key>foreground</key>
+				<string>#fafafa</string>
+			</dict>
+		</dict>
+	</array>
+	<key>uuid</key>
+	<string>uuid</string>
+</dict>
+</plist>
+

src/style.typ

@@ -7,44 +7,86 @@
 // Edited: 27.06.2024
 // License: MIT
 
+#import "branding.typ": *
+
 #let watermark-color = luma(50%).transparentize(70%)
 
-#let watermark() = rotate(-45deg,
+#let watermark-pattern = pattern(size: (5pt, 5pt))[
-      rect(radius: 1em, inset: 1em, stroke: watermark-color, {
+  #place(
-        text(size: 48pt, weight: "bold", fill: watermark-color, "DRAFT")
+    line(
-        linebreak()
+      start: (50%, 0%),
-        text(size: 14pt, weight: "bold", fill: watermark-color)[
+      end: (50%, 100%),
+      stroke: (paint: watermark-color, thickness: 3pt),
+    ),
+  )
+]
+
+#let watermark(config) = if config.draft {
+  rotate(-22.5deg)[
+    #rect(
+      radius: 1em,
+      inset: 1em,
+      stroke: watermark-color,
+    )[
+      #text(size: 4em, weight: "bold", fill: watermark-pattern, "DRAFT")
+      #linebreak()
+      #text(size: 1.25em, weight: "bold", fill: watermark-color)[
         This page is part of a preliminary
         #linebreak()
         document version.
         #linebreak()
-          #text(size: 10pt, "Further usage without the authors consent is not permitted.")
+        #text(
-        ]
+          size: 0.75em,
-      }))
+          "Further usage without the authors consent is not permitted.",
+        )]]]
+}
+
+#let numberingH(c) = {
+  return numbering(c.numbering, ..counter(heading).at(c.location()))
+}
+
+#let currentH(level: 1) = {
+  let elems = query(selector(heading.where(level: level)).after(here()))
+
+  if elems.len() != 0 and elems.first().location().page() == here().page() {
+    return (numberingH(elems.first()), elems.first().body)
+  } else {
+    elems = query(selector(heading.where(level: level)).before(here()))
+    if elems.len() != 0 {
+      return (numberingH(elems.last()), elems.last().body)
+    }
+  }
+  return ""
+}
 
 // global style of document
-#let global_styled_doc(config: dictionary, body: content) = context {
+#let global_styled_doc(config, body) = {
   let thesis = config.thesis
   let style = config.style
 
-  // set page geometry
-  // and paper format
-  set page(
-    paper: style.page.format,
-    margin: style.page.margin)
-
   set text(
     size: style.text.size,
     ligatures: true,
     hyphenate: true,
     dir: ltr,
-    font: style.text.font)
+    font: style.text.font,
+    fill: ABB-BLACK,
+  )
 
   show heading: set text(
     font: style.heading.font,
-    weight: "semibold")
+    weight: "semibold",
+  )
 
-  set heading(supplement: [chapter])
+  let header-supplement = if config.lang == "de" {
+    "Kapitel"
+  } else {
+    "chapter"
+  }
+
+  set heading(supplement: [#header-supplement])
+
+  set math.equation(numbering: "(1)")
 
   // Set header spacing
   show heading.where(level: 1): it => v(2em) + it + v(1em)
@@ -52,21 +94,143 @@
   show heading.where(level: 3): it => v(0.5em) + it + v(0.25em)
 
   // set theme for code blocks
-  set raw(tab-size: 4, theme: "res/github.tmTheme")
+  set raw(tab-size: style.code.tab-size)
-  show raw.where(block: true): code => {
+  show raw.where(block: false): it => box(
-    show raw.line: line => {
+    stroke: 1pt + ABB-GRAY-05,
-      text(fill: gray)[#line.number]
+    radius: 2pt,
-      h(1em)
+    inset: (left: 2pt, right: 2pt),
-      line.body
+    outset: (top: 4pt, bottom: 4pt),
+    fill: ABB-GRAY-06,
+    text(font: style.code.font, size: style.code.size, it.text),
+  )
+  show figure.where(kind: raw): it => align(left)[
+    #let content = it.body
+    #let lang = if content.has("lang") {
+      it.body.lang
+    } else {
+      none
     }
-    code
+    #block(
+      width: 100%,
+      fill: ABB-GRAY-06,
+      stroke: 1pt + ABB-GRAY-05,
+      radius: 0.5em,
+      inset: 0.75em,
+      clip: false,
+      {
+        let (columns, align, make_row) = {
+          if style.code.lines {
+            (
+              (auto, 1fr),
+              (right + top, left),
+              e => {
+                let (i, l) = e
+                let n = i + 1
+                let n_str = if (calc.rem(n, 1) == 0) or (true and i == 0) {
+                  text(
+                    font: style.code.font,
+                    size: style.code.size,
+                    fill: ABB-BLACK,
+                    str(n),
+                  )
+                } else {
+                  none
                 }
+                (n_str + h(0.5em), raw(block: true, lang: lang, l))
+              },
+            )
+          } else {
+            (
+              (1fr,),
+              (left,),
+              e => {
+                let (i, l) = e
+                raw(block: true, lang: lang, l)
+              },
+            )
+          }
+        }
+        grid(
+          stroke: none,
+          columns: columns,
+          rows: (auto,),
+          gutter: 0pt,
+          inset: 0.25em,
+          align: (col, _) => align.at(col),
+          fill: ABB-GRAY-06,
+          ..content
+            .text
+            .split("\n")
+            .enumerate()
+            .map(make_row)
+            .flatten()
+            .map(c => if c.has("text") and c.text == "" {
+            v(1em)
+          } else {
+            c
+          })
+        )
+      },
+    )
+    #v(-1em)
+    #align(center + top, it.caption)
+  ]
+
+  show figure: set block(breakable: true)
+
+  // make figure supplements bold
+  // based on: https://github.com/typst/typst/discussions/3871
+  show figure.caption: c => [
+    #if c.body.fields().len() > 0 {
+      text(weight: "semibold")[
+        #c.supplement #c.counter.display("1.1.1")
+      ]
+      c.separator
+    }
+    #c.body
+  ]
+
+  // change the display supplement according to the text langugae
+  // based on: https://github.com/typst/typst/issues/3273
+  show figure.where(kind: raw): set figure(supplement: context {
+    if text.lang == "de" {
+      "Quelltext"
+    } else {
+      "Listing"
+    }
+  })
+
+  // APA style table
+  set table(
+    inset: 0.5em,
+    align: left,
+    stroke: (x, y) => (
+      left: none,
+      right: none,
+      top: if y == 0 {
+        1.5pt
+      } else if y < 2 {
+        1pt
+      } else {
+        0.5pt
+      },
+      bottom: if y == 0 {
+        1pt
+      } else {
+        1.5pt
+      },
+    ),
+  )
+
+  // make table header bold
+  show table.cell.where(y: 0): set text(weight: "bold")
 
   set block(spacing: 2em)
   set par(
     justify: true,
     first-line-indent: 1em,
-    leading: 1em)
+    leading: 1em,
+  )
 
   // give links a color
   show link: set text(fill: style.link.color)
@@ -74,43 +238,61 @@
 
   set heading(numbering: none)
   set page(
-    foreground: if config.draft {
+    paper: style.page.format,
-      watermark()
+    foreground: watermark(config),
-    },
+    header-ascent: style.header.content-padding,
-    header-ascent: style.header.underline-top-padding + style.header.bottom-padding,
+    footer-descent: style.header.content-padding,
-    footer-descent: 1em,
     margin: (
-      top: style.page.margin.top + style.header.logo-height + style.header.underline-top-padding + style.header.bottom-padding,
+      top: style.page.margin.top + style.header.underline-top-padding + style
-      bottom: style.page.margin.bottom + 1em),
+        .header
+        .content-padding,
+      bottom: style.page.margin.bottom + style.footer.content-padding,
+      left: style.page.margin.left,
+      right: style.page.margin.right,
+    ),
     numbering: (..nums) => {
       let current-page = here().page()
-      if current-page == 1{
+      if current-page == 1 {
         []
-      } else if query(<end-of-prelude>).first().location().page() > current-page {
+      } else if query(<end-of-prelude>)
+        .first()
+        .location()
+        .page() > current-page {
         numbering("I", nums.pos().first())
-      } else if query(<end-of-content>).first().location().page() >= current-page {
+      } else if query(<end-of-content>)
+        .first()
+        .location()
+        .page() >= current-page {
         numbering("1", nums.pos().first())
       } else {
         numbering("a", nums.pos().first())
       }
     },
     footer: context [
-      #set align(center)
       #let page-counter = counter(page).get().first()
       #let page-number = here().page()
+      #set align(center)
+
       #if page-number == 1 {
         []
       } else if query(<end-of-prelude>).first().location().page() > page-number {
+        set align(center)
         numbering("I", page-counter)
       } else if query(<end-of-content>).first().location().page() >= page-number {
-        numbering("1 / 1", page-counter, counter(page).at(<end-of-content>).last())
+        numbering(
+          "1 / 1",
+          page-counter,
+          counter(page).at(<end-of-content>).last(),
+        )
       } else {
         numbering("a", page-counter)
       }
     ],
     header: context {
       set align(left)
-      if here().page() == 1 {
+      let current-page = here().page()
+
+      if current-page == 1 {
         // logo of ABB and DHBW
         grid(
           // set width of columns
@@ -121,57 +303,39 @@
           // right align logo of DHBW
           align(right, image("res/DHBW.svg", height: style.header.logo-height)))
 
-      } else if query(<end-of-prelude>).first().location().page() <= here().page() {
+      } else if query(<end-of-content>)
-        let headers-before = query(selector(heading.where(numbering: "1.", level: 1)).before(here()))
+        .first()
-
+        .location()
-        let header-title = thesis.title
+        .page() >= current-page and query(<end-of-prelude>)
-
+        .first()
-        if headers-before.len() > 0 {
+        .location()
-          header-title = headers-before.last().body
+        .page() < current-page + 1 {
-        } else {
+        let heading = currentH()
-          let headers-after = query(selector(heading.where(numbering: "1.", level: 1)).after(here()))
-
-          if headers-after.len() > 0 {
-            header-title = headers-after.first().body
-          }
-        }
-
-        grid(
-          columns: (1fr, auto),
-          align: (horizon, bottom),
-          context [ _ #header-title _ ],
-          image("res/DHBW.svg", height: style.header.logo-height))
 
+        heading.at(0)
+        h(0.5em)
+        heading.at(1)
         v(style.header.underline-top-padding - 1em)
         line(length: 100%)
       } else {
-        grid(
+        config.thesis.title
-          columns: (1fr, auto),
+        v(style.header.underline-top-padding - 1em)
-          align: (horizon, bottom),
+        line(length: 100%)
-          context [ _ #config.thesis.title _ ],
+      }
-          image("res/DHBW.svg", height: style.header.logo-height)
+    },
   )
-        v(style.header.underline-top-padding - 1em)
-        line(length: 100%)
-      }
-    })
 
   body
 }
 
-#let content_styled(config: dictionary, body: content) = [
+#let content_styled(config, body) = {
-  #set heading(numbering: "1.")
+  set heading(numbering: "1.1.1")
 
-  #let thesis = config.thesis
+  body
+}
 
-  #body
+#let end_styled(config, body) = {
-]
+  set heading(numbering: "1.1.1")
 
-#let end_styled(config: dictionary, body: content) = [
+  body
-
+}
-  #set heading(numbering: "1.")
-
-  #let thesis = config.thesis
-
-  #body
-]

template/appendix.typ

@@ -7,3 +7,6 @@
 == More raw data
 
 #lorem(50)
+
+#figure(```
+```)

template/glossary.typ

@@ -1,15 +0,0 @@
-
-#let glossary = (
-  (
-    key: "oidc", 
-    short: "OIDC", 
-    long: "OpenID Connect", 
-    desc: [OpenID is an open standard and decentralized authentication protocol promoted by the non-profit #link("https://en.wikipedia.org/wiki/OpenID#OpenID_Foundation")[OpenID Foundation].]
-  ),
-  (
-    key: "potato",
-    short: "potato",
-    plural: "potatoes",
-    desc: [#lorem(10)]
-  ),
-)

template/glossary.yml

@@ -0,0 +1,13 @@
+
+oidc:
+  short: OIDC
+  long: OpenID Connect
+  desc: "OpenID is an open standard and decentralized authentication protocol promoted by the non-profit #link(\"https://en.wikipedia.org/wiki/OpenID#OpenID_Foundation\")[OpenID Foundation]."
+
+potato:
+  short: potato
+  desc: "#lorem(50)"
+
+HTTP:
+  short: HTTP
+  long: Hyper Text Transfer Protocol

template/main.typ

@@ -1,12 +1,11 @@
-#import "../src/lib.typ": dhbw-template
+#import "../src/lib.typ": *
 
-#import "glossary.typ": glossary
 #import "abstract.typ": abstract, summary
 
-#show: dhbw-template.with(
+#show: dhbw-template.with((
-  config: (
+  lang: "de",
-    lang: "en",
+  region: "de",
-    region: "en",
+  draft: false,
   author: (
     name: "Sven Vogel",
     semester: 4,
@@ -16,7 +15,8 @@
     university: "DHBW Mannheim",
     company: "ABB AG",
     supervisor: "Benny Goodman",
-      matriculation-number: 123456789),
+    matriculation-number: 123456789,
+  ),
   thesis: (
     title: "Unofficial ABB/DHBW Typst template",
     subtitle: "for reports and thesises",
@@ -26,17 +26,22 @@
     summary: summary,
     abstract: abstract,
     preface: include "preface.typ",
-      keywords: ( "IT", "other stuff" ),
+    keywords: ("IT", "other stuff"),
     bibliography: bibliography("refs.bib"),
-      glossary: glossary,
+    glossary: yaml("glossary.yml"),
-      appendices: include "appendix.typ")))
+    appendices: include "appendix.typ",
+  ),
+))
 
 #import "@preview/wrap-it:0.1.0": wrap-content
 
 = Lorem Ipsum
 
+#text(fill: ABB-RED, "Hello ABB branding")
+
 #lorem(25)
 @oidc
+@potato
 
 #lorem(100)
 @Anhang-A
@@ -46,9 +51,9 @@
 #lorem(200)
 @einstein
 
-= Lorem Ipsum 3
+= Lorem Ipsum 3 <sec:hello>
 
-#lorem(15)
+#lorem(15) t `Hello, World!` #lorem(50)
 
 $
   angle.l a, b angle.r &= arrow(a) dot arrow(b) \
@@ -60,53 +65,51 @@ $
 
 #wrap-content(
   figure(image("assets/digitaldog.jpg", width: 200pt), caption: [ Some image caption ]),
-  lorem(200))
+  lorem(200),
+)
+
+#url("https://github.com", "text") @sec:hello
+
+#lorem(50)
 
 #figure(
   table(
-    columns: 2,
+    columns: 3,
-    "Hello", "World"),
+    table.header[Date][Exercise Type][Calories Burned],
-    caption: [ Some table ])
+    [2023-03-15], [Swimming], [400],
+    [2023-03-17], [Weightlifting], [250],
+    [2023-03-18], [Yoga], [200],
+    [2023-03-15], [Swimming], [400],
+    [2023-03-17], [Weightlifting], [250],
+    [2023-03-18], [Yoga], [200],
+    [2023-03-15], [Swimming], [400],
+    [2023-03-17], [Weightlifting], [250],
+    [2023-03-18], [Yoga], [200],
+  ),
+  caption: [ Some table ],
+)
 
 #pagebreak()
 
+#lorem(100)
+#inline-color("#ff0000", "red") @HTTP
+
 #figure(
   ```rust
-use std::env;
+  use std::env;
-use std::fs::OpenOptions;
+  use std::fs::OpenOptions;
-use std::io::Write;
+  use std::io::Write;
 
-fn main() {
+  fn main() {
-    // Get the file path from the environment variable
+      println!("Hello, World!!!");
-    let file_path = match env::var("OUTPUT_FILE") {
-        Ok(path) => path,
-        Err(_) => {
-            eprintln!("Error: OUTPUT_FILE environment variable is not set");
-            return;
   }
-    };
+  ```,
+  caption: [Some code],
+)
 
-    // Open the file in append mode, create it if it doesn't exist
+#lorem(100)
-    let mut file = match OpenOptions::new()
-        .append(true)
-        .create(true)
-        .open(&file_path)
-    {
-        Ok(file) => file,
-        Err(e) => {
-            eprintln!("Error opening file {}: {}", file_path, e);
-            return;
-        }
-    };
 
-    // Write "Hello, World" to the file
+#pagebreak()
-    if let Err(e) = writeln!(file, "Hello, World") {
-        eprintln!("Error writing to file: {}", e);
-    } else {
-        println!("Successfully appended 'Hello, World' to {}", file_path);
-    }
-}
-  ```, caption: [Some code])
 
 = Conclusion
 

tests/invalid-config/test-case-1.typ

@@ -1,8 +1,7 @@
 
 #import "../../src/lib.typ": dhbw-template
 
-#show: dhbw-template.with(
+#show: dhbw-template.with((
-  config: (
     lang: none,
     region: "en",
     author: (

tests/invalid-config/test-case-2.typ

@@ -1,8 +1,7 @@
 
 #import "../../src/lib.typ": dhbw-template
 
-#show: dhbw-template.with(
+#show: dhbw-template.with((
-  config: (
   lang: "en",
   this-key-is-not-in-config: "Ha Ha",
   region: "en",
@@ -15,7 +14,8 @@
     university: "DHBW Mannheim",
     company: "ABB AG",
     supervisor: "Benny Goodman",
-      matriculation-number: 123456789),
+    matriculation-number: 123456789,
+  ),
   thesis: (
     title: "Unofficial ABB/DHBW Typst template",
     subtitle: "for reports and thesises",
@@ -24,7 +24,11 @@
     kind: "T2000",
     summary: none,
     abstract: none,
-      keywords: ( "IT", "other stuff" ),
+    keywords: ("IT", "other stuff"),
     bibliography: none,
     glossary: none,
-      appendices: none)))
+    appendices: none,
+  ),
+))
+
+= Heading

tests/invalid-config/test-case-3.typ

@@ -1,15 +1,15 @@
 
 #import "../../src/lib.typ": dhbw-template
 
-#show: dhbw-template.with(
+#show: dhbw-template.with((
-  config: (
   lang: "en",
   region: "en",
   author: (
     university: "DHBW Mannheim",
     company: "ABB AG",
     supervisor: none,
-      matriculation-number: 123456789),
+    matriculation-number: 123456789,
+  ),
   thesis: (
     title: "Unofficial ABB/DHBW Typst template",
     subtitle: "for reports and thesises",
@@ -18,7 +18,9 @@
     kind: "T2000",
     summary: none,
     abstract: none,
-      keywords: ( "IT", "other stuff" ),
+    keywords: ("IT", "other stuff"),
     bibliography: none,
     glossary: none,
-      appendices: none)))
+    appendices: none,
+  ),
+))

tests/local-import/main.typ

@@ -1,8 +1,7 @@
 
 #import "../../src/lib.typ": dhbw-template
 
-#show: dhbw-template.with(
+#show: dhbw-template.with((
-  config: (
     lang: "en",
     region: "en",
     author: (
@@ -27,3 +26,5 @@
       bibliography: none,
       glossary: none,
       appendices: none)))
+
+= Heading

typst.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dhbw-abb-typst-template"
-version = "0.1.0"
+version = "0.4.1"
 entrypoint = "src/template.typ"
 authors = ["Sven Vogel <sven.vogel1@de.abb.com>"]
 license = "MIT"