Change "keys" hash to "key_properties" in config.yml

[perso/Immae/Projets/Python/MusicSampler.git] / documentation_fr.md

diff --git a/documentation_fr.md b/documentation_fr.md
index b739aa2c752cddb5e75c62472da717b7073ec336..d7d2f2cb4e961e3fa219cd1760ab592e69090535 100644 (file)
--- a/documentation_fr.md
+++ b/documentation_fr.md
@@ -247,6 +247,12 @@ secondes d'intervalle, le second appui est ignoré.
 - `repeat_delay: x` (par défaut : 0) : délai de "sécurité" en cas d'appuis
   successifs sur la touche. La touche est désactivée (grisée et barrée) pendant
   toute la durée des actions puis le délai de x secondes.
+- `actions: liste`: Liste des actions à effectuer en appuyant sur la touche.
+
+### Propriété `common`
+
+Une entrée spéciale `common` s'applique à toutes les touches. Les propriétés
+définies dans cette entrée peuvent être modifiées individuellement.
 
 ### `keys` : actions sur les touches
 
@@ -254,6 +260,8 @@ Cette section sert à décrire, pour chaque touche, la liste des actions
 successives. Notez que la plupart des actions (hors `wait` et quelques cas
 particuliers, voir plus bas) sont quasi-instantanées.
 
+*Cette section est obsolète et remplacée par une clé `actions` contenant une
+liste dans la section `key_properties` pour chaque touche.*
 
 #### Exemples
 
@@ -427,10 +435,24 @@ successivement mais sans attendre (donc presque simultanément) : ne pas hésite
       suite de celle-ci puisqu'elles seront systématiquement interrompues.
 - `interrupt_wait`: interrompt l'attente (de `wait` ou fin d'un fondu avec
   attente) et passe directement à l'action suivante. Paramètre :
-    * `wait_id: name` : précise l'identifiant du `wait` à stopper (défini par
-      `set_wait_id`, voir les actions `wait` et `stop`). Pour interrompre
-      plusieurs `wait` d'un seul coup, il faut mettre plusieurs
-      `interrupt_wait`.
+    * `wait_id: name` (facultatif) précise l'identifiant du `wait` à stopper
+      (défini par `set_wait_id`, voir les actions `wait` et `stop`). Si absent,
+      interrompt toutes les attentes.
+- `pause_wait`: met une attente en pause (uniquement pour une attente ayant une
+  durée définie). La touche qui attend cet événement ne continuera pas tant que
+  l'attente n'est pas reprise. Paramètres :
+    * `wait_id: name` (facultatif) précise l'identifiant du `wait` à mettre en
+      pause. Si absent, met en pause toutes les attentes compatibles.
+- `unpause_wait`: reprend une attente en pause (uniquement pour une attente
+  ayant une durée définie). Le compte à rebours reprendra pour la touche
+  correspondante en train d'attendre. Paramètres:
+    * `wait_id: name` (facultatif) précise l'identifiant du `wait` à reprendre.
+      Si absent, reprend toutes les attentes compatibles.
+- `reset_wait`: réinitialise une attente (uniquement pour une attente ayant une
+  durée définie). Si l'attente est en pause, le compte à rebours ne recommencera
+  au début que lorsque l'attente sera reprise. Paramètres:
+    * `wait_id: name` (facultatif) précise l'identifiant du `wait` à
+      réinitialiser. Si absent, réinitialise toutes les attentes compatibles.
 - `run_command` : lance une commande. Paramètres :
     * `command: my_command` : précise la commande à lancer.
     * `wait: true/false` (facultatif, défaut : false) : si `wait` est true,