This is an official template for students reports for the ISC degree programme at the School of engineering in Sion. An example of the generated output can be accessed here.
In the Typst web application, start with the isc-hei-report and voilà ! Using the CLI, you can initialize the project with the command :
typst init @preview/isc-hei-report:0.1.5This template will initialize an sample report with sensible default values.
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.shfrom within the fonts directory.
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.typEven nicer, the following command compiles the report every time the file is modified.
typst watch report.typAnother nice possibility is of course to use a VScod[e | ium] via the Typst LSP plugin which enables direct compilation.
In the future, several things might be updated, such as :
- State diagrams and UML diagrams examples
- Glossary inclusion
- Master thesis version of this template
- Themes for code
- Other nice things
- Appendix
- Acronyms inclusion
- 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!