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,15 +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: |
-      - name: Set up Python 3
+          apt update -y
-        run: apt update -y && apt install python3-pip -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,21 +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: Set up Python 3
-        run: apt update -y && apt install python3-pip -y
       - 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

@@ -5,16 +5,12 @@ on: [push]
 jobs:
   run-ci-linux:
     runs-on: ubuntu-latest
-    env:
-      TYPST_INSTALL: $HOME/.typst
-      TYPST_VERSION: 0.11.1
     steps:
       - name: Check out repository code
         uses: actions/checkout@v3
-      - name: Install Typst CLI
+      - name: Setup Nix
-        run: curl -fsSL https://typst.community/typst-install/install.sh | sh -s "$TYPST_VERSION"
+        uses: cachix/install-nix-action@v27
-      - uses: actions/setup-python@v5
         with:
-          python-version: '3.11' 
+          nix_path: nixpkgs=channel:nixos-unstable
       - name: Run CI
-        run: export PATH="$TYPST_INSTALL/bin:$PATH" && bash -c ./run-ci.sh
+        run: nix-shell --run ./run-ci.sh

.github/workflows/release.yml

@@ -1,32 +1,30 @@
+name: release
+
 on:
   push:
-    # Sequence of patterns matched against refs/tags
     tags:
-      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+      - 'v*.*.*'
-
-name: Create Release
 
 jobs:
-  build:
+  release:
-    name: Create Release
     runs-on: ubuntu-latest
     steps:
       - name: Check out repository code
         uses: actions/checkout@v3
-      - name: Install Typst CLI
+      - name: Setup Nix
-        run: curl -fsSL https://typst.community/typst-install/install.sh | sh -s "$TYPST_VERSION"
+        uses: cachix/install-nix-action@v27
-      - uses: actions/setup-python@v5
         with:
-          python-version: '3.11' 
+          nix_path: nixpkgs=channel:nixos-unstable
       - name: Run CI
-        run: export PATH="$TYPST_INSTALL/bin:$PATH" && bash -c ./run-ci.sh
+        run: nix-shell --run ./run-ci.sh
-      - name: Create Release
+      - name: Setup go
-        id: create_release
+        uses: https://github.com/actions/setup-go@v4
-        uses: actions/create-release@latest
-        env:
-          GITHUB_TOKEN: ${{ secrets.PAT }}
         with:
-          tag_name: ${{ github.ref }}
+          go-version: '>=1.20.1'
-          release_name: Release ${{ github.ref }}
+      - name: Create release
-          draft: false
+        id: create-release
-          prerelease: false
+        uses: https://gitea.com/actions/release-action@main
+        with:
+          files: |-
+            example.pdf
+          api_key: '${{secrets.RELEASE_TOKEN}}'

base16/abb.yml

@@ -1,20 +0,0 @@
-# Base16 ABB branded color scheme
-scheme-author: "Sven Vogel"
-scheme-slug: "abb-base16"
-scheme-name: "ABB Base16"
-base00: "ffffff" # Default Background
-base01: "fafafa" # Lighter Background
-base02: "f0f0f0" # Selection Background
-base03: "6e6e6e" # Comments, Invisibles, Line Highlighting
-base04: "000000" # Dark Foreground
-base05: "000000" # Default Foreground, Caret, Delimiters, Operators
-base06: "fafafa" # Light Foreground (Not often used)
-base07: "fafafa" # Light Background (Not often used)
-base08: "262626" # Variables, XML Tags, Markup Link Text, Markup Lists, Diff Deleted
-base09: "004c97" # Integers, Boolean, Constants, XML Attributes, Markup Link Url
-base0A: "ff000f" # Classes, Markup Bold, Search Text Background
-base0B: "004c97" # Strings, Inherited Class, Markup Code, Diff Inserted
-base0C: "262626" # Support, Regular Expressions, Escape Characters, Markup Quotes
-base0D: "007a33" # Functions, Methods, Attribute IDs, Headings
-base0E: "ff000f" # Keywords, Storage, Selector, Markup Italic, Diff Changed
-base0F: "6e6e6e" # Deprecated, Opening/Closing Embedded Language Tags

base16/generator.py

