qcm

git clone git://bebou.netlib.re/qcm
Log | Files | Refs | README |

commit 603607d31b96c7fb7a3489d66c4b9f09c562101d
parent 1f9cdf31f1e3f93a31b0932ce25a7cc75eae9072
Auteurice: Arthur Pons <arthur.pons@unistra.fr>
Date:   Thu,  7 Nov 2024 12:20:54 +0100

Documentation des fichiers -f

Diffstat:
M
README
 | 
52
+++++++++++++++++++++++++++++++++++++++++++++++++++-
M
qcm.sh
 | 
4
++--

2 files changed, 53 insertions(+), 3 deletions(-)
diff --git a/README b/README
@@ -56,6 +56,56 @@ Modifier le fichier de log *et* le nombre de questions par défaut
 
 	qcm -n 3 -l /var/log/httpd/logs
 
-Rafraîchir l'affichage plus vite (attention ça peut être un peu lourd en calcul)
+Rafraîchir l'affichage plus vite (attention ça peut être un peu lourd en
+calcul)
 
 	qcm -r 0.1
+
+Lancer un questionnaire pré-rempli se trouvant dans le fichier
+`questionnaire.qcm` avec un taux de rafraichissement plus lent :
+
+	qcm -r 2 -f ./questionnaire.qcm
+
+## Le format du fichier de questionnaire
+
+Le fichier de questionnaire est un fichier texte. Chaque question contient des
+champs pour renseigner ses attributs et *doit* terminer par l'instruction
+`demander`. Les attributs *doivent* être sous la forme `nom:` sans espace entre
+le `:` et `nom` mais avec un espace après le `:`. La liste des attributs
+
+  * `titre` : L'intitulé de la question. Optionnel, s'il n'existe pas rien ne sera affiché
+  * `type` : le type de question. Optionnel, ne fait rien pour le moment.
+  * `options` : la liste des réponses possibles séparées par des `~`. Il ne
+	doit pas y avoir de `~` à la fin.  Optionnel, s'il n'existe pas c'est `-n`
+	qui décidera du nombre de réponses possibles qui sera le même pour toutes
+	les questions.
+  * `demander` : "enregistre" la question
+
+Ainsi le fichier
+
+	titre: blabla ?
+	type: qcm
+	options: oui~non~haha~coucou
+	demander
+
+	titre: deuxième question
+	type: qcm
+	options: coucou~mac hin~bidule
+	demander
+
+	titre: troisième :\)
+	options: oui~non
+	demander
+
+Posera trois questions `blabla ?`, `deuxième question` et `troisième :)` avec
+les options respectives `oui, non, haha, coucou`, `coucou, mac hin, bidule` et
+`oui, non`.
+
+Etant donné que tous les attributs sont optionnels le fichier suivant :
+
+	demander
+	demander
+	demander
+
+Est valide. S'il est lancé avec la commande `qcm -f ./questionnaire.qcm -n 3`
+il posera trois questions sans intutilé avec trois options de réponses chacune.
diff --git a/qcm.sh b/qcm.sh
@@ -3,7 +3,7 @@
 usage() <<-. cat
 	Faire des sondages simples en parsant les logs d'un serveur web
 
-	Usage : qcm [-u url] [-l logs] [-n nombre_questions] [-r temps_de_rafraichissement]
+	Usage : qcm [-u url] [-l logs] [-n nombre_questions] [-r temps_de_rafraichissement] [-f fichier_de_questions]
 
 	url par défaut : http://bebou.netlib.re (modifiable dans le code)
 	log par défaut : /var/log/nginx/access.log (modifiable dans le code)
@@ -16,6 +16,7 @@ usage() <<-. cat
 	qcm -u http://monsite.com
 	qcm -n 6
 	qcm -l /var/log/httpd/logs
+	qcm -f ./mon-questionnaire.qcm
 .
 
 playout() {
@@ -68,7 +69,6 @@ refresh="${r:-1}"
 logs="${l:-/var/log/nginx/access.log}"
 file="$f"
 
-
 tmpd=$(mktemp -d XXX)
 id=$(basename "$tmpd")