Universe

Create project in app

GitHub Repo stars GitHub Release License

This is the official templates for reports and bachelors thesis for the ISC degree programme at the School of engineering in Sion.

An example of a generated report can be accessed here. An example of a generated bachelor theis can be accessed here.

Using the template, on the Web

In the Typst web application, start with the isc-hei-report and voilà !

Using the template in your shell

First start by installing Typst on your machine. You can then initialize the project with the command :

typst init @preview/isc-hei-report

This template will initialize an sample report with sensible default values.

For the latest template for a bachelor thesis, use:

typst init @preview/isc-hei-bthesis

or if you need a specific version, use:

typst init @preview/isc-hei-bthesis:0.5.0

Installing fonts locally

If you are running typst locally, you might miss some of the required fonts. For your convenience, a font download script is included in this repos. As all the fonts are released under the SIL Open Font License, there are no file inclusion issues here.

To the install the fonts locally in a Linux environment, simply type

source install_fonts.sh

from within the fonts directory.

PDF images inclusion

Unfortunately, typst does not support PDF file types inclusion at the time of writing this documentation. As a temporary workaround, PDF files can be converted to SVG via pdf2svg.

When used locally, creating a PDF is straightforward with the command

typst compile report.typ

Even nicer, the following command compiles the report every time the file is modified.

typst watch report.typ

Another nice possibility is of course to use VScod(e | ium) via the Typst LSP plugin which enables direct compilation.

In the future, several things might be updated, such as :

  • [x] Cleaning-up of user experience when writing a thesis or a report
  • [x] Master thesis version of this template
  • [x] Glossary inclusion
  • [x] Themes for code
  • [x] Appendix
  • [x] Acronyms inclusion
  • [x] Basic support for including code files

If you need any help for installing or running those tools, do not hesitate to get in touch with its maintainer pmudry.

You can of course also propose changes using PR or raise issues if something is not clear. Have fun writing reports!