From 8b6339c1418b233ccc00ce5149e37a497cfb2d23 Mon Sep 17 00:00:00 2001 From: "mathias.chouet" <mathias.chouet@irstea.fr> Date: Mon, 5 Aug 2019 10:08:33 +0200 Subject: [PATCH] #157 : updated README with documentation on help links --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 119747ae2..b6fe0e950 100644 --- a/README.md +++ b/README.md @@ -168,6 +168,17 @@ Custom Material SVG Icons will only show up when the application is deployed on - éventuellement le type de noeud de paramètres particuliers (objets comportant _"type":"input"_) avec le champ _"nodeType": "MaCalculetteBleue"_ (par défaut, "_ComputeNodeType.None_") + - éventuellement l'URL de l'aide pour n'importe quel élément de l'interface graphique : + - pour un champ de saisie numérique : `{... "type": "input", "id": "ID", "help": "aide.html", ...}` (remplacer la forme courte `"ID"` si nécessaire) + - pour n'importe quelle entrée d'un champ de type "select" : `{... "type": "select", "help": "aide.html", ...}` + - pour des entrées spécifiques d'un champ de type "select" : `{... "type": "select", "help": { "IdDeLOption": "aide.html", ...}, ...}` (se référer au fichier de traduction du module pour la liste des ID des options, par exemple "SeuilTriangulaireTrunc_TriangularTruncWeirFree") + - pour un _fieldset_: `{... "type": "fieldset", + "help": "aide.html", ...}` + - pour tous les _fieldset_ d'un _fieldset_template_: `{... "type": "fieldset_template", + "help": "aide.html", ...}` + - pour l'entête d'un _template_container_: `{... "type": "template_container", + "help": "aide.html", ...}` + - dans _src/app/calculators/ma-calculette_ : Créer les fichiers d'internationalisation (_ma-calculette.<langue>.json_). Il doivent reprendre tous les ids utilisés dans le fichier de configuration et fournir leur traduction. -- GitLab