@@ -1,30 +0,0 @@
-import yaml
-import logging
-import sys
-import re
-
-global data
-
-def replace_tag(match):
-    return data[match.group(1)]
-
-if __name__ == '__main__':
-    logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(levelname)s - %(message)s')
-    logger = logging.getLogger()
-
-    with open(sys.argv[1], 'r') as file:
-        data = yaml.safe_load(file)
-
-        content = ""
-
-        with open(sys.argv[2], "r") as file:
-            logger.info(f"opened file: {sys.argv[2]}")
-            content = file.read()
-            logger.info(f"read file: {sys.argv[2]}")
-        
-            logger.info(f"converting...")
-            content = re.sub("\\{\\{([a-z0-9-]+)\\}\\}", replace_tag, content, 0, re.IGNORECASE)
-
-            with open(sys.argv[3], "w") as file:
-                logger.info(f"writing changes...")
-                file.write(content)

base16/requirements.txt

@@ -1 +0,0 @@
-pyyaml

base16/template.tmTheme

@@ -1,561 +0,0 @@
-<?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: {{scheme-author}}</string>
-	<key>name</key>
-	<string>Base16 {{scheme-name}}</string>
-	<key>semanticClass</key>
-	<string>theme.base16.{{scheme-slug}}</string>
-	<key>colorSpaceName</key>
-	<string>sRGB</string>
-	<key>gutterSettings</key>
-	<dict>
-		<key>background</key>
-		<string>#{{base01}}</string>
-		<key>divider</key>
-		<string>#{{base01}}</string>
-		<key>foreground</key>
-		<string>#{{base03}}</string>
-		<key>selectionBackground</key>
-		<string>#{{base02}}</string>
-		<key>selectionForeground</key>
-		<string>#{{base04}}</string>
-	</dict>
-	<key>settings</key>
-	<array>
-		<dict>
-			<key>settings</key>
-			<dict>
-				<key>background</key>
-				<string>#{{base00}}</string>
-				<key>caret</key>
-				<string>#{{base05}}</string>
-				<key>foreground</key>
-				<string>#{{base05}}</string>
-				<key>invisibles</key>
-				<string>#{{base03}}</string>
-				<key>lineHighlight</key>
-				<string>#{{base03}}55</string>
-				<key>selection</key>
-				<string>#{{base02}}</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>#{{base05}}</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>#{{base03}}</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>#{{base05}}</string>
-			</dict>
-		</dict>
-		<dict>
-			<key>name</key>
-			<string>Delimiters</string>
-			<key>scope</key>
-			<string>none</string>
-			<key>settings</key>
-			<dict>
-				<key>foreground</key>
-				<string>#{{base05}}</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>#{{base05}}</string>
-			</dict>
-		</dict>
-		<dict>
-			<key>name</key>
-			<string>Keywords</string>
-			<key>scope</key>
-			<string>keyword</string>
-			<key>settings</key>
-			<dict>
-				<key>foreground</key>
-				<string>#{{base0E}}</string>
-			</dict>
-		</dict>
-		<dict>
-			<key>name</key>
-			<string>Variables</string>
-			<key>scope</key>
-			<string>variable</string>
-			<key>settings</key>
-			<dict>
-				<key>foreground</key>
-				<string>#{{base08}}</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>#{{base0D}}</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>#{{base0F}}</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>#{{base0A}}</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>#{{base07}}</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>#{{base0D}}</string>
-			</dict>
-		</dict>
-		<dict>
-			<key>name</key>
-			<string>Storage</string>
-			<key>scope</key>
-			<string>storage</string>
-			<key>settings</key>
-			<dict>
-				<key>foreground</key>
-				<string>#{{base0E}}</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>#{{base0C}}</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>#{{base0B}}</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>#{{base09}}</string>
-			</dict>
-		</dict>
-		<dict>
-			<key>name</key>
-			<string>Floats</string>
-			<key>scope</key>
-			<string>none</string>
-			<key>settings</key>
-			<dict>
-				<key>foreground</key>
-				<string>#{{base09}}</string>
-			</dict>
-		</dict>
-		<dict>
-			<key>name</key>
-			<string>Boolean</string>
-			<key>scope</key>
-			<string>none</string>
-			<key>settings</key>
-			<dict>
-				<key>foreground</key>
-				<string>#{{base09}}</string>
-			</dict>
-		</dict>
-		<dict>
-			<key>name</key>
-			<string>Constants</string>
-			<key>scope</key>
-			<string>constant</string>
-			<key>settings</key>
-			<dict>
-				<key>foreground</key>
-				<string>#{{base09}}</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>#{{base08}}</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>#{{base09}}</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>#{{base0D}}</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>#{{base0E}}</string>
-			</dict>
-		</dict>
-		<dict>
-			<key>name</key>
-			<string>Values</string>
-			<key>scope</key>
-			<string>none</string>
-			<key>settings</key>
-			<dict>
-				<key>foreground</key>
-				<string>#{{base09}}</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>#{{base0D}}</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>#{{base09}}</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>#{{base0A}}</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>#{{base0E}}</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>#{{base0B}}</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>#{{base08}}</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>#{{base09}}</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>#{{base08}}</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>#{{base09}}</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>#{{base02}}</string>
-				<key>foreground</key>
-				<string>#{{base05}}</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>#{{base0B}}</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>#{{base08}}</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>#{{base0E}}</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>#{{base0C}}</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>#{{base0C}}</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>#{{base0C}}</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>#{{base0E}}</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>#{{base08}}</string>
-				<key>foreground</key>
-				<string>#{{base07}}</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>#{{base09}}</string>
-				<key>foreground</key>
-				<string>#{{base00}}</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>#{{base0F}}</string>
-				<key>foreground</key>
-				<string>#{{base07}}</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>#{{base03}}</string>
-				<key>foreground</key>
-				<string>#{{base07}}</string>
-			</dict>
-		</dict>
-	</array>
-	<key>uuid</key>
-	<string>uuid</string>
-</dict>
-</plist>
-

run-ci.sh

@@ -25,19 +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 "BUILD: ABB code theme" "./generate-theme.sh" 0
+enter-section "Typstyle checking" "./run-fmt.sh --check src/lib.typ" 0
-enter-section "Compiling template..." "typst compile template/main.typ --root . example.pdf" 0
+enter-section "Compiling template..." "typst compile template/main.typ --root . example.pdf"
-enter-section "TEST: local template import" "typst compile tests/local-import/main.typ --root ." 0
+enter-section "TEST: local template import" "typst compile tests/local-import/main.typ --root ."
-enter-section "TEST: invalid config case 1" "typst compile tests/invalid-config/test-case-1.typ --root ." 1
+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 2" "compile tests/invalid-config/test-case-2.typ" 0
+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 ." 1
+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/glossarium.typ

@@ -30,7 +30,10 @@ SOFTWARE.*/
 #let __query_labels_with_key(loc, key, before: false) = {
   if before {
     query(
-      selector(label(__glossary_label_prefix + key)).before(loc, inclusive: false),
+      selector(label(__glossary_label_prefix + key)).before(
+        loc,
+        inclusive: false,
+      ),
       loc,
     )
   } else {
@@ -40,7 +43,7 @@ SOFTWARE.*/
 
 // key not found error
 #let __not-found-panic-error-msg(key) = {
- __glossarium_error_prefix+"key '"+key+"' not found"
+  __glossarium_error_prefix + "key '" + key + "' not found"
 }
 
 // Reference a term
@@ -56,13 +59,18 @@ SOFTWARE.*/
       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 {
+      } 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)]
+      [#link(
+          label(entry.key),
+          textLink,
+        )#label(__glossary_label_prefix + entry.key)]
     } else {
       panic(__not-found-panic-error-msg(key))
     }
@@ -80,10 +88,10 @@ SOFTWARE.*/
       let gloss = __query_labels_with_key(here(), key, before: true)
 
       let is_first = gloss == ()
-      let entlongplural = entry.at("longplural", default: "");
+      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: "");
+        let entlong = entry.at("long", default: "")
         if entlong != [] and entlong != "" {
           [#entlong#suffix]
         } else {
@@ -93,20 +101,25 @@ SOFTWARE.*/
         [#entlongplural]
       }
 
-      let entplural = entry.at("plural", default: "");
+      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 {
+      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)]
+      [#link(
+          label(entry.key),
+          textLink,
+        )#label(__glossary_label_prefix + entry.key)]
     } else {
       panic(__not-found-panic-error-msg(key))
     }
@@ -116,7 +129,9 @@ SOFTWARE.*/
 // 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 {
+    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 {
@@ -170,51 +185,71 @@ SOFTWARE.*/
             numbering: none,
             caption: {
               context {
-                  let term_references = __query_labels_with_key(here(), entry.key)
+                let key = if entry.key.ends-with("__glossary_entry") {
-                  if term_references.len() != 0 or show-all {
+                  entry.key.replace("__glossary_entry", "")
-                    let desc = entry.at("desc", default: "")
+                } else {
-                    let long = entry.at("long", default: "")
+                  entry.key
-                    let hasLong = long != "" and long != []
-                    let hasDesc = desc != "" and desc != []
-                    grid(
-                      columns: 2,
-                      column-gutter: 1em,
-                      text(weight: "bold", entry.short),
-                      {
-                        if hasLong {
-                          text(weight: "bold", entry.long)
                 }
-                        if hasLong and hasDesc [:]
+
-                        if hasDesc [ #desc ] else [. ]
+                let term_references = __query_labels_with_key(here(), key)
-                        if disable-back-references != true {
+                if term_references.len() != 0 or show-all [
-                          term_references.map(x => x.location()).sorted(key: x => x.page()).fold(
+                  #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, 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();
+                          .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))]
+                              link(x)[#numbering(
-                            }
+                                  page-numbering,
-                          ).join(", ")
+                                  ..counter(page).at(x),
-                        }
+                                )]
                             }
                           )
+                          .join(", ")
                       }
+                    ],
+                  )
+                ]
               }
             },
           )[] #label(entry.key)
-          #parbreak()
         ]
       }
     }
-    if enable-group-pagebreak { pagebreak(weak: true) }
+    if enable-group-pagebreak {
+      pagebreak(weak: true)
+    }
   }
 };

src/glossary.typ

@@ -7,68 +7,94 @@
 // Edited: 08.07.2024
 // License: MIT
 
-#let glossary(entries) = {
+#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")
+      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)
+        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")
+      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")
+        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")
+        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")
+        message: "The optional group of glossary entry `" + k + "` is not a string",
+      )
     } else {
-          let group = if "long" in v {
+      let acronym_group = if config.lang == "de" {
-            if (context text.lang) == "de" {
+        "Abkürzungsverzeichnis"
-              "Akronyme"
       } else {
-              "Acronyms"
+        "List of Acronyms"
       }
-          } else {
+
-            if (context text.lang) == "de" {
+      let glossary_group = if config.lang == "de" {
         "Begriffe"
       } else {
-              "Terms"
+        "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
+      }
     }
   }
 
-          entries.at(k).group = group
+  return processed_glossary.pairs().map(((key, entry)) => (
-      }
-    }
-
-  return entries.pairs().map(((key, entry)) => (
     key: key,
-      short: eval(entry.short, mode: "markup"),
+    short: entry.short,
     long: eval(entry.at("long", default: ""), mode: "markup"),
     desc: eval(entry.at("desc", default: ""), mode: "markup"),
-      group: entry.at("group", default: "")
+    group: entry.at("group", default: ""),
   ))
 }

src/lib.typ

@@ -7,23 +7,58 @@
 // Edited: 27.06.2024
 // License: MIT
 
-  #import "conf.typ": validate-config
+#import "conf.typ": validate-config, default-config
-  #import "branding.typ": *
+#import "branding.typ": *
-  #import "style.typ": global_styled_doc, content_styled, end_styled
+#import "style.typ": global_styled_doc, content_styled, end_styled
-  #import "glossary.typ": glossary
+#import "glossary.typ": glossary
-  #import "pages/titlepage.typ": new_title_page
+#import "pages/titlepage.typ": new_title_page
-  #import "pages/declaration-of-authorship.typ": new_declaration_of_authorship
+#import "pages/declaration-of-authorship.typ": new_declaration_of_authorship
-  #import "pages/confidentiality-statement.typ": new_confidentiality_statement_page
+#import "pages/confidentiality-statement.typ": new_confidentiality_statement_page
-  #import "pages/prerelease-note.typ": new_prerelease_note
+#import "pages/prerelease-note.typ": new_prerelease_note
-  #import "pages/outline.typ": new_outline
+#import "pages/outline.typ": new_outline
-  #import "pages/abstract.typ": new_abstract
+#import "pages/abstract.typ": new_abstract
-  #import "pages/preface.typ": new-preface
+#import "pages/preface.typ": new-preface
-  #import "pages/appendix.typ": show-appendix
+#import "pages/appendix.typ": show-appendix
 
-#let group-break()= {
+#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, body) = [
   #let config = validate-config(config)
@@ -36,12 +71,14 @@
     #set document(
       author: config.author.name,
       keywords: config.thesis.keywords,
-      title: config.thesis.title)
+      title: config.thesis.title,
+    )
 
     // configure text locale
     #set text(
       lang: config.lang,
