Merge branch 'main' of gitea.champs-libres.be:Vendee/manuals

admin/generation-documents.md

@@ -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:
 
 ```
-personBirthdateShort=15/06/1980
-personBirthdateLong=15 juin 1980
+person.Birthdate.Short=15/06/1980
+person.Birthdate.Long=15 juin 1980
 ```
 
 
@@ -230,7 +230,7 @@ ${courseStartDateShort} // 15/01/2021
 * `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)
-* `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
 * `socialIssues` (liste de SocialIssue): liste de problématiques sociales associées
 * `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éé;
 * `users` (liste de Users): les utilisateurs qui sont associés à l'échange.
 
-### ActivityPrésence
+### ActivityPresence
 
 Présence à l'échange
 
@@ -290,22 +290,22 @@ Présence à l'échange
 * `gensDuVoyage` (bool): `true` si la personne fait partie des gens du voyage
 * `titreDeSejour` (TitreDeSejour): entité TitreDeSejour
 * `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
-* `tempsDeTravail` (tempsDeTravail): entité tempsDeTravail
+* `tempsDeTravail` (TempsDeTravail): entité TempsDeTravail
 * `situationProfessionelleComment` (Comment): Commentaire (avec la date de la dernière mise à jour)
 * `situationProfessionelleStartDate` (Date)
-* `niveauEtude` (niveauEtude): entité niveauEtude
-* `mobilite` (mobilite): entité mobilite
+* `niveauEtude` (NiveauEtude): entité NiveauEtude
+* `mobilite` (mMbilite): entité Mobilite
 * `permisDeConduire` (bool): `true` si la personne a un permis de conduire
 * `moyenDeTransport` (bool): `true` si la personne a un moyen de transport
 * `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)
 * `numeroSecuriteSociale` (texte)
 * `caisseSecuriteSociale` (texte)
 * `pasDeMedecinTraitant` (bool): `true` si la personne n'a pas de médecin traitant
-* `medecinTraitant` (tiers): entité tiers
+* `medecinTraitant` (Tiers): entité ThirdParty
 * `medecinTraitantTexteLibre` (texte)
 * `mdph` (texte)
 * `mdphStartDate` (Date)
@@ -332,10 +332,11 @@ Présence à l'échange
 * `girEndDate` (Date)
 * `girComment` (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)
 * `caisseDeRetraitePrincipale` (texte)
 * `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:
 
@@ -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
 * `delegationDate` (Date)
 * `delegationComment` (Comment): Commentaire (avec la date de la dernire mise à jour)
-* `delegationThirdParty` (tiers): entité tiers
-* `delegationPerson` (person): entité person
+* `delegationThirdParty` (tiers): entité ThirdParty
+* `delegationPerson` (person): entité Person
 * `tuteur` (texte)
-* `tuteurThirdParty` (tiers): entité tiers
+* `tuteurThirdParty` (tiers): entité ThirdParty
 * `administrateurAdhoc` (bool): `true` si administrateurAdhoc
 * `administrateurAdhocDate` (Date)
 * `administrateurAdhocComment` (Comment): Commentaire (avec la date de la dernire mise à jour)
 * `pupilleEtat` (bool): `true` si pupilleEtat
 * `pupilleEtatDate` (Date)
 * `pupilleComment` (Comment): Commentaire (avec la date de la dernire mise à jour)
-* `tuteurPerson` (person): entité person
+* `tuteurPerson` (person): entité Person
 * `enfantEmancipe` (bool): `true` si enfantEmancipe
 * `enfantEmancipeDate` (Date)
 * `gardeAlternee` (texte)
@@ -396,6 +397,7 @@ En outre, si la personne est mineure, on a accès aux champs suivants:
 * `notificationMDPHStartDate` (Date)
 * `notificationMDPHEndDate` (Date)
 * `dispositifsComment` (Comment): Commentaire (avec la date de la dernire mise à jour)
+* `adresseDeRelais` (adresse): liste d'adresses
 :::
 
 #### 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);
 * `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
 
@@ -446,6 +458,14 @@ Téléphone du père: ${personFatherFirstphonenumber} // 01 23 45 67 89
 * `id` (int): identifiant de la position;
 * `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
 
 * `id` (int): identifiant du tiers;

build-pandoc.sh

@@ -21,6 +21,9 @@ fi
 
 if [ $kind = 'user' ]; then
   export files="
+    $kind/intro.md
+    $kind/concept.md
+    $kind/interface.md
     $kind/person.md
     $kind/person-vendee.md
     $kind/activite.md

user/concept.md

