Compare commits

..

1 Commits

Author SHA1 Message Date
6bb97f6f7d update User definition (docgen documentation)
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
2023-11-13 13:55:19 +00:00

View File

@ -1,3 +1,4 @@
# Génération de documents
L'administrateur fonctionnel prépare la génération des documents.
@ -469,12 +470,6 @@ Seul le champ `comment` est donc disponible.
* `id` (texte): identifiant
* `title` (texte): le titre du résultat
### GenderEntity (Genre)
* `label` (texte): label du genre;
* `id` (int): identifiant (utile pour des comparaisons);
* `genderTranslation` (texte): utilisation grammaticale;
### Household (Ménage)
@ -543,7 +538,7 @@ La composition du ménage entre deux dates. Cette entité associe une `Household
* `birthdate` (Date)
* `age`: (int) age de la personne;
* `deathdate` (Date)
* `genderEntity` (GenderEntity): Genre;
* `gender` (texte): genre (texte traduit);
* `maritalStatus` (texte): représentation textuelle de l'état civil;
* `maritalStatusDate` (Date): date à la quelle le statut de l'état civil a été mis à jour;
* `maritalStatusComment` (Comment): Commentaire sur l'état civil (avec la date de la dernière mise à jour)
@ -558,9 +553,6 @@ La composition du ménage entre deux dates. Cette entité associe une `Household
* `address` (Adresse): l'adresse actuelle
* `resources` (PersonResource): les personnes ressources, ajoutées depuis le dossier de l'usager.
**Note**: La clé `gender` est dépréciée. Merci d'utiliser `GenderEntity`.
#### variant `household`
* `household` (Household): le ménage actuel de l'usager;
@ -714,12 +706,17 @@ Les variables présentent le nom de la relation (`text`), et la personne avec qu
* `username` (texte): le login
* `email` (texte): l'email de l'utilisateur
* `text` (texte): le libellé complet de l'utilisateur (avec son métier et son service entre parenthèse);
* `text_without_absent` (texte): le libellé complet de l'utilisateur, sans la mention "est absent";
* `label` (texte): le libellé de l'utilisateur, tel qu'il est enregistré par l'administrateur fonctionnel
* `main_scope` (Scope): service principal
* `user_job` (UserJob): métier principal
* `current_location` (Location): lieu de l'utilisateur, celui actuellement choisi par l'utilisateur par le menu "utilisateur";
* `main_location` (Location): localisation de l'utilisateur définie par l'administrateur fonctionnel (parfois appelé "résidence administrative"). L'utilisateur ne peut pas la modifier lui-même;
* `main_center` (Center): Centre principal (défini par l'administrateur fonctionnel);
* `civility` (Civility): la civilité de l'utilisateur;
* `isAbsent` (bool): true si l'utilisateur est noté comme absent;
* `phonenumber` (texte): Numéro de téléphone de l'utilisateur
### UserJob (Métier)