francoisponcin/Chill-manuals
1
0
Fork 0
forked from Chill-project/manuals
Code Pull Requests 1 Activity

update doc admin docgen"

Browse Source
This commit is contained in:
nobohan 2022-03-18 07:49:06 +01:00
parent e59c482b2d
commit 4a95cae4e9
1 changed files with 35 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
admin/generation-documents.md
View File

@ -57,8 +57,8 @@ Les dates sont disponibles dans deux formats:
lorsqu'une date est disponible, il est donc possible d'avoir accès à son format en précisant sa chaine de caractère. Exemple avec la date de naissance de la personne: lorsqu'une date est disponible, il est donc possible d'avoir accès à son format en précisant sa chaine de caractère. Exemple avec la date de naissance de la personne:
``` ```
personBirthdateShort=15/06/1980 person.Birthdate.Short=15/06/1980
personBirthdateLong=15 juin 1980 person.Birthdate.Long=15 juin 1980
``` ```
@ -230,7 +230,7 @@ ${courseStartDateShort} // 15/01/2021
* `location` (Location): Lieu de l'échange * `location` (Location): Lieu de l'échange
* `reasons` (liste de ActivityReason): Sujets de l'échange (pas utilisé en Vendée) * `reasons` (liste de ActivityReason): Sujets de l'échange (pas utilisé en Vendée)
* `scope` (Scope): Service (pas utilisé en Vendée) * `scope` (Scope): Service (pas utilisé en Vendée)
* `sentReceived (text): sera `received` si reçu, et `sent` si envoyé; * `sentReceived` (text): sera `received` si reçu, et `sent` si envoyé;
* `socialActions` (liste de SocialAction): liste d'actions sociales associées * `socialActions` (liste de SocialAction): liste d'actions sociales associées
* `socialIssues` (liste de SocialIssue): liste de problématiques sociales associées * `socialIssues` (liste de SocialIssue): liste de problématiques sociales associées
* `thirdParties` (liste de ThirdParty): liste de tiers associés * `thirdParties` (liste de ThirdParty): liste de tiers associés
@ -238,7 +238,7 @@ ${courseStartDateShort} // 15/01/2021
* `user` (User): l'utilisateur pour lequel l'échange a été créé; * `user` (User): l'utilisateur pour lequel l'échange a été créé;
* `users` (liste de Users): les utilisateurs qui sont associés à l'échange. * `users` (liste de Users): les utilisateurs qui sont associés à l'échange.
### ActivityPrésence ### ActivityPresence
Présence à l'échange Présence à l'échange
@ -290,22 +290,22 @@ Présence à l'échange
* `gensDuVoyage` (bool): `true` si la personne fait partie des gens du voyage * `gensDuVoyage` (bool): `true` si la personne fait partie des gens du voyage
* `titreDeSejour` (TitreDeSejour): entité TitreDeSejour * `titreDeSejour` (TitreDeSejour): entité TitreDeSejour
* `titreDeSejourComment` (Comment): Commentaire (avec la date de la dernière mise à jour) * `titreDeSejourComment` (Comment): Commentaire (avec la date de la dernière mise à jour)
* `situationProfessionelle` (situationProfessionelle): entité situationProfessionelle * `situationProfessionelle` (SituationProfessionelle): entité SituationProfessionelle
* `aidantFamilial` (bool): `true` si la personne fait partie des gens du voyage * `aidantFamilial` (bool): `true` si la personne fait partie des gens du voyage
* `tempsDeTravail` (tempsDeTravail): entité tempsDeTravail * `tempsDeTravail` (TempsDeTravail): entité TempsDeTravail
* `situationProfessionelleComment` (Comment): Commentaire (avec la date de la dernière mise à jour) * `situationProfessionelleComment` (Comment): Commentaire (avec la date de la dernière mise à jour)
* `situationProfessionelleStartDate` (Date) * `situationProfessionelleStartDate` (Date)
* `niveauEtude` (niveauEtude): entité niveauEtude * `niveauEtude` (NiveauEtude): entité NiveauEtude
* `mobilite` (mobilite): entité mobilite * `mobilite` (mMbilite): entité Mobilite
* `permisDeConduire` (bool): `true` si la personne a un permis de conduire * `permisDeConduire` (bool): `true` si la personne a un permis de conduire
* `moyenDeTransport` (bool): `true` si la personne a un moyen de transport * `moyenDeTransport` (bool): `true` si la personne a un moyen de transport
* `infoSocioProComment` (Comment): Commentaire (avec la date de la dernière mise à jour) * `infoSocioProComment` (Comment): Commentaire (avec la date de la dernière mise à jour)
* `entourage` (entourage): entité entourage * `entourage` (Entourage): entité Entourage
* `entourageComment` (Comment): Commentaire (avec la date de la dernière mise à jour) * `entourageComment` (Comment): Commentaire (avec la date de la dernière mise à jour)
* `numeroSecuriteSociale` (texte) * `numeroSecuriteSociale` (texte)
* `caisseSecuriteSociale` (texte) * `caisseSecuriteSociale` (texte)
* `pasDeMedecinTraitant` (bool): `true` si la personne n'a pas de médecin traitant * `pasDeMedecinTraitant` (bool): `true` si la personne n'a pas de médecin traitant
* `medecinTraitant` (tiers): entité tiers * `medecinTraitant` (Tiers): entité ThirdParty
* `medecinTraitantTexteLibre` (texte) * `medecinTraitantTexteLibre` (texte)
* `mdph` (texte) * `mdph` (texte)
* `mdphStartDate` (Date) * `mdphStartDate` (Date)
@ -332,10 +332,11 @@ Présence à l'échange
* `girEndDate` (Date) * `girEndDate` (Date)
* `girComment` (Comment): Commentaire (avec la date de la dernière mise à jour) * `girComment` (Comment): Commentaire (avec la date de la dernière mise à jour)
* `infoMedicaleComment` (Comment): Commentaire (avec la date de la dernière mise à jour) * `infoMedicaleComment` (Comment): Commentaire (avec la date de la dernière mise à jour)
* `statutLogement` (statutLogement): entité statutLogement * `statutLogement` (StatutLogement): entité StatutLogement
* `statutLogementComment` (Comment): Commentaire (avec la date de la dernière mise à jour) * `statutLogementComment` (Comment): Commentaire (avec la date de la dernière mise à jour)
* `caisseDeRetraitePrincipale` (texte) * `caisseDeRetraitePrincipale` (texte)
* `caisseDeRetraiteComment` (Comment): Commentaire (avec la date de la dernière mise à jour) * `caisseDeRetraiteComment` (Comment): Commentaire (avec la date de la dernière mise à jour)
* `caissesDeRetraiteComplementaires` (texte): Caisses de retraite complémentaires, séparées par des virgules
En outre, si la personne est mineure, on a accès aux champs suivants: En outre, si la personne est mineure, on a accès aux champs suivants:
@ -353,17 +354,17 @@ En outre, si la personne est mineure, on a accès aux champs suivants:
* `delegation` (bool): `true` si délégation * `delegation` (bool): `true` si délégation
* `delegationDate` (Date) * `delegationDate` (Date)
* `delegationComment` (Comment): Commentaire (avec la date de la dernire mise à jour) * `delegationComment` (Comment): Commentaire (avec la date de la dernire mise à jour)
* `delegationThirdParty` (tiers): entité tiers * `delegationThirdParty` (tiers): entité ThirdParty
* `delegationPerson` (person): entité person * `delegationPerson` (person): entité Person
* `tuteur` (texte) * `tuteur` (texte)
* `tuteurThirdParty` (tiers): entité tiers * `tuteurThirdParty` (tiers): entité ThirdParty
* `administrateurAdhoc` (bool): `true` si administrateurAdhoc * `administrateurAdhoc` (bool): `true` si administrateurAdhoc
* `administrateurAdhocDate` (Date) * `administrateurAdhocDate` (Date)
* `administrateurAdhocComment` (Comment): Commentaire (avec la date de la dernire mise à jour) * `administrateurAdhocComment` (Comment): Commentaire (avec la date de la dernire mise à jour)
* `pupilleEtat` (bool): `true` si pupilleEtat * `pupilleEtat` (bool): `true` si pupilleEtat
* `pupilleEtatDate` (Date) * `pupilleEtatDate` (Date)
* `pupilleComment` (Comment): Commentaire (avec la date de la dernire mise à jour) * `pupilleComment` (Comment): Commentaire (avec la date de la dernire mise à jour)
* `tuteurPerson` (person): entité person * `tuteurPerson` (person): entité Person
* `enfantEmancipe` (bool): `true` si enfantEmancipe * `enfantEmancipe` (bool): `true` si enfantEmancipe
* `enfantEmancipeDate` (Date) * `enfantEmancipeDate` (Date)
* `gardeAlternee` (texte) * `gardeAlternee` (texte)
@ -396,6 +397,7 @@ En outre, si la personne est mineure, on a accès aux champs suivants:
* `notificationMDPHStartDate` (Date) * `notificationMDPHStartDate` (Date)
* `notificationMDPHEndDate` (Date) * `notificationMDPHEndDate` (Date)
* `dispositifsComment` (Comment): Commentaire (avec la date de la dernire mise à jour) * `dispositifsComment` (Comment): Commentaire (avec la date de la dernire mise à jour)
* `adresseDeRelais` (adresse): liste d'adresses
::: :::
#### variant `household` #### variant `household`
@ -422,6 +424,16 @@ Téléphone du père: ${personFatherFirstphonenumber} // 01 23 45 67 89
* `id` (int): identifiant (utile pour des comparaisons); * `id` (int): identifiant (utile pour des comparaisons);
* `name` (texte): titre, label de la civilité; * `name` (texte): titre, label de la civilité;
::: { .vendee }
### Entourage
* `person` (person): entité Person
* `thirdParty` (tiers): entité ThirdParty
* `text` (texte)
* `comment` (comment): Commentaire (avec la date de la dernire mise à jour)
* `aidantProche` (bool): `true` si aidantProche
:::
### Household ### Household
@ -446,6 +458,14 @@ Téléphone du père: ${personFatherFirstphonenumber} // 01 23 45 67 89
* `id` (int): identifiant de la position; * `id` (int): identifiant de la position;
* `label` (texte): label de la position dans le ménage; * `label` (texte): label de la position dans le ménage;
::: { .vendee }
### Mobilite, NiveauEtude, SituationProfessionelle, StatutLogement, TempsDeTravail, TitreDeSejour
* `active` (bool): `true` si active
* `name` (texte)
:::
### ThirdParty ### ThirdParty
* `id` (int): identifiant du tiers; * `id` (int): identifiant du tiers;