-      region: config.region)
+      region: config.region,
+    )
 
     // preppend title page
     #new_title_page(config)
@@ -66,9 +103,11 @@
 
     #if "glossary" in config.thesis and config.thesis.glossary != none {
       print-glossary(
+        show-all: false,
         disable-back-references: true,
         enable-group-pagebreak: true,
-        glossary(config.thesis.glossary))
+        glossary(config.thesis.glossary, config),
+      )
 
       pagebreak(weak: true)
     }

src/pages/abstract.typ

@@ -6,7 +6,8 @@
 // Edited: 28.06.2024
 // License: MIT
 
-#let new_abstract(config) = context {
+#let new_abstract(config) = (
+  context {
 
     set align(center + horizon)
 
@@ -24,4 +25,5 @@
 
     heading("Abstract")
     config.thesis.abstract
-}
+  }
+)

src/pages/appendix.typ

@@ -6,7 +6,8 @@
 // Edited: 28.06.2024
 // License: MIT
 
-#let show-appendix(config: dictionary) = context {
+#let show-appendix(config: dictionary) = (
+  context {
     counter(heading).update(0)
 
     let title = if text.lang == "en" {
@@ -41,4 +42,5 @@
 
       config.thesis.appendices
     }
-}
+  }
+)

src/pages/confidentiality-statement.typ

@@ -6,7 +6,8 @@
 // Edited: 28.06.2024
 // License: MIT
 
-#let new_confidentiality_statement_page(config) = context {
+#let new_confidentiality_statement_page(config) = (
+  context {
 
     pagebreak(weak: true)
 
@@ -14,13 +15,13 @@
     let author = config.author
 
     if text.lang == "de" [
-    #heading(level: 1, "Sperrvermerk", supplement: [special])
+      #heading(level: 1, "Sperrvermerk")
     ] else if text.lang == "en" [
-    #heading(level: 1, "Confidentiality Statement", supplement: [special])
+      #heading(level: 1, "Confidentiality Statement")
     ]
 
     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
     ]
@@ -43,7 +44,7 @@
     set par(justify: true)
 
     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.
     ]
@@ -59,4 +60,5 @@
     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" [ Unterschrift ] else if text.lang == "en" [ Signature ] else { panic("no translation for language: ", text.lang) }))
-}
+  }
+)

src/pages/declaration-of-authorship.typ

@@ -6,7 +6,8 @@
 // Edited: 28.06.2024
 // License: MIT
 
-#let new_declaration_of_authorship(config) = context {
+#let new_declaration_of_authorship(config) = (
+  context {
 
     pagebreak(weak: true)
 
@@ -61,4 +62,5 @@
     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" [ Unterschrift ] else if text.lang == "en" [ Signature ] else { panic("no translation for language: ", text.lang) }))
-}
+  }
+)

src/pages/outline.typ

@@ -10,21 +10,34 @@
 // 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: 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" {
@@ -32,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" {
@@ -42,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" {
@@ -52,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: title,
-      indent: auto)
+      indent: auto,
-}
+    )
+  }
+)
 
