Fix typo

add link to the dedicated section

add link to the dedicated section

.gitea/workflows/build-and-push-mkdocs-docker-image.yml

@@ -0,0 +1,103 @@
+name: Build and Push MkDocs Docker Image
+
+on:
+    push:
+        branches:
+            - main
+            - master
+        paths:
+            - 'Dockerfile'
+            - 'user/**'
+            - 'admin/**'
+            - '.gitea/workflows/**'
+    workflow_dispatch:
+
+jobs:
+    build-and-push:
+        runs-on: cth-ubuntu-latest
+
+        env:
+            REGISTRY: ${{ vars.REGISTRY }}
+            IMAGE: ${{ vars.IMAGE }}
+            IMAGE_NAME: ${{ vars.REGISTRY }}/${{ vars.IMAGE }}:${{ github.sha }}
+            KUBE_CA: ${{ vars.KUBE_CA }}
+            KUBE_SERVER: ${{ vars.KUBE_SERVER }}
+            REGISTRY_USERNAME: ${{ vars.REGISTRY_USERNAME }}
+            NAMESPACE: ${{ vars.NAMESPACE }}
+            DEPLOYMENT_NAME: ${{ vars.DEPLOYMENT_NAME }}
+            CONTAINER: ${{ vars.CONTAINER }}
+
+        steps:
+            -   name: Checkout code
+                uses: https://github.com/actions/checkout@v4
+                with:
+                    persist-credentials: 'true' # Optional; should be the default
+
+            -   name: Checkout lfs
+                run: |
+                    git lfs install --local
+                    AUTH=$(git config --local http.${{ github.server_url }}/.extraheader)
+                    git config --local --unset http.${{ github.server_url }}/.extraheader
+                    git config --local http.${{ github.server_url }}/${{ github.repository }}.git/info/lfs/objects/batch.extraheader "$AUTH"
+                    git lfs pull
+
+            -   name: Set up Docker Buildx
+                uses: https://github.com/docker/setup-buildx-action@v3
+
+            -   name: Log in to Docker registry
+                uses: https://github.com/docker/login-action@v3
+                with:
+                    registry: ${{ env.REGISTRY }}
+                    username: ${{ env.REGISTRY_USERNAME }}
+                    password: ${{ secrets.REGISTRY_PASSWORD }}
+
+            -   name: Build and push
+                id: build-push
+                uses: https://github.com/docker/build-push-action@v5
+                with:
+                    context: .
+                    file: Dockerfile
+                    push: true
+                    tags: '${{ env.IMAGE_NAME }}'
+
+            -   name: Install kubectl
+                run: |
+                    curl -LO "https://dl.k8s.io/release/v1.31.0/bin/linux/amd64/kubectl"
+                    chmod +x ./kubectl
+                    sudo mv ./kubectl /usr/local/bin/kubectl
+
+            -   name: Set up kubeconfig
+                env:
+                    KUBE_SERVER: ${{ env.KUBE_SERVER }}      # e.g. https://<API_ENDPOINT>
+                    KUBE_CA: ${{ env.KUBE_CA }}              # base64 encoded, or fetched via kubectl config view
+                    KUBE_TOKEN: ${{ secrets.KUBE_TOKEN }}        # Token generated via 'kubectl create token'
+                run: |
+                    mkdir -p ~/.kube
+                    cat <<EOF > ~/.kube/config
+                    apiVersion: v1
+                    kind: Config
+                    clusters:
+                      - name: default-cluster
+                        cluster:
+                          server: "$KUBE_SERVER"
+                          certificate-authority-data: "$KUBE_CA"
+                    contexts:
+                      - name: default-context
+                        context:
+                          cluster: default-cluster
+                          user: gitea-actions
+                    current-context: default-context
+                    users:
+                      - name: gitea-actions
+                        user:
+                          token: "$KUBE_TOKEN"
+                    EOF
+
+            -   name: Patch Deployment Image
+                env:
+                    NAMESPACE: ${{ env.NAMESPACE }}
+                    DEPLOYMENT: ${{ env.DEPLOYMENT_NAME }}
+                    CONTAINER: ${{ env.CONTAINER }}
+                run: |
+                    echo "deploy new tag: $TAG_IMAGE"
+                    kubectl -n ${NAMESPACE} set image deployment/${DEPLOYMENT} ${CONTAINER}=${IMAGE_NAME}

.gitignore

