diff --git a/admin/docs/generation-documents/cheatsheet.md b/admin/docs/generation-documents/cheatsheet.md new file mode 100644 index 0000000..862fa06 --- /dev/null +++ b/admin/docs/generation-documents/cheatsheet.md @@ -0,0 +1,37 @@ +# Cheatsheet + +## Tableau des variables par contexte + +| Contexte | Variable | Type | Condition | +| --- | --- | --- | --- | +| Tous les contextes | `creator` | [User](properties.md#sec:entity-user) | toujours présent | +| Tous les contextes | `createdAt` | [Date](properties.md#sec:entity-date) | toujours présent | +| Tous les contextes | `createdAtDate` | [Date](properties.md#sec:entity-date) | toujours présent | +| Tous les contextes | `location` | [Location](properties.md#sec:entity-location) | toujours présent | +| Parcours | `course` | [AccompanyingPeriod](properties.md#sec:entity-accompanyingperiod) | toujours présent | +| Parcours | `mainPerson` | [Person](properties.md#sec:entity-user) | si `usager principal du parcours` est coché | +| Parcours | `person1` | [Person](properties.md#sec:entity-user) | si `usager 1` est coché | +| Parcours | `person2` | [Person](properties.md#sec:entity-user) | si `usager 2` est coché | +| Parcours | `thirdParty` | [ThirdParty](properties.md#sec:entity-thirdparty) | si `tiers` est coché | +| Parcours, contexte "liste des activités" | `activities` | liste de [Activity](properties.md#sec:entity-activity) | toujours présent (variant "light") | +| Évaluation | `evaluation` | [AccompanyingPeriodWorkEvaluation](properties.md#sec:entity-accompanyingperiodworkevaluation) | toujours présent | +| Évaluation | `work` | [AccompanyingPeriodWork](properties.md#sec:entity-accompanyingperiodwork) | toujours présent | +| Évaluation | `course` | [AccompanyingPeriod](properties.md#sec:entity-accompanyingperiod) | toujours présent | +| Évaluation | `mainPerson` | [Person](properties.md#sec:entity-person) | si `usager principal du parcours` est coché | +| Évaluation | `person1` | [Person](properties.md#sec:entity-person) | si `usager 1` est coché | +| Évaluation | `person2` | [Person](properties.md#sec:entity-person) | si `usager 2` est coché | +| Évaluation | `thirdParty` | [ThirdParty](properties.md#sec:entity-thirdparty) | si configuré par l'administrateur fonctionnel | +| Échange | `activity` | [Activity](properties.md#sec:entity-activity) | toujours présent | +| Échange | `course` | [AccompanyingPeriod](properties.md#sec:entity-accompanyingperiod) | si l'échange a été créé dans un contexte parcours | +| Échange | `person` | [Person](properties.md#sec:entity-person) | si l'échange a été créé dans un contexte d'usager | +| Échange | `mainPerson` | [Person](properties.md#sec:entity-person) | si `usager principal du parcours` est coché | +| Échange | `person1` | [Person](properties.md#sec:entity-person) | si `usager 1` est coché | +| Échange | `person2` | [Person](properties.md#sec:entity-person) | si `usager 2` est coché | +| Personne (contexte "personne basique") | `person` | [Person](properties.md#sec:entity-person) | toujours présent | +| Personne (contexte "personne basique") | `thirdParty` | [ThirdParty](properties.md#sec:entity-thirdparty) | si configuré par l'administrateur fonctionnel | +| Personne (contexte "personne avec un tiers") | `person` | [Person](properties.md#sec:entity-person) | toujours présent | +| Personne (contexte "personne avec un tiers") | `thirdParty` | [ThirdParty](properties.md#sec:entity-thirdparty) | toujours présent | +| Rendez-vous | `calendar` | [Calendar](properties.md#sec:entity-calendar) | toujours présent | +| Rendez-vous | `mainPerson` | [Person](properties.md#sec:entity-person) | si configuré par l'administrateur fonctionnel | +| Rendez-vous | `thirdParty` | [ThirdParty](properties.md#sec:entity-thirdparty) | si configuré par l'administrateur fonctionnel | + diff --git a/admin/docs/generation-documents/properties.md b/admin/docs/generation-documents/properties.md index 0e1f723..7e3b661 100644 --- a/admin/docs/generation-documents/properties.md +++ b/admin/docs/generation-documents/properties.md @@ -206,7 +206,7 @@ Dans le variant `light`, Seul le champ `comment` est donc disponible. -## Calendar (Rendez-vous) { #sec:entity-calendar} +## Calendar (Rendez-vous) { #sec:entity-calendar } * id (int): identifiant diff --git a/admin/mkdocs.yml b/admin/mkdocs.yml index 519918e..53ad750 100644 --- a/admin/mkdocs.yml +++ b/admin/mkdocs.yml @@ -15,6 +15,7 @@ nav: - Génération de document: Principes: generation-documents/index.md Propriété des objets: generation-documents/properties.md + Cheatsheet: generation-documents/cheatsheet.md - Gestion des droits: gestion-des-droits.md - Personnalisation du logiciel: personalize-chill.md hooks: