Documentation

src/app/shared/assets/data/question_final.md → documentation.md

-# Documentation questions_final.json
+# Documentation du quiz 
 
-Le Json est composé d'un dictionnaire global avec trois clés.
+Le quiz repose sur un fichier json qui contient les questions et les réponses possibles.
 
-## question_topics
+## Json
+Ce Json est composé d'un dictionnaire global avec trois clés.
+
+### question_topics
 
 Cette clé contient les différentes catégories de questions du quiz (str).
 Actuellement, il y a 4 catégories.
@@ -11,7 +14,7 @@ Pour ajouter une catégorie, il suffit de rajouter le nom de la nouvelle catégo
 
 La liste doit avoir le même nombre d'élements que la liste de question_cycle.
 
-## question_cycle
+### question_cycle
 
 Cette clé contient les cycles de choix de catégorie différent (int).
 Les cartes quiz apparaissent de manière aléatoire mais il doit y avoir une cohérence au niveau des catégories qui apparaissent.
@@ -19,39 +22,39 @@ Ainsi, le premier élément de la liste concerne le premier élément de la list
 
 La liste doit avoir le même nombre d'élements que la liste de question_topics.
 
-## questions
+### questions
 
 Cette clé contient des dictionnaires qui correspondent aux différentes catégories de question_topics.
 
 Dans chacun des dictionnaires, il y a une liste de dictionnaires qui correspondent à chacune des cartes du jeu.
 
-### question_type
+#### question_type
 
 Cette clé (str) sert à définir le type de questions de la carte quiz parmi les deux types suivants : 
 - QCM
 - QCU
 
-### question
+#### question
 
 Cette clé (str) contient la question de la carte quiz.
 
-### possible_answers
+#### possible_answers
 
 Cette clé (list) sert à définir les différentes réponses affichées à l'utilisateur. Cela a été pensé pour avoir entre 2 et 4 propositions.
 C'est une liste d'élément string.
 
 Pour les QCM, il faut entrer pour la première proposition "A : " suivi de la proposition, pour la seconde, c'est "B : " suivant de la proposition, etc...
 
-### true_answers
+#### true_answers
 
 Cette clé (list) sert à définir l'indice (en commançant à 0) de la bonne réponse parmis les réponses possibles définies dans possible_answers.
 
 La liste doit-être composée d'un élément (int) unique si le question_type est QCU et est composée d'un ou plusieurs éléments (int) si le question_type est QCM.
 
-### sentences
+#### sentences
 Seulement pour les QCM, cela permet d'afficher les bonnes réponses à l'utilisateur.
 
-### explanation
+#### explanation
 
 Cette clé (str) contient l'explication de la bonne réponse de la carte quiz.
 
@@ -59,4 +62,23 @@ Pour les QCM, il faut rajouter s'il n'y a pas qu'elles sont les bonnes réponses
 Par exemple, si la deuxième et troisième proposition est juste, il faudra marquer avant l'explication : 
 "Les bonnes réponses sont B et C. \n"
 
-De plus, s'il y a des sources dans l'explication, il faut rajouter un "\n" avant le mot "Source".
+De plus, s'il y a des sources dans l'explication, il faut rajouter un "\n" avant le mot "Source".
\ No newline at end of file
+
+## Les services 
+
+Le site utilise deux services : 
+    - progress-service : pour sauvegarder la progression de l'utilisateur
+    - quiz-service : pour récupérer les questions du quiz
+Ce deuxième service se base sur un tirage aléatoire des questions par thèmes. Ensuite on tire une à une les questions pour chaque thème jusqu'à ne plus en avoir.
+
+## Les composants
+
+Le site affiche un composant quiz et les cartes viennent varier à l'intérieur. On a alors des quiz-card qui utilise des answer-box et des choice-box.
+
+## Les types 
+
+Il y a deux interfaces qui sont utilisées pour les questions : 
+    - QuizData -> qui contient : question_topics, question_cycle et questions
+    - QuizSegment -> qui contient : QCM_answers, question_type, question, possible_answers, true_answers, explanation
+
+

src/app/views/quiz/quiz-card/choice-box/choice-box.component.html

@@ -18,7 +18,7 @@
           (change) = "checkAnswer()"/>
         }
 
-        <!-- Mise en place des radiobutton dans le cas d'un QCu -->
+        <!-- Mise en place des radiobutton dans le cas d'un QCU -->
         @else if (quiz_segment()?.question_type === "QCU") {
           <p-radiobutton class="radio"
             [value]="$index"