Universe
Create project in app

GitHub Repo stars GitHub Release


Industrial Systems Logo

This is the official template for a students report or project or lab report for the HEI-Vs Engineering School in Sion, Switzerland. More templates can the found in our GitHub organization

Using the template

  1. In the Typst Univers select the hei-synd-report template. Locally you can use the Typst CLI to initialise the project:

    # from the typst universe
typst init @preview/hei-synd-report:0.1.0

  2. Fill in the metadata in the metadata.typ file.

All metadata is optional, but it is recommended to fill in as much as possible. The metadata is divided into three sections: options, doc, and settings.

Metadata Type Description
options dictionary These are fixed values for the document, who doesn’t contribute to the content.
option.type string (“draft”,“final”) Type of the document. “final” will omit some text at the beginning of chapters (default: "final")
option.lang string (“en”, “fr”, “de”) Language of the document. Many element will be changed accordingly (default:"en")
doc dictionary Document metadata
doc.title content Title of the document.
doc.abbr content Abbreviation of the Title.
doc.subtitle content Subtitle of the document.
doc.url string URL for the document or project
doc.logos dictionary Dicrionary for the different logos
doc.logos.tp_topleft image Image for the topleft section of the titlepage
doc.logos.tp_topright image Image for the topright section of the titlepage
doc.logos.tp_main image Image for the main section of the titlepage
doc.logos.header image Image for the header of the document
doc.authors list of dictionary List of authors with their metadata
doc.authors.name content Name of the author
doc.authors.abbr content Abbreviation of the author
doc.authors.email string Email of the author
doc.authors.url string URL of the author
doc.school dictionary School metadata
doc.school.name content Name of the school
doc.school.major content Major of the school
doc.school.orientation content Orientation of the school
doc.school.url string URL of the school
doc.course dictionary Course metadata
doc.course.name content Name of the course
doc.course.url string URL of the course
doc.course.prof content Name of the professor
doc.course.class content Class of the course
doc.course.semester content Semester of the course
doc.keywords list of string Keywords for the document
doc.version content Version of the document
date datetime Date of the document (default: datetime.today()
tableof dictionary Table of … settings for the document
tableof.toc boolean Create table of contents (default: true)
tableof.tof boolean Create table of figures (default: false)
tableof.tot boolean Create table of tables (default: false)
tableof.tol boolean Create table of listings (default: false)
tableof.toe boolean Create table of equations (default: false)
tableof.maxdepth integer Max depth of the table of contents (default: 3)
gloss boolean Create glossary and acronyms (default: true)
appendix boolean Create appendix (default: false)
bib dictionary Bibliography settings for the document
bib.display boolean Display bibliography (default: true)
bib.path string Path to the bibliography file (default: "/tail/bibliography.bib")
bib.style string Style of the bibliography (default: "ieee")
  1. Write your content in the report.typ file as well as the other files in the main folder.

Usage

In order to build the Typst document locally you can use one of the following command:

# Create pdf
typst compile report.typ

# Create pdf and watch for changes
typst watch report.typ

Features

  • [x] All metadata is optional
  • [x] Title page
  • [x] Table of contents
  • [x] Table of figures
  • [x] Table of tables
  • [x] Table of listings
  • [x] Table of equations
  • [x] Custom Boxes
  • [x] Sourcecode with codelst
  • [x] Glossary and Acronyms with Glossarium
  • [x] Bibliography
  • [x] Draft and Final Typesetting
  • [x] Content help
    • [x] Introduction
    • [x] Specification
    • [x] Design
    • [x] Implementation
    • [x] Validation
    • [x] Conclusion
  • [ ] Wavedrom diagrams
  • [ ] PlantUML diagrams

Help

If you need help writting your document look at the Typst documentation or if ou need more help with the template specifics look at the document Guide-to-Typst.

Contributing

If you would like to contribute to any of the repositories in this organization, please follow these steps:

  1. Fork the repository you want to contribute to.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with conventional commit messages.
  4. Push your branch to your forked repository.
  5. Open a pull request in the original repository and describe your changes.

Issues and Support

If you encounter any issues or have questions regarding the course or any of the repositories, please feel free to open an issue in the respective repository. Our team will be happy to assist you.

Changelog

All notable changes to this project are documented in the CHANGELOG.md file.

Find us on

hevs.ch  ·  LinkedIn HEI-Vs  ·  LinkedIn HES-SO Valais-Wallis  ·  Youtube HES-SO Valais-Wallis Twitter @hessovalais  ·  Facebook @hessovalais  ·