Skip to content

Commit

Permalink
Styles (#32)
Browse files Browse the repository at this point in the history
* wip: change styles for chapters heading

* wip: deal with asymmetric changes (TODO)

* wip: deal with asymmetric changes (TODO)

* wip: deal with asymmetric changes (TODO)

* wip: deal with asymmetric changes (TODO)

* wip: deal with asymmetric changes (TODO)

* wip : new table of contents
  • Loading branch information
jy95 authored May 21, 2020
1 parent 56468bc commit 8772477
Show file tree
Hide file tree
Showing 14 changed files with 98 additions and 81 deletions.
33 changes: 18 additions & 15 deletions commonPreamble.sty
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,21 @@
% Pour rajouter ces fameuses sous sections
\usepackage[compact]{titlesec}
\usepackage{titletoc}
% Pour styler les chapitres
% Je préfère la Glenn car elle est assez agréable pour tout (y compris la bibliographie)
\usepackage[Glenn]{fncychap}
% Pour éviter que les chapitres prennent trop de place
% https://tex.stackexchange.com/a/174539/129702
\usepackage{etoolbox} % provides macros for patching macros
% Pour éviter que les chapitres prennent trop de place + style
\makeatletter
\patchcmd{\@makechapterhead}{50\p@}{0\p@}{}{}
\patchcmd{\@makeschapterhead}{50\p@}{0\p@}{}{}
\makeatother
% Pour réduire l'espace après les chapitres
% https://tex.stackexchange.com/a/111645/129702
% TODO on peut adapter selon les besoins
\makeatletter
\patchcmd{\DOTI}{\vskip 80\p@}{\vskip 40\p@}{}{}
\patchcmd{\DOTIS}{\vskip 40\p@}{\vskip 0\p@}{}{}
\titleformat{\chapter}[frame]
{\normalfont}
{ \filright
\MakeUppercase{\chaptertitlename}\
\thechapter
\enspace
}
{0.5em}
{\Large\filleft\textsc}
\titlespacing*{\chapter}{0pt}{25pt}{25pt}
\makeatother


% Créer un semblant d'itemize
\newcommand{\tabitem}{~~\llap{\textbullet}~~}

Expand All @@ -63,6 +60,7 @@
a4paper,
% A voir ce qu'on choisit : j'ai pris au pif
left=2cm,
right=2cm,
top=0.5cm,
}

Expand Down Expand Up @@ -293,6 +291,11 @@ literate=%

\makeatother

% Pour la toc
\usepackage[toc]{multitoc}
\renewcommand*{\multicolumntoc}{2}
\setlength{\columnseprule}{0.5pt}

% Pour ignorer des figures / tables des tables
% C'est uniquement pour les annexes, pour ne pas polluer le tout
% \captionsetup{list=no} pour cacher
Expand Down
Binary file modified images/serveur/doc_example.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 10 additions & 6 deletions sections/annexes/analyseBibliographique/index.tex
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
\includepdf[
pages=1,
pagecommand=\chapter{Analyse Bibliographique}\label{annexe:AnalyseBiblio},
offset=0 -1cm,
scale=0.8
pages={1},
offset=0cm -1cm,
width=\textwidth,
pagecommand={
\fboxrule0.4pt
\chapter{Analyse Bibliographique}
\label{annexe:AnalyseBiblio}
},
]{sections/annexes/analyseBibliographique/Analyse_Bibliographique.pdf}

