diff --git a/README.md b/README.md index c9e4aad..fefd8ad 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,32 @@ -# DHBW-ABB Typst template 📃 +
+

DHBW-ABB template for Typst

+ + + + + +
+
+ Unofficial but feature rich Typst template for writing a thesis or report at DHBW
+ with according ABB AG branding in mind. +
+ +
-![last-commit-bade](https://img.shields.io/gitea/last-commit/dhbw/dhbw-abb-typst-template?gitea_url=https%3A%2F%2Fgit.montehaselino.de) -![release-badge](https://img.shields.io/gitea/v/release/dhbw/dhbw-abb-typst-template?gitea_url=https%3A%2F%2Fgit.montehaselino.de&display_name=release) -![typst-badge](https://img.shields.io/badge/Typst-2B9CB0) -![language-count-badge](https://img.shields.io/gitea/languages/count/dhbw/dhbw-abb-typst-template?gitea_url=https%3A%2F%2Fgit.montehaselino.de) -![license-badge](https://img.shields.io/badge/license-MIT-ff0000) +## Table of Contents -**Unofficial** but feature rich Typst template for writing a thesis or report at DHBW with according ABB AG branding in mind. - -![thumbnail](https://git.montehaselino.de/DHBW/dhbw-abb-typst-template/raw/commit/cd325b7076da91e58849512539460a481e48ef4e/assets/thumbnail.png) +1. [Features](#features) +2. [Usage](#usage) +2. [Preview of pages](#preview) +3. [Relation to DHBW docx template](#dhbw-docx-template) +4. [Format and branding conformance](#format) +5. [Fonts](#fonts) +6. [Legal](#legal) +7. [For LaTeX users](#for-users-jumping-over-from-latex) +8. [FAQ](#faq) + 1. [Typst vs LaTeX](#why-typst-instead-of-latex) + 2. [Source of logos](#where-are-the-logos-from) ## Features @@ -19,6 +36,74 @@ This template includes designs for a titlepage, confidantiality statement, declaration of authorship and more with a consistent design inspired by various unofficial works made by students at DHBW. Layout and the choise fonts are based on the unofficial [supercharged-dhbw](https://github.com/DannySeidel/typst-dhbw-template) Typst template. It comes with automatic generation of outlines for figures, tables, code snippets and appendices. The template can generate sections for a glossary, combinging acronyms and technical terms into a singular section. +A short overview of all features the template is capable of: +- Acronyms +- Glossary +- Table of Contents for: headings, figures, tables and listings and appendecis +- Appendix +- Extra page for: + - Declaration of Authorship + - Confidentiality Statement + - Preleminary notice +- Watermark for draft versions +- Automatic form filling for data provided via configuration +- Styles for captions, tables and equations +- ABB branding inspired code theme + +## Preview + +![](./assets/page-preview.png) + +## Usage + +### Without Typst package manager + +Clone the repository into a subfolder of your project or add it a git submodule. The you can import the `lib.typ` file from `src`. +Once thats done calling the following snippet `#show: dhbw-template.with(conf)` will setup the template. You can provide a configuration for the template to use. +The default configuration can be found in `src/conf.typ`. + +```typst +#import "src/lib.typ": * + +#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: summary, + abstract: abstract, + preface: include "preface.typ", + keywords: ( "IT", "other stuff" ), + bibliography: bibliography("refs.bib"), + glossary: yaml("glossary.yml"), + appendices: include "appendix.typ"))) + +// Your document code goes here! + += Introduction + +lorem(50) + += Chapter 1 + +#lorem(230) + +``` + ## DHBW DOCX template The official [DHBW template for Word](https://blog.fakultaet-technik.de/wp-content/uploads/2015/06/Studienarbeitsvorlage.docx) was used a strong inspiration but not as base template. diff --git a/assets/banner.png b/assets/banner.png new file mode 100644 index 0000000..d77e278 Binary files /dev/null and b/assets/banner.png differ diff --git a/assets/page-preview.png b/assets/page-preview.png new file mode 100644 index 0000000..634f161 Binary files /dev/null and b/assets/page-preview.png differ