Skip to content

Commit d885a94

Browse files
authored
Improvements (#8)
* fix: entries sorting with accents considered * wip: put "library" into the glossary * wip: re-enable some gitignore rules let's see what happens ^^ * fix: xindy should be specified I had no problem for that on windows (MiKTeX) * fix: xindy in Tex Live In MiKTeX, the package is included it seems * chore: remove old thing * wip: testing workaround for weird Tex Live issue * wip: set version instead of master * wip: test weird workaround * wip: weird workaround * fix: cleaner version of workaround
1 parent 81e7251 commit d885a94

File tree

5 files changed

+40
-21
lines changed

5 files changed

+40
-21
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ acs-*.bib
113113
*.lzs
114114

115115
# uncomment this for glossaries-extra (will ignore makeindex's style files!)
116-
# *.ist
116+
*.ist
117117

118118
# gnuplottex
119119
*-gnuplottex-*
@@ -275,6 +275,9 @@ TSWLatexianTemp*
275275
# Makeindex log files
276276
*.lpz
277277

278+
# Output
279+
main.pdf
280+
278281
# REVTeX puts footnotes in the bibliography by default, unless the nofootinbib
279282
# option is specified. Footnotes are the stored in a file with suffix Notes.bib.
280283
# Uncomment the next line to have this generated file ignored.

commonPreamble.sty

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,12 @@ literate=%
272272
% Styles for table
273273
% J'ai choisi la "long3col-booktabs" mais il y en a d'autres :
274274
% https://www.dickimaw-books.com/gallery/glossaries-styles/
275-
\usepackage[toc,nonumberlist,nogroupskip,nopostdot]{glossaries}
275+
\usepackage[
276+
toc,
277+
nonumberlist,
278+
nogroupskip,
279+
nopostdot,
280+
xindy
281+
]{glossaries}
276282
\usepackage{glossary-longbooktabs}
277283
\makeglossaries

glossary.tex

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,4 +152,14 @@
152152
Terme générique pour désigner tout logiciel permettant de mettre en relation plusieurs applications.
153153
Ce terme existe également sous une version francisée : le "logiciel médiateur".
154154
}
155+
}
156+
157+
\newglossaryentry{library}
158+
{
159+
name={Librairie},
160+
text={librairie},
161+
plural={librairies},
162+
description={
163+
Ce terme désigne, comme expliqué par Wikipédia\cite{libraryDef}, "une collection de fonctions utilitaires prêtes à être utilisées par des programmes".
164+
}
155165
}

sections/chapters/analyseCritique/index.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ \subsubsection*{Création de \glspl{resinfo}}
6767

6868
\bigskip
6969
\begin{enumerate}
70-
\item Actuellement, il faut d'abord créer un bloc de code puis copier-coller le code que l'on veut formater dedans. La librairie d'édition de texte que nous utilisons (Tiptap) ne gère pas nativement ce qui a été soulevé dans la remarque. En revanche, cette même libraire est extensible et autorise la modification/l'ajout de fonctionnalités de manière aisée. Il est donc tout à fait envisageable de corriger le tir dans une prochaine mise à jour de l'application.
70+
\item Actuellement, il faut d'abord créer un bloc de code puis copier-coller le code que l'on veut formater dedans. La \gls{library} d'édition de texte que nous utilisons (Tiptap) ne gère pas nativement ce qui a été soulevé dans la remarque. En revanche, cette même \gls{library} est extensible et autorise la modification/l'ajout de fonctionnalités de manière aisée. Il est donc tout à fait envisageable de corriger le tir dans une prochaine mise à jour de l'application.
7171
\item Certaines personnes se plaignaient que la boîte d'édition était trop petite (ou trop grande). Dans son état actuel, \texttt{SourceCode} n'est pas responsive, et dans la perspective où elle le serait, ce problème sera certainement réglé pour tout écran.
7272
\item Comme cela a déjà été soulevé dans la section concernant la bibliothèque, le panneau des \glspl{tag} est un peu lourd à l'utilisation. Il y avait jusqu'à 3 scrollbars pour naviguer dans le panneau, ce qui diminuait considérablement l'accessibilité. Nous avons donc changé ce comportement en faisant en sorte d'afficher une seule scrollbar, avec un accès plus clair à la barre de recherche sous chaque \glspl{tagCat}.
7373
\end{enumerate}

sections/chapters/solution/choixTechno/index.tex

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -235,11 +235,11 @@ \subsubsection*{Framework pour le \Gls{cli}}
235235

236236
Yargs a été la solution que nous avons retenue, car celui-ci surclasse de manière incontestable les autres solutions existantes. En effet, la documentation (très claire et complète) et le nombre de fonctionnalités permettent une rapide adoption pour construire une solution dans les plus brefs délais.
237237

238-
\subsection*{Choix des librairies externes}
238+
\subsection*{Choix des \glspl{library} externes}
239239

