-
Notifications
You must be signed in to change notification settings - Fork 1k
thwildau-telematics:0.1.0 #4407
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
C4mperpr0
wants to merge
13
commits into
typst:main
Choose a base branch
from
C4mperpr0:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
6ce7967
added version 0.1.0 for the thwildau-thesis template
C4mperpr0 be082ce
remove main.pdf in template
C4mperpr0 103a064
forgot to add README.md
C4mperpr0 117114b
changed variable and function names from snake_case to kebab-case as …
C4mperpr0 a1a6d62
updated hydra to latest version 0.6.2 as suggested by the pipeline check
C4mperpr0 705769d
fixed typo
C4mperpr0 d26d681
fixed convergence error for more that 4 units/abbreviations in defini…
C4mperpr0 728a9ea
add TH-Wildau Logo License
C4mperpr0 8982cf9
rebranding from thwildau-thesis to thwildau-telematics to speed up th…
C4mperpr0 c12a023
removed main.pdf
C4mperpr0 af5112f
further rebranding
C4mperpr0 f48f5b2
moved package to rebranded folder
C4mperpr0 0c8b894
rebranded naming in README
C4mperpr0 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| Copyright © 2026 Carl Heinrich Bellgardt | ||
|
|
||
| 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. | ||
|
|
||
|
|
||
| The TH-Wildau Logo supplied along with this template under /assets/TH-Wildau-Logo_rgb.png is published under the CC BY-SA 4.0 License on https://en.wikipedia.org/wiki/Technical_University_of_Applied_Sciences_Wildau#/media/File:TH_Wildau_Logo.png |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,274 @@ | ||
| # TH Wildau Typst Telematics Template | ||
|
|
||
| ## Overview | ||
|
|
||
| A Typst template for creating academic theses and internship reports in the course Telematics at TH Wildau. It provides structured layouts, consistent styling, and utilities for common academic elements. | ||
|
|
||
| --- | ||
|
|
||
| ## Configuration | ||
|
|
||
| The template is configured centrally via `conf.with(...)`. Required fields are validated at compile time and will produce errors if missing. | ||
|
|
||
| ### Required fields | ||
|
|
||
| * `title` | ||
| * `student` | ||
| * `supervisor` | ||
|
|
||
| ### Optional fields | ||
|
|
||
| * `internship` | ||
| * `bibliography` | ||
| * `language` | ||
|
|
||
| --- | ||
|
|
||
| ## Auto-generated Pages | ||
|
|
||
| The template automatically generates several standard pages: | ||
|
|
||
| * Title page (can be replaced by custom content or a PDF) | ||
| * Bibliographic description (multi-language) | ||
| * Reading guide | ||
| * Declaration of authorship | ||
| * Company confirmation | ||
| * Appendix support | ||
|
|
||
| --- | ||
|
|
||
| ## Multi-language Support | ||
|
|
||
| Static UI text is translated using `/utils/translations.json`. | ||
| The system is easily extendable without programming knowledge. Missing translations will result in compile errors. | ||
|
|
||
| --- | ||
|
|
||
| ## Tables | ||
|
|
||
| The template provides predefined table styles: | ||
|
|
||
| * `tables.x-header` | ||
| * `tables.xy-header` | ||
|
|
||
| Tables are automatically included in a list of tables. | ||
|
|
||
| --- | ||
|
|
||
| ## Figures and Code | ||
|
|
||
| * Native Typst figures are supported | ||
| * Automatic list of figures | ||
| * Inline and block code supported | ||
|
|
||
| --- | ||
|
|
||
| ## Info Cards | ||
|
|
||
| Info cards allow highlighting important content such as notes or definitions. | ||
| Their appearance can be customized. | ||
|
|
||
| --- | ||
|
|
||
| ## Units | ||
|
|
||
| Units can be defined and reused centrally: | ||
|
|
||
| * Define via `define_unit` | ||
| * Use via `unit` | ||
|
|
||
| --- | ||
|
|
||
| ## Abbreviations | ||
|
|
||
| Abbreviations can be defined and referenced: | ||
|
|
||
| * Define via `define_abbreviation` | ||
| * Use via `abbreviation` | ||
| * Automatic list of abbreviations | ||
|
|
||
| --- | ||
|
|
||
| ## TODO System | ||
|
|
||
| * Inline TODOs via `todo[...]` | ||
| * Optional annotations | ||
| * Automatic TODO list | ||
| * Visual highlighting in the document | ||
|
|
||
| --- | ||
|
|
||
| ## Bibliography | ||
|
|
||
| The template integrates Typst’s bibliography system and allows configurable citation styles. | ||
|
|
||
| --- | ||
|
|
||
| ## Example | ||
|
|
||
| ```typst | ||
| #import "@preview/thwildau-telematics:0.1.0": * | ||
|
|
||
| #show: conf.with( | ||
| title: "My Thesis", | ||
| student: ( | ||
| name: "Max Mustermann", | ||
| matrnr: "12345678", | ||
| ), | ||
| supervisor: ( | ||
| name: "Dr. Example", | ||
| ), | ||
| ) | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Notes | ||
|
|
||
| Designed for minimal Typst knowledge with a strong focus on automation and consistency. | ||
|
|
||
| --- | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions and feature requests are welcome. | ||
|
|
||
| --- | ||
|
|
||
| # TH Wildau Telematik Typst-Vorlage für Abschlussarbeiten | ||
|
|
||
| ## Überblick | ||
|
|
||
| Eine Typst-Vorlage zur Erstellung von Abschlussarbeiten und Praxisberichten für den Studiengang Telematik an der TH Wildau. Sie bietet strukturierte Layouts, einheitliches Styling und Hilfsfunktionen für typische wissenschaftliche Inhalte. | ||
|
|
||
| --- | ||
|
|
||
| ## Konfiguration | ||
|
|
||
| Die Vorlage wird zentral über `conf.with(...)` konfiguriert. Pflichtfelder werden zur Compile-Zeit geprüft und erzeugen Fehler, falls sie fehlen. | ||
|
|
||
| ### Pflichtfelder | ||
|
|
||
| * `title` | ||
| * `student` | ||
| * `supervisor` | ||
|
|
||
| ### Optionale Felder | ||
|
|
||
| * `internship` | ||
| * `bibliography` | ||
| * `language` | ||
|
|
||
| --- | ||
|
|
||
| ## Automatisch erzeugte Seiten | ||
|
|
||
| Die Vorlage erzeugt automatisch mehrere Standardseiten: | ||
|
|
||
| * Titelseite (kann durch eigenes PDF ersetzt werden) | ||
| * Bibliographische Beschreibung (mehrsprachig) | ||
| * Lesehinweise | ||
| * Selbstständigkeitserklärung | ||
| * Firmenbestätigung | ||
| * Anhang | ||
|
|
||
| --- | ||
|
|
||
| ## Mehrsprachigkeit | ||
|
|
||
| Statische Texte werden über `/utils/translations.json` übersetzt. | ||
| Das System ist einfach ohne Programmierkenntnisse erweiterbar. Fehlende Übersetzungen führen zu Compilerfehlern. | ||
|
|
||
| --- | ||
|
|
||
| ## Tabellen | ||
|
|
||
| Die Vorlage bietet vordefinierte Tabellenstile: | ||
|
|
||
| * `tables.x-header` | ||
| * `tables.xy-header` | ||
|
|
||
| Tabellen werden automatisch in ein Tabellenverzeichnis aufgenommen. | ||
|
|
||
| --- | ||
|
|
||
| ## Abbildungen und Code | ||
|
|
||
| * Typst-Abbildungen werden unterstützt | ||
| * Automatisches Abbildungsverzeichnis | ||
| * Inline- und Block-Code möglich | ||
|
|
||
| --- | ||
|
|
||
| ## Info-Karten | ||
|
|
||
| Info-Karten ermöglichen die Hervorhebung wichtiger Inhalte wie Hinweise oder Definitionen. | ||
| Das Erscheinungsbild ist anpassbar. | ||
|
|
||
| --- | ||
|
|
||
| ## Einheiten | ||
|
|
||
| Einheiten können zentral definiert und wiederverwendet werden: | ||
|
|
||
| * Definition über `define_unit` | ||
| * Verwendung über `unit` | ||
|
|
||
| --- | ||
|
|
||
| ## Abkürzungen | ||
|
|
||
| Abkürzungen können definiert und referenziert werden: | ||
|
|
||
| * Definition über `define_abbreviation` | ||
| * Verwendung über `abbreviation` | ||
| * Automatisches Abkürzungsverzeichnis | ||
|
|
||
| --- | ||
|
|
||
| ## TODO-System | ||
|
|
||
| * Inline-TODOs über `todo[...]` | ||
| * Optionale Hinweise | ||
| * Automatisches TODO-Verzeichnis | ||
| * Visuelle Hervorhebung im Dokument | ||
|
|
||
| --- | ||
|
|
||
| ## Literaturverzeichnis | ||
|
|
||
| Die Vorlage integriert das Typst-Bibliographiesystem und ermöglicht konfigurierbare Zitierstile. | ||
|
|
||
| --- | ||
|
|
||
| ## Beispiel | ||
|
|
||
| ```typst | ||
| #import "@preview/thwildau-telematics:0.1.0": * | ||
|
|
||
| #show: conf.with( | ||
| title: "Meine Arbeit", | ||
| student: ( | ||
| name: "Max Mustermann", | ||
| matrnr: "12345678", | ||
| ), | ||
| supervisor: ( | ||
| name: "Dr. Beispiel", | ||
| ), | ||
| ) | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Hinweise | ||
|
|
||
| Für geringe Typst-Vorkenntnisse konzipiert, mit Fokus auf Automatisierung und Konsistenz. | ||
|
|
||
| --- | ||
|
|
||
| ## Mitwirken | ||
|
|
||
| Beiträge und Feature-Wünsche sind willkommen. | ||
|
|
||
| ## Logo License | ||
| Das TH-Wildau Logo, welches von diesem Template verwendet und unter assets/TH-Wildau-Logo_rgb.png gespeichert wird, darf nach der CC BY-SA 4.0 License verwendet werden. Es wurde unter https://en.wikipedia.org/wiki/Technical_University_of_Applied_Sciences_Wildau#/media/File:TH_Wildau_Logo.png abgerufen. | ||
Binary file added
BIN
+75.9 KB
packages/preview/thwildau-telematics/0.1.0/assets/TH-Wildau-Logo_rgb.png
|
C4mperpr0 marked this conversation as resolved.
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions
19
packages/preview/thwildau-telematics/0.1.0/components/abbreviation.typ
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| #let abbr-state = state("abbreviations", (:)) | ||
|
|
||
| #let define-abbreviation(abbreviation, description) = { | ||
| // TODO: duplicates error handling | ||
| let id = str("abbr-" + abbreviation) | ||
| // Store full info in state | ||
| abbr-state.update(state => state + (str(id): (abbreviation, description))) | ||
| // Create link to later entry | ||
| show link: set text(fill: black) | ||
| link(label(id))[#emph[#abbreviation]] | ||
| } | ||
|
|
||
| #let abbreviation(abbreviation) = { | ||
| // TODO: make this work with either symbol or name. Error handling | ||
| let id = str("abbr-" + abbreviation) | ||
| show link: set text(fill: black) | ||
|
|
||
| link(label(id))[#emph[#abbreviation]] | ||
| } |
33 changes: 33 additions & 0 deletions
33
packages/preview/thwildau-telematics/0.1.0/components/infocard.typ
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| #import "th_color.typ": th-color | ||
|
|
||
| #let infocard( | ||
| heading, | ||
| description, | ||
| color-dark: th-color.paleblue, | ||
| color-light: th-color.lightblue2 | ||
| ) = { | ||
| figure( | ||
| { | ||
| set block( | ||
| width: 100%, | ||
| inset: 10pt, | ||
| stroke: 1pt + color-dark | ||
| ) | ||
| show block: (it) => align(left, it) | ||
| block( | ||
| text(strong(heading), fill: color-light), | ||
| fill: color-dark, | ||
| radius: (top: 5pt), | ||
| below: 0pt, | ||
| ) | ||
| block( | ||
| text(description), | ||
| fill: color-light, | ||
| radius: (bottom: 5pt), | ||
| above: 0pt | ||
| ) | ||
| }, | ||
| kind: "infocard", | ||
| supplement: none | ||
| ) | ||
| } |
45 changes: 45 additions & 0 deletions
45
packages/preview/thwildau-telematics/0.1.0/components/tables.typ
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| #import "th_color.typ": th-color | ||
|
|
||
| #let frame() = (x, y) => ( | ||
| left: none, | ||
| right: none, | ||
| top: 0pt, | ||
| bottom: .5pt + gray, | ||
| ) | ||
|
|
||
| #let x-header(doc) = { | ||
| // default styling for tables | ||
| set table( | ||
| fill: (x, y) => if y == 0 { th-color.paleblue } else if calc.even(y) { color.white } else { th-color.lightblue }, | ||
| stroke: frame(), | ||
| ) | ||
| show table.cell: it => { | ||
| if it.y == 0 { | ||
| set text(white) | ||
| strong(it) | ||
| } else { | ||
| it | ||
| } | ||
| } | ||
| doc | ||
| } | ||
|
|
||
| #let xy-header(doc) = { | ||
| // default styling for tables | ||
| set table( | ||
| fill: (x, y) => if x == 0 or y == 0 { th-color.paleblue } else if calc.even(y) { color.white } else { | ||
| th-color.lightblue | ||
| }, | ||
| // TODO: the border is 1px to long at the left-bottom corner | ||
| stroke: frame(), | ||
| ) | ||
| show table.cell: it => { | ||
| if it.x == 0 or it.y == 0 { | ||
| set text(white) | ||
| strong(it) | ||
| } else { | ||
| it | ||
| } | ||
| } | ||
| doc | ||
| } |
10 changes: 10 additions & 0 deletions
10
packages/preview/thwildau-telematics/0.1.0/components/th-color.typ
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| #let th-color = ( | ||
| "blue": rgb("#005bae"), | ||
| "paleblue": rgb("#3E6E9F"), | ||
| "lightblue": rgb("#D8E8F5"), | ||
| "lightblue2": rgb("#EFF4FB"), | ||
| "orange": rgb("#f2871a"), | ||
| "paleorange": rgb("#FCDCAA"), | ||
| "green": rgb("#99c23c"), | ||
| "magenta": rgb("#d80976"), | ||
| ) |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this package is built for the telematics class, I'm not sure the new name really fits our guidelines either. If the head teacher agrees to making this template official, they can send the verification email themselves. Otherwise I will ask you to pick another name. We can discuss it here before changing again, if you want to be sure to chose something that will fit our guidelines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One of the professors responsible for this told me that they send you an email today, verifying my work. The template idea has been discussed with multiple of my profs and all of them like idea and agree with uploading it to the typst universe as an template for my class/field of study specifically. They wouldve even supported me to make it an official template for the whole institution, especially since there is none yet and nothing else is planned, but it would also take a while to get the responsible people involved and have them verify me, so we opted for the faster route here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, I'll wait for the email and merge then :)