diff --git a/README.md b/README.md index d5c8bfa..430b7b9 100644 --- a/README.md +++ b/README.md @@ -75,31 +75,78 @@ The default configuration can be found in `src/conf.typ`. #import "src/lib.typ": * #show: dhbw-template.with(( - lang: "en", - region: "en", - author: ( - name: "Sven Vogel", - semester: 4, + // 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", - course: "TINF19IT1", faculty: "Technik", - university: "DHBW Mannheim", - company: "ABB AG", - supervisor: "Benny Goodman", - matriculation-number: 123456789), + 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 thesis: ( title: "Unofficial ABB/DHBW Typst template", - subtitle: "for reports and thesises", + subtitle: "for reports and thesises", // subtitle may be none submission-date: "23rd march 2020", timeframe: "1st january 2020 - 20th march 2020", kind: "T2000", - summary: summary, - abstract: abstract, - preface: include "preface.typ", + // translated version of abstract, only used in case language is not english + summary: none, + abstract: none, + preface: none, keywords: ( "IT", "other stuff" ), - bibliography: bibliography("refs.bib"), - glossary: yaml("glossary.yml"), - appendices: include "appendix.typ"))) + 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))) // Your document code goes here!