doc fr: new features + aliases

diff --git a/documentation_fr.md b/documentation_fr.md
index 260f088775dedb16a9fcb851b17e32866c2048d0..c5298a5c0e94e16538632f4d46b74c22834a0f28 100644 (file)
--- a/documentation_fr.md
+++ b/documentation_fr.md
@@ -80,16 +80,16 @@ Cette section sert à décrire l'affichage à l'écran des touches : couleur et
           - STOP !
         color: [255, 0, 0]
 
-La touche échap est de couleur rouge, et le texte "STOP !" est affiché sur la deuxième ligne
+La touche échap est de couleur rouge, et le texte "STOP !" est affiché sur la deuxième ligne.
 
 #### Liste des options possibles
-- `description` : le texte qui s'affiche, à côté du "nom" de la touche. Il faut mettre un tirer pour une ligne de texte (pas de retour à la ligne automatique). La première ligne correspond à celle de la lettre associée à la touche, aussi il n'est pas absurde de la laisser vide (voir l'exemple ci-dessus). Sur un écran de taille raisonnable, on peut compter 3 lignes (incluant la première) pour une touche "standard".
-- `color: [r,g,b]` : la couleur de la touche. r, g et b sont les proportions de rouge, vert et bleu, et doivent être des entiers entre 0 et 255.
+- `description` : le texte qui s'affiche, à côté du "nom" de la touche. Il faut mettre un tiret pour une ligne de texte (pas de retour à la ligne automatique). La première ligne correspond à celle de la lettre associée à la touche, aussi il vaut mieux souvent la laisser vide, ou ne mettre que très peu de texte (voir l'exemple ci-dessus). Sur un écran de taille raisonnable, on peut compter 3 lignes (incluant la première) pour une touche "standard".
+- `color: [r, g, b]` : la couleur de la touche. r, g et b sont les proportions de rouge, vert et bleu, et doivent être des entiers entre 0 et 255.
 
 
 ### `keys` : actions sur les touches
 
-Cette section sert à décrire, pour chaque touche, la liste des actions successives. Notez qu'à l'exception de `wait` (voir plus bas), les actions sont exécutées les unes à la suite des autres, sans attendre que la précédente soit terminée.
+Cette section sert à décrire, pour chaque touche, la liste des actions successives. Notez que la plupart des commandes (hors `wait` et quelques cas particuliers, voir plus bas), les actions sont exécutées les unes à la suite des autres, sans attendre que la précédente soit terminée.
 
 
 #### Exemples
@@ -103,53 +103,53 @@ Cette section sert à décrire, pour chaque touche, la liste des actions success
           duration: 5
       - stop:
           file: "music1.mp3"
-          fade_out 2
+          fade_out: 2
 
 Lance la musique "music1.mp3" à 70% de son volume max, puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes.
 
     :::yaml
     'b':
       - stop: 
-          file "music1.mp3"
-          fade_out 5
+          file: "music1.mp3"
+          fade_out: 5
           wait: false
       - play:
-          file "music2.mp3"
-          fade_in 5
+          file: "music2.mp3"
+          fade_in: 5
 
 Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3"
 
     :::yaml
     'c':
       - stop: 
-          file "music1.mp3"
-          fade_out 5
+          file: "music1.mp3"
+          fade_out: 5
           wait: true
       - wait:
           duration: 2
       - play:
-          file "music2.mp3"
+          file: "music2.mp3"
       - seek:
-          file "music2.mp3"
+          file: "music2.mp3"
           delta: false
           value: 60
-Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du fondu, puis attend deux secondes et lance la musique "music2.mp3", au temps d'une minute.
+Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du fondu, puis attend encore deux secondes et lance la musique "music2.mp3", au temps d'une minute.
 
     :::yaml
     'd':
       - volume: 
-          file "music1.mp3"
+          file: "music1.mp3"
           value: 50
       - play:
-          file "noise.mp3"
+          file: "noise.mp3"
           loop: 1
       - wait:
-          duration 2
+          file: "noise.mp3"
       - volume:
-          file "music1.mp3"
+          file: "music1.mp3"
           value: 100
 
