Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions packages/preview/haw-hamburg-bachelor-thesis/0.9.0/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Lasse Rosenow

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 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.
45 changes: 45 additions & 0 deletions packages/preview/haw-hamburg-bachelor-thesis/0.9.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# HAW Hamburg Typst Template

This is an **`unofficial`** template for writing a bachelor thesis in the `HAW Hamburg` Faculty of `Computer Science and Digital Society` style using [Typst](https://github.com/typst/typst).

## Usage

To use this package just add the following code to your [Typst](https://github.com/typst/typst) document:

```typst
#import "@preview/haw-hamburg:0.9.0": bachelor-thesis

#show: bachelor-thesis.with(
language: "en",

title-de: "Beispiel Titel",
keywords-de: ("Stichwort", "Wichtig", "Super"),
abstract-de: "Beispiel Zusammenfassung",

title-en: "Example title",
keywords-en: ("Keyword", "Important", "Super"),
abstract-en: "Example abstract",

author: "Example author",
faculty: "Computer Science and Digital Society",
study-course: "Bachelor of Science Informatik Technischer Systeme",
supervisors: ("Prof. Dr. Example", "Prof. Dr. Example"),
submission-date: datetime(year: 1948, month: 12, day: 10),
)
```

## How to Compile

This project contains an example setup that splits individual chapters into different files.\
This can cause problems when using references etc.\
These problems can be avoided by following these steps:

- Make sure to always compile your `main.typ` file which includes all of your chapters for references to work correctly.
- **CLI**:
- Install [Typst](https://github.com/typst/typst) on your system.
- Open the terminal and run: `typst compile main.typ`.
- **VSCode**:
- Install the [Tinymist Typst](https://marketplace.visualstudio.com/items?itemName=myriad-dreamin.tinymist) extension.
- Make sure to start the `PDF` or `Live Preview` only from within your `main.typ` file.
- References and the language server in general only work correctly when the `Live Preview` of the `main.typ` file is running in the background.
- If problems occur it usually helps to close the preview and restart it from your `main.typ` file.
1 change: 1 addition & 0 deletions packages/preview/haw-hamburg-bachelor-thesis/0.9.0/lib.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// This file is redundant, but required by the Typst packaging system
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// Abbreviations
// Use: @key or @key:pl to reference and #print-glossary to print it
// More documentation: https://typst.app/universe/package/glossarium/

#let abbreviations-entry-list = (
(
key: "cpu",
short: "CPU",
long: "Central Processing Unit",
),
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
@book{UN,
author = {{United Nations}},
title = {Universal Declaration of Human Rights},
year = {1948},
month = dec,
venue = {Paris},
month_numeric = {12}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#import "../dependencies.typ": *

= Introduction

== How to Use Abbreviations

This is how to call an abbreviation such as @cpu for the first time.

After that it will look different: @cpu.

And for plurals: @cpu:pl.

It is also call it using a different syntax: #gls("cpu") and #glspl("cpu").

== How to Use Glossary Entries

Glossary entries can be called the same way: @freedom or #gls("freedom").

It is also possible to call plurals: @freedom:pl or #glspl("freedom").
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#import "../dependencies.typ": *

= Background

== Subsection

#lorem(400)

== Another Subsection

#lorem(300)
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#import "@preview/glossarium:0.5.10": *
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// Glossary
// Use: @key or @key:pl to reference and #print-glossary to print it
// More documentation: https://typst.app/universe/package/glossarium/

#let glossary-entry-list = (
(
key: "freedom",
short: "freedom",
description: "Freedom is the power or right to speak, act and change as one wants without hindrance or restraint. Freedom is often associated with liberty and autonomy in the sense of \"giving oneself one's own laws\"",
),
)

Loading
Loading