-#let render_appendix_outline() = context {
+#let render_appendix_outline() = (
+  context {
     let supplement = if text.lang == "en" {
       [Appendix]
     } else {
@@ -86,16 +114,16 @@
       outline(
         target: heading.where(supplement: supplement),
         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,
-  ): it => {
     v(1.5em, weak: true)
     strong(it)
   }

src/pages/prerelease-note.typ

@@ -6,7 +6,8 @@
 // Edited: 28.06.2024
 // License: MIT
 
-#let new_prerelease_note(config) = context {
+#let new_prerelease_note(config) = (
+  context {
 
     pagebreak(weak: true)
 
@@ -53,4 +54,5 @@
     v(1em)
     h(1em)
     [#author.name, #datetime.today().display()]
-}
+  }
+)

src/pages/titlepage.typ

@@ -6,7 +6,8 @@
 // Edited: 28.06.2024
 // License: MIT
 
-#let new_title_page(config) = context [
+#let new_title_page(config) = (
+  context [
 
     #let thesis = config.thesis
     #let author = config.author
@@ -15,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)
@@ -27,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 [
@@ -60,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(
@@ -85,30 +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)
     ]
 
-  #align(bottom,
+    #align(
+      bottom,
       grid(
       // set width of columns
       // we need two, so make both half the page width
@@ -121,7 +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/style.typ

@@ -12,7 +12,13 @@
 #let watermark-color = luma(50%).transparentize(70%)
 
 #let watermark-pattern = pattern(size: (5pt, 5pt))[
-  #place(line(start: (50%, 0%), end: (50%, 100%), stroke: (paint: watermark-color, thickness: 3pt)))
+  #place(
+    line(
+      start: (50%, 0%),
+      end: (50%, 100%),
+      stroke: (paint: watermark-color, thickness: 3pt),
+    ),
+  )
 ]
 
 #let watermark(config) = if config.draft {
@@ -20,7 +26,8 @@
     #rect(
       radius: 1em,
       inset: 1em,
-    stroke: watermark-color)[
+      stroke: watermark-color,
+    )[
       #text(size: 4em, weight: "bold", fill: watermark-pattern, "DRAFT")
       #linebreak()
       #text(size: 1.25em, weight: "bold", fill: watermark-color)[
@@ -28,13 +35,17 @@
         #linebreak()
         document version.
         #linebreak()
-        #text(size: 0.75em, "Further usage without the authors consent is not permitted.")]]]}
+        #text(
-
+          size: 0.75em,
-#let numberingH(c)={
+          "Further usage without the authors consent is not permitted.",
-  return numbering(c.numbering,..counter(heading).at(c.location()))
+        )]]]
 }
 
-#let currentH(level: 1)={
+#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() {
@@ -59,13 +70,21 @@
     hyphenate: true,
     dir: ltr,
     font: style.text.font,
-    fill: ABB-BLACK)
+    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)")
 
@@ -75,38 +94,59 @@
   show heading.where(level: 3): it => v(0.5em) + it + v(0.25em)
 
   // set theme for code blocks
-  set raw(
+  set raw(tab-size: style.code.tab-size)
-    tab-size: style.code.tab-size,
+  show raw.where(block: false): it => box(
-    theme: style.code.theme)
+    stroke: 1pt + ABB-GRAY-05,
-  show raw: set text(font: style.code.font, size: style.code.size)
+    radius: 2pt,
+    inset: (left: 2pt, right: 2pt),
+    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
+    }
     #block(
       width: 100%,
       fill: ABB-GRAY-06,
-        stroke: none,
+      stroke: 1pt + ABB-GRAY-05,
       radius: 0.5em,
       inset: 0.75em,
       clip: false,
       {
         let (columns, align, make_row) = {
-            if style.code.lines {(
+          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 }
+                let n_str = if (calc.rem(n, 1) == 0) or (true and i == 0) {
-                (n_str + h(0.5em), raw(lang: content.lang, l))
+                  text(
-              })
+                    font: style.code.font,
+                    size: style.code.size,
+                    fill: ABB-BLACK,
+                    str(n),
+                  )
+                } else {
+                  none
                 }
-            else {
+                (n_str + h(0.5em), raw(block: true, lang: lang, l))
-                  ( ( 1fr, ),
+              },
-                    ( left, ),
+            )
+          } else {
+            (
+              (1fr,),
+              (left,),
               e => {
                 let (i, l) = e
-                      raw( lang:content.lang, l)
+                raw(block: true, lang: lang, l)
-                    }
+              },
             )
           }
         }
