diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..fa8a2a43bf5ad368fc683a18359c60d3fdaa945e --- /dev/null +++ b/README.md @@ -0,0 +1,81 @@ +# Structure de rapport HEPIA - HES-SO + +Ce repo vous permet de créer rapidement un rapport de semestre ou de bachelor conformément aux demandes de l'HEPIA. + +## Installation + +Il faut installer [Pandoc](https://pandoc.org/). Pandoc 2.9 c'est mieux. Il faut l'installer avec un `.deb` car les versions sur les repos sont en général tous nuls et tout vieux. + +Il faut ensuite [XeLaTeX](https://packages.debian.org/fr/sid/texlive-xetex). Il permet de convertir notre rapport de LaTeX en `.pdf`. + +Il y a probablement d'autres paquets à installer, mais pas de panique : en lancant la compilation de votre rapport, Pandoc vous indiquera si quelque chose manque, ce en plantant lamentablement. C'est très drôle à voir. + +## Compilation de votre rapport + +Ce qui est tout à fait classe avec Pandoc, c'est que vous pouvez écrire votre rapport en Markdown et il vous le convertira correctement. Vous pouvez même mettre du LaTeX dedans, cela fonctionnera convenablement. Il y a toutefois quelques indications à suivre (voir plus bas). + +Avant tout, pensez à changer les informations dans `config.yaml`. Elles changeront automatiquement dans tout le travail. Par exemple, si vous changez la valeur `sensei` dans `config.yaml`, le nom de votre professeur responsable sera changé dans tout le rapport. + +Pour lancer la compilation de votre rapport, faites simplement `make`. Pour nettoyer votre projet, faites `make clean`. Pas trop compliqué en somme. + +## Les trucs qui sont faits pour vous + +- Le titre +- La table des matières +- La table des figures +- Le glossaire +- La bibliographie + +## Les trucs PAS faits pour vous + +Cette section est plus importante que celle du dessus. + +- La table des annexes +- La vérification de la syntaxe et de l'orthographe +- Le texte : le contenu, les remerciements, le résumé, l'introduction et la conclusion. + +## Indications d'usage + +Dans le désordre, quelques recommendations pour vous rendre la vie facile. + +- Mettez vos fichier markdown dans le dossier `text`. + +- Mettez vos image dans le dossier `figs`. + +- Vous **DEVEZ** mettre vos fichiers markdown dans l'ordre alphabétique d'apparition. Par exemple, si vous avez une préface, une introduction, un chapitre, et une conclusion, vous nomerrez vos fichiers : + + - `1-préface.md` + - `2-introduction.md` + - `3-chapitre-un.md` + - `4-conclusion.md` + + Le nom après le chiffre (et le tiret) n'est pas important, mais le reste l'est. + +- Il **faut** finir tous ces fichiers Markdown dans `text` par un `\pagebreak`. Cela permet de séparer chaque document par un saut de page. Ce n'est pas nécessaire d'en mettre un pour le dernier document (cela ferait une page vierge à la fin du document) + +- Je vous fournis du LaTeX dans certains fichiers markdown. Il n'est pas là par hasard. N'y touchez pas, sans quoi je serai triste. Très triste. + +- Vous pouvez ajouter des notes de bas de page, des listes, des tableaux, tout plein de trucs en bouquinant [la documentation Pandoc](https://pandoc.org/MANUAL.html). Je vous recommande d'y jetter un œil, c'est fort sympa ce qu'on peut faire sans trop s'embêter. + +## Raccourcis + +Je vous ai simplifiés la vie au plus : il y a des raccourcis pour aller plus vite. La synthaxe est un peu dégueu, mais c'est pas la mer à boire. + +Rappel : une figure = une image. + +```latex +% Insère une image (et l'ajoute dans la table des figures) : +\img{Le chemin vers l'image}{les options de l'image, comme la taille (scale=0.2)}{La légende de l'image} + +% Insère une image dans le texte (et l'ajoute dans la table des figures): +\wimg{Le chemin vers l'image}{les options de l'image, comme la taille (scale=0.2)}{La légende de l'image}{l'emplacement de l'image : r pour right, l pour left}{la taille prévue pour l'image, comme 200pt} +``` + +## Remerciements + +Merci au Docteur Orestis Malaspinas pour sa sagesse de l'utilisation de Pandoc et de la promotion tout à fait positive qu'il en a faite. + +Merci à Monsieur Heirich d'avoir été mon cobaye pour la création de ce rapport. + + + diff --git a/text/0-preface.md b/text/0-preface.md new file mode 100644 index 0000000000000000000000000000000000000000..a3e049500322635dd2bea622d0376c9679611be7 --- /dev/null +++ b/text/0-preface.md @@ -0,0 +1,33 @@ +# Remerciements {-} + +Je souhaite remercier chaleureusement Monsieur Malaspinas, qui m'a apporté son aide, ses encouragements, et ses critiques le long +de ce travail. + +Un grand merci à Monsieur Hoerdt, qui m'a pointé sur la technologie sur laquelle se repose ce projet. + +J'aimerais aussi remercier Eduardo Basilico, qui a permis le déploiement de ce projet sur les machines de l'HEPIA. + +Enfin, je souhaite adresser mes remerciements à Monsieur El Kharroubi, qui m'a assisté dans le déploiement des différents outils nécessaires à +ce projet de semestre. + +# Résumé {-} + +Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé Texte de votre résumé + +\begin{figure} + \vspace{.25cm} + \begin{center} + \includegraphics[width=6cm,height=6cm]{figs/front-logo.png} + \end{center} + \vspace{.5cm} +\end{figure} +\begin{tabular}{ p{3cm} p{1cm} p{1cm} p{6cm} } + \multicolumn{1}{l}{Candidat :}& & & \multicolumn{1}{l}{Professeur-e(s) responsable(s) :}\\ + \multicolumn{1}{l}{\textbf{Théo PIRKL}} & & & \multicolumn{1}{l}{\textbf{Docteur Orestis Malaspinas}} \\ + \multicolumn{1}{l}{Filière d'études : ITI} & & & \multicolumn{1}{l}{Travail de semestre soumis à une convention de stage en} \\ + \multicolumn{1}{l}{} & & & \multicolumn{1}{l}{entreprise : non} \\ + \multicolumn{1}{l}{} & & & \multicolumn{1}{l}{Travail soumis à un contrat de confidentialité : non} \\ +\end{tabular} + + +\pagebreak \ No newline at end of file diff --git a/text/1-references.md b/text/1-references.md new file mode 100644 index 0000000000000000000000000000000000000000..7702155652735d17f3a7a18e69ecd52c3bd6e7c6 --- /dev/null +++ b/text/1-references.md @@ -0,0 +1,11 @@ +\printnoidxglossary[sort=word,title=Glossaire,nonumberlist] + +\listoffigures + +\listoftables + +# Liste des annexes {-} + +1, 2, 3, 4.. + +\pagebreak \ No newline at end of file diff --git a/text/2-introduction.md b/text/2-introduction.md new file mode 100644 index 0000000000000000000000000000000000000000..a34ee7a303e15cfe997ac95bf8a816ccdb2f04e8 --- /dev/null +++ b/text/2-introduction.md @@ -0,0 +1,26 @@ +\pagenumbering{arabic} + +# Introduction {-} + +Une amorce. Elle permet d'accrocher l'intérêt du lecteur. L'introduction +donne ensuite une vision générale du projet. + +## Problématique {-} + +J'expliquerai ici la situation d'aujourd'hui; notre capacité à obtenir des informations à très grande vitesse, +l'ultraconnectivité, le paradoxe humain-machine et les problèmes qui en résultent. + +## Présentation du projet {-} + +Une présentation en quelques lignes du projet, ce qu'il permet de faire. + +## Approche méthodologique {-} + +Quelle a été ma façon d'amener la solution que je propose dans ce projet. + +## Structure du projet {-} + +Quels sont les modules, les unités organisationelles de chaque système et sous-système, +un glossaire général. + +\pagebreak \ No newline at end of file diff --git a/text/8-annexes.md b/text/8-annexes.md new file mode 100644 index 0000000000000000000000000000000000000000..b54bf6ca4944199391883584cf3deb838b3ace8f --- /dev/null +++ b/text/8-annexes.md @@ -0,0 +1,5 @@ +# Annexes {-} + +Tout est dans le titre. + +\pagebreak \ No newline at end of file diff --git a/text/9-bibliographie.md b/text/9-bibliographie.md new file mode 100644 index 0000000000000000000000000000000000000000..3b5583f182a59a405705141d0ff375e94466c08a --- /dev/null +++ b/text/9-bibliographie.md @@ -0,0 +1 @@ +# Références documentaires {-} diff --git a/text/ZZ-glossaire.tex b/text/ZZ-glossaire.tex index f2bd7c44e150c6bd25ef21b80b48facf80df445e..85ea301994a915013bc411b37b4a6ad7d448ccf0 100644 --- a/text/ZZ-glossaire.tex +++ b/text/ZZ-glossaire.tex @@ -2,7 +2,7 @@ % Insérez les termes pour le glossaire ici. % Ne mettez pas de points à la fin d'une entrée, ils sont mis pour vous ! -\newglossaryentry{scraper_g}{name=scrapper,description=Logiciel permettant la récupération en masse de documents} +\newglossaryentry{scraper_g}{name=scraper,description=Logiciel permettant la récupération en masse de documents} \newglossaryentry{scraping_g}{name=scraping,description=Utilisation d'un \gls{scraper_g}} \newglossaryentry{framework_g}{name=framework,description=Un framework est un ensemble de composants permettant de poser les fondations d'un logiciel de façon à ne pas tout programmer de zéro} \newglossaryentry{captcha_g}{name=captcha,description=Un système permettant de différencier une machine d'un humain en demandant par exemple de faire une addition ou lire du texte}