rapport-labo-hes-so:0.1.0#4675
Conversation
amaurywailliez2005
temporarily deployed
to
Package Check
GitHub Actions
Inactive
amaurywailliez2005
temporarily deployed
to
Package Check
GitHub Actions
Inactive
amaurywailliez2005
temporarily deployed
to
Package Check
GitHub Actions
Inactive
|
Description: While there are existing generic templates, this one aims to provide a fully featured, ready-to-use environment for French-speaking engineering students. Key features include: A standardized, highly customizable cover page (supporting up to 5 authors and 3 professors). Built-in utility boxes (info, warning, success, error, todo) for structured content. Pre-configured formatting for code blocks with line numbers. Native integration for glossaries and acronyms (@preview/glossarium). Easy inclusion of external PDF annexes. This template has been thoroughly tested locally and is designed to significantly reduce the time students spend on formatting, allowing them to focus on their scientific content. All automated checks (typst.toml format, thumbnail size, kebab-case naming conventions) have been addressed and are now passing. Thank you for your time and for reviewing this submission! |
elegaanz
left a comment
elegaanz
left a comment
There was a problem hiding this comment.
Thank you for this template, I have left some remarks, mostly about package/template structure and separation. If you struggle to understand how it is supposed to look like, I would recommend looking at other templates and how they are built. We can also discuss it if you have specific questions (in English or French if that's more comfortable for you).
|
|
||
| Tous les changements importants du projet sont documentés dans ce fichier. | ||
|
|
||
| ## [2.0.0] - 2026-04-20 |
There was a problem hiding this comment.
The versions here don't match what's in the typst.toml, is that intentional?
|
|
||
| // FONCTION UTILITAIRE: Insérer une annexe (PDF/Figure) | ||
| #let pdf(nom-fichier, titre, debut: 1, fin: 1, etiquette: none) = { | ||
| let chemin = "../template/src/assets/PDF/" + nom-fichier |
There was a problem hiding this comment.
This won't work, package can only read their own files, not user supplied files. Instead you should take an image(…) as parameter directly, instead of a path. See https://github.com/typst/packages/blob/main/docs/resources.md#paths-are-package-scoped
| // BIBLIOGRAPHIE | ||
| #if config.afficher-bibliographie == true { | ||
| bibliography( | ||
| "../template/src/settings/refs.bib", |
There was a problem hiding this comment.
Same here, this won't work properly: it will always read the version of the file that ships with the package, not the copy that will be made to the user project, so their edits won't be reflected.
There was a problem hiding this comment.
I'm not convinced that it is a good idea to have both this file and main.typ ship with the template. I would pick either of those and remove the other one.
| #import "template/src/settings/name.typ": * | ||
| #import "template/src/settings/glossaire.typ": mes-acronymes |
There was a problem hiding this comment.
The package is not supposed to export definitions from the template directory. Either those files are supposed to be edited by the user, in which case they should be part of the template only and their contents should be passed as arguments to the template function(s), or they are not supposed to be changed by the user, in which case the files should be moved outside of the template directory.
|
|
||
| ## 🚀 Démarrage rapide | ||
|
|
||
| ### 1. Structure du projet |
There was a problem hiding this comment.
This section is not super relevant to people reading the package documentation on Typst Universe, as their project will only contain a copy of the template directory. I would suggest removing it or moving it to CONTRIBUTING.md where it will be more helpful.
| @@ -0,0 +1,22 @@ | |||
| [package] | |||
| name = "rapport-labo-hes-so" | |||
There was a problem hiding this comment.
If this isn't an official package of the university, could you pick another name please? It should be distinctive enough so that another package with the same purpose can be published without one of the two having an unfair advantage, and it should be clear from the name that it is community-built and not officially endorsed by the university. See our naming rules.
If you want to make this an official template, to keep the current name, that's also an option. In that case a member of the University staff should send an email to hello@typst.app stating that they officially endorse your package. In practice it means that they will accept submission of works built using it, and ideally promote it and guarantee that it will be maintained in the long term.
| @@ -0,0 +1,170 @@ | |||
| # 📋 Modèle de Rapport HES-SO avec Typst | |||
|
|
|||
| Un template professionnel et complet pour créer des rapports de laboratoire avec **Typst**, optimisé pour HES-SO. | |||
There was a problem hiding this comment.
It is generally appreciated to have at least the first paragraph of the README translated in English, to give an idea of what the package is about to the broader Typst community, even if the target audience speaks French.
| entrypoint = "lib.typ" | ||
| authors = [ "Amaury Wailliez" ] | ||
| license = "MIT" | ||
| description = "Modèle professionnel et complet de rapport de laboratoire pour HES-SO avec Typst" |
There was a problem hiding this comment.
Same for the description here. Having it in both languages is possible, but it should be in English if only in one language.
There was a problem hiding this comment.
Are you allowed to distribute this logo? Under which terms can it be used? Can you please check and specify this information in your README?
3 participants
I am submitting
Description: Explain what the package does and why it's useful.
I have read and followed the submission guidelines and, in particular, I
typst.tomlfile with all required keysREADME.mdwith documentation for my packageLICENSEfile or linked one in myREADME.mdexcluded PDFs or README images, if any, but not the LICENSE