@@ -1,2 +1,3 @@
 build/*
 *-manual.pdf
+.venv/

.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

.idea/manuals.iml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module version="4">
+  <component name="TemplatesService">
+    <option name="TEMPLATE_FOLDERS">
+      <list>
+        <option value="$MODULE_DIR$/pandoc/cl/templates" />
+      </list>
+    </option>
+  </component>
+</module>

.idea/misc.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Black">
+    <option name="sdkName" value="Python 3.10 (manuals)" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.10 (manuals)" project-jdk-type="Python SDK" />
+</project>

.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/manuals.iml" filepath="$PROJECT_DIR$/.idea/manuals.iml" />
+    </modules>
+  </component>
+</project>

.idea/vcs.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/pandoc/cl" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/pandoc/template" vcs="Git" />
+  </component>
+</project>

CODEOWNERS

@@ -0,0 +1 @@
+.gitea/workflows/.* @julienfastre @juminet @LenaertsJ

Dockerfile

@@ -0,0 +1,29 @@
+# -------- Stage 1: Build the documentation using mkdocs --------
+FROM python:3.13-slim AS builder
+
+# add pandoc to image
+COPY --from=pandoc/minimal:3 /usr/local/bin/pandoc /usr/local/bin/pandoc
+
+RUN chmod +x /usr/local/bin/pandoc
+
+WORKDIR /build
+
+# Install dependencies
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY mkdocs/ mkdocs/
+COPY pandoc/filters pandoc/filters
+COPY user/ user/
+COPY admin/ admin/
+
+RUN cd user && mkdocs build --clean && cd ..
+RUN cd admin && mkdocs build --clean && cd ..
+
+# -------- Stage 2: Serve the built documentation with nginx --------
+FROM nginx:alpine
+
+# Copy the built site from the builder stage
+COPY --from=builder /build/admin/site /usr/share/nginx/html/admin
+COPY --from=builder /build/user/site /usr/share/nginx/html/user
+

admin/.gitignore

@@ -0,0 +1 @@
+site/*

admin/docs/generation-documents.md

@@ -1,4 +1,3 @@
-
 # Génération de documents
 
 L'administrateur fonctionnel prépare la génération des documents.
@@ -50,7 +49,7 @@ Le document est préparé de manière habituelle: le texte y est écrit, le logo
 
 Le travail de préparation consiste à préciser les endroits où ces informations doivent être insérées: des champs spécifiques.
 
-::: .note
+::: {.note}
 
 Le fonctionnement de la génération de document est assez semblable au "publi-postage": des champs sont définis dans le document, et le logiciel de traitement de texte vient les remplacer par ceux provenant d'une base de donnée.
 
@@ -139,16 +138,16 @@ Les options disponibles dépendent du contexte.
 
 Par exemple, pour un courrier généré dans un contexte "parcours", l'utilisateur pourra choisir un usager du parcours pour un courrier; l'administrateur indiquera qu'il s'agira du "destinataire" du courrier. Tandis que pour un formulaire officiel, l'administrateur configurera un "demandeur" et "co-demandeur", et ce sont ces libellés qui s'afficheront.
 
-## Variables par contexte
+## Variables par contexte 
 
-### Pour tous les contextes { #sec:gendoc:champs-documents }
+### Pour tous les contextes { #sec:gendoc-champs-documents }
 
-#### Variables
+#### Variables { #sec:entity-variables-all-context }
 
-* `creator`: (User) le créateur;
-* `createdAt` (Date): la date et l'heure de création;
-* `createdAtDate` (Date): la date de la création (sans l'heure). Utilisable pour indiquer la date d'un courrier, par exemple;
-* `location` (Location): le lieu sélectionné par le créateur, au moment de la génération **ou** celui choisi par l'étape 1.
+* `creator`: ([User](#sec:entity-user)) le créateur;
+* `createdAt` ([Date](#sec:entity-date)): la date et l'heure de création;
+* `createdAtDate` ([Date](#sec:entity-date)): la date de la création (sans l'heure). Utilisable pour indiquer la date d'un courrier, par exemple;
+* `location` ([Location](#sec:entity-location)): le lieu sélectionné par le créateur, au moment de la génération **ou** celui choisi par l'étape 1.
 
 ### Document générés pour un parcours
 
@@ -161,15 +160,15 @@ Les administrateurs fonctionnels peuvent activer les paramètres suivants:
 * un champ "usager principal du parcours", qui permet, cette fois, de choisir parmi les usagers concernés par le parcours, les interlocuteurs privilégiés qui sont des usagers (à l'exclusion des tiers), et les personnes ressources associées à un usager concerné du parcours (à l'exclusion des ressources tiers et "texte libre");
 * un champ "tiers", qui permet de choisir un tiers parmi les tiers "personnes ressources" du parcours, ou le demandeur du parcours (s'il s'agit d'un tiers);
 
-#### Variables
+#### Variables { #sec:entity-variables-accompanying-period }
 
 Le document présente:
 
-* une variable `course`, de type `AccompanyingPeriod`;
-* si `usager principal du parcours` est coché, une variable `mainPerson`, de type `Person`, avec les variants `relations`, `household` (ménage) et `budget`;
-* 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`;
-* une variable `thirdParty`, de type `ThirdParty`, uniquement si l'administrateur fonctionnel l'a configuré.
+* une variable `course`, de type [`AccompanyingPeriod`](#sec:entity-accompanyingperiod);
+* si `usager principal du parcours` est coché, une variable `mainPerson`, de type [`Person`](#sec:entity-user), avec les variants `relations`, `household` (ménage) et `budget`;
+* si `usager 1` est coché, une variable `person1`, de type [Person](#sec:entity-user), avec les variants `relations`, `household` (ménage) et `budget`;
+* si `usager 2` est coché, une variable `person2`, de type [Person](#sec:entity-user), avec les variants `relations`, `household` (ménage) et `budget`;
+* une variable `thirdParty`, de type [`ThirdParty`](#sec:entity-thirdparty), uniquement si l'administrateur fonctionnel l'a configuré.
 
 ### Document générés pour un parcours, contexte "liste des activités"
 
@@ -177,38 +176,38 @@ Le contexte présente les mêmes variables et paramètre que les documents gén
 
 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.
+* `activities` (liste de [Activity](#sec:entity-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
 
 Le document présente:
 
-* une variable `evaluation` de type `AccompanyingPeriodWorkEvaluation`: l'évaluation concernée;
-* une variable `work` de type `AccompanyingPeriodWork`: l'action d'accompagnement au sein de laquelle l'évaluation est générée;
-* une variable `course`, de type `AccompanyingPeriod`: le parcours au sein duquel l'évaluation est générée;
-* si `usager principal du parcours` est coché, une variable `mainPerson`, de type `Person`, avec les variants `relations`, `household` (ménage) et `budget`;
-* 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`;
-* une variable `thirdParty`, de type `ThirdParty`, uniquement si l'administrateur fonctionnel l'a configuré.
+* une variable `evaluation` de type [`AccompanyingPeriodWorkEvaluation`](#sec:entity-accompanyingperiodworkevaluation): l'évaluation concernée;
+* une variable `work` de type [`AccompanyingPeriodWork`](#sec:entity-accompanyingperiodwork): l'action d'accompagnement au sein de laquelle l'évaluation est générée;
+* une variable `course`, de type [`AccompanyingPeriod`](#sec:entity-accompanyingperiod): le parcours au sein duquel l'évaluation est générée;
+* si `usager principal du parcours` est coché, une variable `mainPerson`, de type [`Person`](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
+* si `usager 1` est coché, une variable `person1`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
+* si `usager 2` est coché, une variable `person2`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
+* une variable `thirdParty`, de type [`ThirdParty`](#sec:entity-thirdparty), uniquement si l'administrateur fonctionnel l'a configuré.
 
 ### Document générés pour un échange
 
 Le document présente:
 
-* une variable `activity`, de type `Activity`: l'évaluation concernée
-* une variable `course`, de type `AccompanyingPeriod`: le parcours concerné, à condition que l'échange ait été créé dans un contexte parcours
-* une variable `person`, de type `Person`: la personne concernée, à condition que l'échange ait été créée dans un contexte d'usager.
+* une variable `activity`, de type [`Activity`](#sec:entity-activity): l'évaluation concernée
+* une variable `course`, de type [`AccompanyingPeriod`](#sec:entity-accompanyingperiod): le parcours concerné, à condition que l'échange ait été créé dans un contexte parcours
+* une variable `person`, de type [`Person`](#sec:entity-person): la personne concernée, à condition que l'échange ait été créée dans un contexte d'usager.
 
 Il est possible également d'injecter des dossiers d'usagers, parmi ceux associés **à l'échange** (l'utilisateur peut choisir parmis les usagers de l'échange, et pas les usagers concernés du parcours).
 
-* si `usager principal du parcours` est coché, une variable `mainPerson`, de type `Person`, avec les variants `relations`, `household` (ménage) et `budget`;
-* 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`;
+* si `usager principal du parcours` est coché, une variable `mainPerson`, de type [`Person`](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
+* si `usager 1` est coché, une variable `person1`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
+* si `usager 2` est coché, une variable `person2`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
 
 ### Documents générés dans le dossier d'une personne: contexte "personne basique"
 
-* une variable `person`, de type `Person`, avec les variants `relations`, `household` (ménage) et `budget`;
-* une variable `thirdParty`, de type `ThirdParty`, uniquement si l'administrateur fonctionnel l'a configuré.
+* une variable `person`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
+* une variable `thirdParty`, de type [`ThirdParty`](#sec:entity-thirdparty), uniquement si l'administrateur fonctionnel l'a configuré.
 
 ### Documents générés dans le dossier d'une personne: contexte "personne avec un tiers"
 
@@ -218,155 +217,155 @@ Cela peut être utile pour, par exemple, générer un courrier vers un tiers dé
 
 Les variables disponibles sont les suivantes:
 
-* une variable `person`, de type `Person`, avec les variants `relations`, `household` (ménage) et `budget`.
-* une variable `thirdParty`, de type `ThirdParty`;
+* une variable `person`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`.
+* une variable `thirdParty`, de type [`ThirdParty`](#sec:entity-thirdparty);
 
 ### Document générés dans un contexte "rendez-vous"
 
 Les champs suivant sont disponibles:
 
-* une variable `calendar` (Calendar), qui contient les données du rendez-vous;
-* une variable `mainPerson` (Person), la personne principale parmi les personnes participant au rendez-vous. Cette variable n'est présente que si l'administrateur fonctionnel l'a configurée.
-* une variable `thirdParty` (ThirdParty): un tiers participant au rendez-vous. Cette variable n'est présente que si l'administrateur fonctionnel l'a configurée.
+* une variable `calendar` ([Calendar](#sec:entity-calendar)), qui contient les données du rendez-vous;
+* une variable `mainPerson` ([Person](#sec:entity-person)), la personne principale parmi les personnes participant au rendez-vous. Cette variable n'est présente que si l'administrateur fonctionnel l'a configurée.
+* une variable `thirdParty` ([ThirdParty](#sec:entity-thirdparty)): un tiers participant au rendez-vous. Cette variable n'est présente que si l'administrateur fonctionnel l'a configurée.
 
 ## Principes liés au variables
 
 ## Champs par objet { #sec:gendoc-champs-objets }
 
-### AccompanyingPeriod (Parcours)
+### AccompanyingPeriod (Parcours) { #sec:entity-accompanyingperiod }
 
 * `id` (texte): l'identifiant du parcours
-* `type` (texte): toujours égal à `accompanying_course`
+* `type` (texte): toujours égal à `accompanying-course`
 * `isNull`: (bool) renvoie `true` si est une entité nulle (toutes les variables sont vides);
-* `closingDate` (Date): date de clotûre;
+* `closingDate` ([Date](#sec:entity-date)): date de clotûre;
 * `confidential` (bool): `true` si confidentiel;
 * `confidentialText` (texte): "Confidentiel" si le parcours est confidentiel, texte vide sinon;
-* `createdAt` (Date): date de création;
-* `createdBy` (User): utilisateur ayant créé le parcours;
+* `createdAt` ([Date](#sec:entity-date)): date de création;
+* `createdBy` ([User](#sec:entity-user)): utilisateur ayant créé le parcours;
 * `emergency` (bool): `true` si parcours en urgence;
 * `emergencyText` (texte): "Urgent" si le parcours est urgent, texte vide sinon;
 * `openingDate` (texte): la date de confirmation du parcours;
-* `origin` (AccompanyingPeriodOrigin): l'origine du parcours;
+* `origin` ([AccompanyingPeriodOrigin](#sec:entity-accompanyingperiodorigin)): l'origine du parcours;
 * `originText` (texte): Le titre de l'origine, directement utilisable dans le document;
-* `participations` (liste de AccompanyingPeriodParticipation): les participations du parcours, actuelles **et anciennes**;
-* `currentParticipations` (liste de AccompanyingPeriodParticipation): les participations actuelles du parcours;
+* `participations` (liste de [AccompanyingPeriodParticipation](#sec:entity-accompanyingperiodparticipation)): les participations du parcours, actuelles **et anciennes**;
+* `currentParticipations` (liste de [AccompanyingPeriodParticipation](#sec:entity-accompanyingperiodparticipation)): les participations actuelles du parcours;
 * `requestorAnonymous` (bool): `true` si le demandeur du parcours est anonyme;
 * `hasRequestor` (bool): `true` si le parcours a un demandeur (il peut être un tiers ou une personne);
 * `requestorKind` (texte): `person` si le demandeur est une personne, `thirdparty` si c'est un tiers;
-* `requestorPerson` (Person): demandeur, si le demandeur est une personne;
+* `requestorPerson` ([Person](#sec:entity-person)): demandeur, si le demandeur est une personne;
 * `hasRequestorPerson` (bool): `true` si le demandeur est une personne;
-* `requestorThirdParty` (ThirdParty): demandeur, si le demandeur est un tiers;
+* `requestorThirdParty` ([ThirdParty](#sec:entity-thirdparty)): demandeur, si le demandeur est un tiers;
 * `hasRequestorThirdParty` (bool): `true` si le demandeur est un tiers;
-* `resources` (liste de AccompanyingPeriodResource): les ressources du parcours;
-* `scopes` (liste de Scope): services associés au parcours;
+* `resources` (liste de [AccompanyingPeriodResource](#sec:entity-accompanyingperiodresource)): les ressources du parcours;
+* `scopes` (liste de [Scope](#sec:entity-scope)): services associés au parcours;
 * `scopesText` (texte): titre des services associés au parcours, séparés par une virgule;
-* `socialIssues` (liste de SocialIssues): problématiques sociales associées au parcours;
+* `socialIssues` (liste de [SocialIssue](#sec:entity-socialissue)): problématiques sociales associées au parcours;
 * `socialIssuesText` (texte): Liste des problématiques sociales, séparées par une virgule;
 * `intensity` (texte): texte traduit de l'intensité: "ponctuel" ou "régulier";
 * `step` (texte): texte traduit de l'étape du parcours: "Brouillon", ou "En cours";
 * `isClosed` (bool): `true` si le parcours est fermé (la date de clotûre est renseignée);
 * `closingMotiveText` (texte): titre du motif de clotûre;
-* `closingMotive` (ClosingMotive): motif de clotûre
-* `ref` (User): référent du parcours;
+* `closingMotive` ([ClosingMotive](#sec:entity-closingmotive)): motif de clotûre
+* `ref` ([User](#sec:entity-user)): référent du parcours;
 * `hasRef` (bool): `true` si un référent est désigné;
 * `hasLocation` (bool): `true` si un parcours a une localisation;
 * `hasLocationPerson` (bool): `true` si un parcours a une localisation auprès d'un personne. `false` si c'est une localisation temporaire;
-* `location` (Adresse): l'adresse de localisation du parcours
-* `locationPerson` (Person): l'utilisateur qui localise le parcours (s'il y en a un, peut être vide);
-* `administrativeLocation` (Location): localisation administrative du parcours;
+* `location` ([Address](#sec:entity-address)): l'adresse de localisation du parcours
+* `locationPerson` ([Person](#sec:entity-person)): l'utilisateur qui localise le parcours (s'il y en a un, peut être vide);
+* `administrativeLocation` ([Location](#sec:entity-location)): localisation administrative du parcours;
 * `hasAdministrativeLocation` (bool): `true` si une localisation administrative est définie;
-* `works` (liste de AccompanyingPeriodWork): liste des actions d'accompagnement créées dans le cadre de ce parcours;
-* `comments` (liste de AccompanyingPeriodComment): liste des commentaires;
-* `pinnedComment` (AccompanyingPeriodComment): commentaire épinglé;
+* `works` (liste de [AccompanyingPeriodWork](#sec:entity-accompanyingperiodwork)): liste des actions d'accompagnement créées dans le cadre de ce parcours;
+* `comments` (liste de [AccompanyingPeriodComment](#sec:entity-accompanyingperiodcomment)): liste des commentaires;
+* `pinnedComment` ([AccompanyingPeriodComment](#sec:entity-accompanyingperiodcomment)): commentaire épinglé;
 
-### AccompanyingPeriodComment (Commentaire du parcours)
+### AccompanyingPeriodComment (Commentaire du parcours) { #sec:entity-accompanyingperiodcomment } 
 
 * `id` (int): identifiant
 * `content` (texte): contenu du commentaire
-* `createdAt` (Date): date de création
-* `creator` (User): Créateur du commentaire
+* `createdAt` ([Date](#sec:entity-date)): date de création
+* `creator` ([User](#sec:entity-user)): Créateur du commentaire
 
-### AccompanyingPeriodOrigin (Origine du parcours)
+### AccompanyingPeriodOrigin (Origine du parcours) { #sec:entity-accompanyingperiodorigin }
 
 * `id` (int): identifiant;
 * `label` (texte): libellé de l'origine;
 
 
-### AccompanyingPeriodParticipation (Participation à un parcours)
+### AccompanyingPeriodParticipation (Participation à un parcours) { #sec:entity-accompanyingperiodparticipation }
 
 Cet objet effectue la jointure entre les parcours et les usagers concernés à un parcours. Elle permet d'avoir accès à des informations supplémentaires, comme la date de début et l'éventuelle date de fin de la participation à un parcours.
 
 * `id` (int): identifiant
-* `person` (Person): usager associé au parcours;
-* `startDate` (Date): date de début;
-* `endDate` (Date): date de fin. Vide si la participation est toujours en cours;
+* `person` ([Person](#sec:entity-person)): usager associé au parcours;
+* `startDate` ([Date](#sec:entity-date)): date de début;
+* `endDate` ([Date](#sec:entity-date)): date de fin. Vide si la participation est toujours en cours;
 
 
-### AccompanyingPeriodResource (Interlocuteur privilégiés dans un parcours)
+### AccompanyingPeriodResource (Interlocuteur privilégiés dans un parcours) { #sec:entity-accompanyingperiodresource }
 
 * `id` (int): identifiant;
-* `person` (Person): usager ressource (vide, avec le paramètre `isNull` à `true`, si la ressource est un tiers);
-* `thirdParty` (ThirdParty): tiers ressource (vide, avec le paramètre `isNull` à `true`, si la ressource est une personne);
+* `person` ([Person](#sec:entity-person)): usager ressource (vide, avec le paramètre `isNull` à `true`, si la ressource est un tiers);
+* `thirdParty` ([ThirdParty](#sec:entity-thirdparty)): tiers ressource (vide, avec le paramètre `isNull` à `true`, si la ressource est une personne);
 * `comment` (texte): commentaire associé à la personne ressource.
 
-### AccompanyingPeriodWork (Action d'accompagnement)
+### AccompanyingPeriodWork (Action d'accompagnement) { #sec:entity-accompanyingperiodwork }
 
 * `id` (texte): l'identifiant de l'action;
 * `note` (texte): la note;
-* `persons` (liste de Person): liste des usagers concernés par l'action
-* `results` (liste de Result): liste des résultats directement associé au parcours (résultats sans objectifs)
-* `socialAction` (SocialAction): type d'action sociale;
-* `startDate` (Date): la date de début de l'action (vide si inexistant)
-* `endDate` (Date): la date de début de l'action (vide si inexistant)
-* `thirdParties` (liste de ThirdParty): les tiers associés à l'action comme tiers intervenants;
-* `updatedBy` (User): utilisateur ayant fait la mise à jour;
-* `updatedAt` (Date): date de mise à jour;
-* `handlingThierParty` (ThirdParty): tiers traitant;
-* `goals` (AccompanyingPeriodWorkGoal): objectifs
-* `createdBy` (Date): date de mise à jour;
-* `createdAt` (User): utilisateur ayant fait la mise à jour;
+* `persons` (liste de [Person](#sec:entity-person)): liste des usagers concernés par l'action
+* `results` (liste de [Result](#sec:entity-result)): liste des résultats directement associé au parcours (résultats sans objectifs)
+* `socialAction` ([SocialAction](#sec:entity-socialaction)): type d'action sociale;
+* `startDate` ([Date](#sec:entity-date)): la date de début de l'action (vide si inexistant)
+* `endDate` ([Date](#sec:entity-date)): la date de début de l'action (vide si inexistant)
+* `thirdParties` (liste de [ThirdParty](#sec:entity-thirdparty)): les tiers associés à l'action comme tiers intervenants;
+* `updatedBy` ([User](#sec:entity-user)): utilisateur ayant fait la mise à jour;
+* `updatedAt` ([Date](#sec:entity-date)): date de mise à jour;
+* `handlingThierParty` ([ThirdParty](#sec:entity-thirdparty)): tiers traitant;
+* `goals` ([AccompanyingPeriodWorkGoal](#sec:entity-accompanyingperiodworkgoal)): objectifs
+* `createdBy` ([Date](#sec:entity-date)): date de mise à jour;
+* `createdAt` ([User](#sec:entity-user)): utilisateur ayant fait la mise à jour;
 * `createdAutomatically` (bool): `true` si l'action a été créée automatiquement (par exemple, en créant un échange);
-* `evaluations` (AccompanyingPeriodWorkEvaluation): liste des évaluations générées;
-* `referrers` (liste de User): liste des agents traitants;
+* `evaluations` ([AccompanyingPeriodWorkEvaluation](#sec:entity-accompanyingperiodworkevaluation)): liste des évaluations générées;
+* `referrers` (liste de [User](#sec:entity-user)): liste des agents traitants;
 
-### AccompanyingPeriodWorkEvaluation (évaluation dans une action d'accompagnement)
+### AccompanyingPeriodWorkEvaluation (évaluation dans une action d'accompagnement) { #sec:entity-accompanyingperiodworkevaluation }
 
 * `id` (texte): l'identifiant de l'évaluation;
 * `type` (texte): le libellé de l'évaluation;
-* `startDate` (Date): la date de début de l'évaluation;
+* `startDate` ([Date](#sec:entity-date)): la date de début de l'évaluation;
 * `endDate` (Date) la date de fin de l'évaluation;
-* `maxDate` (Date): la date d'échéance de l'évaluation;
+* `maxDate` ([Date](#sec:entity-date)): la date d'échéance de l'évaluation;
 * `comment` (texte): le commentaire de l'évaluation;
-* `createdBy` (User): le créateur de l'évaluation;
-* `createdAt` (Date): la date de création de l'évaluation;
-* `evaluation` (Evaluation): le type d'évaluation;
+* `createdBy` ([User](#sec:entity-user)): le créateur de l'évaluation;
+* `createdAt` ([Date](#sec:entity-date)): la date de création de l'évaluation;
+* `evaluation` ([Evaluation](#sec:entity-evaluation)): le type d'évaluation;
 
-### AccompanyingPeriodWorkGoal (objectifs et résultats d'une action d'accompagnement)
+### AccompanyingPeriodWorkGoal (objectifs et résultats d'une action d'accompagnement) { #sec:entity-accompanyingperiodworkgoal }
 
 * `id` (texte): identifiant
-* `goal` (Goal): objectif d'une action
-* `results` (liste de Result): liste des résultats
+* `goal` ([Goal](#sec:entity-goal)): objectif d'une action
+* `results` (liste de [Result](#sec:entity-result)): liste des résultats
 
 
-### Activity (échange)
+### Activity (échange) { #sec:entity-activity }
 
 * `id` (int): identifiant;
-* `activityType` (ActivityType): Type d'échange
-* `attendee` (ActivityPresence): Présence à l'échange
-* `comment` (Comment): Commentaire (avec la date de la dernière mise à jour)
-* `date` (Date): Date de l'échange
+* `activityType` ([ActivityType](#sec:entity-activitytype)): Type d'échange
+* `attendee` ([ActivityPresence](#sec:entity-activitypresence)): Présence à l'échange
+* `comment` ([Comment](#sec:entity-comment)): Commentaire (avec la date de la dernière mise à jour)
+* `date` ([Date](#sec:entity-date)): Date de l'échange
 * `durationTimeMinute` (int): Durée de l'échange, en minutes
 * `emergency` (bool): True si en urgence
-* `location` (Location): Lieu de l'échange
-* `reasons` (liste de ActivityReason): Sujets de l'échange (pas utilisé en Vendée)
-* `scope` (Scope): Service (pas utilisé  en Vendée)
+* `location` ([Location](#sec:entity-location)): Lieu de l'échange
+* `reasons` (liste de [ActivityReason](#sec:entity-activityreason)): Sujets de l'échange (pas utilisé en Vendée)
+* `scope` ([Scope](#sec:entity-scope)): Service (pas utilisé  en Vendée)
 * `sentReceived` (text): sera `received` si reçu, et `sent` si envoyé;
-* `socialActions` (liste de SocialAction): liste d'actions sociales associées
-* `socialIssues` (liste de SocialIssue): liste de problématiques sociales associées
-* `thirdParties` (liste de ThirdParty): liste de tiers associés
+* `socialActions` (liste de [SocialAction](#sec:entity-socialaction)): liste d'actions sociales associées
+* `socialIssues` (liste de [SocialIssue](#sec:entity-socialissue)): liste de problématiques sociales associées
+* `thirdParties` (liste de [ThirdParty](#sec:entity-thirdparty)): liste de tiers associés
 * `travelTimeMinute` (int): durée du trajet en minutes
-* `user` (User): l'utilisateur pour lequel l'échange a été créé;
-* `users` (liste de Users): les utilisateurs qui sont associés à l'échange.
+* `user` ([User](#sec:entity-user)): l'utilisateur pour lequel l'échange a été créé;
+* `users` (liste de [User](#sec:entity-user)): les utilisateurs qui sont associés à l'échange.
 
 #### variant `light`
 
@@ -379,36 +378,38 @@ Ce variant comporte les mêmes attributs, avec les différences suivantes:
 * le champ `reasons` n'est pas présent;
 * le champ `comment` est également présenté avec le variant `light`.
 
-### ActivityType (Type d'activité)
+### ActivityReason (Sujet d'activité) { #sec:entity-activityreason }
+
+### ActivityType (Type d'activité) { #sec:entity-activitytype }
 
 Type d'activité.
 
 * `id` (int): identifiant;
 * `name` (texte): libellé
 
-### ActivityPresence (Présence à l'échange)
+### ActivityPresence (Présence à l'échange) { #sec:entity-activitypresence }
 
 Présence à l'échange
 
 * `id` (int): identifiant;
 * `name` (texte): libellé
 
-### Address (Une adresse)
+### Address (Une adresse) { #sec:entity-address }
 
-* `address_id` (int): l'identifiant de l'adresse;
+* `address-id` (int): l'identifiant de l'adresse;
 * `text` (texte): une chaine de caractère représentant l'adresse complète;
 * `street` (texte): le nom de la rue (exemple: "RUE DES ÉGLANTIERS");
 * `streetNumber` (texte): le numéro de police;
-* `postcode` (PostCode): le code postal;
-* `country` (Country): le pays de l'adresse;
+* `postcode` ([PostCode](#sec:entity-postcode)): le code postal;
+* `country` ([Country](#sec:entity-country)): le pays de l'adresse;
 * `floor` (texte): l'étage;
 * `corridor` (texte): le couloir;
 * `flat` (texte): l'appartement;
 * `buildingName` (texte): le nom du bâtiment / résidence;
 * `distribution` (texte): service particulier de distribution;
 * `extra` (texte): champs extras
-* `validFrom` (Date): date de début de validité;
-* `validTo` (Date): date de fin de validité (vide si toujours valide);
+* `validFrom` ([Date](#sec:entity-date)): date de début de validité;
+* `validTo` ([Date](#sec:entity-date)): date de fin de validité (vide si toujours valide);
 * `lines` (liste de texte): les lignes de l'adresses, comme elles devraient être formatées dans une adresses
 
 Il est possible de représenter l'adresse au format postal en effectuant une boucle sur les lignes. Par exemple, pour l'adresse d'une personne (chaque ligne est un "renvoi > substituant" dans l'exemple ci-dessous):
@@ -419,13 +420,13 @@ line
 /for
 ```
 
-### Comment (Commentaire)
+### Comment (Commentaire) { #sec:entity-comment }
 
 Certains champs commentaire enregistrent également l'utilisateur qui a effectué la dernière mise à jour, et la date de celle-ci, en plus du commentaire en tant que tel. Ces champs ont les attributs suivants:
 
 * `comment` (texte): le commentaire en tant que tel;
-* `date` (Date): la date de la dernière modification;
-* `user` (User): l'utilisateur qui a effectué la dernière modification;
+* `date` ([Date](#sec:entity-date)): la date de la dernière modification;
+* `user` ([User](#sec:entity-user)): l'utilisateur qui a effectué la dernière modification;
 
 #### Variant `light`
 
@@ -436,101 +437,110 @@ Dans le variant `light`,
 
 Seul le champ `comment` est donc disponible.
 
+### Calendar (Rendez-vous) { #sec:entity-calendar}
 
-### Civility (Civilité)
+* id (int): identifiant
+
+### Civility (Civilité) { #sec:entity-civility }
 
 * `abbreviation` (texte): abbréviation;
 * `id` (int): identifiant (utile pour des comparaisons);
 * `name` (texte): titre, label de la civilité;
 
-### ClosingMotive (Motif de cloture)
+### ClosingMotive (Motif de cloture) { #sec:entity-closingmotive }
 
 * `id` (int): identifiant;
 * `name` (texte): libellé
 
 
-### Country (Pays)
+### Country (Pays) { #sec:entity-country }
 
 * `id` (int): identifiant
 * `name` (texte): nom du pays
 * `code` (texte): deux lettres du code ISO pays
 
-### Date (Date)
+### Date (Date) { #sec:entity-date }
 
 * `short` (texte): la date au format dd/mm/yyyy, vide si la date est absente;
 * `long` (texte): la date au format jour mois années: 15 août 1980, vide si al date est absente;
 
-### Evaluation (type d'évaluation)
+### Evaluation (type d'évaluation) { #sec:entity-evaluation }
 
 * `id` (texte): l'identifiant du type d'évaluation;
 * `title` (texte): le titre du type d'évaluation;
 
-### Goal (objectif d'une action)
+### Goal (objectif d'une action) { #sec:entity-goal }
 
 * `id` (texte): identifiant
 * `title` (texte): le titre du résultat
 
-### Household (Ménage)
+### GenderEntity (Genre) { #sec:entity-genderentity }
+
+* `label` (texte): label du genre;
+* `id` (int): identifiant (utile pour des comparaisons);
+* `genderTranslation` (texte): utilisation grammaticale;
+
+### Household (Ménage) { #sec:entity-household }
 
 
 * `id` (int): l'identifiant du ménage;
-* `current_address` (Adress) : adresse actuelle du ménage
-* `current_composition` (HouseholdComposition): Composition **actuelle** du ménage
-* `currentMembers` (liste de HouseholdMember): liste des membres **actuels** du ménage;
-* `members` (liste de HouseholdMember): liste des membres du ménages. Cette liste inclut également les anciens membres;
+* `current-address` (Adress) : adresse actuelle du ménage
+* `current-composition` ([HouseholdComposition](#sec:entity-householdcomposition)): Composition **actuelle** du ménage
+* `currentMembers` (liste de [HouseholdMember](#sec:entity-householdmember)): liste des membres **actuels** du ménage;
+* `members` (liste de [HouseholdMember](#sec:entity-householdmember)): liste des membres du ménages. Cette liste inclut également les anciens membres;
 * `waitingForBirth` (bool): `true` si une naissance est attendue;
-* `waitingForBirthDate` (Date): date de la naissance attendue;
+* `waitingForBirthDate` ([Date](#sec:entity-date)): date de la naissance attendue;
 
-### HouseholdComposition
+### HouseholdComposition { #sec:entity-householdcomposition }
 
 La composition du ménage entre deux dates. Cette entité associe une `HouseholdCompositionType` avec une date de début et une date de fin
 
 * `id` (int): L'identifiant de la composition
-* `startDate` (Date): date de début de validité de la composition du ménage;
-* `endDate` (Date): date de fin de validité de la composition du ménage (vide si actif)
+* `startDate` ([Date](#sec:entity-date)): date de début de validité de la composition du ménage;
+* `endDate` ([Date](#sec:entity-date)): date de fin de validité de la composition du ménage (vide si actif)
 * `numberOfChildren` (int): nombre d'enfants
-* `householdCompositionType` (HouseholdCompositionType): Type de composition choisie, entre deux dates
+* `householdCompositionType` ([HouseholdCompositionType](#sec:entity-householdcompositiontype)): Type de composition choisie, entre deux dates
 
-### HouseholdCompositionType
+### HouseholdCompositionType { #sec:entity-householdcompositiontype }
 
 * `id` (int): L'identifiant du type de composition
 * `label` (texte): Le libellé de la composition
 
-### HouseholdMember (Membre d'un ménage)
+### HouseholdMember (Membre d'un ménage) { #sec:entity-householdmember }
 
 * `comment` (texte): texte du commentaire;
 * `id` (int): identifiant de la participation au ménage;
-* `endDate` (Date): date de fin de participation au ménage;
+* `endDate` ([Date](#sec:entity-date)): date de fin de participation au ménage;
 * `holder` (bool): `true` si le participant est titulaire;
-* `person` (Person): l'usager qui est membre du ménage;
-* `position` (HouseholdPosition): la position du membre dans le ménage;
-* `startDate` (Date): date de début de participation au ménage;
+* `person` ([Person](#sec:entity-person)): l'usager qui est membre du ménage;
+* `position` ([HouseholdPosition](#sec:entity-householdposition)): la position du membre dans le ménage;
+* `startDate` ([Date](#sec:entity-date)): date de début de participation au ménage;
 
-### HouseholdPosition (Position du membre dans le ménage)
+### HouseholdPosition (Position du membre dans le ménage) { #sec:entity-householdposition }
 
 * `id` (int): identifiant de la position;
 * `label` (texte): label de la position dans le ménage;
 
-### Location (lieu)
+### Location (lieu) { #sec:entity-location }
 
 * `id` (int): identifant;
 * `name` (texte): nom;
-* `address` (Address): adresse du lieu;
+* `address` ([Address](#sec:entity-address)): adresse du lieu;
 * `phonenumber1` (texte): numéro de téléphone;
 * `phonenumber2` (texte): numéro de téléphone;
 * `email` (email): email
-* `locationType` (LocationType): le type de lieu
+* `locationType` ([LocationType](#sec:entity-locationtype)): le type de lieu
 
-### LocationType (type de lieu)
+### LocationType (type de lieu) { #sec:entity-locationtype }
 
 * `id` (int): identifant;
 * `title` (texte): titre du type de lieu;
 
-### Person (Personne, usager)
+### Person (Personne, usager) { #sec:entity-person }
 
 * `id` (texte): Identifiant du dossier usager;
 * `isNull` (bool): `true` si le dossier usager est vide;
-* `civility` (Civility): Civilité
+* `civility` ([Civility](#sec:entity-civility)): Civilité
 * `firstName` (texte): Prénom
 * `lastName` (texte): Nom
 * `altNames` (texte): noms supplémentaire (nom de naissance, …)
@@ -538,10 +548,10 @@ La composition du ménage entre deux dates. Cette entité associe une `Household
 * `birthdate` (Date)
 * `age`: (int) age de la personne;
 * `deathdate` (Date)
-* `gender` (texte): genre (texte traduit);
+* `genderEntity` ([GenderEntity](#sec:entity-genderentity)): Genre;
 * `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)
+* `maritalStatusDate` ([Date](#sec:entity-date)): date à la quelle le statut de l'état civil a été mis à jour;
+* `maritalStatusComment` ([Comment](#sec:entity-comment)): Commentaire sur l'état civil (avec la date de la dernière mise à jour)
 * `email` (texte): adresse email
 * `firstPhoneNumber` (texte): soit le numéro de mobile s'il existe, soit le numéro fixe s'il existe, sinon vide;
 * `fixPhoneNumber` (texte): le numéro de téléphone fixe;
@@ -550,16 +560,19 @@ La composition du ménage entre deux dates. Cette entité associe une `Household
 * `placeOfBirth (texte): le lieu de naissance
 * `memo` (texte): le mémo
 * `numberOfChildren` (texte): le nombre d'enfants
-* `address` (Adresse): l'adresse actuelle
-* `resources` (PersonResource): les personnes ressources, ajoutées depuis le dossier de l'usager.
+* `address` ([Adresse](#sec:entity-address)): l'adresse actuelle
+* `resources` ([PersonResource](#sec:entity-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;
+* `household` ([Household](#sec:entity-household)): le ménage actuel de l'usager;
 
 #### variant `relations`
 
-* `relations` (liste de Relationship): les relations (filiations) de l'usager;
+* `relations` (liste de [Relationship](#sec:entity-relationship)): les relations (filiations) de l'usager;
 
 #### variant `budget`
 
@@ -586,7 +599,7 @@ Pour chaque ligne de budget, la somme de toutes les lignes de budget du même ty
 
     On verra donc apparaitre non seulement les frais payés par chaque usager (pour leur abonnement individuel au téléphone mobile, par exemple), mais également la somme payée par le ménage (pour le téléphone fixe ou l'accès à internet).
 
-Enfin, seules les lignes _actives_ **au moment de la génération du document** sont prises en compte. Ainsi, par exemple, si un CDI a expiré la veille de la génération, son montant ne sera pas pris en compte.
+Enfin, seules les lignes -actives- **au moment de la génération du document** sont prises en compte. Ainsi, par exemple, si un CDI a expiré la veille de la génération, son montant ne sera pas pris en compte.
 
 Le calcul du caractère actif d'une ligne est effectué comme suit:
 
@@ -602,7 +615,7 @@ Les attributs suivants sont disponibles, pour chaque objet `Person` qui a un var
 * `budget.household.resources.<clé du type de ligne de budget>` (Ligne de budget): une ligne de budget pour la ressource dont la clé est indiquée par `<clé du type de ligne de budget>`. La liste des clés est à obtenir auprès de l'administrateur technique. Les lignes de budget de tous les usagers actuels du ménages sont globalisées, ainsi que les lignes de budget associées directement au dossier ménage;
 * `budget.household.charges.<clé du type de ligne de budget>` (Ligne de budget): une ligne de budget pour la charge dont la clé est indiquée par `<clé du type de ligne de budget>`. La liste des clés est à obtenir auprès de l'administrateur technique. Les lignes de budget de tous les usagers actuels du ménages sont globalisées, ainsi que les lignes de budget associées directement au dossier ménage;
 
-### PersonResource (Ressources associée à l'usager)
+### PersonResource (Ressources associée à l'usager) { #sec:entity-personresource }
 
 Pour rappel, les ressources peuvent être:
 
@@ -614,71 +627,72 @@ Pour rappel, les ressources peuvent être:
 * `comment` (Comment)
 * `freeText` (texte): commentaire, quand la personne ressources un texte libre
 * `id` (int)
-* `kind` (PersonResourceKind): le type de personne ressources (voisin, etc.)
-* `thirdParty` (ThirdParty): le tiers, quand la ressources est liée à un tiers
-* `person` (Person): l'usager, quand la ressources liée à un autre usager
+* `kind` ([PersonResourceKind](#sec:entity-personresourcekind)): le type de personne ressources (voisin, etc.)
+* `thirdParty` ([ThirdParty](#sec:entity-thirdparty)): le tiers, quand la ressources est liée à un tiers
+* `person` ([Person](#sec:entity-person)): l'usager, quand la ressources liée à un autre usager
 * `resourceKind` (texte): un discriminateur qui permet de vérifier si la ressources est lié à un usager (alors égal à `person`, un tiers (`thirdparty`) ou un texte libre (`freetext`). A utiliser dans les conditions dans les documents.
 
-### PersonResourceKind (Type de personne ressource)
+### PersonResourceKind (Type de personne ressource) { #sec:entity-personresourcekind }
 
 * `id` (int)
 * `title` (texte)
 
-### Postcode (Code Postal)
+### Postcode (Code Postal) { #sec:entity-postcode }
 
 * `id` (int): identifiant
 * `name` (texte): localité
 * `code` (texte): code postal
 
-### Relationship (relations (filiations) entre usagers)
+### Relationship (relations (filiations) entre usagers) { #sec:entity-relationship }
 
 Pour faciliter l'usager, les relations sont toujours représentée à partir d'un usager d'origine.
 
 Les variables présentent le nom de la relation (`text`), et la personne avec qui la relation est formée (`opposite`).
 
 * `id` (int): identifant;
-* `fromPerson` (Person): personne d'origine;
-* `toPerson` (Person): personne de destination;
+* `fromPerson` ([Person](#sec:entity-person)): personne d'origine;
+* `toPerson` ([Person](#sec:entity-person)): personne de destination;
 * `text` (texte): le titre ou le titre inversé de la `Relation`, selon l'usager d'origine;
-* `opposite` (Person): l'usager avec qui la relation est formée;
+* `opposite` ([Person](#sec:entity-person)): l'usager avec qui la relation est formée;
 * `relationId` (int): identifiant du lien de filiation;
 
 **Note**: la différence entre `fromPerson` et `toPerson` est arbitraire.
 
-### Result (résultat d'une action)
+### Result (résultat d'une action) { #sec:entity-result }
 
 * `id` (texte): identifiant
 * `title` (texte): le titre du résultat
 
+### Scope (service) { #sec:entity-scope }
 
-### SocialAction (type d'action d'accompagnement)
+### SocialAction (type d'action d'accompagnement) { #sec:entity-socialaction }
 
 * `id` (texte): identifiant
 * `text` (texte): texte, avec les parents inclus, séparés par un ` > `;
 * `title`: titre du type d'action, sans les parents;
 
-### Social Issue (problématique sociale)
+### SocialIssue (problématique sociale) {#sec:entity-socialissue} 
 
 * `name`: le nom de la problématique seule
 * `text`: le nom de la problématique et des problématiques parentes
 
-### ThirdParty (Tiers)
+### ThirdParty (Tiers) { #sec:entity-thirdparty }
 
 * `id` (int): identifiant du tiers;
 * `acronym` (text): acronyme;
-* `address` (Adress): adresse du tiers
-* `categories` (liste de ThirdPartyCategory): liste des catégories;
-* `civility` (Civility): civilité
+* `address` ([Adress](#sec:entity-address)): adresse du tiers
+* `categories` (liste de [ThirdPartyCategory](#sec:entity-thirdpartycategory)): liste des catégories;
+* `civility` ([Civility](#sec:entity-civility)): civilité
 * `contactDataAnonymous` (bool): `true` si le tiers est anonyme;
 * `email` (texte): email;
 * `name` (texte): nom du tiers;
 * `firstname` (texte): Prénom du tiers;
-* `parent` (ThirdParty): tiers parent (pour les contacts)
+* `parent` ([ThirdParty](#sec:entity-thirdparty)): tiers parent (pour les contacts)
 * `profession` (ThirdPartyProfession)
 * `telephone` (texte): numéro de téléphone du tiers
 * `kind` (texte): permet de distinguer les personnes morales, les contacts et les personnes physiques (voir ci-après)
 * `child` (bool) vaut TRUE s'il existe un parent (contact), false sinon;
-* `parent` (ThirdParty): s'il s'agit d'un contact d'une personne morale, contient la fiche d'une personne morale
+* `parent` ([ThirdParty](#sec:entity-thirdparty)): s'il s'agit d'un contact d'une personne morale, contient la fiche d'une personne morale
 
 
 `kind` vaut:
@@ -687,19 +701,19 @@ Les variables présentent le nom de la relation (`text`), et la personne avec qu
 * `child` lorsuq'il s'agit d'un  contact d'une personne morale
 * `contact` lorsqu'il s'agit d'une personne **physique** (à ne pas confondre avec un contact d'une personne morale)
 
-### ThirdPartyCategory (catégorie de tiers)
+### ThirdPartyCategory (catégorie de tiers) { #sec:entity-thirdpartycategory }
 
 * `id` (int): identifiant
 * `name` (texte)
 
 
-### ThirdPartyProfession (profession du tiers)
+### ThirdPartyProfession (profession du tiers) { #sec:entity-thirdpartyprofession }
 
 * `id` (int): identifiant
 * `name` (texte)
 
 
-### User (Utilisateur) { #sec:gendoc-var-user }
+### User (Utilisateur) { #sec:entity-user }
 
 * `id` (int): identifant
 * `type` (texte): vaut toujours `user`
@@ -707,13 +721,13 @@ Les variables présentent le nom de la relation (`text`), et la personne avec qu
 * `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);
 * `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;
-* `civility` (Civility): la civilité de l'utilisateur;
+* `main-scope` ([Scope](#sec:entity-scope)): service principal
+* `user-job` ([UserJob](#sec:entity-userjob)): métier principal
+* `current-location` ([Location](#sec:entity-location)): lieu de l'utilisateur, celui actuellement choisi par l'utilisateur par le menu "utilisateur";
+* `main-location` ([Location](#sec:entity-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;
+* `civility` ([Civility](#sec:entity-civility)): la civilité de l'utilisateur;
 
-### UserJob (Métier)
+### UserJob (Métier) { #sec:entity-userjob }
 
 * `id` (int): identifiant
 * `label` (texte): nom du métier

admin/docs/index.md

@@ -0,0 +1,3 @@
+# Documentation administrateur
+
+En construction.

admin/mkdocs.yml

@@ -0,0 +1,45 @@
+---
+site_name: "Manuel administrateur Chill"
+site_url: https://manuel.chill.social/admin
+repo_url: https://gitea.champs-libres.be/Chill-project/manuals
+repo_name: Chill-project/manuals
+theme:
+    name: material
+    features:
+        - content.code.copy
+        - content.code.select
+        - content.code.annotate
+nav:
+    -   Accueil: index.md
+    -   Génération de document: generation-documents.md
+hooks:
+    - ../mkdocs/hooks/pandoc-to-mkdocs.py
+markdown_extensions:
+    - markdown_include.include
+    # code layout
+    - pymdownx.highlight:
+          anchor_linenums: true
+          line_spans: __span
+          pygments_lang_class: true
+          use_pygments: true
+          linenums: true
+    - pymdownx.inlinehilite
+    - pymdownx.snippets
+    - pymdownx.superfences
+    # admonition
+    - admonition
+    - pymdownx.details
+    - pymdownx.superfences
+    # use emojis
+    - attr_list
+    - pymdownx.emoji:
+        emoji_index: !!python/name:material.extensions.emoji.twemoji
+        emoji_generator: !!python/name:material.extensions.emoji.to_svg
+    # footnotes
+    - footnotes
+    # https://squidfunk.github.io/mkdocs-material/reference/formatting/?h=key#adding-keyboard-keys
+    - pymdownx.critic
+    - pymdownx.caret
+    - pymdownx.keys
+    - pymdownx.mark
+    - pymdownx.tilde

build-pandoc.sh

@@ -4,7 +4,8 @@ set -e
 
 # enter the current directory
 cd "$(dirname $0)"
-export PANDOC_DIR="/pandoc/cl"
+export PANDOC_DIR="$(pwd)/pandoc/cl"
+export OUTPUT_DIR="$(pwd)"
 
 
 if [ -z $1 ]; then
@@ -59,23 +60,22 @@ else
   exit 1;
 fi
 
-cd $kind
+export PDF_TEMPLATE="$(pwd)/eisvogel.latex"
+
+cd $kind/docs
 
 export ARGS="
   --from markdown
   --number-sections
   --resource-path ./.
   --metadata-file ./metadata.yaml
-  `#--lua-filter "../${PANDOC_DIR}/format-link.lua`
 "
-export PDF_TEMPLATE="./../pandoc/template/eisvogel.tex"
 export LATEX_ARGS="
   --metadata=footer-left:$(date +%d-%m-%Y)
-  --template "${PDF_TEMPLATE}"
-  --lua-filter "../${PANDOC_DIR}/boxes.lua"
+  --template ${PDF_TEMPLATE}
+  --lua-filter "${PANDOC_DIR}/boxes.lua"
 "
 
-
 if [ $target = "latex" ]; then
   pandoc $ARGS $LATEX_ARGS \
     --to latex \
@@ -84,18 +84,7 @@ elif [ $target = "pdf" ]; then
   pandoc $ARGS $LATEX_ARGS \
     --to pdf \
     --pdf-engine xelatex \
-    -o "./../$kind-manual.pdf" \
+    -o "${OUTPUT_DIR}/$kind-manual.pdf" \
     $files
-elif [ $target = "html" ]; then
-  # check target directory exists
-  if [ ! -d "./../build/html" ]; then
-    echo "create build/html directory"
-    mkdir -p "./../build/html"
-  fi
-
-  pandoc $ARGS \
-   --to html \
-   -o ./../build/html/index.html \
-  $files
 fi
 

mkdocs/hooks/pandoc-to-mkdocs.py

@@ -0,0 +1,29 @@
+import subprocess
+import os
+
+def on_page_markdown(markdown: str, page, config, files) -> str | None:
+    # Récupère le dossier où se trouve mkdocs.yaml
+    base_dir = os.path.dirname(config.config_file_path)
+    # Construit le chemin absolu du filtre lua relatif à mkdocs.yaml
+    lua_filter_path = os.path.normpath(os.path.join(base_dir, '../pandoc/filters/admonitionTransformer.lua'))
+    # Prépare la commande avec le chemin correct pour le filtre
+    cmd = [
+        "pandoc",
+        f"--lua-filter={lua_filter_path}",
+        "--to", "markdown"
+    ]
+
+    try:
+        # Appelle le script bash/commande via subprocess, en passant le markdown via stdin
+        result = subprocess.run(
+            cmd,
+            input=markdown.encode('utf-8'),
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            check=True
+        )
+        # Retourne la sortie standard (stdout) décodée
+        return result.stdout.decode('utf-8')
+    except subprocess.CalledProcessError as e:
+        print("Erreur lors de l'exécution du script bash :", e.stderr.decode('utf-8'))
+        return None

pandoc/filters/admonitionTransformer.lua

@@ -0,0 +1,27 @@
+-- admonition.lua
+-- Filtre Pandoc : transforme les divs en admonitions type "!!! note"
+
+function Div(div)
+  if div.classes ~= nil and #div.classes > 0 then
+    local class = div.classes[1]
+    -- Génère le préfixe admonition
+    local admonition_header = pandoc.Plain{pandoc.Str("!!! " .. class)}
+    local contents = {}
+
+    -- Pour chaque bloc de contenu, ajoute une indentation de 4 espaces à chaque ligne
+    for _, blk in ipairs(div.content) do
+      local s = pandoc.write(pandoc.Pandoc({blk}), "markdown")
+      -- Ajoute une indentation de 4 espaces sur chaque ligne non vide
+      s = s:gsub("([^\n]+)", "    %1")
+      table.insert(contents, pandoc.RawBlock("markdown", s))
+    end
+
+    -- Construit la nouvelle sequence de blocs : en-tête + contenus
+    local blocks = {admonition_header}
+    for _, blk in ipairs(contents) do
+      table.insert(blocks, blk)
+    end
+
+    return blocks
+  end
+end

pandoc/filters/admonitionTransformer/from.md

@@ -0,0 +1,11 @@
+
+::: { .note }
+Ceci est une note
+:::
+
+
+::: { .warning }
+
+Ceci est un warning
+
+:::

pandoc/template

@@ -1 +1 @@
-Subproject commit 04e329698d01c3a25aa72ad81d98483284669316
+Subproject commit 62377f36a0ce5b48281e5ee51cb4eef364162037

requirements.txt

@@ -0,0 +1,3 @@
+mkdocs
+markdown-include
+mkdocs-material

user/.gitignore

@@ -0,0 +1,2 @@
+site/*
+

user/docs/exports_accompanying_period.md

@@ -209,8 +209,11 @@ Ce filtre permet d'indiquer deux dates qui forment une période de recherche, ai
 
 Filtre les parcours qui avaient un des statuts sélectionné pendant la période de recherche. 
 
+Note: comme un parcours peut avoir différents statuts au cours du temps, le présent filtre tiendra compte des parcours qui ont eu ce statut au moins un jour dans la période indiquée, même si ce statut a été changé pendant la période.
+
 Pour les différentes statuts, voir la section correspondante: [statuts du parcours](#sec:parcours-statut).
 
+
 #### Filtrer les parcours par type d'échange
 
 <!-- PHPFILE: src/Bundle/ChillActivityBundle/Export/Filter/ACPFilters/ActivityTypeFilter.php -->
@@ -350,7 +353,7 @@ Groupe les parcours par localisation administrative.
 
 Groupe les parcours par motifs de clôture.
 
-Lorsqu'un parcours ne comporte pas de motif de clôture (parce qu'il est toujours ouvert), le regroupement est repris sous une ligne sans contenu.
+Lorsqu'un parcours ne comporte pas de motif de clôture (parce qu'il est toujours ouvert, ou qu'il a été ré-ouvert après une clôture), le regroupement est repris sous une ligne sans contenu.
 
 #### Grouper les parcours par métier de l'intervenant
 

user/docs/exports_activity.md

@@ -76,6 +76,14 @@ Le filtre prend en compte tous les utilisateurs ajoutés dans les "parties conce
 
 L'échange est pris en compte dès qu'un utilisateur dans les "parties concernées" est associé à l'un des métiers demandés.
 
+#### Filtrer les échanges par métier du créateur de l'échange
+
+<!-- PHPFILE: src/Bundle/ChillActivityBundle/Export/Filter/CreatorJobFilter.php -->
+
+Filtre les échanges par métier du créateur de l'échange.
+
+Le métier doit être associé à l'utilisateur à la date de l'échange.
+
 #### Filtrer les échanges par problématique liée
 
 <!-- PHPFILE: src/Bundle/ChillActivityBundle/Export/Filter/ACPFilters/BySocialIssueFilter.php-->
@@ -207,6 +215,14 @@ Le métier pris en compte est celui associé à l'utilisateur à la date de l'é
 
 **Relation un-à-plusieurs**: lorsque plusieurs utilisateurs participent à l'échange, l'échange est comptabilisé une seule fois par métier de chaque utilisateur. Si plusieurs utilisateurs participant comportent le même métier, l'échange n'est donc comptabilisé qu'une seule fois.
 
+#### Grouper les échanges par métier du créateur de l'échange
+
+Groupe les échanges par métier du créateur de l'échange.
+
+Le métier pris en compte est celui associé à l'utilisateur à la date de l'échange.
+
+<!-- PHPFILE: src/Bundle/ChillActivityBundle/Export/Aggregator/CreatorScopeAggregator.php -->
+
 #### Grouper les échanges par problématique liée
 
 <!-- PHPFILE: src/Bundle/ChillActivityBundle/Export/Aggregator/ACPAggregators/BySocialIssueAggregator.php-->