isc-hei / isc-hei-report Goto Github PK

View Code? Open in Web Editor NEW

6.0 2.0 2.0 13.07 MB

A typst template for reports in the ISC @ HEI curricula

Home Page: https://isc.hevs.ch

License: MIT License

TeX 17.78% Shell 1.96% Typst 78.53% Scala 1.73%

computer-science-education engineering report teaching typst-template

isc-hei-report's Introduction

ISC report template 📜

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.

Using the template

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.5

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

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.

Usage

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 a VScod[e | ium] via the Typst LSP plugin which enables direct compilation.

Future changes

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

Questions and help

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!

isc-hei-report's People

Contributors

Stargazers

Watchers

Forkers

madeinshinea lordbaryhobal

isc-hei-report's Issues

Translatable resources

It could be a good idea to add some automatic values depending on the language. This could be done by setting the default value to auto and using a dictionary of translatable words.

For example:

#let langs = (
  fr: (
    toc-title: "Table des matières"
  ),
  en: (
    toc-title: "Table of contents"
  )
)

#let i18n(lang, key) = {
  if not lang in langs {
    lang = "fr"
  }
  let keys = langs.at(lang)
  if not key in keys {
    panic("I18n key " + key + "doesn't exist")
  }
  return keys.at(key)
}

#let project(
  toc-title: auto
) = {
  if toc-title == auto {
    toc-title = i18n(language, "toc-title")
  }
}

Originally posted by @LordBaryhobal in #6 (comment)

Markdown in caption not working

#figure( 
  sourcecode()[
  ```scala 
  def foo(val a : Any) : Int = { 
    a match :  
      case a: Int  => 12
      case _ => 42
  }  
  ```],
  caption: "Un tout petit listing en `Scala`"
)

The Scala in the caption is rendered as is and not interpreted as real markdown. It seems hard to use eval for the caption itself (or I don't know how to do it right now).

Using #import "@preview/pintorita:0.1.1" for instance ?
UML class diagram and other schemas
State machines and time charts
....
Document and make an example

ISC master thesis template

Should we make a different repos ? Probably
Should take inspiration from Silvan's work from EPFL

Font not correct by default

Should add #set text(font: "Source Sans Pro")

Example for code inclusion in the template itself in appendix

Comment and add as example

#let text = read("test.scala")
#figure(
    sourcecode()[
      #raw(text, lang: "scala")
    ],
  caption: "Code included from the file test.scala, which is cool"
)