Compare commits
No commits in common. "main" and "v0.5.0" have entirely different histories.
|
|
@ -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.
|
||||
|
|
|
|||
79
README.md
79
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: (
|
||||
program: "Informationtechnology",
|
||||
faculty: "Technik",
|
||||
name: "dualen Hochschule Baden-Württemberg",
|
||||
campus: "Eppelheim"
|
||||
),
|
||||
authors: (
|
||||
(
|
||||
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
|
||||
),
|
||||
(
|
||||
name: "Kurt Jammer",
|
||||
course: "TINF24AI2",
|
||||
company: "Siemens",
|
||||
supervisor: "Henry Badman",
|
||||
matriculation-number: 478568763
|
||||
),
|
||||
),
|
||||
// information about thesis
|
||||
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
|
||||
];
|
||||
}
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
#!/bin/bash
|
||||
|
||||
cd baker
|
||||
|
||||
echo "==> generate assets"
|
||||
nix-shell --run "./run-bake-banner.sh ../example.pdf"
|
||||
48
run-ci.sh
48
run-ci.sh
|
|
@ -1,3 +1,49 @@
|
|||
#!/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"
|
||||
|
||||
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
|
||||
];
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,16 +3,16 @@
|
|||
// 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)
|
||||
#let ABB-RED = cmyk(0%, 100%, 95%, 0%)
|
||||
#let ABB-BLACK = cmyk(0%, 0%, 0%, 100%)
|
||||
#let ABB-GRAY-01 = cmyk(0%, 0%, 0%, 90%)
|
||||
#let ABB-GRAY-02 = cmyk(0%, 0%, 0%, 75%)
|
||||
#let ABB-GRAY-03 = cmyk(0%, 0%, 0%, 55%)
|
||||
#let ABB-GRAY-04 = cmyk(0%, 0%, 0%, 35%)
|
||||
#let ABB-GRAY-05 = cmyk(0%, 0%, 0%, 15%)
|
||||
#let ABB-GRAY-06 = cmyk(0%, 0%, 0%, 5%)
|
||||
#let ABB-WHITE = cmyk(0%, 0%, 0%, 0%)
|
||||
// ABB branding functinal colors
|
||||
#let ABB-BLUE = rgb(0, 101, 210)
|
||||
#let ABB-GREEN = rgb(17, 184, 0)
|
||||
#let ABB-YELLOW = rgb(255, 232, 0)
|
||||
#let ABB-BLUE = cmyk(100%, 53%, 2%, 16%)
|
||||
#let ABB-GREEN = cmyk(91%, 4%, 100%, 25%)
|
||||
#let ABB-YELLOW = cmyk(0%, 9%, 100%, 0%)
|
||||
|
|
|
|||
52
src/conf.typ
52
src/conf.typ
|
|
@ -22,10 +22,24 @@
|
|||
program: "Informationtechnology",
|
||||
faculty: "Technik",
|
||||
name: "dualen Hochschule Baden-Württemberg",
|
||||
campus: "Eppelheim",
|
||||
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
|
||||
),
|
||||
),
|
||||
supervisor-signature: false,
|
||||
authors: ((), ()),
|
||||
// information about thesis
|
||||
thesis: (
|
||||
title: "Unofficial ABB/DHBW Typst template",
|
||||
|
|
@ -37,49 +51,38 @@
|
|||
summary: none,
|
||||
abstract: none,
|
||||
preface: none,
|
||||
keywords: ("IT", "other stuff"),
|
||||
bibliography: none, /* bibliography("refs.bib") */
|
||||
keywords: ( "IT", "other stuff" ),
|
||||
bibliography: none /* bibliography("refs.bib") */,
|
||||
glossary: none,
|
||||
appendices: none,
|
||||
),
|
||||
appendices: none),
|
||||
style: (
|
||||
header: (
|
||||
content-padding: 1.5em,
|
||||
underline-top-padding: 0pt,
|
||||
logo-height: 5em,
|
||||
logo-image: "res/ABB.svg",
|
||||
),
|
||||
logo-image: "res/ABB.svg"),
|
||||
footer: (
|
||||
content-padding: 1.5em,
|
||||
),
|
||||
content-padding: 1.5em),
|
||||
page: (
|
||||
format: "a4",
|
||||
margin: (
|
||||
left: 3cm,
|
||||
right: 2.5cm,
|
||||
top: 2.5cm,
|
||||
bottom: 2.5cm,
|
||||
),
|
||||
),
|
||||
bottom: 2.5cm)),
|
||||
text: (
|
||||
size: 12pt,
|
||||
font: "Fira Sans",
|
||||
),
|
||||
font: "Fira Sans"),
|
||||
heading: (
|
||||
font: "Fira Sans",
|
||||
),
|
||||
font: "Fira Sans"),
|
||||
code: (
|
||||
theme: "res/abb.tmTheme",
|
||||
font: "FiraCode Nerd Font",
|
||||
lines: false,
|
||||
size: 10pt,
|
||||
tab-size: 4,
|
||||
),
|
||||
tab-size: 4),
|
||||
link: (
|
||||
color: ABB-GRAY-02,
|
||||
),
|
||||
),
|
||||
)
|
||||
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
|
||||
|
|
@ -98,7 +101,6 @@
|
|||
|
||||
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) {
|
||||
|
|
|
|||
|
|
@ -34,9 +34,10 @@ SOFTWARE.*/
|
|||
loc,
|
||||
inclusive: false,
|
||||
),
|
||||
loc,
|
||||
)
|
||||
} else {
|
||||
query(selector(label(__glossary_label_prefix + key)))
|
||||
query(selector(label(__glossary_label_prefix + key)), loc)
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -48,7 +49,7 @@ SOFTWARE.*/
|
|||
// Reference a term
|
||||
#let gls(key, suffix: none, long: none, display: none) = {
|
||||
context {
|
||||
let __glossary_entries = __glossary_entries.final()
|
||||
let __glossary_entries = __glossary_entries.final(here())
|
||||
if key in __glossary_entries {
|
||||
let entry = __glossary_entries.at(key)
|
||||
|
||||
|
|
@ -199,10 +200,7 @@ SOFTWARE.*/
|
|||
|
||||
#block(
|
||||
below: 1.5em,
|
||||
width: 100%,
|
||||
par(
|
||||
hanging-indent: 1em,
|
||||
align(left)[
|
||||
par(hanging-indent: 1em)[
|
||||
#text(weight: "bold", entry.short)
|
||||
#if hasLong and hasDesc [
|
||||
(#text(entry.long))
|
||||
|
|
@ -242,7 +240,6 @@ SOFTWARE.*/
|
|||
.join(", ")
|
||||
}
|
||||
],
|
||||
),
|
||||
)
|
||||
]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@
|
|||
// License: MIT
|
||||
|
||||
#let glossary(entries, config) = {
|
||||
|
||||
assert(
|
||||
type(entries) == dictionary,
|
||||
message: "The glossary is not a dictionary",
|
||||
|
|
|
|||
16
src/lib.typ
16
src/lib.typ
|
|
@ -122,27 +122,17 @@
|
|||
|
||||
#metadata("content terminate") <end-of-content>
|
||||
|
||||
#end_styled(
|
||||
config,
|
||||
context [
|
||||
#end_styled(config)[
|
||||
// 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"
|
||||
},
|
||||
)
|
||||
set bibliography(style: "ieee")
|
||||
config.thesis.bibliography
|
||||
}
|
||||
|
||||
// appendix
|
||||
#show-appendix(config: config)
|
||||
],
|
||||
)
|
||||
]
|
||||
]
|
||||
]
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@
|
|||
|
||||
#let new_abstract(config) = (
|
||||
context {
|
||||
|
||||
set align(center + horizon)
|
||||
|
||||
// only include summary when a language other than english is used
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@
|
|||
|
||||
#let new_confidentiality_statement_page(config) = (
|
||||
context {
|
||||
|
||||
pagebreak(weak: true)
|
||||
|
||||
let thesis = config.thesis
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@
|
|||
|
||||
#let new_declaration_of_authorship(config) = (
|
||||
context {
|
||||
|
||||
pagebreak(weak: true)
|
||||
|
||||
let thesis = config.thesis
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@
|
|||
// 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 elems = query(figure.where(kind: kind), here())
|
||||
let count = elems.len()
|
||||
|
||||
show outline.entry: it => {
|
||||
|
|
|
|||
|
|
@ -8,9 +8,11 @@
|
|||
|
||||
#let new_prerelease_note(config) = (
|
||||
context {
|
||||
|
||||
pagebreak(weak: true)
|
||||
|
||||
let thesis = config.thesis
|
||||
let author = config.author
|
||||
|
||||
if text.lang == "de" [
|
||||
#heading("Vorabfassung")
|
||||
|
|
@ -44,9 +46,13 @@
|
|||
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.
|
||||
handelt es sich _nicht_ um die fertige Fassung. Das Dokument kann Inhaltliche-, Grammatikalische- sowie Format-Fehler enthalten. Das Dokument ist im Rahmen der Aufgabenstellung von Seiten der #author.university nicht zur Bewertung freigegeben und ein anderer Verwendungszweck als eine Vorschau ist nicht gestattet.
|
||||
] else if text.lang == "en" [
|
||||
is not the final version. The document may contain errors in content, grammar and formatting. The document may not be released for evaluation to #config.university.name as part of the assignment, and any use other than a preview is not permitted.
|
||||
is not the final version. The document may contain errors in content, grammar and formatting. The document may not be released for evaluation to #author.university as part of the assignment, and any use other than a preview is not permitted.
|
||||
]
|
||||
|
||||
v(1em)
|
||||
h(1em)
|
||||
[#author.name, #datetime.today().display()]
|
||||
}
|
||||
)
|
||||
|
|
|
|||
|
|
@ -49,17 +49,9 @@
|
|||
// faculty
|
||||
#pad()[
|
||||
#if text.lang == "de" [
|
||||
aus dem Studiengang #config.university.program
|
||||
aus dem Studiengang #config.university.program | #config.university.faculty
|
||||
] 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
|
||||
from the course of studies #config.university.program | #config.university.faculty
|
||||
] else [
|
||||
#context panic("no translation for language: ", text.lang)
|
||||
]
|
||||
|
|
@ -76,19 +68,14 @@
|
|||
]
|
||||
#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)[
|
||||
#pad(top: 1em)[
|
||||
#let names = ()
|
||||
|
||||
#for author in config.authors {
|
||||
names.push(author.name)
|
||||
}
|
||||
#if text.lang == "de" [
|
||||
von
|
||||
] else if text.lang == "en" [
|
||||
|
|
@ -96,43 +83,71 @@
|
|||
] 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 text(size: 16pt)
|
||||
#grid(columns: 1, row-gutter: 1em, ..names)
|
||||
]
|
||||
|
||||
#set align(bottom)
|
||||
|
||||
#pad(top: 1.5em)[
|
||||
#pad(top: 1em)[
|
||||
#thesis.timeframe
|
||||
]
|
||||
|
||||
#if config.supervisor-signature {
|
||||
align(
|
||||
#set align(bottom + left)
|
||||
|
||||
#if text.lang == "de" [
|
||||
#grid(
|
||||
columns: 2,
|
||||
column-gutter: 1cm,
|
||||
row-gutter: 0.5cm,
|
||||
align: top + left,
|
||||
stroke: none,
|
||||
[Matrikelnummer, Kurs:],
|
||||
par(
|
||||
leading: 0.5em,
|
||||
for author in config.authors {
|
||||
str(author.matriculation-number) + ", " + author.course
|
||||
linebreak()
|
||||
},
|
||||
),
|
||||
|
||||
[Betrieb, Betreuer:],
|
||||
par(
|
||||
leading: 0.5em,
|
||||
for author in config.authors {
|
||||
author.company + ", " + author.supervisor
|
||||
linebreak()
|
||||
},
|
||||
),
|
||||
)
|
||||
] else if text.lang == "en" [
|
||||
#grid(
|
||||
columns: 2,
|
||||
column-gutter: 1cm,
|
||||
row-gutter: 0.5cm,
|
||||
align: top + left,
|
||||
stroke: none,
|
||||
[Student ID, Course:],
|
||||
par(
|
||||
leading: 0.5em,
|
||||
for author in config.authors {
|
||||
str(author.matriculation-number) + ", " + author.course
|
||||
linebreak()
|
||||
},
|
||||
),
|
||||
|
||||
[Company, Supervisor:],
|
||||
par(
|
||||
leading: 0.5em,
|
||||
for author in config.authors {
|
||||
author.company + ", " + author.supervisor
|
||||
linebreak()
|
||||
},
|
||||
),
|
||||
)
|
||||
] else [
|
||||
#context panic("no translation for language: ", text.lang)
|
||||
]
|
||||
|
||||
#align(
|
||||
bottom,
|
||||
grid(
|
||||
// set width of columns
|
||||
|
|
@ -148,7 +163,6 @@
|
|||
),
|
||||
align(right, {line(length: 6cm)})),
|
||||
)
|
||||
}
|
||||
|
||||
#counter(page).update(0)
|
||||
]
|
||||
|
|
|
|||
|
|
@ -184,7 +184,7 @@
|
|||
show figure.caption: c => [
|
||||
#if c.body.fields().len() > 0 {
|
||||
text(weight: "medium")[
|
||||
#c.supplement #context c.counter.display("1.1.1")
|
||||
#c.supplement #c.counter.display("1.1.1")
|
||||
]
|
||||
c.separator
|
||||
}
|
||||
|
|
@ -241,7 +241,6 @@
|
|||
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: (
|
||||
|
|
@ -296,6 +295,7 @@
|
|||
|
||||
if current-page == 1 {
|
||||
// logo moved to content
|
||||
|
||||
} else if query(<end-of-content>)
|
||||
.first()
|
||||
.location()
|
||||
|
|
|
|||
|
|
@ -6,23 +6,16 @@
|
|||
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"
|
||||
),
|
||||
(
|
||||
author: (
|
||||
name: "Sven Vogel",
|
||||
semester: 4,
|
||||
program: "Informationtechnology",
|
||||
course: "TINF19IT1",
|
||||
faculty: "Technik",
|
||||
university: "DHBW Mannheim",
|
||||
company: "ABB AG",
|
||||
supervisor: "Benny Goodman",
|
||||
matriculation-number: 123456789,
|
||||
contact: "sven.vogel123@web.de"
|
||||
)
|
||||
),
|
||||
thesis: (
|
||||
title: "Unofficial ABB/DHBW Typst template",
|
||||
|
|
|
|||
|
|
@ -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