-Baisse temporairement (pour 2 secondes) le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par dessus (joué deux fois).
+Baisse le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par dessus (deux fois). Le volume revient à la normale une fois que le son "noise" est terminé.
 
     :::yaml
     'e':
@@ -169,35 +169,78 @@ Met en pause la musique "music1.mp3" pour 10 secondes et la relance après, en a
 #### Liste des actions possibles: 
 - `play` : joue une musique. Paramètres :
     * `file: "music.mp3"` précise la musique jouée (chemin relatif).
-    * `fade_in x` (facultatif) lance la musique avec un fade in de x secondes.
-    * `volume x` (facultatif) la musique doit être jouée à x% de son volume max (x doit être entre 0 et 100, 100 par défaut)
-    * `loop: x` (facultatif) la musique doit être répétée x fois. Indiquer -1 pour la répéter indéfiniment. Attention, x est le nombre de répétitions, donc pour lire trois fois la musique, mettre `loop: 2`
+    * `fade_in: x` (facultatif) lance la musique avec un fondu au départ de x secondes.
+    * `volume: x` (facultatif, défaut : 100) la musique doit être jouée à x% de son volume max (x doit être entre 0 et 100). Pour jouer une musique à plus de 100%, voir la section "file: properties".
+    * `loop: x` (facultatif, défaut : 0) la musique doit être répétée x fois. Indiquer -1 pour la répéter indéfiniment. Attention, x est le nombre de répétitions, donc pour lire trois fois la musique, mettre `loop: 2`.
 - `stop` : arrête une musique donnée. Paramètres :
     * `file: "music.mp3"` (facultatif) précise la musique à stopper. Si aucune musique n'est précisée, le `stop` s'applique à toutes les musiques.
-    * `fade_out x` (facultatif) stoppe la musique avec un fondu de x secondes.
-    * `wait: true/false` (par défaut : false) dans le cas d'un fondu, attendre la durée du fondu pour faire les actions suivantes. Si la musique s'arrêtait naturellement avant la fin du fondu, l'attente se termine lorsque la musique se termine naturellement. FIXME
+    * `fade_out: x` (facultatif) stoppe la musique avec un fondu de x secondes.
+    * `wait: true/false` (facultatif, par défaut : false) dans le cas d'un fondu, attendre la durée du fondu pour faire les actions suivantes. Si la musique s'arrêtait naturellement avant la fin du fondu, l'attente se termine lorsque la musique se termine naturellement. FIXME
 - `volume` : change le volume d'une musique donnée. Paramètres :
-    * `file: "music.mp3"` précise la musique. Si aucune musique n'est précisée, la modification s'applique au volume global.
-    * `delta: true/false` le volume doit il être précisé en absolu (false, option par défaut), ou en relatif (true), voir plus bas.
+    * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique n'est précisée, la modification s'applique au volume global.
+    * `delta: true/false` (facultatif, par défaut : false) le volume doit il être précisé en absolu (false), ou en relatif (true), voir plus bas.
     * `value: x` Si delta est à false, met le volume à x% du volume max (x doit être entre 0 et 100).
 Ce facteur est appliqué à la musique déjà chargée en mémoire (voir section "propriétés"), donc le 100% fait référence au volume de chargement.
 Si delta est à true, applique un modificateur de x% au volume (x doit être un entier signé).
+Notez qu'une action "+10%" relative ne correspond pas à un pourcentage du volume actuel, mais du volume "de référence" 100%. Ainsi, effectuer +10% et -10% en relatif revient bien à 100%.
+    * `fade: x` (facultatif) le changement de volume est appliqué en fondu sur x secondes. Il n'y a pas d'attente de la fin du fondu pour lancer les actions suivantes : au besoin, rajouter un `wait` à la main.
 - `pause` : met en pause une musique. Paramètres :
-    * `file: "music.mp3"` précise la musique à mettre en pause.
+    * `file: "music.mp3"` (facultatif) précise la musique à mettre en pause. Si non précisé, s'applique à toutes les musiques.
 - `unpause` : relance une musique mise en pause (là où elle en était). Paramètres :
