g-roch / heig-tb-template

Modele de rapport en LaTeX pour le TB à l'HEIG

Travail de Bachelor de ...

• Ce dépôt git contient un template QUI N'EST PAS FINI
• Les issues et pull-request sont les bienvenues, merci beaucoup

Fonctionnalité

• Modèle de rapport de TB
• Construction de PDF indiquant les différances entre 2 commits.
• Construction uniquement d'un sous-fichier LaTeX.
• Indication du tag git de version (v[0-9]*) dans le PDF.
• Auto publication de pre-release lors du push sur main.
• Auto publication de release lors du push sur avec un tag de version.

Dépendance

Rapport

Le paquet texlive-full (sous Debian/Ubuntu) contient toutes les dépendences. Une installation plus spécifique peut fonctionner aussi, mais n'est pas documenté.

Le Makefile utilise les programmes suivants (doivent être dans le path) :

• find
• latexdiff et latexdiff-vc
• sed
• make
• latexmk
• zip

La construction peut également se faire à travers un container docker, grâce au scipt make-on-docker.sh qui remplace la commande make dans les examples suivants. (Seul docker est une dépendance dans ce cas)

Construction

Rapport

Attention la construction dépends dur dépôt git, voir section Dépôt git

Pour construire tout le rapport:

make report

Pour construire tout les PDFs de base:

make pdf

Pour automatiquement reconstruire le rapport lorsqu'un fichier change:

cd latex && make report.pdf.pvc

Pour construire juste une sous-partie du rapport:

cd latex && make <dir>/<subfile>.pdf

avec le fichier <dir>/<subfile>.tex existant et correspondant au modele suivant :

\documentclass[report]{subfiles}
\begin{document}
  % Le contenu
\end{document}

Pour construire tout les PDFs en affichant les différences avec un commit :

make diff-<ref>

example:

make diff-main

Dépôt git

Pour que la construction fonctionne vous devez avoir un tag dans l'historique git matchant avec v[0-9]* (ex: v0.5.3 ou v2)

Branche principale à utiliser : main (pour utiliser une autre branche, adaptez les fichiers github actions)

Lors d'un push sur main, le rapport est automatiquement construit et publier dans une releases github.

Dossier

• diff-*.zip: PDF de diff avec *
• diff-*/: Construction des fichiers de différence avec * (si corresponds à *..* contient les différences entre les deux commits referencé)
• lastdiff.zip: PDF de difference avec la dernière version taggée
• lastdiff: Difference avec la dernière version taggée
• latex/*.tex: Fichier LaTeX de premier niveau
• latex/[a-zA-Z0-9]*/: Contients des subfile LaTeX (ils sont inclus dans un/des fichiers latex/*.tex
• latex/_dyn/: Contient des fichiers générée dynamiquement par make pour LaTeX
• latex/_meta.tex: Méta information à propos du TB (titre, auteur, ...)
• latex/: Contient les sources LaTeX
• latex/publishable-summary.tex: Résumé publiable (également inclue de le rapport)
• latex/report.tex: Rapport de TB
• latex/bibliography.tex: Toutes les entrées bibliographiques
• latex/bibliography-draft.tex: Toutes les entrées bibliographiques, avec les identifiants pour les citer dans LaTeX

Crédits

Les logos sont pris de https://intra.heig-vd.ch/services/communication/papeterie_logos/Pages/default.aspx . Ces logos ne sont pas libre de droit.

L'illustration d'example provient de https://www.peppercarrot.com/fr/artworks/misc.html . Elle a été crée par David Revoy et est sous CC-BY