Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/preview/heh-template/1.0.0/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
*.pdf
!manuel.pdf
!demo_presentation.pdf

88 changes: 88 additions & 0 deletions packages/preview/heh-template/1.0.0/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Code de conduite _Contributor Covenant_

## Prélude

Ce code de conduite est dérivé du [contributor covenant v2.0](https://www.contributor-covenant.org) et adapté pour le dépot dépendant de la haute école. En plus des règles présentes ci-dessous, veuillez également prendre en compte le règlement d'ordre intérieur qui doit être appliqué à ce dépot.

## Notre engagement

En tant que membres, contributeur·trice·s et dirigeant·e·s, nous nous engageons à faire de la participation à notre communauté une expérience sans harcèlement, quel que soit l'âge, la taille corporelle, le handicap visible ou invisible, l'appartenance ethnique, les caractéristiques sexuelles, l'identité et l'expression de genre, le niveau d'expérience, l'éducation, le statut socio-économique, la nationalité, l'apparence personnelle, la race, la religion, ou l'identité et l'orientation sexuelle.

Nous nous engageons à agir et interagir de manière à contribuer à une communauté ouverte, accueillante, diversifiée, inclusive et saine.

## Nos critères

Exemples de comportements qui contribuent à créer un environnement positif :

* Faire preuve d'empathie et de bienveillance envers les autres
* Être respectueux des opinions, points de vue et expériences divergents
* Donner et recevoir avec grâce les critiques constructives
* Assumer ses responsabilités et s'excuser auprès des personnes affectées par nos erreurs et apprendre de ces expériences
* Se concentrer sur ce qui est le meilleur non pas uniquement pour nous en tant qu'individu, mais aussi pour l'ensemble de la communauté

Exemples de comportements inacceptables :

* L'utilisation de langage ou d'images sexualisés et d'attentions ou d'avances sexuelles de toute nature
* Le _trolling_, les commentaires insultants ou désobligeants et les attaques personnelles ou d'ordre politique
* Le harcèlement en public ou en privé
* La publication d'informations privées d'autrui, telle qu'une adresse postale ou une adresse électronique, sans leur autorisation explicite
* Toute autre conduite qui pourrait raisonnablement être considérée comme inappropriée dans un cadre professionnel

## Responsabilités d'application

Les dirigeant·e·s de la communauté sont chargé·e·s de clarifier et de faire respecter nos normes de comportements acceptables et prendront des mesures correctives appropriées et équitables en réponse à tout comportement qu'ils ou elles jugent inapproprié, menaçant, offensant ou nuisible.

Les dirigeant·e·s de la communauté ont le droit et la responsabilité de supprimer, modifier ou rejeter les commentaires, les contributions, le code, les modifications de wikis, les rapports d'incidents ou de bogues et autres contributions qui ne sont pas alignés sur ce code de conduite, et communiqueront les raisons des décisions de modération le cas échéant.

## Portée d'application

Ce code de conduite s'applique à la fois au sein des espaces du projet ainsi que dans les espaces publics lorsqu'un individu représente officiellement le projet ou sa communauté. Font parties des exemples de représentation d'un projet ou d'une communauté l'utilisation d'une adresse électronique officielle, la publication sur les réseaux sociaux à l'aide d'un compte officiel ou le fait d'agir en tant que représentant·e désigné·e lors d'un événement en ligne ou hors-ligne.

## Application

Les cas de comportements abusifs, harcelants ou tout autre comportement inacceptables peuvent être signalés aux personnes reponsables du dépôt heh-template. Toutes les plaintes seront examinées et feront l'objet d'une enquête rapide et équitable.

Tou·te·s les dirigeant·e·s de la communauté sont tenu·e·s de respecter la vie privée et la sécurité des personnes ayant signalé un incident.

## Directives d'application

Les dirigeant·e·s de communauté suivront ces directives d'application sur l'impact communautaire afin de déterminer les conséquences de toute action qu'ils jugent contraire au présent code de conduite :

### 1. Correction

**Impact communautaire** : utilisation d'un langage inapproprié ou tout autre comportement jugé non professionnel ou indésirable dans la communauté.

**Conséquence** : un avertissement écrit et privé de la part des dirigeant·e·s de la communauté, clarifiant la nature du non-respect et expliquant pourquoi le comportement était inapproprié. Des excuses publiques peuvent être demandées.

### 2. Avertissement

**Impact communautaire** : un non-respect par un seul incident ou une série d'actions.

**Conséquence** : un avertissement avec des conséquences dû à la poursuite du comportement. Aucune interaction avec les personnes concernées, y compris l'interaction non sollicitée avec celles et ceux qui sont chargé·e·s de l'application de ce code de conduite, pendant une période déterminée. Cela comprend le fait d'éviter les interactions dans les espaces communautaires ainsi que sur les canaux externes comme les médias sociaux. Le non-respect de ces conditions peut entraîner un bannissement temporaire ou permanent.

### 3. Bannissement temporaire

**Impact communautaire** : un non-respect grave des normes communautaires, notamment un comportement inapproprié soutenu.

**Conséquence** : un bannissement temporaire de toutes formes d'interactions ou de communications avec la communauté pendant une période déterminée. Aucune interaction publique ou privée avec les personnes concernées, y compris les interactions non sollicitées avec celles et ceux qui appliquent ce code de conduite, n'est autorisée pendant cette période. Le non-respect de ces conditions peut entraîner un bannissement permanent.

### 4. Bannissement permanent

**Impact communautaire** : démontrer un schéma récurrent de non-respect des normes de la communauté y compris un comportement inapproprié soutenu, le harcèlement d'un individu ainsi que l'agression ou le dénigrement de catégories d'individus.

**Conséquence** : un bannissement permanent de toutes formes d'interactions publiques au sein de la communauté.

## Attributions

Ce code de conduite est adapté du [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, disponible à [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].

Les Directives d'application ont été inspirées par le [Code of conduct enforcement ladder][Mozilla CoC] de Mozilla.

Pour obtenir des réponses aux questions courantes sur ce code de conduite, consultez la FAQ à [https://www.contributor-covenant.org/faq][FAQ]. Les traductions sont disponibles sur [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

24 changes: 24 additions & 0 deletions packages/preview/heh-template/1.0.0/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Contribuer à typst-template

Premièrement, merci de prendre le temps de contribuer à ce dépot.

Toutes les contributions, peu importe leur taille sont les bienvenues. Ce document a pour but de faciliter le processus de contribution et la maintenance du dépot en définissant les **prérequis à respecter** en créant une pull request. Il est donc essentiel de prendre connaissance du contenu de ce document **avant** de contribuer

## Rapports de bugs / suggestion de fonctionalités

Pour signaler des problèmes ou suggérer des fonctionnalités, nous utilisons les **issues** de GitHub. Avant de faire une demande, assurez vous qu'une autre issue concernant le même problème ou contenant la même demande **n'est pas déjà ouverte**.

Si une issue existe déjà, vous pouvez éventuellement y contribuer en y ajoutant des **informations supplémentaires** dans le cas d'un rapport de bug (exemple: préciser depuis quand vous avez le problème si personne d'autre ne l'a fait). Dans le cas d'une demande de fonctionnalités, vous pouvez simplement **réagir avec un :+1: pour montrer votre support**

## Contribuer au code

Si vous souhaitez contribuer au code (résoudre un bug, ajouter une fonctionalité, ...), nous vous demandons de faire une **pull request** sur GitHub.

Premièrement, faites attention à bien respecter notre **convention de commit** qui est basée sur les [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). Nous utilisons le formattage suivant `type(cible (optionnel)): message en français` ou le `type` vient des conventional commits et est en anglais

**Avant** d'envoyer la PR, il est impératif de tester le code en compilant le manuel et la démo et en vérifiant que **tous** les éléments s'affichent correctemnt

Nous vous demandons aussi de formatter le code avec `just fmt` et de suivre les pratiques de style indiquées dans [STYLE.md](STYLE.md)

Bien sûr, si vous avez une hésitation sur comment implémenter une fonctionnalité / formatter votre code / ..., n'hésitez pas à soumettre la pull request et poser les questions nécéssaires, le but n'étant pas non plus de freiner les contributions.

52 changes: 52 additions & 0 deletions packages/preview/heh-template/1.0.0/Justfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
demo_file := "manuel.typ"
demo_presentation_file := "demo_presentation.typ"

alias b := build-manuel
alias w := watch-manuel

alias bm := build-monochrome
alias wm := watch-monochrome

alias bp := build-presentation
alias wp := watch-presentation

alias bmp := build-monochrome-presentation
alias wmp := watch-monochrome-presentation

alias fmt := format

# Créer le PDF de démonstration (manuel)
build-manuel:
typst compile {{ demo_file }}

# Compile le pdf de démonstration (manuel) à chaque changement
watch-manuel:
typst watch {{ demo_file }}

# Créer le manuel PDF en monochrome
build-monochrome:
typst compile --input monochrome=true {{ demo_file }}

# Compile le PDF monochrome a chaque changement
watch-monochrome:
typst watch --input monochrome=true {{ demo_file }}

# Créer le PDF la présentation de démonstration
build-presentation:
typst compile {{ demo_presentation_file }}

# Créer le PDF la présentation de démonstration à chaque changement
watch-presentation:
typst watch {{ demo_presentation_file }}

# Créer le PDF la présentation de démonstration en monochrome
build-monochrome-presentation:
typst compile --input monochrome=true {{ demo_presentation_file }}

# Créer le PDF la présentation de démonstration monochrome a chaque changement
watch-monochrome-presentation:
typst watch --input monochrome=true {{ demo_presentation_file }}

# Formatte le code avec typstyle
format:
typstyle -i .
7 changes: 7 additions & 0 deletions packages/preview/heh-template/1.0.0/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright (c) 2026 Haute École en Hainaut

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
68 changes: 68 additions & 0 deletions packages/preview/heh-template/1.0.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
![Template de documents HEH. Fait par des étudiant.e.s pour des Étudiant.e.s](meta/banner.svg)

Le projet HEH typst a pour objectif de simplifier la rédaction de rapports, document et cours aux sein de la HEH que ce soit pour les étudiants ou les élèves.

Le projet prend la forme d'un package [typst](https://typst.app/) multi-fonction.

### Table des matières
1. [Contenus](#contenus)
2. [Utilisation](#utilisation)
3. [Contribution](#contribution)
4. [License](#license)

## Contenus

Le package heh-template comprend les éléments suivants :
- Deux templates de document (rapport et tfe)
- Un template de présentation
- Une librarie de composants complète (font, boite, tableaux, mise ne page)

![Deux templates de document. Un template de présentation. Librarie complète](meta/whatisincluded.svg)

Les templates gèrent automatiquement la mise en forme et la coloration des différents éléments selon le campus, le tout étant modulaire et s'adaptant automatiquement aux paramètres du template.

La librairie de composants dispose des éléments suivants:
- Des tableaux modulaires
- Des boites informatives
- Contextes d'environnement spécifique au campus
- Dites-nous ce qu'ont pourrait ajouter! (ou [contribuez](#contribution)!)

![Des tableaux modulaires. Des voxes informatives. S'adapte aux campus!](meta/components.svg)

## Utilisation

Pour commencer, vous devez avoir Typst `v0.15.x` ou une version supérieur afin d'être sur que la librairie puisse fonctionner. Il est également vivement conseilé de comprendre au moins le base de la rédaction de document en [typst](https://typst.app/).

Pour utiliser le package, vous n'avez qu'a ajouter la ligne `#import "@preview/heh-template:1.0.0"` en haut de n'importe quel fichier .typ

Pour créer un document simple il suffit d'instancier le template de document avec les paramètres suivants:
```typst
#import "@preview/heh-template:1.0.0": heh-document, campus, config

// Appel du template en utilisant le style du département technique (DST)
#show: heh-document.with(
campus-config-fn: campus.dst-config,
document-config-fn: config.default-document-config
)

= Premier titre
```

Vous pouvez choisir votre campus an changent la valeur de `campus.dst-config` par les valeurs suivantes:
- `campus.dss-ms-config` Pour le Département des Sciences Sociales de Mons.
- `campus.dss-to-config` Pour le Département des Sciences Sociales de Tournai.
- `campus.dsee-to-config` Pour le Département des Sciences de l'Éducation et de l'Enseignement de Tournai.
- `campus.dsee-ms-config` Pour le Département des Sciences de l'Éducation et de l'Enseignement de Mons.
- `campus.deco-config` Pour le Département des Sciences Juridiques, Éconnomique et gestion.
- `campus.dst-config` Pour le Département des Sciences et Technologies.

Avec ceci, vous devriez avoir ce qu'il vous faut pour commencer, mais il est important de noter que le template regorge de bien plus de fonctionnalités que ça! Si vous voulez en savoir plus sur comment personnaliser votre documents, comment utiliser les tableaux, boites, le template de TFE et de présentation, jetez un coup d'œil au [manuel d'utilisation](manuel.pdf)!

## Contribution
Toutes contribution est la bienvenue afin de souvetenir le projet HEH template!
Cepandant avant de vous lancer dans le bain, jetez un œil au [règles de contribution](CONTRIBUTING.md) et au [code de conduite](CODE_OF_CONDUCT.md) de notre communauté.

Également, ce répertoire est soumis au règlement d'ordre intérieur de la Haute École en Hainaut et tout manquement a celui-ci peut avoir des répercution au sein de l'établissement.

## License
Le projet HEH Typst est sous la license [MIT](LICENSE.md) à l'exception des différents logos de la HEH qui eux sont la propriété de la [Haute École en Hainaut](https://HEH.be).
47 changes: 47 additions & 0 deletions packages/preview/heh-template/1.0.0/STYLE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Règles de formatage - template HEH Typst

Les règles suivantes sont **complémentaires** au style par défaut appliqué par `typststyle`. Pour appliquer automatiquement le style de `typstyle`, utilisez la commande `just format`

## Règles de base

### Indentation

- Le code est indenté avec une longeur de **2 espaces**
- Les variables et noms de fonctions utilisent la convention **kebab-case**
- Les blocs (`()`, `{}`, `[]`, ...) doivent être indentés selon la hiérarchie du document

### Longeur des lignes

- Maximum de 100 charactères par ligne

### Espacement

- Tout les variables, opérateurs, et blocs sont **entourés d'un espace**. Par exemple, on écrira `200px + 200px` au lieu de `200px+200px`.
- Les virgules ne sont **pas précédées d'un espace**
- Les virgules qui ne constituent **pas la fin de la ligne sont succédées par un espace**

## Blocs

- L'accolade ouvrante **peut se situer sur la même ligne**
- L'accolade fermante doit se trouver sur **sa propre ligne**
- Les fonctions et les blocs de contenu ne contenant qu'une ligne ne **doivent pas utiliser d'accolades**
- Si un bloc est quasiment composé exclusivement de code et **d'un peu de markup**, il vaut mieux utiliser **un bloc de code**

## Fonctions et appels de fonction

- Les valeurs par défaut des paramètres d'une fonction **doivent être utiles pour la compréhension du code si nécéssaire**
- Si la ligne des paramètres est trop longue, les paramètres peuvent être listées sur plusieurs lignes (un paramètre par ligne)
- Le raccourci `#function(params)[content]` **devrait** être utilisé uniquement si il n'y a pas de `params`, par exemeple pour `#function[content]`. Dans les autres cas, la syntaxe `#function(params, content)` **devrait** être utilisée

## Conditions, boucles, ...

- Les paramètres doivent être **espacés** d'un espace si ils sont mis entre paranthèses

## Commentaires

- Les commentaires **doivent** être placés au dessus du code qu'ils concernent

## Fichiers

- Les fichiers **doivent** être terminés par une ligne vide

3 changes: 3 additions & 0 deletions packages/preview/heh-template/1.0.0/assets/icons/address.vsvg
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M16 1C21.5227 1 25.9998 5.52443 26 11.1057C26 12.2535 25.8073 13.3559 25.4585 14.3842C25.2216 15.2282 20.2102 25.0612 17.7338 29.8723C17.0569 31.3759 14.9432 31.3759 14.2662 29.8723C11.7882 25.0668 6.71801 15.3573 6.47585 14.4748C6.13365 13.4554 6 12.2419 6 11.1057C6.0002 5.52443 10.4773 1 16 1ZM16 6.15629C12.9875 6.15629 10.5455 8.67471 10.5455 11.7813C10.5455 14.888 12.9875 17.4064 16 17.4064C19.0125 17.4064 21.4545 14.888 21.4545 11.7813C21.4545 8.67471 19.0125 6.15629 16 6.15629Z" fill="{color}"/>
</svg>
Loading
Loading