-    * `file: "music.mp3"` précise la musique à relancer.
+    * `file: "music.mp3"` (facultatif) précise la musique à relancer. Si non précisé, s'applique à toutes les musiques.
 - `wait` : attend un temps donné. Paramètres :
-    * `duration: x` attend x secondes
-Notez une fois enore que `wait` est la seule action qui attend d'avoir terminé pour lancer la commane suivante, toutes les autres sont lancées successivement mais sans attendre (donc quasiment simultanément).
+    * `file: "music.mp3"` (facultatif) attend la fin de la musique "music.mp3"
+    * `duration: x` (facultatif) attend x secondes. Si `file` et `duration` sont précisés, l'attente dure jusqu'à la fin de la musique PUIS la durée donnée par `duration`.
+Notez une fois enore que `wait` est quasiment la seule action qui attend d'avoir terminé pour lancer la commane suivante, toutes les autres sont lancées successivement mais sans attendre (donc presque simultanément) : ne pas hésiter à rajouter des commandes d'attente partout où c'est nécessaire.
 - `seek` : permet d'aller à un endroit précis dans une musique. Paramètres :
-    * `file: "music.mp3"` précise la musique. Si aucune musique n'est précisée, l'action s'applique à toutes les musiques.
-    * `delta: true/false` Si delta est true, le temps est relatif. Si delta est false (par défaut ?), le temps est absolu, voir plus bas.
-    * `value: x` Si delta est true, alors fait avancer de x secondes dans la musique (reculer si x est négatif). Si delta est false, alors la lecture se place à x secondes du début. Si la musique est en train de faire un fondu au départ, le fondu est oublié et la musique est jouée au volume normal. Si la musique est en train de se terminer en fondu, le "seek" est ignoré.
+    * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique n'est précisée, l'action s'applique à toutes les musiques.
+    * `delta: true/false` (facultatif, défaut : false) Si delta est true, le temps est relatif. Si delta est false, le temps est absolu, voir plus bas.
+    * `value: x` Si delta est true, alors fait avancer de x secondes dans la musique (reculer si x est négatif). Si delta est false, alors la lecture se place à x secondes à partir du début. Si la musique est en train de faire un fondu (au départ, ou changement de volume), le fondu se "termine automatiquement" : et la musique est immédiatement au volume final voulu. Si la musique est en train de se terminer en fondu, le "seek" est ignoré (un fondu de fin considère la musique comme déjà terminée).
+    * `stop_all_actions:` Interrompt toutes les actions en cours et à faire.
 
 ### `aliases` : définir des alias
 
-Il est possible de définir des alias pour les différents objets du fichier yml.
+Il est possible de définir des alias pour les différents paramètres. Ces alias sont internes au fichier de configuration, pour afficher un "joli" nom d'une musique, voir plutôt "file: properties".
+
 
 #### Exemples
 
-``
+    :::yaml
+    aliases:
+      music1:
+        file: "path/to/my/favourite/music.mp3"
+
+    keys:
+      'a':
+        play:
+          include: music1
+
+`music1` est désormais un alias pour `"path/to/my/favourite/music.mp3"`. À chaque fois qu'on veut écrire `file: "path/to/my/favourite/music.mp3"`, on peut écrire à la place `include: music1`. Attention, dans la section "file_properties", les alias ne fonctionnent pas, et il faut écrire le nom du fichier complet.
+
+    :::yaml
+    aliases:
+      blue:
+        color: [0, 0, 255]
+
+    keys_properties:
+      'a':
+        description:
+          - 
+          - blue key
+        include: blue
+
+`blue` est un alias pour la couleur `[0, 0, 255]`. À chaque fois qu'on veut écrire `color: [0, 0, 255]`, on peut écrire `include: blue` à la place.
+
+    :::yaml
+    aliases:
+      long_time:
+        duration: 42
+
+    keys:
+      'b':
+        wait:
+          include: long_time
+        play: 
+          file: "music1.mp3"
+
+`long_time` est un alias pour la durée 42 secondes. Au lieu d'écrire `duration: 42`, on peut écrire `include: long_time`.