forked from typst/packages
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
773 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,13 @@ | ||
| # [v0.1.3](https://github.com/npikall/vienna-tech/releases/tag/v0.1.3) | ||
| - Fixed a bug that caused the appendix label not to change when a different language was selected. | ||
|
|
||
| # [v0.1.2](https://github.com/npikall/vienna-tech/releases/tag/v0.1.2) | ||
| - Added layout customization options (font-sizes, title-page, etc.) | ||
| - Added functionality to set fonts for the document. | ||
| - Adapted code to new typst version (0.12.0) | ||
|
|
||
| # [v0.1.1](https://github.com/npikall/vienna-tech/releases/tag/v0.1.1) | ||
| - Added the possibility to exclude the table of contents from the document with `toc: false` in the configuration. | ||
|
|
||
| # [v0.1.0](https://github.com/npikall/vienna-tech/releases/tag/v0.1.0) | ||
| Initial Release |
This file contains 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,24 @@ | ||
| This is free and unencumbered software released into the public domain. | ||
|
|
||
| Anyone is free to copy, modify, publish, use, compile, sell, or | ||
| distribute this software, either in source code form or as a compiled | ||
| binary, for any purpose, commercial or non-commercial, and by any | ||
| means. | ||
|
|
||
| In jurisdictions that recognize copyright laws, the author or authors | ||
| of this software dedicate any and all copyright interest in the | ||
| software to the public domain. We make this dedication for the benefit | ||
| of the public at large and to the detriment of our heirs and | ||
| successors. We intend this dedication to be an overt act of | ||
| relinquishment in perpetuity of all present and future rights to this | ||
| software under copyright law. | ||
|
|
||
| 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 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. | ||
|
|
||
| For more information, please refer to <http://unlicense.org/> |
This file contains 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,77 @@ | ||
| # The `vienna-tech` Template | ||
| <div align="center">Version 0.1.3</div> | ||
|
|
||
| This is a template, modeled after the LaTeX template provided by the Vienna University of Technology for Engineering Students. It is intended to be used as a starting point for writing Bachelor's or Master's theses, but can be adapted for other purposes as well. It shall be noted that this template is not an official template provided by the Vienna University of Technology, but rather a personal effort to provide a similar template in a new typesetting system. If you want to checkout the original templates visit the website of [TU Wien](https://www.tuwien.at/cee/edvlabor/lehre/vorlagen) | ||
|
|
||
|
|
||
| ## Getting Started | ||
|
|
||
| These instructions will help you set up the template on the typst web app. | ||
|
|
||
| ```typ | ||
| #import "@preview/vienna-tech:0.1.3": * | ||
| // Useing the configuration | ||
| #show: tuw-thesis.with( | ||
| title: [Titel of the Thesis], | ||
| thesis-type: [Bachelorthesis], | ||
| lang: "de", | ||
| authors: ( | ||
| ( | ||
| name: "Firstname Lastname", | ||
| email: "[email protected]", | ||
| matrnr: "12345678", | ||
| date: datetime.today().display("[day] [month repr:long] [year]"), | ||
| ), | ||
| ), | ||
| abstract: [The Abstract of the Thesis], | ||
| bibliography: bibliography("bibliography.bib"), | ||
| appendix: [The Appendix of the Thesis], | ||
| ) | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| All the available options that are available for the template are listed below. | ||
|
|
||
| | Parameter | Type | Description | | ||
| |---------------------|----------------------------------------|-------------------------------------------------------------------------------------------------------| | ||
| | `title` | `content` | Title of the thesis. | | ||
| | `thesis-type` | `content` | Type of thesis (e.g., Bachelor's thesis, Master's thesis). | | ||
| | `authors` | `content`; `string`; `array` | Name of the author(s) as text or array. | | ||
| | `abstract` | `content` | Abstract of the thesis. | | ||
| | `papersize` | `string` | Paper size (e.g., A4, Letter). | | ||
| | `bibliography` | `bibliography` | Bibliography section. | | ||
| | `lang` | `string` | Language of the thesis (e.g., "en" for English, "de" for German). | | ||
| | `appendix` | `content` | Appendix of the thesis. | | ||
| | `toc` | `bool` | Show table of contents (`true` or `false`). | | ||
| | `font-size` | `length` | Font size for the main text. | | ||
| | `main-font` | `string`; `array` | Main font as a name or an array of font names. | | ||
| | `title-font` | `string`; `array` | Font for the title as a name or an array of font names. | | ||
| | `raw-font` | `string`; `array` | Font for specific text as a name or an array of font names. | | ||
| | `title-page` | `content` | Content of the title page. | | ||
| | `paper-margins` | `auto`; `relative`; `dictionary` | Margins of the document. Can be set as automatic, relative, or defined by a dictionary. | | ||
| | `title-hyphenation` | `auto`; `bool` | Title hyphenation, either automatic (`auto`) or manual (`true` or `false`). | | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| These instructions will get you a copy of the project up and running on the typst web app. | ||
|
|
||
| ```bash | ||
| typst init @preview/vienna-tech:0.1.3 | ||
| ``` | ||
|
|
||
| ### Template overview | ||
|
|
||
| After setting up the template, you will have the following files: | ||
|
|
||
| - `main.typ`: the file which is used to compile the document | ||
| - `abstract.typ`: a file where you can put your abstract text | ||
| - `appendix.typ`: a file where you can put your appendix text | ||
| - `sections.typ`: a file which can include all your contents | ||
| - `refs.bib`: references | ||
|
|
||
| ## Contribute to the template | ||
|
|
||
| Feel free to contribute to the template by opening a pull request. If you have any questions, feel free to open an issue. |
Oops, something went wrong.