Compare commits
2 Commits
main
...
draft/t300
Author | SHA1 | Date |
---|---|---|
Sven Vogel | 3ebcccd74d | |
Sven Vogel | eaf803dc8d |
|
@ -1,22 +1,10 @@
|
|||
name: Build'n check
|
||||
name: Gitea Action for checking typst compilation
|
||||
run-name: Performing Typst compilation
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
push:
|
||||
branches-ignore:
|
||||
- main
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
run-ci-linux:
|
||||
runs-on: ubuntu-latest
|
||||
# run action mutally exclusive on PRs or
|
||||
# push with commit containing "Run-Checks"
|
||||
if: >
|
||||
(contains(github.event.head_commit.message, 'Run-Checks') &&
|
||||
github.event_name == 'push') ||
|
||||
github.event_name == 'pull_request'
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v3
|
||||
|
@ -28,9 +16,5 @@ jobs:
|
|||
uses: cachix/install-nix-action@v27
|
||||
with:
|
||||
nix_path: nixpkgs=channel:nixos-unstable
|
||||
- name: Stylecheck
|
||||
run: nix-shell --run "./run-fmt.sh --check src/lib.typ"
|
||||
- id: build
|
||||
name: Build
|
||||
run: |
|
||||
nix-shell --run ./run-ci.sh
|
||||
- name: Run CI
|
||||
run: nix-shell --run ./run-ci.sh
|
||||
|
|
|
@ -1,55 +0,0 @@
|
|||
name: Create Release Commit
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
tags-ignore:
|
||||
- v*.*.*
|
||||
jobs:
|
||||
prepare:
|
||||
runs-on: ubuntu-latest
|
||||
if: contains(github.event.head_commit.message, 'Release-As:')
|
||||
env:
|
||||
USERNAME: servostar
|
||||
EMAIL: sven.vogel123@web.de
|
||||
GIT_AUTH_TOKEN: ${{ secrets.RELEASE_TOKEN }}
|
||||
COMMIT_MESSAGE: ${{ github.event.head_commit.message }}
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
ref: 'main'
|
||||
token: ${{ secrets.RELEASE_TOKEN }}
|
||||
- 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:
|
||||
nix_path: nixpkgs=channel:nixos-unstable
|
||||
- name: Setup Git
|
||||
run: |
|
||||
git config --global user.name "${USERNAME}"
|
||||
git config --global user.email "${EMAIL}"
|
||||
- name: Update Typst.toml
|
||||
run: |
|
||||
export VERSION=$(echo "${COMMIT_MESSAGE}" | grep -Po '(?<=Release-As: )v\d+\.\d+\.\d+')
|
||||
sed -i "/version/c\version = \"${VERSION#v}\"" typst.toml
|
||||
git add typst.toml
|
||||
git commit -m "chore: bump release version to $VERSION" -m "Generated-By: ${{ gitea.actor }}"
|
||||
- name: Generate Example Document
|
||||
run: nix-shell --run ./run-ci.sh
|
||||
- name: Generate Assets
|
||||
if: contains(github.event.head_commit.message, 'Generate-Assets')
|
||||
run: |
|
||||
./run-bake-assets.sh
|
||||
git add assets/banner.png
|
||||
git add assets/page-preview.png
|
||||
git commit -m "chore: update assets" -m "Generated-By: ${{ gitea.actor }}"
|
||||
- name: Tag and Push Changes
|
||||
run: |
|
||||
git push origin main
|
||||
export VERSION=$(echo "${COMMIT_MESSAGE}" | grep -Po '(?<=Release-As: )v\d+\.\d+\.\d+')
|
||||
git tag -m "Release" "${VERSION}"
|
||||
git push origin "${VERSION}"
|
|
@ -1,11 +1,12 @@
|
|||
name: Create Release
|
||||
name: release
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v[0-9]+.[0-9]+.[0-9]+'
|
||||
- 'v*.*.*'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: Check Template and Build example
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
|
@ -18,48 +19,16 @@ jobs:
|
|||
uses: cachix/install-nix-action@v27
|
||||
with:
|
||||
nix_path: nixpkgs=channel:nixos-unstable
|
||||
- name: Stylecheck
|
||||
run: nix-shell --run "./run-fmt.sh --check src/lib.typ"
|
||||
- id: build
|
||||
name: Build
|
||||
run: |
|
||||
nix-shell --run ./run-ci.sh
|
||||
- name: Upload artifact
|
||||
id: artifact-upload
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: example-document
|
||||
path: ${{ github.workspace }}/example.pdf
|
||||
if-no-files-found: error
|
||||
retention-days: 1
|
||||
- name: Output artifact ID
|
||||
run: echo 'Artifact ID is ${{ steps.artifact-upload.outputs.artifact-id }}'
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v3
|
||||
- name: Run CI
|
||||
run: nix-shell --run ./run-ci.sh
|
||||
- name: Setup go
|
||||
uses: actions/setup-go@v4
|
||||
uses: https://github.com/actions/setup-go@v4
|
||||
with:
|
||||
go-version: '>=1.20.1'
|
||||
- name: Download Artifact
|
||||
id: download
|
||||
uses: actions/download-artifact@v3
|
||||
with:
|
||||
name: example-document
|
||||
path: ${{ github.workspace }}/Example.pdf
|
||||
- name: 'Artifact Download Path'
|
||||
run: echo ${{ steps.download.outputs.download-path }}
|
||||
- name: Prepare Release
|
||||
run: echo ${{ github.sha }} > Release.txt
|
||||
- name: Create release
|
||||
id: create-release
|
||||
uses: https://gitea.com/actions/release-action@main
|
||||
with:
|
||||
files: |-
|
||||
Example.pdf
|
||||
Release.txt
|
||||
LICENSE
|
||||
example.pdf
|
||||
api_key: '${{secrets.RELEASE_TOKEN}}'
|
||||
|
|
|
@ -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
|
|
@ -1,13 +1,12 @@
|
|||
name: Build'n check
|
||||
name: release
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
tags:
|
||||
- 'v[0-9]+.[0-9]+.[0-9]+'
|
||||
- 'v*.*.*'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
name: Check Template and Build example
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
|
@ -16,49 +15,16 @@ jobs:
|
|||
uses: cachix/install-nix-action@v27
|
||||
with:
|
||||
nix_path: nixpkgs=channel:nixos-unstable
|
||||
- name: Stylecheck
|
||||
run: nix-shell --run "./run-fmt.sh --check src/lib.typ"
|
||||
- id: build
|
||||
name: Build
|
||||
run: |
|
||||
nix-shell --run ./run-ci.sh
|
||||
- name: Upload artifact
|
||||
id: artifact-upload
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: example-document
|
||||
path: ${{ github.workspace }}/example.pdf
|
||||
if-no-files-found: error
|
||||
retention-days: 1
|
||||
- name: Output artifact ID
|
||||
run: echo 'Artifact ID is ${{ steps.artifact-upload.outputs.artifact-id }}'
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v3
|
||||
- name: Run CI
|
||||
run: nix-shell --run ./run-ci.sh
|
||||
- name: Setup go
|
||||
uses: actions/setup-go@v4
|
||||
uses: https://github.com/actions/setup-go@v4
|
||||
with:
|
||||
go-version: '>=1.20.1'
|
||||
- name: Download Artifcat
|
||||
id: download
|
||||
uses: actions/download-artifact@v3
|
||||
- name: Create release
|
||||
id: create-release
|
||||
uses: https://gitea.com/actions/release-action@main
|
||||
with:
|
||||
name: example-document
|
||||
path: ${{ github.workspace }}/Example.pdf
|
||||
- name: 'Artifact Download Path'
|
||||
run: echo ${{ steps.download.outputs.download-path }}
|
||||
- name: Prepare Release
|
||||
run: echo ${{ github.sha }} > Release.txt
|
||||
- name: Release
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
files: |
|
||||
Example.pdf
|
||||
Release.txt
|
||||
LICENSE
|
||||
files: |-
|
||||
example.pdf
|
||||
api_key: '${{secrets.RELEASE_TOKEN}}'
|
||||
|
|
|
@ -1,3 +1,2 @@
|
|||
*.pdf
|
||||
*.log
|
||||
images/
|
||||
|
|
|
@ -1,17 +0,0 @@
|
|||
# Contributing
|
||||
|
||||
Development of this template happens at
|
||||
[git.montehaselino.de](https://git.montehaselino.de/DHBW/dhbw-abb-typst-template).
|
||||
For this reason pull request opened at any mirror such as on GitHub, will not be
|
||||
merged as this would compromise the push mirror.
|
||||
|
||||
Pull requests shall be opened exclusively in the official
|
||||
[repository](https://git.montehaselino.de/DHBW/dhbw-abb-typst-template).
|
||||
Issues may be created at GitHub or the official repository.
|
||||
Beware, that linked pull requests and issues in commits messages refer to those
|
||||
in the official instance and may be broken or invalid on mirrors such as GitHub.
|
||||
|
||||
Direct pushes to the `main` branch are discouraged. In order to make a change
|
||||
create a new pull request and wait for a maintainer to merge it. Note that in
|
||||
order to be able to merge, the continuous integration pipeline must run
|
||||
successfully.
|
18
LICENSE
18
LICENSE
|
@ -2,20 +2,8 @@ MIT License
|
|||
|
||||
Copyright (c) 2024 Sven Vogel
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
|
83
README.md
83
README.md
|
@ -2,7 +2,7 @@
|
|||
<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/release.yml?label=build">
|
||||
<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">
|
||||
|
@ -75,78 +75,31 @@ The default configuration can be found in `src/conf.typ`.
|
|||
#import "src/lib.typ": *
|
||||
|
||||
#show: dhbw-template.with((
|
||||
// language settings used to make decisions about hyphenation and others
|
||||
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)
|
||||
university: (
|
||||
lang: "en",
|
||||
region: "en",
|
||||
author: (
|
||||
name: "Sven Vogel",
|
||||
semester: 4,
|
||||
program: "Informationtechnology",
|
||||
course: "TINF19IT1",
|
||||
faculty: "Technik",
|
||||
name: "dualen Hochschule Baden-Württemberg",
|
||||
campus: "Eppelheim"
|
||||
),
|
||||
authors: (
|
||||
(
|
||||
name: "Sven Vogel",
|
||||
course: "TINF19IT1",
|
||||
company: "ABB AG",
|
||||
supervisor: "Benny Goodman",
|
||||
matriculation-number: 123456789
|
||||
),
|
||||
(
|
||||
name: "Kurt Jammer",
|
||||
course: "TINF24AI2",
|
||||
company: "Siemens",
|
||||
supervisor: "Henry Badman",
|
||||
matriculation-number: 478568763
|
||||
),
|
||||
),
|
||||
// information about thesis
|
||||
university: "DHBW Mannheim",
|
||||
company: "ABB AG",
|
||||
supervisor: "Benny Goodman",
|
||||
matriculation-number: 123456789),
|
||||
thesis: (
|
||||
title: "Unofficial ABB/DHBW Typst template",
|
||||
subtitle: "for reports and thesises", // subtitle may be none
|
||||
subtitle: "for reports and thesises",
|
||||
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,
|
||||
summary: summary,
|
||||
abstract: abstract,
|
||||
preface: include "preface.typ",
|
||||
keywords: ( "IT", "other stuff" ),
|
||||
bibliography: none /* bibliography("refs.bib") */,
|
||||
glossary: none,
|
||||
appendices: none),
|
||||
style: (
|
||||
header: (
|
||||
content-padding: 1.5em,
|
||||
underline-top-padding: 0pt,
|
||||
logo-height: 5em,
|
||||
logo-image: "res/ABB.svg"),
|
||||
footer: (
|
||||
content-padding: 1.5em),
|
||||
page: (
|
||||
format: "a4",
|
||||
margin: (
|
||||
left: 3cm,
|
||||
right: 2.5cm,
|
||||
top: 2.5cm,
|
||||
bottom: 2.5cm)),
|
||||
text: (
|
||||
size: 12pt,
|
||||
font: "Fira Sans"),
|
||||
heading: (
|
||||
font: "Fira Sans"),
|
||||
code: (
|
||||
theme: "res/abb.tmTheme",
|
||||
font: "FiraCode Nerd Font",
|
||||
lines: false,
|
||||
size: 10pt,
|
||||
tab-size: 4),
|
||||
link: (
|
||||
color: ABB-GRAY-02)))
|
||||
bibliography: bibliography("refs.bib"),
|
||||
glossary: yaml("glossary.yml"),
|
||||
appendices: include "appendix.typ")))
|
||||
|
||||
// Your document code goes here!
|
||||
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 1.3 MiB After Width: | Height: | Size: 2.8 MiB |
Binary file not shown.
Before Width: | Height: | Size: 9.0 MiB After Width: | Height: | Size: 2.2 MiB |
|
@ -1,59 +0,0 @@
|
|||
#import "@preview/shadowed:0.1.2": shadowed
|
||||
|
||||
#let LE = 10cm
|
||||
#let shadow = 0.25cm
|
||||
|
||||
#set page(margin: 0pt, width: 2 * LE, height: LE, fill: rgb(0, 0, 0, 0))
|
||||
|
||||
#place(
|
||||
dx: 3cm,
|
||||
dy: 1.1cm,
|
||||
rotate(
|
||||
-9deg,
|
||||
shadowed(
|
||||
radius: 0pt,
|
||||
inset: 0pt,
|
||||
blur: shadow,
|
||||
image("./images/21.svg", height: LE * 0.6))))
|
||||
|
||||
#place(
|
||||
dx: 1cm,
|
||||
dy: 3.25cm,
|
||||
rotate(
|
||||
-20deg,
|
||||
shadowed(
|
||||
radius: 0pt,
|
||||
inset: 0pt,
|
||||
blur: shadow,
|
||||
image("./images/51.svg", height: LE * 0.55))))
|
||||
|
||||
#place(
|
||||
dx: 14cm,
|
||||
dy: 1.5cm,
|
||||
rotate(
|
||||
6deg,
|
||||
shadowed(
|
||||
radius: 0pt,
|
||||
inset: 0pt,
|
||||
blur: shadow,
|
||||
image("./images/41.svg", height: LE * 0.65))))
|
||||
|
||||
#place(
|
||||
dx: 11cm,
|
||||
dy: 2cm,
|
||||
rotate(
|
||||
25deg,
|
||||
shadowed(
|
||||
radius: 0pt,
|
||||
inset: 0pt,
|
||||
blur: shadow,
|
||||
image("./images/31.svg", height: LE * 0.6))))
|
||||
|
||||
#place(
|
||||
dx: 7cm,
|
||||
dy: 0.75cm,
|
||||
shadowed(
|
||||
radius: 0pt,
|
||||
inset: 0pt,
|
||||
blur: shadow,
|
||||
image("./images/11.svg", height: LE * 0.75)))
|
|
@ -1,34 +0,0 @@
|
|||
|
||||
#let gap = 0.5cm
|
||||
|
||||
#set page(margin: 0pt, width: 210mm * 3 + 2 * gap, height: 297mm * 2 + gap, fill: rgb(0, 0, 0, 0))
|
||||
|
||||
#place(
|
||||
dx: 0mm,
|
||||
dy: 0mm,
|
||||
image("./images/11.svg", height: 297mm))
|
||||
|
||||
#place(
|
||||
dx: 210mm + gap,
|
||||
dy: 0mm,
|
||||
image("./images/21.svg", height: 297mm))
|
||||
|
||||
#place(
|
||||
dx: (210mm + gap) * 2,
|
||||
dy: 0mm,
|
||||
image("./images/31.svg", height: 297mm))
|
||||
|
||||
#place(
|
||||
dx: 210mm * 0,
|
||||
dy: 297mm + gap,
|
||||
image("./images/71.svg", height: 297mm))
|
||||
|
||||
#place(
|
||||
dx: (210mm + gap) * 1,
|
||||
dy: 297mm + gap,
|
||||
image("./images/41.svg", height: 297mm))
|
||||
|
||||
#place(
|
||||
dx: (210mm + gap) * 2,
|
||||
dy: 297mm + gap,
|
||||
image("./images/51.svg", height: 297mm))
|
|
@ -1,18 +0,0 @@
|
|||
#!/bin/bash
|
||||
|
||||
echo "==> generate images"
|
||||
mkdir images || true
|
||||
|
||||
# extract images from document created by action
|
||||
mutool convert -o images/1.svg "$1" 1
|
||||
mutool convert -o images/2.svg "$1" 2
|
||||
mutool convert -o images/2.svg "$1" 2
|
||||
mutool convert -o images/3.svg "$1" 5
|
||||
mutool convert -o images/7.svg "$1" 7
|
||||
mutool convert -o images/4.svg "$1" 15
|
||||
mutool convert -o images/5.svg "$1" 16
|
||||
|
||||
echo "==> generate banner"
|
||||
typst compile banner.typ --ppi 360 ../assets/banner.png
|
||||
echo "==> generate preview"
|
||||
typst compile preview.typ --ppi 360 ../assets/page-preview.png
|
|
@ -1,14 +0,0 @@
|
|||
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
|
||||
mupdf-headless
|
||||
];
|
||||
}
|
|
@ -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
|
|
@ -1,6 +0,0 @@
|
|||
#!/bin/bash
|
||||
|
||||
cd baker
|
||||
|
||||
echo "==> generate assets"
|
||||
nix-shell --run "./run-bake-banner.sh ../example.pdf"
|
52
run-ci.sh
52
run-ci.sh
|
@ -1,3 +1,53 @@
|
|||
#!/bin/bash
|
||||
|
||||
typst compile template/main.typ --root . --font-path fonts example.pdf
|
||||
function log() {
|
||||
local timestamp=$(date +"%Y-%m-%d %H:%M:%S")
|
||||
echo "$1 at $timestamp: $2"
|
||||
}
|
||||
|
||||
function abort() {
|
||||
log "ERROR" "test case $1 has failed"
|
||||
exit 1
|
||||
}
|
||||
|
||||
function print-box() {
|
||||
printf "\\n"
|
||||
echo ".----------------------------------------------------------------."
|
||||
printf "| %-62s |\\n" "$1"
|
||||
echo "'----------------------------------------------------------------'"
|
||||
}
|
||||
|
||||
function enter-section() {
|
||||
print-box "$1"
|
||||
|
||||
log "INFO" "running task in section $1: $2"
|
||||
log "INFO" "section output following..."
|
||||
printf "\\n"
|
||||
|
||||
eval "$2"
|
||||
exit_status=$?
|
||||
|
||||
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 "Typstyle checking" "./run-fmt.sh --check src/lib.typ" 0
|
||||
enter-section "Compiling template..." "typst compile template/main.typ --root . --font-path fonts example.pdf"
|
||||
enter-section "TEST: local template import" "typst compile tests/local-import/main.typ --root . --font-path fonts"
|
||||
enter-section "TEST: invalid config case 1" "typst compile tests/invalid-config/test-case-1.typ --root . --font-path fonts" "should fail"
|
||||
enter-section "TEST: invalid config case 2" "typst compile tests/invalid-config/test-case-2.typ --root . --font-path fonts"
|
||||
enter-section "TEST: invalid config case 3" "typst compile tests/invalid-config/test-case-3.typ --root . --font-path fonts" "should fail"
|
||||
|
||||
log "INFO" "CI completed successfully"
|
||||
|
|
12
run-fmt.sh
12
run-fmt.sh
|
@ -17,7 +17,7 @@ function format() {
|
|||
exit 1
|
||||
fi
|
||||
|
||||
local imports=$(rg "#import \"([a-z0-9/\-.]+\.typ)\"" -Nor '$1' "$1")
|
||||
local imports=$(rg "#import \"([a-z0-9/\-]+\.typ)\"" -Nor '$1' "$1")
|
||||
|
||||
# format all included files
|
||||
while IFS= read -r line; do
|
||||
|
@ -26,16 +26,6 @@ function format() {
|
|||
fi
|
||||
format "$wd/$line" "$2"
|
||||
done <<< "$imports"
|
||||
|
||||
local includes=$(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 <<< "$includes"
|
||||
}
|
||||
|
||||
case $1 in
|
||||
|
|
|
@ -9,6 +9,5 @@ pkgs.mkShellNoCC {
|
|||
python312Packages.pyyaml
|
||||
typst
|
||||
typstyle
|
||||
ripgrep
|
||||
];
|
||||
}
|
||||
|
|
|
@ -1,18 +0,0 @@
|
|||
|
||||
// Reference color scheme can be found here:
|
||||
// https://brand.abb/portal/en/branding-principles/basic-brand-elements/color
|
||||
|
||||
// ABB branding colors
|
||||
#let ABB-RED = rgb(255, 0, 13)
|
||||
#let ABB-BLACK = rgb(0, 0, 0)
|
||||
#let ABB-GRAY-01 = rgb(25, 25, 25)
|
||||
#let ABB-GRAY-02 = rgb(64, 64, 64)
|
||||
#let ABB-GRAY-03 = rgb(115, 115, 115)
|
||||
#let ABB-GRAY-04 = rgb(166, 166, 166)
|
||||
#let ABB-GRAY-05 = rgb(217, 217, 217)
|
||||
#let ABB-GRAY-06 = rgb(242, 242, 242)
|
||||
#let ABB-WHITE = rgb(255, 255, 255)
|
||||
// ABB branding functinal colors
|
||||
#let ABB-BLUE = rgb(0, 101, 210)
|
||||
#let ABB-GREEN = rgb(17, 184, 0)
|
||||
#let ABB-YELLOW = rgb(255, 232, 0)
|
119
src/conf.typ
119
src/conf.typ
|
@ -1,119 +0,0 @@
|
|||
|
||||
// .--------------------------------------------------------------------------.
|
||||
// | Configuration |
|
||||
// '--------------------------------------------------------------------------'
|
||||
|
||||
// Author: Sven Vogel
|
||||
// Edited: 27.06.2024
|
||||
// License: MIT
|
||||
|
||||
#import "branding.typ": *
|
||||
|
||||
// default configuration
|
||||
#let default-config = (
|
||||
// language settings used to make decisions about hyphenation and others
|
||||
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)
|
||||
university: (
|
||||
program: "Informationtechnology",
|
||||
faculty: "Technik",
|
||||
name: "dualen Hochschule Baden-Württemberg",
|
||||
campus: "Eppelheim",
|
||||
),
|
||||
supervisor-signature: false,
|
||||
authors: ((), ()),
|
||||
// information about thesis
|
||||
thesis: (
|
||||
title: "Unofficial ABB/DHBW Typst template",
|
||||
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,
|
||||
keywords: ("IT", "other stuff"),
|
||||
bibliography: none, /* bibliography("refs.bib") */
|
||||
glossary: none,
|
||||
appendices: none,
|
||||
),
|
||||
style: (
|
||||
header: (
|
||||
content-padding: 1.5em,
|
||||
underline-top-padding: 0pt,
|
||||
logo-height: 5em,
|
||||
logo-image: "res/ABB.svg",
|
||||
),
|
||||
footer: (
|
||||
content-padding: 1.5em,
|
||||
),
|
||||
page: (
|
||||
format: "a4",
|
||||
margin: (
|
||||
left: 3cm,
|
||||
right: 2.5cm,
|
||||
top: 2.5cm,
|
||||
bottom: 2.5cm,
|
||||
),
|
||||
),
|
||||
text: (
|
||||
size: 12pt,
|
||||
font: "Fira Sans",
|
||||
),
|
||||
heading: (
|
||||
font: "Fira Sans",
|
||||
),
|
||||
code: (
|
||||
theme: "res/abb.tmTheme",
|
||||
font: "FiraCode Nerd Font",
|
||||
lines: false,
|
||||
size: 10pt,
|
||||
tab-size: 4,
|
||||
),
|
||||
link: (
|
||||
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
|
||||
#let deep-insert-checked(base, update) = {
|
||||
if base == none {
|
||||
panic("target dictionary is none")
|
||||
}
|
||||
|
||||
if update == none {
|
||||
return base
|
||||
}
|
||||
|
||||
for (key, val) in base {
|
||||
if key in update {
|
||||
let update_val = update.at(key)
|
||||
|
||||
if type(val) == array {
|
||||
// ignore checking arraay
|
||||
base.insert(key, update_val)
|
||||
} else if type(val) == dictionary and type(update_val) == dictionary {
|
||||
base.insert(key, deep-insert-checked(val, update_val))
|
||||
} else if val == none or type(val) == type(update_val) {
|
||||
base.insert(key, update_val)
|
||||
} else {
|
||||
panic("missmatched dictionary entry `" + key + "` type: expected `" + type(val) + "` got `" + type(update_val) + "`")
|
||||
}
|
||||
} else {
|
||||
base.insert(key, val)
|
||||
}
|
||||
}
|
||||
|
||||
return base
|
||||
}
|
||||
|
||||
#let validate-config(config) = {
|
||||
return deep-insert-checked(default-config, config)
|
||||
}
|
|
@ -1,258 +0,0 @@
|
|||
// .--------------------------------------------------------------------------.
|
||||
// | 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,
|
||||
),
|
||||
)
|
||||
} else {
|
||||
query(selector(label(__glossary_label_prefix + key)))
|
||||
}
|
||||
}
|
||||
|
||||
// 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()
|
||||
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,
|
||||
width: 100%,
|
||||
par(
|
||||
hanging-indent: 1em,
|
||||
align(left)[
|
||||
#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)
|
||||
}
|
||||
}
|
||||
};
|
|
@ -1,99 +0,0 @@
|
|||
|
||||
// .--------------------------------------------------------------------------.
|
||||
// | 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: ""),
|
||||
))
|
||||
}
|
161
src/lib.typ
161
src/lib.typ
|
@ -4,145 +4,54 @@
|
|||
// '--------------------------------------------------------------------------'
|
||||
|
||||
// Author: Sven Vogel
|
||||
// Edited: 27.06.2024
|
||||
// Edited: 01.10.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, body) = [
|
||||
#let config = validate-config(config)
|
||||
#let doc = body
|
||||
#let dhbw-template(body) = [
|
||||
|
||||
// apply global style to every element in the argument content
|
||||
#global_styled_doc(config)[
|
||||
#set page(margin: 2.5cm, footer: counter(page).display())
|
||||
#set text(size: 10pt, font: "Times New Roman")
|
||||
#set par(justify: true)
|
||||
#set block(below: 1em, above: 0pt)
|
||||
|
||||
// set document properties
|
||||
#set document(
|
||||
// author: config.author.name,
|
||||
keywords: config.thesis.keywords,
|
||||
title: config.thesis.title,
|
||||
)
|
||||
#show heading.where(level: 1): it => align(center, pad(top: 0.85cm, text(size: 12pt, it)))
|
||||
#show heading.where(level: 2): it => text(size: 10pt, it)
|
||||
|
||||
// configure text locale
|
||||
#set text(
|
||||
lang: config.lang,
|
||||
region: config.region,
|
||||
)
|
||||
#show raw: it => text(font: "Consolas", size: 8pt, it)
|
||||
|
||||
// preppend title page
|
||||
#new_title_page(config)
|
||||
#set align(center)
|
||||
#block(below: 0.85cm, text(size: 16pt, weight: "bold", "Title"))
|
||||
|
||||
// prelude includes: title, declaration of authorship, confidentiality statement, outline and abstract
|
||||
// these will have roman page numbers
|
||||
#new_declaration_of_authorship(config)
|
||||
#new_confidentiality_statement_page(config)
|
||||
#if config.draft {
|
||||
new_prerelease_note(config)
|
||||
}
|
||||
#new_abstract(config)
|
||||
#new-preface(config)
|
||||
#new_outline()
|
||||
#let authors = (
|
||||
(
|
||||
name: "Johann Goethe",
|
||||
matriculation-number: 123456789,
|
||||
company: "SAP",
|
||||
e-mail: "johann-goether@sap.de",
|
||||
),
|
||||
)
|
||||
|
||||
// glossary is built inline here because the links must be
|
||||
// exposed to the entire document
|
||||
#import "glossarium.typ": *
|
||||
#show: make-glossary
|
||||
#grid(columns: authors.len(), column-gutter: 0.95cm, rows: 1, ..authors.map(author => block()[
|
||||
#text(size: 10pt, weight: "bold", author.name)
|
||||
#set text(size: 9pt)
|
||||
#linebreak()
|
||||
#author.matriculation-number, #author.company
|
||||
#linebreak()
|
||||
#author.e-mail
|
||||
]))
|
||||
|
||||
#pagebreak(weak: true)
|
||||
#v(10pt)
|
||||
|
||||
#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, config),
|
||||
)
|
||||
#set align(left)
|
||||
#columns(gutter: 0.95cm)[
|
||||
#align(center, text(weight: "bold", size: 10pt, "Abstract"))
|
||||
#lorem(20)
|
||||
|
||||
pagebreak(weak: true)
|
||||
}
|
||||
#counter(page).update(1)
|
||||
#body
|
||||
|
||||
// mark end of prelude
|
||||
#metadata("prelude terminate") <end-of-prelude>
|
||||
#align(center, pad(top: 1em, text(weight: "bold", size: 10pt, "Citations and references")))
|
||||
|
||||
#content_styled(config, doc)
|
||||
|
||||
#metadata("content terminate") <end-of-content>
|
||||
|
||||
#end_styled(
|
||||
config,
|
||||
context [
|
||||
// add bibliography if set
|
||||
#if "bibliography" in config.thesis and config.thesis.bibliography != none {
|
||||
pagebreak(weak: true)
|
||||
counter(page).update(1)
|
||||
set bibliography(
|
||||
style: "ieee",
|
||||
title: if (text.lang == "de") {
|
||||
"Literaturverzeichnis"
|
||||
} else if text.lang == "en" {
|
||||
"Bibliography"
|
||||
},
|
||||
)
|
||||
config.thesis.bibliography
|
||||
}
|
||||
|
||||
// appendix
|
||||
#show-appendix(config: config)
|
||||
],
|
||||
)
|
||||
#bibliography("../template/refs.bib", title: none, style: "annual-reviews-author-date")
|
||||
]
|
||||
]
|
||||
|
|
|
@ -1,28 +0,0 @@
|
|||
// .--------------------------------------------------------------------------.
|
||||
// | Abstract |
|
||||
// '--------------------------------------------------------------------------'
|
||||
|
||||
// Author: Sven Vogel
|
||||
// Edited: 28.06.2024
|
||||
// License: MIT
|
||||
|
||||
#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)
|
||||
|
||||
= Zusammenfassung
|
||||
#config.thesis.summary
|
||||
]
|
||||
|
||||
// abstract is supposed to be on separate page
|
||||
pagebreak(weak: true)
|
||||
|
||||
heading("Abstract")
|
||||
config.thesis.abstract
|
||||
}
|
||||
)
|
|
@ -1,46 +0,0 @@
|
|||
// .--------------------------------------------------------------------------.
|
||||
// | Appendix |
|
||||
// '--------------------------------------------------------------------------'
|
||||
|
||||
// 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" {
|
||||
"Appendix"
|
||||
} else {
|
||||
"Anhang"
|
||||
}
|
||||
|
||||
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)
|
||||
|
||||
// APA style appendix
|
||||
show heading: it => {
|
||||
let number = if it.numbering != none {
|
||||
counter(heading).display(it.numbering)
|
||||
}
|
||||
block()[
|
||||
#title #number - #it.body
|
||||
]
|
||||
}
|
||||
|
||||
show heading.where(level: 1): it => v(2em) + it + v(1em)
|
||||
show heading.where(level: 2): it => v(1em) + it + v(0.5em)
|
||||
show heading.where(level: 3): it => v(0.5em) + it + v(0.25em)
|
||||
|
||||
set heading(numbering: "A.1", supplement: title)
|
||||
|
||||
config.thesis.appendices
|
||||
}
|
||||
}
|
||||
)
|
|
@ -1,62 +0,0 @@
|
|||
// .--------------------------------------------------------------------------.
|
||||
// | Confidentiality Statement |
|
||||
// '--------------------------------------------------------------------------'
|
||||
|
||||
// Author: Sven Vogel
|
||||
// Edited: 28.06.2024
|
||||
// License: MIT
|
||||
|
||||
#let new_confidentiality_statement_page(config) = (
|
||||
context {
|
||||
pagebreak(weak: true)
|
||||
|
||||
let thesis = config.thesis
|
||||
|
||||
if text.lang == "de" [
|
||||
#heading(level: 1, "Sperrvermerk")
|
||||
] else if text.lang == "en" [
|
||||
#heading(level: 1, "Confidentiality Statement")
|
||||
]
|
||||
|
||||
if text.lang == "de" [
|
||||
Der Inhalt dieser Arbeit mit dem Thema
|
||||
] else if text.lang == "en" [
|
||||
The content of this work with the topic
|
||||
]
|
||||
|
||||
v(1em)
|
||||
|
||||
set align(center)
|
||||
|
||||
text(weight: "bold", thesis.title)
|
||||
|
||||
if thesis.subtitle != none {
|
||||
linebreak()
|
||||
thesis.subtitle
|
||||
}
|
||||
|
||||
set align(left)
|
||||
|
||||
v(1em)
|
||||
|
||||
set par(justify: true)
|
||||
|
||||
if text.lang == "de" [
|
||||
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.
|
||||
]
|
||||
|
||||
set align(horizon)
|
||||
|
||||
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" [ Unterschrift ] else if text.lang == "en" [ Signature ] else { panic("no translation for language: ", text.lang) }))
|
||||
}
|
||||
)
|
|
@ -1,64 +0,0 @@
|
|||
// .--------------------------------------------------------------------------.
|
||||
// | Declaration of Authorship |
|
||||
// '--------------------------------------------------------------------------'
|
||||
|
||||
// Author: Sven Vogel
|
||||
// Edited: 28.06.2024
|
||||
// License: MIT
|
||||
|
||||
#let new_declaration_of_authorship(config) = (
|
||||
context {
|
||||
pagebreak(weak: true)
|
||||
|
||||
let thesis = config.thesis
|
||||
|
||||
if text.lang == "de" [
|
||||
#heading("Selbständigkeitserklärung")
|
||||
] else if text.lang == "en" [
|
||||
#heading("Declaration of Authorship")
|
||||
]
|
||||
|
||||
v(1em)
|
||||
|
||||
if text.lang == "de" [
|
||||
Ich versichere hiermit, dass ich meine Prüfung mit dem Thema
|
||||
] else if text.lang == "en" [
|
||||
I hereby confirm that I have written this thesis with the subject
|
||||
]
|
||||
|
||||
v(1em)
|
||||
|
||||
set align(center)
|
||||
|
||||
text(weight: "bold", thesis.title)
|
||||
|
||||
if thesis.subtitle != none {
|
||||
linebreak()
|
||||
thesis.subtitle
|
||||
}
|
||||
|
||||
set align(left)
|
||||
|
||||
v(1em)
|
||||
|
||||
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.
|
||||
]
|
||||
|
||||
set align(horizon)
|
||||
|
||||
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" [ Unterschrift ] else if text.lang == "en" [ Signature ] else { panic("no translation for language: ", text.lang) }))
|
||||
}
|
||||
)
|
|
@ -1,139 +0,0 @@
|
|||
// .--------------------------------------------------------------------------.
|
||||
// | 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 elems = query(figure.where(kind: kind))
|
||||
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),
|
||||
)
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
#let render_figures_outline() = (
|
||||
context {
|
||||
let title = if (text.lang == "de") {
|
||||
"Abbildungsverzeichnis"
|
||||
} else if text.lang == "en" {
|
||||
"List of Figures"
|
||||
}
|
||||
|
||||
render_filtered_outline(title: title, kind: image)
|
||||
}
|
||||
)
|
||||
|
||||
#let render_table_outline() = (
|
||||
context {
|
||||
let title = if (text.lang == "de") {
|
||||
"Tabellenverzeichnis"
|
||||
} else if text.lang == "en" {
|
||||
"List of Tables"
|
||||
}
|
||||
|
||||
render_filtered_outline(title: title, kind: table)
|
||||
}
|
||||
)
|
||||
|
||||
#let render_raw_outline() = (
|
||||
context {
|
||||
let title = if (text.lang == "de") {
|
||||
"Quelltextverzeichnis"
|
||||
} else if text.lang == "en" {
|
||||
"Code Snippets"
|
||||
}
|
||||
|
||||
render_filtered_outline(title: title, kind: raw)
|
||||
}
|
||||
)
|
||||
|
||||
#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: [#header-supplement]),
|
||||
title: title,
|
||||
indent: auto,
|
||||
)
|
||||
}
|
||||
)
|
||||
|
||||
#let render_appendix_outline() = (
|
||||
context {
|
||||
let supplement = if text.lang == "en" {
|
||||
[Appendix]
|
||||
} else {
|
||||
[Anhang]
|
||||
}
|
||||
|
||||
if query(heading.where(supplement: supplement)).len() > 0 {
|
||||
let title = if (text.lang == "de") {
|
||||
"Anhangsverzeichnis"
|
||||
} else if text.lang == "en" {
|
||||
"Table of Appendices"
|
||||
}
|
||||
|
||||
pagebreak(weak: true)
|
||||
outline(
|
||||
target: heading.where(supplement: supplement),
|
||||
title: title,
|
||||
indent: auto,
|
||||
)
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
#let new_outline() = {
|
||||
pagebreak(weak: true)
|
||||
|
||||
show outline.entry.where(level: 1): it => {
|
||||
v(1.5em, weak: true)
|
||||
strong(it)
|
||||
}
|
||||
|
||||
render_heading_outline()
|
||||
|
||||
render_figures_outline()
|
||||
|
||||
render_table_outline()
|
||||
|
||||
render_raw_outline()
|
||||
|
||||
render_appendix_outline()
|
||||
}
|
|
@ -1,14 +0,0 @@
|
|||
// .--------------------------------------------------------------------------.
|
||||
// | Preface |
|
||||
// '--------------------------------------------------------------------------'
|
||||
|
||||
// Author: Sven Vogel
|
||||
// Edited: 28.06.2024
|
||||
// License: MIT
|
||||
|
||||
#let new-preface(config) = {
|
||||
if config.thesis.preface != none {
|
||||
pagebreak(weak: true)
|
||||
config.thesis.preface
|
||||
}
|
||||
}
|
|
@ -1,52 +0,0 @@
|
|||
// .--------------------------------------------------------------------------.
|
||||
// | Preleminary release Notice |
|
||||
// '--------------------------------------------------------------------------'
|
||||
|
||||
// Author: Sven Vogel
|
||||
// Edited: 28.06.2024
|
||||
// License: MIT
|
||||
|
||||
#let new_prerelease_note(config) = (
|
||||
context {
|
||||
pagebreak(weak: true)
|
||||
|
||||
let thesis = config.thesis
|
||||
|
||||
if text.lang == "de" [
|
||||
#heading("Vorabfassung")
|
||||
] else if text.lang == "en" [
|
||||
#heading("Preliminary Version")
|
||||
]
|
||||
|
||||
v(1em)
|
||||
|
||||
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)
|
||||
|
||||
set align(center)
|
||||
|
||||
text(weight: "bold", thesis.title)
|
||||
|
||||
if thesis.subtitle != none {
|
||||
linebreak()
|
||||
thesis.subtitle
|
||||
}
|
||||
|
||||
set align(left)
|
||||
|
||||
v(1em)
|
||||
|
||||
set par(justify: true)
|
||||
|
||||
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 #university.name 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 #config.university.name as part of the assignment, and any use other than a preview is not permitted.
|
||||
]
|
||||
}
|
||||
)
|
|
@ -1,155 +0,0 @@
|
|||
// .--------------------------------------------------------------------------.
|
||||
// | Titlepage |
|
||||
// '--------------------------------------------------------------------------'
|
||||
|
||||
// Author: Sven Vogel
|
||||
// Edited: 28.06.2024
|
||||
// License: MIT
|
||||
|
||||
#let new_title_page(config) = (
|
||||
context [
|
||||
|
||||
#let thesis = config.thesis
|
||||
|
||||
// logo of ABB and DHBW
|
||||
#v(-config.style.header.content-padding)
|
||||
#grid(
|
||||
// set width of columns
|
||||
// we need two, so make both half the page width
|
||||
columns: (50%, 50%),
|
||||
// left align logo of ABB
|
||||
if config.style.header.logo-image == none {
|
||||
// error
|
||||
} else if config.style.header.logo-image.len() > 0 {
|
||||
align(left, image(config.style.header.logo-image, height: config.style.header.logo-height))
|
||||
} else {
|
||||
align(left, image("../res/DHBW.svg", height: config.style.header.logo-height))
|
||||
},
|
||||
// right align logo of DHBW
|
||||
if config.style.header.logo-image.len() > 0 {
|
||||
align(right, image("../res/DHBW.svg", height: config.style.header.logo-height))
|
||||
})
|
||||
|
||||
#set align(center)
|
||||
|
||||
// title
|
||||
#v(2cm)
|
||||
#par(justify: false, leading: 1.5em)[
|
||||
#text(size: 2em, weight: "bold", hyphenate: false, thesis.title)
|
||||
#linebreak()
|
||||
// subtitle
|
||||
#text(size: 2em, weight: "light", thesis.subtitle)
|
||||
]
|
||||
|
||||
#set align(center + horizon)
|
||||
|
||||
// type of paper
|
||||
#text(size: 1.5em, weight: "medium", thesis.kind)
|
||||
|
||||
// faculty
|
||||
#pad()[
|
||||
#if text.lang == "de" [
|
||||
aus dem Studiengang #config.university.program
|
||||
] else if text.lang == "en" [
|
||||
from the course of studies #config.university.program
|
||||
] else [
|
||||
#context panic("no translation for language: ", text.lang)
|
||||
]
|
||||
|
||||
#if text.lang == "de" [
|
||||
an der Fakultät #config.university.faculty
|
||||
] else if text.lang == "en" [
|
||||
at the faculty of #config.university.faculty
|
||||
] else [
|
||||
#context panic("no translation for language: ", text.lang)
|
||||
]
|
||||
]
|
||||
|
||||
// university
|
||||
#pad()[
|
||||
#if text.lang == "de" [
|
||||
an der
|
||||
] else if text.lang == "en" [
|
||||
at
|
||||
] else [
|
||||
#context panic("no translation for language: ", text.lang)
|
||||
]
|
||||
#config.university.name
|
||||
#linebreak()
|
||||
#if text.lang == "de" [
|
||||
in
|
||||
] else if text.lang == "en" [
|
||||
in
|
||||
] else [
|
||||
#context panic("no translation for language: ", text.lang)
|
||||
]
|
||||
#config.university.campus
|
||||
]
|
||||
|
||||
#pad(top: 1.5em)[
|
||||
#let names = ()
|
||||
|
||||
#if text.lang == "de" [
|
||||
von
|
||||
] else if text.lang == "en" [
|
||||
by
|
||||
] else [
|
||||
#context panic("no translation for language: ", text.lang)
|
||||
]
|
||||
|
||||
#v(1.5em)
|
||||
|
||||
#let rows = int(config.authors.len() / 3 + 0.5)
|
||||
|
||||
#for i in range(0, rows) {
|
||||
let cols = calc.min(config.authors.len() - i * 3, 3)
|
||||
|
||||
grid(columns: cols, column-gutter: 1.5em, ..config
|
||||
.authors
|
||||
.slice(i * 3, i * 3 + cols)
|
||||
.map(author => par([
|
||||
#if author.at("name", default: none) != none {
|
||||
text(size: 1.25em, author.name)
|
||||
linebreak()
|
||||
}
|
||||
#if author.at("company", default: none) != none {
|
||||
text(size: 1em, author.company)
|
||||
linebreak()
|
||||
}
|
||||
#if author.at("contact", default: none) != none {
|
||||
text(size: 1em, author.contact)
|
||||
linebreak()
|
||||
}
|
||||
#str(author.matriculation-number), #author.course
|
||||
])))
|
||||
}
|
||||
]
|
||||
|
||||
#set align(bottom)
|
||||
|
||||
#pad(top: 1.5em)[
|
||||
#thesis.timeframe
|
||||
]
|
||||
|
||||
#if config.supervisor-signature {
|
||||
align(
|
||||
bottom,
|
||||
grid(
|
||||
// set width of columns
|
||||
// we need two, so make both half the page width
|
||||
columns: (60%, 40%),
|
||||
align(left, if text.lang == "de" [
|
||||
Unterschrift des betrieblichen Betreuers
|
||||
] else if text.lang == "en" [
|
||||
Signature of the company supervisor
|
||||
] else [
|
||||
#context panic("no translation for language: ", text.lang)
|
||||
]
|
||||
),
|
||||
align(right, {line(length: 6cm)})),
|
||||
)
|
||||
}
|
||||
|
||||
#counter(page).update(0)
|
||||
]
|
||||
)
|
|
@ -1,10 +0,0 @@
|
|||
|
||||
// .--------------------------------------------------------------------------.
|
||||
// | Required packages for template use |
|
||||
// '--------------------------------------------------------------------------'
|
||||
|
||||
// Author: Sven Vogel
|
||||
// Edited: 05.07.2024
|
||||
// License: MIT
|
||||
|
||||
#import "glossary.typ": *
|
334
src/style.typ
334
src/style.typ
|
@ -1,334 +0,0 @@
|
|||
|
||||
// .--------------------------------------------------------------------------.
|
||||
// | Global style of document |
|
||||
// '--------------------------------------------------------------------------'
|
||||
|
||||
// Author: Sven Vogel
|
||||
// Edited: 27.06.2024
|
||||
// License: MIT
|
||||
|
||||
#import "branding.typ": *
|
||||
|
||||
#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),
|
||||
),
|
||||
)
|
||||
]
|
||||
|
||||
#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: 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, body) = {
|
||||
let thesis = config.thesis
|
||||
let style = config.style
|
||||
|
||||
set text(
|
||||
size: style.text.size,
|
||||
ligatures: true,
|
||||
hyphenate: true,
|
||||
dir: ltr,
|
||||
font: style.text.font,
|
||||
fill: ABB-BLACK,
|
||||
)
|
||||
|
||||
show heading: set text(
|
||||
font: style.heading.font,
|
||||
weight: "bold",
|
||||
)
|
||||
|
||||
let header-supplement = if config.lang == "de" {
|
||||
"Kapitel"
|
||||
} else {
|
||||
"chapter"
|
||||
}
|
||||
|
||||
set heading(supplement: [#header-supplement])
|
||||
|
||||
set math.equation(numbering: "(1)")
|
||||
show math.equation: set text(font: "Fira Math", size: 12pt)
|
||||
|
||||
// Set header spacing
|
||||
show heading.where(level: 1): it => v(2em) + it + v(1em)
|
||||
show heading.where(level: 2): it => v(1em) + it + v(0.5em)
|
||||
show heading.where(level: 3): it => v(0.5em) + it + v(0.25em)
|
||||
|
||||
// set theme for code blocks
|
||||
set raw(tab-size: style.code.tab-size)
|
||||
show raw.where(block: false): it => box(
|
||||
stroke: 1pt + ABB-GRAY-05,
|
||||
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: 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: "medium")[
|
||||
#c.supplement #context 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,
|
||||
)
|
||||
|
||||
// give links a color
|
||||
show link: set text(fill: style.link.color)
|
||||
show ref: set text(fill: style.link.color)
|
||||
|
||||
set heading(numbering: none)
|
||||
set page(
|
||||
paper: style.page.format,
|
||||
foreground: watermark(config),
|
||||
background: [#rect(width: 100%, height: 100%, fill: white)],
|
||||
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,
|
||||
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 {
|
||||
[]
|
||||
} 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 {
|
||||
numbering("1", nums.pos().first())
|
||||
} else {
|
||||
numbering("a", nums.pos().first())
|
||||
}
|
||||
},
|
||||
footer: context [
|
||||
#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(),
|
||||
)
|
||||
} else {
|
||||
numbering("a", page-counter)
|
||||
}
|
||||
],
|
||||
header: context {
|
||||
set align(left)
|
||||
let current-page = here().page()
|
||||
|
||||
if current-page == 1 {
|
||||
// logo moved to content
|
||||
} 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)
|
||||
h(0.5em)
|
||||
heading.at(1)
|
||||
v(style.header.underline-top-padding - 1em)
|
||||
line(length: 100%)
|
||||
} else {
|
||||
config.thesis.title
|
||||
v(style.header.underline-top-padding - 1em)
|
||||
line(length: 100%)
|
||||
}
|
||||
},
|
||||
)
|
||||
|
||||
body
|
||||
}
|
||||
|
||||
#let content_styled(config, body) = {
|
||||
set heading(numbering: "1.1.1")
|
||||
|
||||
body
|
||||
}
|
||||
|
||||
#let end_styled(config, body) = {
|
||||
set heading(numbering: "1.1.1")
|
||||
|
||||
body
|
||||
}
|
|
@ -2,66 +2,21 @@
|
|||
|
||||
#import "abstract.typ": abstract, summary
|
||||
|
||||
#show: dhbw-template.with((
|
||||
lang: "de",
|
||||
region: "de",
|
||||
draft: false,
|
||||
authors: (
|
||||
(
|
||||
name: "Sven Vogel",
|
||||
course: "TINF19IT1",
|
||||
company: none,
|
||||
supervisor: "Benny Goodman",
|
||||
matriculation-number: 123456789,
|
||||
contact: "sven.vogel123@web.de"
|
||||
),
|
||||
(
|
||||
name: "Sven Vogel",
|
||||
course: "TINF19IT1",
|
||||
company: "ABB AG",
|
||||
supervisor: "Benny Goodman",
|
||||
matriculation-number: 123456789,
|
||||
contact: "sven.vogel123@web.de"
|
||||
)
|
||||
),
|
||||
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",
|
||||
),
|
||||
style: (
|
||||
header: (
|
||||
logo-image: ""
|
||||
)
|
||||
)
|
||||
))
|
||||
#show: dhbw-template.with()
|
||||
|
||||
#import "@preview/wrap-it:0.1.0": wrap-content
|
||||
|
||||
= Lorem Ipsum
|
||||
|
||||
#text(fill: ABB-RED, "Hello ABB branding")
|
||||
|
||||
#lorem(25)
|
||||
@oidc
|
||||
@potato
|
||||
|
||||
@einstein
|
||||
|
||||
#lorem(100)
|
||||
@Anhang-A
|
||||
|
||||
== Lorem Ipsum 2
|
||||
|
||||
#lorem(200)
|
||||
@einstein
|
||||
#lorem(230)
|
||||
|
||||
= Lorem Ipsum 3 <sec:hello>
|
||||
|
||||
|
@ -76,12 +31,7 @@ $
|
|||
|
||||
#lorem(140)
|
||||
|
||||
#wrap-content(
|
||||
figure(image("assets/digitaldog.jpg", width: 200pt), caption: [ Some image caption ]),
|
||||
lorem(200),
|
||||
)
|
||||
|
||||
#url("https://github.com", "text") @sec:hello
|
||||
#figure(image("assets/digitaldog.jpg", width: 200pt), caption: [ Some image caption ])
|
||||
|
||||
#lorem(50)
|
||||
|
||||
|
@ -102,10 +52,7 @@ $
|
|||
caption: [ Some table ],
|
||||
)
|
||||
|
||||
#pagebreak()
|
||||
|
||||
#lorem(100)
|
||||
#inline-color("#ff0000", "red") @HTTP
|
||||
|
||||
#figure(
|
||||
```rust
|
||||
|
@ -122,8 +69,6 @@ $
|
|||
|
||||
#lorem(100)
|
||||
|
||||
#pagebreak()
|
||||
|
||||
= Conclusion
|
||||
|
||||
#lorem(320)
|
||||
|
|
|
@ -0,0 +1,28 @@
|
|||
|
||||
#import "../../src/lib.typ": dhbw-template
|
||||
|
||||
#show: dhbw-template.with((
|
||||
lang: none,
|
||||
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: none,
|
||||
abstract: none,
|
||||
keywords: ( "IT", "other stuff" ),
|
||||
bibliography: none,
|
||||
glossary: none,
|
||||
appendices: none)))
|
|
@ -0,0 +1,34 @@
|
|||
|
||||
#import "../../src/lib.typ": dhbw-template
|
||||
|
||||
#show: dhbw-template.with((
|
||||
lang: "en",
|
||||
this-key-is-not-in-config: "Ha Ha",
|
||||
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: none,
|
||||
abstract: none,
|
||||
keywords: ("IT", "other stuff"),
|
||||
bibliography: none,
|
||||
glossary: none,
|
||||
appendices: none,
|
||||
),
|
||||
))
|
||||
|
||||
= Heading
|
|
@ -0,0 +1,26 @@
|
|||
|
||||
#import "../../src/lib.typ": dhbw-template
|
||||
|
||||
#show: dhbw-template.with((
|
||||
lang: "en",
|
||||
region: "en",
|
||||
author: (
|
||||
university: "DHBW Mannheim",
|
||||
company: "ABB AG",
|
||||
supervisor: none,
|
||||
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: none,
|
||||
abstract: none,
|
||||
keywords: ("IT", "other stuff"),
|
||||
bibliography: none,
|
||||
glossary: none,
|
||||
appendices: none,
|
||||
),
|
||||
))
|
|
@ -0,0 +1,30 @@
|
|||
|
||||
#import "../../src/lib.typ": dhbw-template
|
||||
|
||||
#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: none,
|
||||
abstract: none,
|
||||
keywords: ( "IT", "other stuff" ),
|
||||
bibliography: none,
|
||||
glossary: none,
|
||||
appendices: none)))
|
||||
|
||||
= Heading
|
|
@ -1,6 +1,6 @@
|
|||
[package]
|
||||
name = "dhbw-abb-typst-template"
|
||||
version = "0.6.3"
|
||||
version = "0.4.1"
|
||||
entrypoint = "src/template.typ"
|
||||
authors = ["Sven Vogel <sven.vogel1@de.abb.com>"]
|
||||
license = "MIT"
|
||||
|
|
Loading…
Reference in New Issue