Skip to content

Commit fd83a35

Browse files
committed
feat: update package name, documentation, repo url and separate examples into german and english
1 parent 5670475 commit fd83a35

File tree

7 files changed

+78
-27
lines changed

7 files changed

+78
-27
lines changed

packages/preview/covered-cs-thesis/0.1.5/CHANGELOG.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## Unreleased
99

1010
### Added
1111

@@ -19,11 +19,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1919

2020
### Security
2121

22-
## [0.1.0] - 2025-01-01
22+
## 0.1.5 - 2025-11-26
2323

24-
Initial version with cover and declaration of independence.
24+
### Added
25+
26+
* Separated german and english examples.
27+
28+
29+
### Changed
2530

31+
* Package name to `covered-cs-thesis`.
2632

33+
### Fixed
34+
35+
* Example image using mixed languages.
36+
37+
38+
## 0.1.0 - 2025-11-23
39+
40+
Initial version with cover and declaration of independence.
2741

28-
[Unreleased]: https://github.com/WyvernIXTL/computer-science-heidelberg-thesis-typst-template/compare/v0.1.0...HEAD
29-
[0.1.0]: https://github.com/WyvernIXTL/computer-science-heidelberg-thesis-typst-template/releases/tag/v0.1.0

packages/preview/covered-cs-thesis/0.1.5/README.md

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
# Computer Science Bachelor or Master Thesis Typst Template for the University Heidelberg
1+
<div align="center">
22

3-
A template for writing a bachelor's or master's computer science thesis at the University Heidelberg.
3+
# `covered-cs-thesis`
4+
5+
**A template for writing a bachelor's or master's computer science thesis at the University Heidelberg.**
6+
7+
</div>
8+
9+
The cover is available in **english** and **german**! Switch the language via the `language` option (see the Usage).
410

511
## Usage
612

@@ -20,11 +26,11 @@ Or use the cover function standalone:
2026
/// Your matriculation number (Matrikelnummer) [string]
2127
matriculation-number: "12345678",
2228
/// What your thesis is (bachelor/master) [string]
23-
thesis-type: "Bachelor-Arbeit",
29+
thesis-type: "Bachelor's Thesis",
2430
/// The title of your thesis [string]
2531
title: "What are ducks?",
2632
/// Your university [string]
27-
university: "Universität Heidelberg",
33+
university: "Heidelberg University",
2834
/// Your institute [string]
2935
institute: "Institut für Informatik",
3036
/// The working group that supervises your thesis [string]
@@ -34,6 +40,25 @@ Or use the cover function standalone:
3440
/// The date of your submission [anything]
3541
date-submission: [#datetime.today().display()],
3642
/// Language of your thesis ["en" OR "de"]
43+
/// This switches in what language your cover is displayed.
44+
language: "en",
45+
)
46+
```
47+
48+
For a cover in German:
49+
```typ
50+
#import "@preview/covered-cs-thesis:0.1.5": *
51+
52+
#cs-thesis-cover(
53+
author: "Max Mustermann",
54+
matriculation-number: "12345678",
55+
thesis-type: "Bachelor-Arbeit",
56+
title: "Was sind Enten?",
57+
university: "Universität Heidelberg",
58+
institute: "Institut für Informatik",
59+
working-group: "Enten Labor",
60+
supervisor: "Professor Einstein",
61+
date-submission: [#datetime.today().display("[day].[month].[year]")],
3762
language: "de",
3863
)
3964
```
@@ -45,4 +70,9 @@ This template is licensed under the [Unlicense license](./LICENSE).
4570

4671
## Images
4772

73+
* [English example pdf](https://github.com/WyvernIXTL/computer-science-heidelberg-thesis-typst-template/releases/download/v0.1.5/covered-cs-thesis-0.1.5-english-example.pdf)
74+
* [German example pdf](https://github.com/WyvernIXTL/computer-science-heidelberg-thesis-typst-template/releases/download/v0.1.5/covered-cs-thesis-0.1.5-german-example.pdf)
75+
4876
![thumbnail](./thumbnail.png)
77+
78+
![thumbnail german](./images/thumbnail-de.png)

packages/preview/covered-cs-thesis/0.1.5/cSpell.json

Lines changed: 0 additions & 12 deletions
This file was deleted.
23.8 KB
Loading

packages/preview/covered-cs-thesis/0.1.5/template/main.typ

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,14 @@
55
// === Settings ===
66

77
// Language of your thesis (either "de" or "en").
8-
#let language = "de"
8+
// This switches in what language your cover is displayed.
9+
#let language = "en"
10+
// #let language = "de"
911

1012
// Title of your thesis
1113
#let title = "What are ducks?"
14+
// #let title = "Was sind Enten?"
15+
1216

1317
// LaTeX like article style
1418
#show: article.with(
@@ -22,7 +26,7 @@
2226
page-paper: "a4",
2327
)
2428

25-
// Cover of your thesis
29+
// Cover of your thesis (English)
2630
#cs-thesis-cover(
2731
// see above
2832
title: title,
@@ -33,9 +37,9 @@
3337
/// Your matriculation number (Matrikelnummer) [string]
3438
matriculation-number: "12345678",
3539
/// What your thesis is (bachelor/master) [string]
36-
thesis-type: "Bachelor-Arbeit",
40+
thesis-type: "Bachelor's Thesis",
3741
/// Your university [string]
38-
university: "Universität Heidelberg",
42+
university: "Heidelberg University",
3943
/// Your institute [string]
4044
institute: "Institut für Informatik",
4145
/// The working group that supervises your thesis [string]
@@ -46,6 +50,22 @@
4650
date-submission: [#datetime.today().display()],
4751
)
4852

53+
// Cover of your thesis (German)
54+
//
55+
// #cs-thesis-cover(
56+
// title: title,
57+
// language: language,
58+
59+
// author: "Max Mustermann",
60+
// matriculation-number: "12345678",
61+
// thesis-type: "Bachelor-Arbeit",
62+
// university: "Universität Heidelberg",
63+
// institute: "Institut für Informatik",
64+
// working-group: "Enten Labor",
65+
// supervisor: "Professor Einstein",
66+
// date-submission: [#datetime.today().display("[day].[month].[year]")],
67+
// )
68+
4969

5070
// === Abstracts in german and english ===
5171
// Your need a summary in german and english, each one page.
303 Bytes
Loading

packages/preview/covered-cs-thesis/0.1.5/typst.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ entrypoint = "src/lib.typ"
77
authors = ["Adam McKellar"]
88
license = "Unlicense"
99
description = "A template for writing a bachelor's or master's computer science thesis at the University Heidelberg."
10-
repository = "https://github.com/WyvernIXTL/computer-science-heidelberg-thesis-typst-template"
10+
repository = "https://github.com/WyvernIXTL/covered-cs-thesis-typst-template"
1111
keywords = ["template"]
1212
categories = ["paper", "report"]
1313
disciplines = ["computer-science"]
@@ -20,7 +20,8 @@ exclude = [
2020
".typstignore",
2121
"Justfile",
2222
"thumbnail.png",
23-
"cSpell.json"
23+
"cSpell.json",
24+
"images"
2425
]
2526

2627
[template]

0 commit comments

Comments
 (0)