scribbling-hm:0.1.3 (#3341)

Author: fine-seat

packages/preview/scribbling-hm/0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 fine-seat
+
+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.

packages/preview/scribbling-hm/0.1.3/README.md

@@ -0,0 +1,61 @@
+# scribbling-hm
+
+Unofficial computer science Bachelor's thesis template for Munich University of Applied Sciences (Hochschule München).
+
+## Installation
+You can use this template in the Typst web app by clicking "Start from template" on the dashboard and searching for ``scribbling-hm``.
+
+Alternatively, you can use the CLI to initialize this project using the command:
+
+```bash
+typst init @preview/scribbling-hm
+```
+
+## Usage
+1. Open the ``main.typ`` file.
+2. Customize the properties.
+3. Write the content at the bottom of the file.
+4. Compile.
+
+### Properties
+
+| Property | Description |
+|----------|-------------|
+| `title` | The title of your thesis |
+| `title-translation` | English translation of the title |
+| `course-of-study` | Your course of study |
+| `author` | Your full name |
+| `gender` | Your gender |
+| `student-id` | Your student ID number |
+| `birth-date` | Your date of birth (optional) |
+| `study-group` | Your study group |
+| `semester` | Current semester |
+| `supervisors` | Array of supervisor names or single supervisor name |
+| `supervisor-gender` | Gender of supervisor |
+| `submission-date` | Date of thesis submission |
+| `abstract-two-langs` | Enable bilingual abstract (default: true) |
+| `abstract` | Your thesis abstract |
+| `abstract-translation` | English translation of abstract (if bilingual set to true) |
+| `blocking` | Enable blocking notice (default: false) |
+| `enable-header` | Show page headers (default: true) |
+| `draft` | Enable draft mode (default: true) |
+| `bib` | Bibliography file reference |
+| `abbreviations-list` | Abbreviations for the glossary |
+| `variables-list` | Pre-defined variables |
+
+### Draft mode
+
+If you set ``draft`` to true, your thesis will have written "ENTWURF" all over the place. This will help you to keep track of whether you're finished or not.
+
+Additionally, if you're in draft mode, you can set todo texts in your document.
+
+```typst
+#todo[Something to do]
+```
+
+### Variables
+
+The `variables-list` is helpful if you want to pre-define frequently-used phrases, including their formatting. You can use them just like the abbreviations.
+
+IMPORTANT:\
+Your keys must be unique across all files (``abbreviations.typ`` and ``variables.typ``)

packages/preview/scribbling-hm/0.1.3/lib.typ

@@ -0,0 +1 @@
+#import "src/scribbling-hm.typ": *

packages/preview/scribbling-hm/0.1.3/main.png

@@ -0,0 +1,8 @@
+#let abbreviations-list = (
+  (
+    key: "cpu",
+    short: "CPU",
+    long: "Central Processing Unit",
+    description: "Zentrale Recheneinheit im Computer"
+  ),
+)

packages/preview/scribbling-hm/0.1.3/src/components/abbreviations.typ

@@ -0,0 +1,19 @@
+#import "../utils.typ": *
+
+#let abstract-page(
+  two-langs: true,
+  abstract: none,
+  abstract-translation: none
+) = {
+  heading("Zusammenfassung")
+
+  text(if abstract != none {abstract} else {todo[Zusammenfassung]})
+
+  if two-langs == true {
+    heading("Abstract")
+
+    text(if abstract-translation != none {abstract-translation} else {todo[Abstract]})
+  }
+
+  pagebreak()
+}

packages/preview/scribbling-hm/0.1.3/src/components/abstract.typ

@@ -0,0 +1,17 @@
+#let blocking-notice(
+  gender: none
+) = {
+
+  let author = if gender == "w" [der Verfasserin] else if gender == "m" [des Verfassers] else [des Verfassenden]
+
+  v(1fr)
+
+  [
+    Die vorliegende Bachelorarbeit beinhaltet vertrauliche Informationen und darf durch Dritte, mit Ausnahme der Gutachter und berechtigten Beteiligten im Prüfungsverfahren, ohne ausdrückliche schriftliche Zustimmung #author nicht eingesehen werden.
+
+    Insbesondere ist eine Vervielfältigung, weitere Verwendung und eine Veröffentlichung der Bachelorarbeit ohne ausdrückliche schriftliche Genehmigung #author, auch auszugsweise, untersagt.
+
+  ]
+
+  v(1fr)
+}