240-
Comme expliqué par Wikipédia\cite{libraryDef}, le terme librairie désigne "une collection de fonctions utilitaires prêtes à être utilisées par des programmes". En effet, de nombreuses applications y compris la nôtre partagent des besoins communs : de ce fait, il est donc adéquat de réutiliser le travail d'autrui plutôt que de "réinventer la roue". \\
240+
De nombreuses applications, y compris la nôtre, partagent des besoins communs : de ce fait, il est donc adéquat de réutiliser le travail d'autrui plutôt que de "réinventer la roue". \\
241241

242-
Compte tenu du nombre relativement élevé de librairies que nous avons utilisées dans les diverses parties de notre solution, nous évoquerons ici uniquement que les plus conséquentes. \\
242+
Compte tenu du nombre relativement élevé de \glspl{library} que nous avons utilisées dans les diverses parties de notre solution, nous évoquerons ici uniquement que les plus conséquentes. \\
243243

244244

245245
% Pour l'instant, j'ai listé ceci (mais à voir si tu vois d'autres à expliquer)
@@ -259,21 +259,21 @@ \subsection*{Choix des librairies externes}
259259
% Axios (pour les requests)
260260

261261
% Un page break pour l'instant
262-
\subsubsubsection{Librairies communes}
262+
\subsubsubsection{\Glspl{library} communes}
263263

264264
% Sorry mais les \paragraph ne t'autorisent pas à faire un titre avant
265265
% Une \noindent\underline{} est cependant possible
266266
\underline{\href{https://lodash.com/}{Lodash}}\\
267267

268-
Cette librairie propose un grand nombre de fonctionnalités dont nous allons vous montrer un infime échantillon au moyen de cet exemple :
268+
Cette \gls{library} propose un grand nombre de fonctionnalités dont nous allons vous montrer un infime échantillon au moyen de cet exemple :
269269

270270
\lstinputlisting[
271271
style=ES6,
272272
caption={Exemple des fonctionnalités de Lodash}
273273
]{codes/lodash.js}
274274

275275
\pagebreak
276-
\subsubsubsection{Librairies pour le \Gls{frontend}}
276+
\subsubsubsection{\Glspl{library} pour le \Gls{frontend}}
277277

278278
\noindent\underline{\href{https://logaretm.github.io/vee-validate/}{VeeValidate}}\\
279279

@@ -294,7 +294,7 @@ \subsubsubsection{Librairies pour le \Gls{frontend}}
294294
\pagebreak
295295
\noindent\underline{\href{https://tiptap.scrumpy.io}{Tiptap}}\\
296296

297-
Tiptap est un éditeur de texte riche "renderless" (ce terme signifie que la conception du design nous appartient). Cette librairie prévue pour fonctionner avec VueJS permet de mettre en place assez rapidement un éditeur de texte complet et flexible. On peut aisément y rajouter des options comme des triggers que l'on peut attacher à des boutons pour styliser le texte plus facilement. Pour exemple, voici à quoi ressemble l'éditeur de texte de la description d'une \gls{resinfo} :\\
297+
Tiptap est un éditeur de texte riche "renderless" (ce terme signifie que la conception du design nous appartient). Cette \gls{library} prévue pour fonctionner avec VueJS permet de mettre en place assez rapidement un éditeur de texte complet et flexible. On peut aisément y rajouter des options comme des triggers que l'on peut attacher à des boutons pour styliser le texte plus facilement. Pour exemple, voici à quoi ressemble l'éditeur de texte de la description d'une \gls{resinfo} :\\
298298

299299
\begin{figure}[H]
300300
\includegraphics[width=\textwidth,height=0.35\textheight,keepaspectratio]{images/libraries/tiptap.png}
@@ -306,11 +306,11 @@ \subsubsubsection{Librairies pour le \Gls{frontend}}
306306

307307
\noindent\underline{\href{https://highlightjs.org}{Highlight.js}}\\
308308

309-
Librairie permettant de détecter automatiquement le langage de programmation dans un texte et de lui appliquer la coloration syntaxique adéquate. Highlight.js est utilisé conjointement avec la libraire Tiptap pour écrire du code dans l'éditeur et profiter de la coloration syntaxique (voir image précédente).\\
309+
\Gls{library} permettant de détecter automatiquement le langage de programmation dans un texte et de lui appliquer la coloration syntaxique adéquate. Highlight.js est utilisé conjointement avec la libraire Tiptap pour écrire du code dans l'éditeur et profiter de la coloration syntaxique (voir image précédente).\\
310310

311311
\noindent\underline{\href{https://axios.nuxtjs.org/}{Axios}}\\
312312

313-
Librairie facilitant de manière drastique la conception de requêtes HTTP. Nous utilisons donc Axios pour communiquer avec notre API. Voici un exemple d'utilisation : \\
313+
\Gls{library} facilitant de manière drastique la conception de requêtes HTTP. Nous utilisons donc Axios pour communiquer avec notre API. Voici un exemple d'utilisation : \\
314314

315315
\begin{figure}[H]
316316
\includegraphics[width=\textwidth,height=0.35\textheight,keepaspectratio]{images/libraries/axios.png}
@@ -324,11 +324,11 @@ \subsubsubsection{Librairies pour le \Gls{frontend}}
324324

325325
% TODO - Un petit espace pour le code de ta figure (à adapter après)
326326
\vspace*{.7in}
327-
\subsubsubsection{Librairies pour le \Gls{backend}}
327+
\subsubsubsection{\Glspl{library} pour le \Gls{backend}}
328328

329329
\noindent\underline{\href{https://sequelize.org/master/}{Sequelize}}\\
330330

331-
Afin d'interagir avec la base de données en Postgresql (cf section \ref{sec:ContraintesCdc}), nous avons fait le choix d'utiliser la librairie Sequelize qui propose du mapping objet-relationnel\footnote{
331+
Afin d'interagir avec la base de données en Postgresql (cf section \ref{sec:ContraintesCdc}), nous avons fait le choix d'utiliser la \gls{library} Sequelize qui propose du mapping objet-relationnel\footnote{
332332
En anglais, le terme utilisé est \textbf{O}bject-\textbf{R}elational \textbf{M}apping ou \textbf{ORM}.
333333
} (à titre informatif, d'autres alternatives similaires existent, notamment dans Loopback que nous avions étudié en table \ref{table:compFrameworksAPI}).\\
334334

@@ -354,7 +354,7 @@ \subsubsubsection{Librairies pour le \Gls{backend}}
354354

355355
\noindent\underline{OpenAPI-enforcer}\\
356356

357-
Il s'agit d'une librairie développée et massivement utilisée par la \textbf{BYU}\footnote{
357+
Il s'agit d'une \gls{library} développée et massivement utilisée par la \textbf{BYU}\footnote{
358358
Brigham Young University - \url{https://www.byu.edu/about}
359359
}.
360360
Elle permet, sur base de document(s) respectant la \Gls{oas}, d'enrichir notre \Gls{api} de nombreuses fonctionnalités très intéressantes dont voici quelques-unes :
@@ -365,17 +365,17 @@ \subsubsubsection{Librairies pour le \Gls{backend}}
365365
\item Association automatique des chemins au code
366366
\end{itemize}
367367

368-
Nous vous invitons à découvrir la figure \ref{fig:OASEnforcer} qui propose une explication condensée de la librairie.
368+
Nous vous invitons à découvrir la figure \ref{fig:OASEnforcer} qui propose une explication condensée de la \gls{library}.
369369
Nous reviendrons plus en détail sur son intégration dans la section \ref{chapter:api} : cette sous-section ne constituant qu'une brève introduction.
370-
À titre informatif, cette librairie se décline en 3 sous-librairies :
370+
À titre informatif, cette \gls{library} se décline en 3 sous-\glspl{library} :
371371

372372
\begin{itemize}
373373
\item openapi-enforcer\footnote{
374374
\url{https://github.com/byu-oit/openapi-enforcer}
375-
} : le cœur de la librairie
375+
} : le cœur de la \gls{library}
376376
\item openapi-enforcer-middleware\footnote{
377377
\url{https://github.com/byu-oit/openapi-enforcer-middleware}
378-
} : le \gls{middleware} de la librairie
378+
} : le \gls{middleware} de la \gls{library}
379379
\item openapi-enforcer-multer\footnote{
380380
\url{https://github.com/byu-oit/openapi-enforcer-multer}
381381
} : un \gls{middleware} optionnel qui s'occupe automatique de l'upload de fichiers (cf section \ref{section:analyseFonctionnelle})
@@ -384,7 +384,7 @@ \subsubsubsection{Librairies pour le \Gls{backend}}
384384
\begin{figure}[H]
385385
\includegraphics[width=\textwidth,height=\textheight,keepaspectratio]{images/libraries/openapi-enforcer.png}
386386
\centering
387-
\caption[Vue globale de la librairie openapi-enforcer]{Vue globale de la librairie openapi-enforcer
387+
\caption[Vue globale de la \gls{library} openapi-enforcer]{Vue globale de la \gls{library} openapi-enforcer
388388
\footnotemark
389389
}
390390
\label{fig:OASEnforcer}
@@ -413,7 +413,7 @@ \subsubsubsection{Librairies pour le \Gls{backend}}
413413

414414
\noindent\underline{\href{https://github.com/visionmedia/supertest}{Supertest}}\\
415415

416-
Librairie permettant de réaliser des assertions en HTTP de manière plus aisée.
416+
\Gls{library} permettant de réaliser des assertions en HTTP de manière plus aisée.
417417
Une de ses particularités est d'être "framework-agnostic", ce qui permet d'utiliser le framework de test de notre choix, dont notamment celui de Facebook : Jest\footnote{
418418
\url{https://jestjs.io/}
419419
}. (Nous reviendrons sur la dimension des tests de manière plus approfondie dans le chapitre ???(validation) )\\

0 commit comments

Comments
 (0)