@@ -124,9 +164,13 @@
             .enumerate()
             .map(make_row)
             .flatten()
-                  .map(c => if c.has("text") and c.text == "" { v(1em) } else { c })
+            .map(c => if c.has("text") and c.text == "" {
+            v(1em)
+          } else {
+            c
+          })
         )
-      }
+      },
     )
     #v(-1em)
     #align(center + top, it.caption)
@@ -163,8 +207,20 @@
     stroke: (x, y) => (
       left: none,
       right: none,
-      top: if y == 0 { 1.5pt } else if y < 2 { 1pt } else { 0.5pt },
+      top: if y == 0 {
-      bottom: if y == 0 { 1pt } else { 1.5pt } ))
+        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")
@@ -173,7 +229,8 @@
   set par(
     justify: true,
     first-line-indent: 1em,
-    leading: 1em)
+    leading: 1em,
+  )
 
   // give links a color
   show link: set text(fill: style.link.color)
@@ -186,17 +243,26 @@
     header-ascent: style.header.content-padding,
     footer-descent: style.header.content-padding,
     margin: (
-      top: style.page.margin.top + style.header.underline-top-padding + style.header.content-padding,
+      top: style.page.margin.top + style.header.underline-top-padding + style
+        .header
+        .content-padding,
       bottom: style.page.margin.bottom + style.footer.content-padding,
       left: style.page.margin.left,
-      right: style.page.margin.right),
+      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())
@@ -213,7 +279,11 @@
         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)
       }
@@ -233,7 +303,13 @@
           // right align logo of DHBW
           align(right, image("res/DHBW.svg", height: style.header.logo-height)))
 
-      } else if query(<end-of-content>).first().location().page() >= current-page and query(<end-of-prelude>).first().location().page() < current-page + 1 {
+      } else if query(<end-of-content>)
+        .first()
+        .location()
+        .page() >= current-page and query(<end-of-prelude>)
+        .first()
+        .location()
+        .page() < current-page + 1 {
         let heading = currentH()
 
         heading.at(0)
@@ -246,7 +322,8 @@
         v(style.header.underline-top-padding - 1em)
         line(length: 100%)
       }
-    })
+    },
+  )
 
   body
 }

template/appendix.typ

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

template/glossary.yml

@@ -7,3 +7,7 @@ oidc:
 potato:
   short: potato
   desc: "#lorem(50)"
+
+HTTP:
+  short: HTTP
+  long: Hyper Text Transfer Protocol

template/main.typ

@@ -3,8 +3,8 @@
 #import "abstract.typ": abstract, summary
 
 #show: dhbw-template.with((
-  lang: "en",
+  lang: "de",
-  region: "en",
+  region: "de",
   draft: false,
   author: (
     name: "Sven Vogel",
@@ -15,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",
@@ -25,10 +26,12 @@
     summary: summary,
     abstract: abstract,
     preface: include "preface.typ",
-    keywords: ( "IT", "other stuff" ),
+    keywords: ("IT", "other stuff"),
     bibliography: bibliography("refs.bib"),
     glossary: yaml("glossary.yml"),
-    appendices: include "appendix.typ")))
+    appendices: include "appendix.typ",
+  ),
+))
 
 #import "@preview/wrap-it:0.1.0": wrap-content
 
@@ -48,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) \
@@ -62,7 +65,12 @@ $
 
 #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(
@@ -76,29 +84,33 @@ $
     [2023-03-18], [Yoga], [200],
     [2023-03-15], [Swimming], [400],
     [2023-03-17], [Weightlifting], [250],
-    [2023-03-18], [Yoga], [200]),
+    [2023-03-18], [Yoga], [200],
-    caption: [ Some table ])
+  ),
+  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() {
       println!("Hello, World!!!");
-}
+  }
-  ```, caption: [Some code])
+  ```,
+  caption: [Some code],
+)
 
 #lorem(100)
 
 #pagebreak()
 
-
 = Conclusion
 
 #lorem(320)

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"