Skip to content

Commit

Permalink
Doc (#260)
Browse files Browse the repository at this point in the history 
* docs on widgets and parameters
---------

Co-authored-by: amandine-sahl <[email protected]>
  • Loading branch information
@TheoLechemia @amandine-sahl
TheoLechemia and amandine-sahl authored Dec 5, 2023
1 parent 43bffba commit e585ce8
Showing 1 changed file with 50 additions and 6 deletions.
56 changes: 50 additions & 6 deletions docs/sous_module.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ title: 'Création d''un sous-module'
- [Configuration générale](#configuration-générale)
- [Configuration des objets](#configuration-des-objets)
- [Les schémas génériques](#les-schémas-génériques)
- [Liste des widgets disponibles](#liste-des-widgets-disponibles)
- [Listes des paramètres disponibles par type de widgets :](#listes-des-paramètres-disponibles-par-type-de-widgets-)
- [Définir une nouvelle variable](#définir-une-nouvelle-variable)
- [Redéfinir une variable existante](#redéfinir-une-variable-existante)
- [`datalists`](#datalists)
Expand Down Expand Up @@ -95,7 +97,7 @@ Dans le cas général (`module.json`, `site.json`, `visit.json`,

* `label` : permet de nommer les objets, par exemple `"Site"` pour
site,
* `description_field_name` : le nom du champs qui servira à décrire le
* `description_field_name` : le nom du champ qui servira à décrire le
site (pour le titre du site), par exemple :
* `"visit_date_min"` pour une visite,
* `"base_site_name"` pour un site;
Expand Down Expand Up @@ -163,10 +165,10 @@ Chaque entrée de la variable `generic` est le nom d'une variable
* `required` : permet de rendre un input obligatoire
* `definition` : permet d'ajouter une définiton à la variable
pour aider l'utilisateur
* les attributs [spéciaux]{.title-ref} :
* les attributs spéciaux :
* `type_util`: peut prendre pour valeur `"user"`,
`"nomenclature"`, `"dataset"` ou `"taxonomy"`. Permet
d'indiquer qu'il s'agit ici d'un id (d'une nomenclature) et
d'indiquer qu'il s'agit ici d'un identifiant (exemple : nomenclature) et
de traiter cette variable en fonction.

On peut mettre en valeur de ces attributs des données de la
Expand All @@ -184,6 +186,47 @@ Pour cela il faut utiliser les variables suivantes :
qui peuvent servir dans la définition des formulaires (en particulier
pour les datalist). Voir ci dessous

#### Liste des widgets disponibles

| Widgets | Commentaire |
|--------------|--------------------------------------------------------------------------|
| text | Texte sur une seule ligne |
| textarea | Texte sur une plusieurs lignes |
| radio | Choix multiples uniques |
| select | Liste de choix unique |
| time | Heure |
| number | - |
| multiselect | Listes de choix multiples |
| html | Insertion d'un bloc html |
| nomenclature | Liste avec vocabulaire controlé de GeoNature |
| taxonomy | Selection d'un taxon |
| observers | Selection d'un observateur |
| date | Sélection d'une date |
| datalist | Liste dont les items sont fournies par une API (externe ou interne à GN) |
| | |


#### Listes des paramètres disponibles par type de widgets :

| Widgets | Paramètres | Commentaire |
|-----------------------------------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| Tous | attribut_label | Label du formulaire |
| Tous | definition | Ajoute une tooltip avec le contenu de ce paramètre (le paramètre `link_definition` ne doit pas être défini) |
| Tous | required | Booléen : permet de rendre obligatoire cet input |
| Tous | hidden | Booléen : permet de cacher un formulaire |
| Tous | link_definition | Ajoute un lien vers l'addresse pointé par ce paramètre. Le paramètre `definition` doit également être définit |
| Tous | pattern_message | Ajoute un texte en rouge sous le formulaire explicitant une erreur sur le champ |
| Tous | value | Valeur par défaut du formulaire |
| select / multiselect / checkbox / radio | values | Valeurs de choix proposées. Attend une tableau de valeur ou un tableau clé/valeur `[{"value": "my_database_value", "label": "my_display_value"}]` |
| select | noNullOption | Désactive la valeur vide ("-") des choix d'un select |
| number | min | Valeur minimum de l'input |
| number | max | Valeur maximum de l'input |
| nomenclature | code_nomenclature_type | Code de la nomenclature à afficher |
| nomenclature | cd_nomenclatures | Liste des codes nomenclatures à afficher (afin d'éliminer certains items de nomenclatures que l'on ne veut pas pour ce sous-module) |
| nomenclature / dataset | multi_select | Booléan : permet de seléctionner plusieurs items de nomenclatures |
| dataset | module_code | Limite aux jeu de données associés à ce module |
| html | html | Contenu du bloc html |

## Définir une nouvelle variable

Pour définir une nouvelle variable ou aussi redéfinir une
Expand Down Expand Up @@ -301,6 +344,7 @@ selectionner uniquement les jeux de données associés au module.

Il est important d'ajouter `"type_util": "dataset",`.


## Redéfinir une variable existante

Dans plusieurs cas, on peut avoir besoin de redéfinir un élément du
Expand Down Expand Up @@ -656,9 +700,9 @@ placés dans le dossier `<module_code>/exports/csv/`.
```

* Paramètres :
* label : Nom de l'export
* method : Nom de la vue sans le code du module
* filter_dataset (true|false) : Ajoute le filtre des datasets.
* `label` : Nom de l'export
* `method` : Nom de la vue sans le code du module
* `filter_dataset` (true|false) : Ajoute le filtre des datasets.
Dans ce cas il faut que la vue ait un champ `id_dataset`
* La commande `geonature monitorings process_export_csv <module_code>`
permet de :
Expand Down

0 comments on commit e585ce8

Please sign in to comment.