Ce référentiel contient un modèle de document LaTeX pour la production d'un rapport de Bachelor HEIG-VD. Il peut être adapté au besoin.
- Contexte
- Comment démarrer / Quick Start
- Utilisation
- VsCode + Docker + LaTeX Suite
- Compilation
- Prétraitement des figures
- Bibliographie
- Glossaire
- Conventions typographiques et de style
- Technologies utilisées
- Standards
- Références
- Aide et Support
Cet environnement de repose pas sur Overleaf parce que la plateforme en ligne ne permet pas la gestion des dépendances et des artefacts et qu'elle est devenue payante avec le temps. Avec une solution en ligne les figures générées à partir de scripts (Python), les illustrations faites avec draw.io et la conversion de figures (svg en pdf), ne peut pas être automatisée.
Ce modèle de document se veut simple d'accès pour les étudiantes et les étudiants de la HEIG-VD. Il peut être adapté et est libre d'utilisation.
Pour utiliser ce canevas, vous avez besoin des logiciels suivants:
Une fois ces logiciels installés et démarrés, vous devez configurer une extension pour VS Code. Elle vous permettra de faire le lien avec Docker.
Il est suggéré d'utiliser WSL2 avec la distribution Ubuntu par soucis de facilité d'utilisation.
L'environnement d'édition conseillé est l'éditeur Microsoft Visual Studio Code couplé à Docker et au Dev Containers. Ceci vous évite d'installer une distribution LaTeX. Alternativement, il est possible de travailler dans WSL.
La distribution LaTeX conseillée est TeX Live. L'alternative MiKTeX est déconseillée bien que très populaire.
Certainement l'une des plus élégante manière de développer avec LaTeX est d'utiliser Visual Studio Code avec un container POSIX contenant une distribution TeXLive.
L'éditeur couplé à LaTeX Workshop de James Yu permet une éditition fluide. Le menu commands offre l'accès à tous les outils de base. La structure (en bas à gauche) et accessible par Ctrl+Alt+X permet de naviguer facilement dans le code. Le panneau des symboles (à droite) permet l'insertion facile de caractères mathématiques.
Le fichier PDF peut être visualisé dans un navigateur Web sur un deuxième écran. SyncTeX permet de naviguer facilement de la prévisualisation au code source : Control + Clic dans le navigateur.
Vous pouvez utiliser les commandes suivantes suivi de tab:
| Commande | Font command | Description |
|---|---|---|
| FEM | \emph |
Italiques |
| FTT | \textt |
Caractères à espacement fixe |
| FSC | \textsc |
Sans Serif |
| FUL | \underline |
Souligné |
| FBF | \textbf |
Gras |
| SSE | \section |
Nouvelle section |
| SSS | \subsection |
Nouvelle sous-section |
D'autres commandes existent et sont accessibles ici.
L'éditeur de PDF Sumatra est conseillé pour visualiser votre rapport, contrairement à Adobe Acrobat, le contenu est automatiquement rafraichi une fois le rapport recompilé.
Pour bien démarrer, commencez par faire un fork du référentiel en cliquant sur le bouton Fork depuis l'interface GitHub. Ceci vous crée une copie du modèle dans votre propre organisation GitHub. Clonez ensuite le référentiel avec git clone.
Si vous n'avez pas installé VS code et Docker, vous devez les installer au préalable.
Démarrez vscode et installez l'extension Visual Studio Code Remote - Containers.
Ouvrez le dossier (CTRL+K+O), l'environnement de développement sera automatiquement démarré.
NOTE: La construction initiale du container prend beaucoup de temps car la distribution LaTeX doit être téléchargée. Vous pouvez aller boire un café.
Pour compiler le rapport exécutez simplement la commande make. Normalement, votre rapport est automatiquement compilé à chaque sauvegarde de vos modifications.
Pour retirer tous les éléments informatifs du modèle exécutez make fresh. La commande va éditer report.tex pour y retirer les textes d'information marqués par %%if..%%fi. La commande magique est :
find . -name '*.tex' -print0 | xargs -n1 -0 perl -0777 -pi -e "s/\%\%if.+?\%\%fi//gs"Pour gérer le suivi de version de votre rédaction, vous pouvez utiliser Git intégré à VisualSudio Code. L'hébergement sur GitHub couplé à l'intégration continue permet la compilation automatique de votre rapport à chaque git push. Vous recevrez un e-mail en cas de problème de compilation. Le PDF sera quant à lui disponible depuis le panneau des artefacts de GitHub Actions.
Ce modèle de document est prévu pour fonctionner avec XeTeX pour la production d'un fichier .pdf. L'outil latexmk est utilisé pour séquencer la production du document final. Un Makefile s'occupe du prétraitement des figures.
XeTeX permet de directement lire les documents encodés en UTF-8 et supporte par conséquent l'Unicode et les polices de caractères TrueType et OpenType nativement.
Les figures sont placées dans assets/figures.
Les figures au format .svg sont converties en .svg.pdf en utilisant inkscape.
Les figures au format .drawio sont converties en .drawio.pdf en utilisant la version desktop de drawio.
Les figures au format .py sont générées à l'aide de Python.
Pour chacun de ces formats un exemple est donné. L'utilisateur final est libre de modifier la logique de production de ces fichiers et d'en ajouter selon ses besoins.
Les conventions de nommage des fichiers intermédiaires sont les suivantes :
| Type | Source | Destination |
|---|---|---|
| Figure vectorielle svg | .svg |
.svg.pdf |
| Diagramme draw.io | .drawio |
.drawio.pdf |
| Figure Python | .py |
.py.pdf |
Les entrées de bibliographie sont directement éditées dans bibliography.bib.
Le glossaire se trouve dans glossary.tex
L'ordre conseillé pour le sommaire d'un rapport de Bachelor est le suivant:
- Préambule
- Authentification
- Résumé (français)
- Résumé (anglais) optionnel
- Table des matières
- Liste des figures
- Liste des tables
- Liste des abbreviations optionnel
- Liste des symboles optionnel
- Liste des codes sources optionnel
- Introduction
- Conclusion
- Glossaire optionnel
- Bibliographie
- Annexes optionnel
- Index
- Colophon optionnel
Les termes utilisés sont les suivants :
| Terminologie anglaise | Terminologie française | Alternative française |
|---|---|---|
| Abstract | Version abrégée | Résumé |
| Preamble | Préambule | |
| Authentication | Authentification | |
| Content | Table des matières | Sommaire |
| Appendices | Appendices | Annexes |
| Appendix | Annexe |
Les conventions consensuelles d'usage sont les suivantes :
- La première et dernière page de couverture ne sont pas numérotées
- Les pages vide ne sont pas numérotées
- Les pages précédant le premier chapitre du document sont numérotées en chiffres romains.
- Les pages à partir du premier chapitre du document sont numérotées en chiffres indo-arabes.
- Les tables et les figures sont numérotées selon la convention
chapitre.idoù chapitre est le numéro courant du chapitre etidun compteur redémarré à1à chaque nouveau chapitre.
- Éditeur d'équation en ligne latex3technics
- Éditeur de diagrammes en ligne draw.io
- Éditeur de tables pour LaTeX tablegenerator
- Éditeur LaTeX en ligne overleaf
- Correcteur orthographique compatible LaTeX : Druide Antidote
- Les ligatures sont souhaitées.
- Les paragraphes sont soit indentés, soit espacés, mais pas les deux.
- Le premier paragraphe d'une section n'est jamais indenté.
- En français, les énumérations utilisent le tiret demi-cadratin (
U+2013). - Une énumération non ordonnée est considérée comme une phrase continue, chaque entrée sera ponctuée d'une virgule ou d'un point virgule.
- Une énumération ordonnée peut être constituée de phrase complètes.
- Les unités de mesure sont espacée de la grandeur associée par une espace insécable et ne sont pas en italique ni placées entres crochets.
- Les majuscules sont accentuées comme le recommande l'académie Française.
- Et cetera s'écrit
etc.et est toujours précédé d'une virgule dans une énumération. La locution peut être remplacée par des points de suspension.... En aucun cas, ces deux formes sont combinées (etc...). Les points de suspension sont toujours collés dernier caractère d'une liste énumérée. (a, b, c...). - Les mots étrangers ou les anglicismes sont placés en italique.
- La locution confer (voir ceci) est abrégée
cf.(\cf) - La locution id est (c'est à dire) est abrégée
c.-à-d.et noni.e.(\cad) - La locution exempli gratia (pour l'exemple) est abrégée
p. ex.et none.g.(\pex)
Les locutions latines non francisées suivantes seront écrites en italique : ad hoc, ad libitum, a fortiori, a posteriori, a posteriori, a priori, bis, grosso modo, ibidem, idem, in extenso, in extremis, in extenso, in extremis, in fine, infra, loc.cit., modus vivendi, op.cit., passim, quater, sic, statu quo, supra, ter, via, vice versa.
- XeLaTeX permet le support natif de l'Unicode dans la production de fichiers PDF.
- Inkscape pour la conversion d'images SVG en PDF.
- Draw.io pour la conversion de diagrammes au format draw.io (XML) en PDF.
- Python pour la génération de figures à partir d'une source de données brute, et la coloration syntaxique de code.
- Make pour l'ordonnancement des étapes de compilation, et la gestion des dépendances.
- TeX Live est la distribution LaTeX la plus populaire, compatible avec Linux, Windows et macOS.
- Visual Studio Code est un éditeur de code disposant d'extensions
- LaTeX Workshop offre des raccourcis et des fonctionnalités additionnelles pour l'écriture de documents avec LaTeX sous VS Code.
- GitLens pour le suivi de versions au sein de l'éditeur
- Draw.io Integration pour intégrer à VS Code l'éditeur de diagrammes Draw.io
- Diagrammes BPMN 2.0 (Business Process Model And Notation)
- Diagrammes UML 2.5.1 (Unified Modelling Language)
- Petites leçons de typographie de Jaques André
- Lexique des règles typographiques en usage à l’Imprimerie nationale de l'Imprimerie Nationale française. ISBN 2-7433-0482-0
Pour toute question sur l'utilisation de ce modèle de document, veuillez créer une nouvelle issue, ou vous adresser à l'auteur du modèle Prof. Yves Chevallier.