modern-hsh-thesis:1.1.2

packages/preview/modern-hsh-thesis/1.1.2/.gitignore

@@ -0,0 +1,2 @@
+/.idea/
+/modern-hsh-thesis/

packages/preview/modern-hsh-thesis/1.1.2/CHANGELOG.md

@@ -0,0 +1,54 @@
+# [v1.1.2](https://github.com/MrToWy/hsh-thesis/releases/tag/v1.1.2)
+## Added
+- Added `custom-logo1` & `custom-logo2` parameter to allow changing the logos on the first page.
+- Added `prof-title` & 'second-prof-title' parameter to allow changing the title of the professors on the first page.
+
+# [v1.1.1](https://github.com/MrToWy/hsh-thesis/releases/tag/v1.1.1)
+## Added
+- Added `justify-title` parameter to allow for disabling the justification of the title.
+
+## Changed
+- Parameter `title` can now be a string or content. Content is useful if you want to use a custom size or color for the title.
+
+# [v1.1.0](https://github.com/MrToWy/hsh-thesis/releases/tag/v1.1.0)
+## Added
+- Added `custom-declaration-of-independence` parameter to allow for a custom declaration of independence.
+
+## Changed
+- Upgraded codly to 1.3.0
+
+# [v1.0.2](https://github.com/MrToWy/hsh-thesis/releases/tag/v1.0.2)
+## Changed
+- Upgraded Typst to version 0.13
+- Upgraded treet to version 0.1.1
+- Upgraded gentle-clues to 1.2.0
+- Upgraded wrap-it to 0.1.1
+- Upgraded Hydra to 0.6.0
+- Upgraded codly to 1.2.0
+
+## Misc
+- Added "Use Git Bash Console" info to readme
+- Added .gitignore
+- Added CONTRIBUTING.md
+
+
+# [v1.0.1](https://github.com/MrToWy/hsh-thesis/releases/tag/v1.0.1)
+## Added
+- Optional Parameter `chapter-break-mode` to control whether a new chapter should start on a new page.
+
+
+## Changed
+- Upgraded Typst to version 0.12
+- Upgraded Hydra to 0.5.1
+
+## Removed
+- get-current-heading (instead use get-current-heading-hydra)
+
+## Misc
+- Added "Just" install step to readme
+
+
+---
+
+# [v1.0.0](https://github.com/MrToWy/hsh-thesis/releases/tag/v1.0.0)
+Initial Release

packages/preview/modern-hsh-thesis/1.1.2/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# How to contribute
+Everyone is welcome to contribute to this template. Thanks for your work!
+
+## Bugs
+- Create an issue that describes the bug
+- [Optional] Create a PR with your changes and mention the issue you created
+
+
+## Features
+- Create an issue that describes the new feature
+- [Optional] Create a PR with your changes and mention the issue you created
+    - Make sure that your changes won't break exisiting documents. Use optional parameters with a default value for example.
+
+
+## Legal notice
+By contributing to this repo, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.

packages/preview/modern-hsh-thesis/1.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tobias Wylega
+
+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/modern-hsh-thesis/1.1.2/README.md

