elegant-polimi-thesis:0.1.1

packages/preview/elegant-polimi-thesis/0.1.1/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing
+
+If you want to test the package, you must clone the repository in the local packages folder; depending on your operating system it will be:
+
+- `$XDG_DATA_HOME` or `~/.local/share` on Linux
+- `~/Library/Application Support` on macOS
+- `%APPDATA%` on Windows
+
+Then, the structure will be `typst/packages/local/{package.name}/{package.version}` where `name` and `version` are matching the `typst.toml` file. In this project they are `elegant-polimi-thesis` and `0.1.1`.
+
+Finally, create a new project with:
+
+```shell
+typst init "@local/{package.name}:{package.version}"
+```
+
+See the [official documentation](https://github.com/typst/packages?tab=readme-ov-file#local-packages).
+
+> [!TIP]
+> Create a symlink to the location Typst needs to the location where the repository is. For instance in a Linux environment it would be:
+>
+> ```shell
+> mkdir ~/.local/share/typst/packages/local/PACKAGE.NAME
+> ln -s REPO_FOLDER \
+> ~/.local/share/typst/packages/local/PACKAGE.NAME/PACKAGE.VERSION
+> ```
+>
+> You could do the same for the `preview` namespace, will be the one used for the template on Typst Universe. There is the `symlink.sh` to account for those operations: make sure to configure the correct paths.
+> 

packages/preview/elegant-polimi-thesis/0.1.1/README.md

@@ -0,0 +1,100 @@
+# elegant-polimi-thesis 🎓
+
+Elegant and simple thesis template for [Typst](https://typst.app/), a modern typesetting program alternative to LaTeX. I based the design of the document on the following two templates:
+
+- [PhD Thesis Template](https://www.overleaf.com/latex/templates/phd-thesis-template/nwjkggvhrzmz)
+- [DEIB PhD Thesis Template](https://www.overleaf.com/latex/templates/politecnico-di-milano-deib-phd-thesis-template/ydsvtyzwxfdk)
+
+They are rather similar. The main difference is the PoliBlu colour spread across the headings. I recommend to check them out.
+
+> [!NOTE]
+> See the [manual](https://victuarvi.github.io/PoliMi-PhD-Thesis/docs/manual.pdf) for more information.
+
+## Preview ✨
+
+<p align="center">
+  <img alt="Frontspiece" src="thumbnail.png" width="45%">
+</p>
+
+## Usage 🖋
+
+Compile with:
+
+```shell
+typst c main.typ --pdf-standard a-3b
+```
+
+A very simple document:
+
+```typ
+#import "@preview/elegant-polimi-thesis:0.1.1": *
+
+#show: polimi_thesis.with(
+  title: "Thesis Title",
+  author: "Vittorio Robecchi",
+  advisor: "Prof. Donatella Sciuto",
+  coadvisor: "Prof. Antonio Capone",
+  tutor: "Prof. Marco Bramanti",
+  colored-headings: true
+)
+
+#show: frontmatter
+
+// abstract in English
+
+// sommario in Italian
+
+#show: acknowledgements
+
+// acknowledgements
+
+#toc
+#list_of_figures
+#list_of_tables
+
+#let nomenclature_ = (
+  "key" : "value"
+)
+#nomenclature(
+  nomenclature_,
+  indented: true
+)
+
+#show: mainmatter
+
+// main section of the thesis
+
+#show: backmatter
+
+// backmatter
+
+#show: appendix
+
+// appendix
+
+#show: backmatter
+
+// bibliography
+
+#show: acknowledgements
+
+// acknowlegments
+```
+
+The full list of options is as follows:
+
+- `title`: title of the thesis
+- `author`: name and surname of the author
+- `advisor`: name and surname of the advisor
+- `coadvisor`: name and surname of the coadvisor (can be empty)
+- `tutor`: name and surname of the tutor
+- `phdcycle`: PhD cycle of the thesis (defaults to current year)
+- `language`: language of the thesis
+- `colored-headings`: whether to use colored headings or not
+- `main-logo`: main logo of the thesis
+
+See the `docs/` folder for a thorough example on how to style the thesis; also have a look at `docs/docs.pdf` for the full documentation.
+
+# Contributing 🚀
+
+If you happen to have suggestions, ideas or anything else feel free to open issues and pull requests.