@@ -0,0 +1,22 @@
+\newpage
+
+# Survol des concepts dans Chill {#sec:concept}
+
+Chill est un logiciel conçu spécialement pour l'accompagnement social. Il est mis en oeuvre dans des contextes institutionnel différents mais repose sur un socle de concepts qui peuvent être utilisés dans plusieurs environnements où évoluent des travailleur·euses sociaux.
+
+Les trois concepts de base auxquels on ajoute de l'information sont:
+
+- l'usager: la personne bénéficiaire de l'accompagnement social. L'usager est au centre du logiciel: sur la page d'accueil, il y a une recherche par nom parmi les usagers encodés dans le logiciel. La "fiche usager" (voir [cette section](#sec:person)) résume toutes les informations propre à la personne (date de naissance, information de contact, etc.)
+
+- le parcours d'accompagnement: le dossier qui accompagne un ou plusieurs usagers. Un [parcours](#sec:parcours) a une date de début et peut être clôturé. C'est dans un parcours qu'on peut définir des actions d'accompagnement social.
+
+- le ménage: le ménage dont fait partie l'usager. Comme l'accompagnement social peut se faire aussi à l'échelle d'un ménage plutôt qu'individuellement, la [page du ménage](#sec:household) rassemble les informations pour les usagers d'un même ménage.
+
+
+Les pages du logiciel se divisent entre ces trois domaines, chaque domaine étant caractérisé par un bandeau avec une couleur particulière ainsi que son menu.
+
+L'utilisateur peut passer d'un domaine à l'autre, par exemple en ouvrant la fiche d'un usager depuis un parcours ou un ménage. On peut passer du domaine usager vers le domaine ménage en cliquant sur l'icône symbolisant une maison à droite de l'adresse d'un usager, et repasser vers le domaine usager en cliquant sur le nom d'un des usagers du ménage. Plusieurs sections sont aussi accessibles via plusieurs domaines, comme les activités/échanges ou les tâches, accessibles dans le domaine "usager" et "parcours d'accompagnement".
+
+![Les 3 bandeaux dans Chill](user/img/banner_all.png)
+
+Au-dessus des bandeaux se trouve la barre d'outil principale, qu'on retrouve dans chaque page du logiciel.

user/interface.md

@@ -0,0 +1,30 @@
+\newpage
+
+# L'interface générale {#sec:interface}
+
+## Une page du logiciel
+
+[Comme expliqué auparavant](#sec:concept), le logiciel est organisé en trois domaines principaux: usager, parcours d'accompagnement et ménage. Voyons une page du logiciel en détail dans la figure suivante.
+
+![Une page de Chill](user/img/a_chill_page.png)
+
+
+De haut en bas, il y a:
+
+- un premier bandeau bleu foncé;
+- deux bandeaux propre au domaine "parcours d'accompagnement";
+- le contenu de la page à gauche, ici un résumé du parcours d'accompagnement;
+- un menu en jaune, propre au domaine "parcours d'accompagnement".
+
+Dans le premier bandeau, il y a:
+
+- le champ de recherche: ce champ permet de chercher des usagers, et d'aller vers leurs fiches usagers
+- un menu section: ce menu, constamment accessible, permet de faire des actions transversales, c'est-à-dire qui ne sont pas directement liées à un usager, un parcours ou un ménage. Par exemple, ce menu permet d'ajouter un nouvel usager ou un parcours, d'ajouter une activité annexe, de gérer la liste des tiers, de réaliser des exports, etc.
+- un menu utilisateur: ce menu, où est rappelé le nom de l'utilisateur connecté, permet d'accéder aux dossiers propres à l'utilisateurs: ses parcours, ses tâches, rendez-vous, activités annexes, notifications, etc. En outre, une pastille avec un chiffre indique le nombre de notifications et tâches en attente pour lesquelles une action est requise.
+
+## Boutons et codes couleurs
+
+Les mêmes boutons sont utilisés au travers du logiciel. La figure suivante indique la signification de tous les boutons utilisés dans le logiciel.
+
+
+![Les boutons utilisés dans Chill](user/img/chill_buttons.png)

user/intro.md

@@ -0,0 +1,37 @@
+\newpage
+
+# Qu'est-ce que Chill?
+
+## A quoi ça sert ?
+
+Chill est un logiciel libre d'accompagnement social. Le logiciel peut être résumé par un système de « dossier social électronique ».
+
+Chill est une application web : on y accède via un navigateur. Le navigateur recommandé est Firefox : il est libre et gratuit et on y accède sur toutes les plates-formes (Windows, Mac, Linux, tablettes android, …). Le logiciel doit être installé sur un serveur, et peut donc être disponible via le réseau local ou internet.
+
+## Le but du logiciel
+
+Chill vise ces trois buts :
+
+* alléger la charge administrative des travailleurs sociaux en fournissant automatiquement des statistiques relatives à leur activité ;
+* partager les informations relatives à l'accompagnement social entre collègues ;
+* centraliser, en un seul lieu, les informations relatives aux personnes accompagnées.
+
+Les concepteurs de Chill ont remarqué qu'il est essentiel d'allier les trois buts. En effet, ils ont constaté qu'il est désagréable, pour les travailleurs, de « remplir des dossiers pour des statistiques ». Chill doit pouvoir être utilisé au quotidien : les travailleurs auront de l'intérêt à encoder les éléments si, continuellement, l'outil est utile dans leur travail quotidien.
+
+## Chill est un logiciel libre
+
+Le caractère « libre » du logiciel est affirmé dès sa création. La logique d'ouverture du code est poussée au maximum :
+
+* la documentation (élément essentiel qui permet à d'autres développeurs de continuer ou compléter le code) est présente et complète (voir http://docs.chill.social) ;
+* le code est sous licence AGPLv3. Il s'agit d'une des plus restrictives et des plus sûres pour l'utilisateur. Elle impose aux éditeurs de rendre disponible tout le code développé, même lorsque la redistribution est faite sous forme de service en ligne ;
+* il n'existe pas de module « propriétaire » : toutes les fonctionnalités sont accessibles.
+
+La libération du code est vécue comme une opportunité pour les éditeurs : c'est en effet l'occasion de mutualiser les coûts de développement en partageant le logiciel entre différentes institutions.
+
+## Comment l'installer ?
+
+Si vous cherchez la documentation d'installation du logiciel, elle se trouve à http://docs.chill.social.
+
+## Comment l'administrer ?
+
+Chill dispose d'une interface d'administration qui sert à configurer le logiciel, afin qu'il corresponde au mieux au métier des travailleur·euses sociaux. Dans ce document, nous appelons "administrateurs" la ou les personnes qui disposent d'un droit d'administration et qui ont configuré le logiciel. La documentation destiné aux administrateurs est rassemblé dans un autre document.