@@ -0,0 +1,137 @@
+# Contributions welcome
+
+All contributions (no matter if small) are always welcome.
+
+To see how you can help and where to start [see Contributing file](CONTRIBUTING.md).
+
+# The `modern-hsh-thesis` Package
+<div align="center">Version 1.1.2</div>
+
+A template for writing a bachelors or masters thesis at the Hochschule Hannover, Faculty 4.
+
+## Getting Started
+
+### WebApp
+Choose the template in the typst web app and follow the instructions there.
+
+### Terminal
+```bash
+typst init @preview/modern-hsh-thesis:1.1.2
+```
+
+### Import
+```typ
+#import "@preview/modern-hsh-thesis:1.1.2": *
+
+#show: project.with(
+  title: "Beispiel-Titel",
+  subtitle: "Bachelorarbeit im Studiengang Mediendesigninformatik",
+  author: "Vorname Nachname",
+  author_email: "vorname@nachname.tld",
+  matrikelnummer: 1234567,
+  prof: [
+    Prof. Dr. Vorname Nachname\
+    Abteilung Informatik, Fakultät IV\
+    Hochschule Hannover\    
+    #link("mailto:vorname.nachname@hs-hannover.de")
+
+  ],
+  second_prof: [
+    Prof. Dr. Vorname Nachname\
+    Abteilung Informatik, Fakultät IV\
+    Hochschule Hannover\    
+    #link("mailto:vorname.nachname@hs-hannover.de")
+  ],
+  date: "01. August 2024",
+  glossaryColumns: 1,
+  bibliography: bibliography(("sources.bib", "sources.yaml"), style: "institute-of-electrical-and-electronics-engineers", title: "Literaturverzeichnis")
+)
+```
+
+#### Import parameter
+While subtitle, author and many more parameters are self-explanatory, some parameters require additional context to understand their full meaning and usage. 
+
+##### Parameter `title` (optional, String or Fragment)
+The title of the thesis. This can be a string or content. \
+Content is useful if you want to use a custom size or color for the title. \
+Usage for content:
+```typ
+title: [
+    #text(weight: "semibold")[Example-Title]
+  ],
+```
+
+##### Parameter `chapter-break-mode` (optional, String)
+"**default**": Ensures each chapter begins on a left-hand page, potentially inserting an additional blank page if necessary \
+"**recto**": Ensures each chapter begins on a right-hand (recto) page, potentially inserting an additional blank page if necessary \
+"**next-page**": Forces a page break before starting each new chapter
+"**none**": Chapters continue on the current page without interruption
+
+##### Parameter `custom-declaration-of-independence` (optional, String)
+A custom declaration of independence. If not provided, the default declaration will be used.
+
+##### Parameter `justify-title` (optional, boolean, default:true)
+Can be used to disable the justification of the title. Helpful for long titles.
+
+#### Parameter `custom-logo1`, `custom-logo2` (optional, Image)
+Can be used to display custom logos on the title page. If not provided, the default logos will be used.
+Example usage:
+```typ
+  custom-logo1: image("LUH.svg", width: 26%),
+```
+
+
+### Additional functions
+`customFunctions.typ` contains additional functions that can be used in the template.
+
+`#smallLine`: A small line that can be used to separate sections.
+
+`#task`: A card that can be used to create a list of tracks (see example in 1-einleitung.typ).
+
+`#track` or `##narrowTrack`: A track that can be displayed inside a task (see example in 1-einleitung.typ).
+
+`#useCase`: Display a Use Case (see example in 1-einleitung.typ).
+
+`#attributedQuote`: Display a quote with an attribution.
+
+`#diagramFigure`, `#codeFigure`, `#imageFigure`, `#treeFigure`: Wrap an image/code/diagram/tree-list in a figure with a caption.
+
+`#imageFigureNoPad`: Display a figure without padding.
+
+`#getCurrentHeadingHydra`: Get the heading of the current page.
+
+
+
+### Development Environment
+In WebStorm make sure to open a Git Bash Console.
+0. Install Just `winget install --id Casey.Just --exact`
+1. Install Typst https://github.com/typst-community/typst-install
+2. Clone the repository
+3. CD into the repository
+4. Run `git pull && just install && just install-preview` to install/update the template
+5. Run `typst init @local/modern-hsh-thesis:1.1.2 && typst compile modern-hsh-thesis/main.typ` to compile the template
+
+
+## FAQ
+### Change Hyphenation (Silbentrennung)
+```typst
+#set text(lang: "de")
+#set text(hyphenate: true)
+```
+
+### Disable Blocksatz
+```typst
+#set par(justify: false)
+```
+
+### Disable Blocksatz for headings only
+```typst
+#show heading: it => [
+  #set par(justify: false)
+  #it
+]
+```
+
+## Additional Documentation
+
+Take a look at this complete Bachelor's thesis example using the `modern-hsh-thesis` template: [Bachelor's Thesis Example](https://github.com/MrToWy/Bachelorarbeit)