From a85592766b8122448b5e14840e1b7f596ffa6e8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Mon, 11 Apr 2022 16:29:39 +0200 Subject: [PATCH] doc gen for a list of activities on a course --- admin/generation-documents.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/admin/generation-documents.md b/admin/generation-documents.md index 95388a4..13d40c5 100644 --- a/admin/generation-documents.md +++ b/admin/generation-documents.md @@ -114,6 +114,13 @@ Le document présente: * si `usager 1` est coché, une variable `person1`, de type Person, avec les variants `relations`, `household` (ménage) et `budget`; * si `usager 2` est coché, une variable `person2`, de type Person, avec les variants `relations`, `household` (ménage) et `budget`; +### Document générés pour un parcours, contexte "liste des activités" + +Le contexte présente les mêmes variables et paramètre que les documents générés par un parcours. + +La variable suivante est ajoutée: + +* `activities` (liste de Activity): Liste d'activités, variant "light". Aucun filtre n'est appliqué sur les échanges récupérés. ### Document générés pour une évaluation @@ -243,6 +250,24 @@ ${courseStartDateShort} // 15/01/2021 * `user` (User): l'utilisateur pour lequel l'échange a été créé; * `users` (liste de Users): les utilisateurs qui sont associés à l'échange. +#### variant `light` + +Un variant `light` est utilisé dans les listes d'`Activity`, comme par exemple pour le contexte "Liste des activités pour un parcours". + +Ce variant comporte les mêmes attributs, avec les différences suivantes: + +* le champ `user` n'est pas présent; +* le champ `scope` n'est pas présent; +* le champ `reasons` n'est pas présent; +* le champ `comment` est également présenté avec le variant `light`. + +### ActivityType + +Type d'activité. + +* `id` (int): identifiant; +* `name` (texte): libellé + ### ActivityPresence Présence à l'échange @@ -724,3 +749,12 @@ Certains champs commentaire enregistrent également l'utilisateur qui a effectu * `date` (Date): la date de la dernière modification; * `user` (User): l'utilisateur qui a effectué la dernière modification; +#### Variant `light` + +Dans le variant `light`, + +* le champ `date` n'est pas présent; +* le champ `user` n'est pas présent. + +Seul le champ `comment` est donc disponible. +