A Typst template for students' lab reports at INSA Lyon.

Note

This template targets French students, so you may see French words here and there. Should you want to write your report in another language, there’s a workaround, see Notes.

🧭 Table of contents

1. Usage
2. Documentation
3. Notes
4. Contributing

📎 Usage

Colorful lab report template more or less aligned with guidelines guidelines issued in 1st year at INSA Lyon. It is available on Typst Universe : @preview/ttuile:0.2.0.

If you wish to use it locally, you’ll need to either manually include ttuile.typ and folder internal/ in your project’s root directory ; or upload them to the Typst web app if that’s what you use.

You’ll find these files in the releases section.

Your folder structure should then look something like this :

.
├── ttuile.typ
├── internal/
│    ├── defaults.typ
│    ├── helpers.typ
│    └── logo-insa-lyon.png
└── main.typ

The template is now ready to be used, and can be called supplying the following arguments. ? means the argument can be null if not applicable.

A single positional argument is accepted, being the report’s body.

You can call the template using the following syntax :

// Local import
// #import "ttuile.typ": *

// Universe import
#import "@preview/ttuile:0.2.0": *

#show: ttuile.with(
  // This is one way to set the headline, but the following also works :
  //  * headline: [You may supply just the title],
  //  * headline: text(fill: blue, weight: "regular")[And even style it\ however you wish],
  headline: (
    lead: [Compte rendu de TP n°1 :],
    title: [« #lorem(8) »],
  ),
  // Same as above :
  //  * authors: [You may also supply whatever you want],
  authors: (
    "Theresa Tungsten",
    "Jean Dupont",
    "Eugene Deklan",
  ),
  group: "TD0",
  footer-left: [Poste n°0],
  footer-right: datetime.today().display("[day]/[month]/[year]"),
  outlined: true,
  // Also remove the uni logo or insert your own :
  //  * logo: image("your-logo.png"),
  //  * logo: none,
)

📚 Documentation

The package ttuile.typ exposes multiple functions, find out more about them in the documentation.

To the documentation

An example file is also available in template/main.typ

🔖 Notes

• As mentioned previously, the template targets French students, so you’ll get things like Auteurs != Authors, Annexe != Appendix and such. Thankfully I didn’t cut corners there hehe, all of that can be tweaked :

  #show: ttuile.with(
    headline: [Yay, the French's all gone !],
    authors: [*Authors:* Theresa Tungsten, Jean Dupont and Eugene Deklan],
    group: "Group 1",
    // This is supposed to be the lab bench number, but you may as well put whatever in there
    footer-left: [Hello, world!],
    footer-right: datetime.today().display("[day]/[month]/[year]"),
    // You can use your own university's logotype
    logo: image("path_to/logo.png"),
  )
  
  // This will fix tables and figures
  #set text(lang: "en")
  
  // And this the appendices section
  #appendices-section(
    ...,
    headline: "Appendices",
    supplement: "Appendix",
    outline-title: "List of appendices",
  )
  

• You may also tweak heading spacing : #show heading: set block(above: 18pt, below: 5pt).
• The MIT license doesn’t apply to the file logo-insa-lyon.png, it was retrieved from INSA Lyon - éléments graphiques. It doesn’t apply either to the “INSA” branding.

🧩 Contributing

Contributions are welcome ! Parts of the template are very much spaghetti code, so if you know the proper way of achieving what I’m going for, an issue or PR would be greatly appreciated :)