packages/preview/scribbling-hm/0.1.3/src/components/blocking.typ

@@ -0,0 +1,30 @@
+#let declaration(
+  name: none,
+  birth-date: none,
+  study-group: none,
+  semester: none,
+  student-id: none,
+  submission-date: none,
+) = { 
+  v(1fr)
+
+  if name != none and study-group != none and semester != none and student-id != none {
+    [
+      #name#if birth-date != none {
+        [, geb. #birth-date]
+      } (#study-group, #semester)
+    ]
+  }
+
+  v(1cm)
+
+  [
+    Hiermit erkläre ich, dass ich die Bachelorarbeit selbständig verfasst, noch nicht anderweitig für Prüfungszwecke vorgelegt, keine anderen als die angegebenen Quellen oder Hilfsmittel benutzt sowie wörtliche und sinngemäße Zitate als solche gekennzeichnet habe.
+  ]
+
+  v(2cm)
+
+  [München, den #submission-date #h(1fr) #name]
+
+  v(1cm)
+}

packages/preview/scribbling-hm/0.1.3/src/components/declaration.typ

@@ -0,0 +1,12 @@
+#let outline-page() = {
+  show outline.entry.where(level: 1): set outline.entry(fill: none)
+  show outline.entry.where(level: 1): set text(weight: "bold")
+  show outline.entry.where(level: 1): set block(above: 16pt)
+
+  outline(
+    depth: 3,
+    indent: auto
+  )
+
+  pagebreak()
+}

packages/preview/scribbling-hm/0.1.3/src/components/outline.typ

@@ -0,0 +1,89 @@
+#import "../utils.typ": *
+
+#let titlepage(
+  title: none,
+  title-translation: none,
+  date: none,
+  author: none,
+  id: none,
+  supervisors: none,
+  course-of-study: none,
+  gender: none,
+  supervisor-gender: none,
+  draft: true,
+) = {
+  align(center, [
+    #v(1cm)
+
+    #image("../media/HM_logo.png", width: 45%)
+
+    Hochschule München \
+    Fakultät für Informatik und Mathematik
+
+    #v(2cm)
+
+    #text(size: 14pt)[Bachelorarbeit \ zur Erlangung des akademischen Grades \ Bachelor of Science]
+
+    #text(size: 16pt, weight: "bold", if (title != none) {
+      title
+    } else {
+      todo[Titel]
+    })
+
+    #text(size: 14pt, if (title-translation != none) {
+      title-translation
+    } else { todo[Title] })
+
+    #v(0.5cm)
+
+    #text(size: 14pt)[
+      #if draft {
+        emph(text()[ENTWURF])
+      } else {
+        [
+          Abgabetermin \
+          #date
+        ]
+      }
+    ]
+
+    #v(1fr)
+
+    #let gendered-author = ""
+
+    #if (author != none) {
+      if gender == "m" {
+        [Autor: ]
+      } else if gender == "w" {
+        [Autorin: ]
+      } else if gender == "d" or gender == none {
+        [Verfassende Person: ]
+      }
+      author
+    } else { todo[Autor] }
+
+    #if (id != none) { [Matrikelnummer: #id] } else { todo[Matrikelnummer] }
+
+    #if (course-of-study != none) { [Studiengang: #course-of-study ] } else { todo[Matrikelnummer] }
+
+    #if (supervisors != none) {
+      if type(supervisors) == array [
+        [Prüfende Personen:]
+        #supervisors.join(", ")
+      ] else [
+        #if supervisor-gender == "m" {
+          [Prüfer:]
+        } else if supervisor-gender == "w" {
+          [Prüferin:]
+        } else if supervisor-gender == "d" or supervisor-gender == none {
+          [Prüfende Person:]
+        }
+        #supervisors
+      ]
+    } else {
+      todo[Prüfer]
+    }
+
+  ])
+  pagebreak()
+}