\includepdf[
pages=2-,
pagecommand={},
width=1.2\textwidth,
width=\textwidth,
% To have items into list of figures / tables / listings
% WARNING : As explained by the doc, this option is experimental (it MAY change but I don't think so : many people used that)
% SECOND WARNING : the page number argument is the real position from starting point !!
Expand Down
15 changes: 0 additions & 15 deletions sections/annexes/index.tex
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
% On imprime une table des figures / tables pour mieux naviguer ici
\begingroup
\let\clearpage\relax
% prints appendices list of figures
\printlist[appendices]{lof}{}{
\chapter*{\listfigurenameappendixes}
}
% prints appendices list of tables
\printlist[appendices]{lot}{}{
\chapter*{\listtablenameappendixes}
}
% prints appendices list of tables listings
\listofappendixlistings
\endgroup

\import{sections/annexes/problematique/}{index}
\pagebreak
\import{sections/annexes/analyseBibliographique/}{index}
Expand Down
10 changes: 5 additions & 5 deletions sections/annexes/problematique/index.tex
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ \section{Practice-it}
\end{figure}

\begin{figure}[H]
\includegraphics[width=\textwidth,height=0.6\textheight,keepaspectratio]{images/comparison/practice-it-2.png}
\includegraphics[width=\textwidth,height=0.56\textheight,keepaspectratio]{images/comparison/practice-it-2.png}
\centering
\caption[Practice-it : page d'un problème]{Page d'un problème}
\end{figure}
Expand All @@ -24,19 +24,19 @@ \section{Practice-it}
\section{Hackerrank}

\begin{figure}[H]
\includegraphics[width=\textwidth,height=0.35\textheight,keepaspectratio]{images/comparison/hacker-1.png}
\includegraphics[width=\textwidth,height=0.42\textheight,keepaspectratio]{images/comparison/hacker-1.png}
\centering
\caption[Hackerrank : tableau de bord]{Tableau de bord}
\end{figure}

\begin{figure}[H]
\includegraphics[width=\textwidth,height=0.35\textheight,keepaspectratio]{images/comparison/hacker-2.png}
\includegraphics[width=\textwidth,height=0.42\textheight,keepaspectratio]{images/comparison/hacker-2.png}
\centering
\caption[Hackerrank : page pour rechercher un problème]{Page pour rechercher un problème}
\end{figure}

\begin{figure}[H]
\includegraphics[width=\textwidth,height=0.35\textheight,keepaspectratio]{images/comparison/hacker-3.png}
\includegraphics[width=\textwidth,height=0.55\textheight,keepaspectratio]{images/comparison/hacker-3.png}
\centering
\caption[Hackerrank : page d'un challenge]{Page d'un challenge}
\end{figure}
Expand All @@ -56,7 +56,7 @@ \section{Leetcode}
\end{figure}

\begin{figure}[H]
\includegraphics[width=\textwidth,height=0.35\textheight,keepaspectratio]{images/comparison/leetcode-3.png}
\includegraphics[width=\textwidth,height=0.30\textheight,keepaspectratio]{images/comparison/leetcode-3.png}
\centering
\caption[Leetcode : page d'un problème]{Page d'un problème}
\end{figure}
Expand Down
1 change: 1 addition & 0 deletions sections/chapters/cahierDesCharges/index.tex
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ \subsection*{Les différents types d'utilisateurs}
\item \textbf{Super Administrateur} : Celui-ci dispose du droit de supprimer de manière définitive les différentes ressources de notre plateforme (y compris les \glspl{tag} et \glspl{tagCat}).
\end{itemize}

\pagebreak
\subsection*{Fonctionnalités}

Pour réaliser les défis expliqués à la section \ref{section:challengesToDefeat}, il convient de faire l'inventaire des nombreuses fonctionnalités à réaliser de manière formelle.
Expand Down
6 changes: 3 additions & 3 deletions sections/chapters/problematique/index.tex
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ \section{Situation actuelle}
\end{table}

Avant d'aller plus loin, nous tenons à mentionner l'outil \href{https://oer.uclouvain.be/}{OER UCLouvain} hors du champ de notre analyse. En effet, notre projet est une version simplifiée de leur application, car nous ne traitons qu'un seul domaine des \gls{oer} : les \glspl{resinfo}. Par conséquent, le système de recherche que le site propose ne correspond pas à la vision que nous avons pour notre type de plateforme étant donné qu'il est beaucoup plus complexe que ce que nous voulons mettre en place : Un catalogue de \glspl{resinfo}. Néanmoins, nous avons pu discuter avec \textit{Christine Jacqmot}, membre du \textit{Louvain Learning Lab}, afin de lui présenter notre projet et de voir comment se comporte l'outil \href{https://oer.uclouvain.be/}{OER UCLouvain} côté administration. Ses conseils nous ont aidé à améliorer notre prototype et dans le cas échéant, à rajouter dans le chapitre \ref{chapter:pourAllerPlusLoin} des précieuses pistes d'améliorations.

\pagebreak
\subsection*{Practice-it}

\href{https://practiceit.cs.washington.edu/problem/list}{Practice-it} est une plateforme permettant de résoudre des problèmes en Java en ligne. Comme le site le relate : \textit{la plupart des problèmes viennent des cours d'introduction en Java de l'université de Washington}.
Expand Down Expand Up @@ -246,15 +246,15 @@ \section{Problème}
\label{figure:patchwork}

\begin{figure}[H]
\includegraphics[width=\textwidth,height=0.4\textheight,keepaspectratio]{images/filters.JPG}
\includegraphics[width=\textwidth,height=0.45\textheight,keepaspectratio]{images/filters.JPG}
\centering
\caption{Représentation du système de filtres avec les \glspl{tag}}
\end{figure}
\label{figure:systemeDeFiltres}


\begin{figure}[H]
\includegraphics[width=\textwidth,height=0.4\textheight,keepaspectratio]{images/resource.JPG}
\includegraphics[width=\textwidth,height=0.45\textheight,keepaspectratio]{images/resource.JPG}
\centering
\caption{Page d'une \gls{fiche}}
\end{figure}
Expand Down
4 changes: 2 additions & 2 deletions sections/chapters/solution/api/index.tex
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ \subsubsection{Paramétrisation de l'\Gls{api}}
Comme révélé en section \ref{section:AnalyseNonFonctionnelle}, il convient d'accorder un certain contrôle aux utilisateurs finaux.
Une manière de configurer une telle application est d'utiliser des \glspl{envvar},
qui permettent, contrairement à d'autres approches (comme les fichiers de configuration \textbf{JSON}, \textbf{YAML}, ...),
de changer de valeur directement, sans éteindre/redémarrer l'application par exemple. \\
de changer de valeur directement, sans éteindre/redémarrer l'application. \\

Nous avons accordé les possibilités suivantes (la liste détaillée des \glspl{envvar} est disponible dans le fichier README.MD) :

Expand Down Expand Up @@ -76,7 +76,7 @@ \subsubsection{Documentation de l'\Gls{api}}
\end{itemize}

\begin{figure}[H]
\includegraphics[width=\textwidth,height=0.44\textheight,keepaspectratio]{images/serveur/doc_example.png}
\includegraphics[width=\textwidth,height=0.40\textheight,keepaspectratio]{images/serveur/doc_example.png}
\centering
\caption{Exemple de documentation \textbf{HTML} générée sur base de fichiers \Gls{oas}}
\label{fig:exampleDoc}
Expand Down
8 changes: 5 additions & 3 deletions sections/chapters/solution/choixTechno/index.tex
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,19 @@ \subsection*{Choix de l'environnement de programmation}
Node.js nous permet désormais, à l'instar du PHP, d'écrire du code JavaScript du côté serveur qui servira à répondre aux requêtes du client, tout en bénéficiant des avantages du JavaScript. \\

\begin{figure}[H]
\includegraphics[width=\textwidth,height=0.24\textheight,keepaspectratio]{images/choixTechnologiques/SchemaNodejs.png}
\includegraphics[width=\textwidth,height=0.3\textheight,keepaspectratio]{images/choixTechnologiques/SchemaNodejs.png}
\centering
\caption[Du JavaScript aussi bien côté serveur que client]{Du JavaScript aussi bien côté serveur que client~\cite{NodejsIllustrations}}
\label{pic:WhatIsNodeJs}
\end{figure}

Deux points sont élémentaires pour expliquer l'intérêt et la rapidité de Nodejs : le moteur JavaScript V8 et son fonctionnement non bloquant. \\

\pagebreak

Ce moteur, développé par Google, très performant et optimisé propose la compilation à la volée (en anglais, JIT , just-in-time compilation) , approche hybride entre la compilation et l'interprétation, dont nous pouvons schématiser leur mode de fonctionnement individuel par la figure suivante :
\begin{figure}[H]
\includegraphics[width=\textwidth,height=0.2\textheight,keepaspectratio]{images/choixTechnologiques/compilationVSinterpretation.png}
\includegraphics[width=\textwidth,height=0.25\textheight,keepaspectratio]{images/choixTechnologiques/compilationVSinterpretation.png}
\centering
\caption{Compilation et interprétation - mode de fonctionnement}
\end{figure}
Expand All @@ -39,7 +41,7 @@ \subsection*{Choix de l'environnement de programmation}
Dans un mode de fonctionnement bloquant, il convient d'attendre la fin de ces taches avant de réaliser autre chose. Ceci est un gâchis dans la mesure où des tâches moins gourmandes en temps sont ainsi bloquées. Node.js permet, par son mode de fonctionnement non bloquant, des gains de performances, comme illustré ci-dessous.

\begin{figure}[H]
\includegraphics[width=\textwidth,height=0.19\textheight,keepaspectratio]{images/choixTechnologiques/ComparaisonBloquantOuNon.png}
\includegraphics[width=\textwidth,height=0.25\textheight,keepaspectratio]{images/choixTechnologiques/ComparaisonBloquantOuNon.png}
\centering
\caption[Bloquant/non bloquant : un exemple pour l'illustrer]{Bloquant/non bloquant : un exemple pour l'illustrer~\cite{NodejsIllustrations}}
\label{pic:BloquantOrNot}
Expand Down
4 changes: 4 additions & 0 deletions sections/chapters/solution/client/index.tex
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ \section{Client}

L'URL \textit{/administration} contient les fonctionnalités exigeant le plus haut niveau de privilèges sur \texttt{SourceCode}. Cette partie est donc entièrement dédiée aux administrateurs et super-administrateurs. Ils peuvent gérer absolument toutes les \glspl{resinfo} disponibles sur la plateforme (impliquant aussi la modification et création de celles-ci), l'importation/exportation de \glspl{resinfo}, la gestion/création/modification de \glspl{tag}, la gestion/création/modification des \glspl{tagCat} et finalement la gestion des utilisateurs de la plateforme.\\

\pagebreak

L'URL \textit{/tutoriel} concerne un aspect plus ludique de \texttt{SourceCode}. À travers différentes pages, une thématique de l'application est décortiquée afin que l'utilisateur puisse améliorer sa prise en main avec la plateforme.\\

Avant d'aller plus loin, considérez la section \ref{section:challengesToDefeat} afin de vous remettre en tête ce que nous voulions apporter à \texttt{SourceCode}.
Expand Down Expand Up @@ -52,6 +54,8 @@ \subsection{Connexion et création de comptes}

Lorsque l'utilisateur possède déjà un compte, il lui suffit de renseigner son adresse email et son mot de passe. Pour l'instant, une session d'une heure lui sera attribuée pour gérer ses ressources, favoris, ... Après quoi il sera redirigé vers la page de login pour entrer à nouveau ses identifiants. Ce comportement est bien évidemment modifiable depuis l'api (cf. section \ref{section:apiConfig}), mais nous avions surtout choisi ce timing pour la séance de validation de notre plateforme (cf. \ref{annexe:googleForm}).\\

% Pour fill un peu l'espace et être moins condensé
\vspace{20mm} %5mm vertical space

\subsection{Exercices}

Expand Down
29 changes: 0 additions & 29 deletions sections/tables.tex

This file was deleted.

28 changes: 28 additions & 0 deletions sections/tablesAnnexes.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
% On imprime une table des figures / tables pour mieux naviguer ici
\begingroup
\let\clearpage\relax
% Temporary reduce size of headers, to fit all of this on one page
\makeatletter
\titleformat{\chapter}[frame]
{\normalfont}
{ \filright
\MakeUppercase{\chaptertitlename}\
\thechapter
\enspace
}
{0.5em}
{\bfseries\filleft}
\titlespacing*{\chapter}{0pt}{0pt}{20pt}
\makeatother

% prints appendices list of figures
\printlist[appendices]{lof}{}{
\chapter*{\listfigurenameappendixes}
}
% prints appendices list of tables
\printlist[appendices]{lot}{}{
\chapter*{\listtablenameappendixes}
}
% prints appendices list of tables listings
\listofappendixlistings
\endgroup
13 changes: 13 additions & 0 deletions sections/tablesMain.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
\begingroup
\let\clearpage\relax
% prints main list of figures
\printlist[main]{lof}{}{
\chapter*{\listfigurename}
}
% prints main list of tables
\printlist[main]{lot}{}{
\chapter*{\listtablename}
}
% print main listings
\lstlistoflistings
\endgroup
12 changes: 9 additions & 3 deletions structure.tex
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
\startlist[main]{lof}% starts main list of figures
\startlist[main]{lot}% starts main list of tables

% Table des matières + autres tables
\import{sections/}{tables}
% Table des matières
\tableofcontents

% Le glossaire
% Pour forcer l'affichage de tout ( mais pas idéal car cela n'affiche pas les bonnes pages pour les termes ): https://tex.stackexchange.com/a/492011/129702
Expand Down Expand Up @@ -72,4 +72,10 @@ \chapter{Conclusion}

% Stop partial lists
\stoplist[appendices]{lof}% stops main list of figures
\stoplist[appendices]{lot}% stops main list of tables
\stoplist[appendices]{lot}% stops main list of tables

% Tables des figures / tables / extraits de code [PRINCIPALE]
\import{sections/}{tablesMain}
\pagebreak
% Tables des figures / tables / extraits de code [ANNEXES]
\import{sections/}{tablesAnnexes}

0 comments on commit 8772477

Please sign in to comment.