Co-authored-by: Julien Fastré <julien.fastre@champs-libres.coop>
Reviewed-on: Vendee/manuals#12
This commit is contained in:
Julien Fastré 2022-05-16 13:12:55 +00:00
parent 8e3c6634fa
commit 9f0418299f
14 changed files with 85 additions and 66 deletions

View File

@ -3,14 +3,21 @@ kind: pipeline
type: docker
name: build-release
clone:
disable: true
steps:
- name: submodules
- name: clone
image: plugins/git
settings:
recursive: true
- name: fetch images
image: alpine/git
commands:
- git submodule init
- git submodule update --recursive --remote
- git lfs fetch
- git lfs checkout
- name: pandoc
image: pandoc/core:2.18-alpine
@ -18,11 +25,19 @@ steps:
- sh build-pandoc.sh latex user > user/user-manual.tex
- sh build-pandoc.sh latex admin > admin/admin-manual.tex
- name: build-latex
image: ghcr.io/xu-cheng/texlive-full:latest
- name: build-latex-user
image: texlive/texlive
commands:
- latexmk -pdf -file-line-error -halt-on-error -interaction=nonstopmode -xelatex user/user-manual.tex
- latexmk -pdf -file-line-error -halt-on-error -interaction=nonstopmode -xelatex admin/admin-manual.tex
- cd user
- latexmk -pdf -file-line-error -halt-on-error -interaction=nonstopmode -xelatex user-manual.tex
- mv user-manual.pdf ../.
- name: build-latex-admin
image: texlive/texlive
commands:
- cd admin
- latexmk -pdf -file-line-error -halt-on-error -interaction=nonstopmode -xelatex admin-manual.tex
- mv admin-manual.pdf ../.
- name: release
image: plugins/gitea-release
@ -36,9 +51,11 @@ steps:
checksum:
- sha512
title: ${DRONE_TAG:=latest}
prerelease: true
when:
event:
- tag
---
kind: signature
hmac: ba0091444464145c540b6dd7407af9b765cf6a31460b88d590ea6eccc7659a7e
hmac: 686b3bf2e6d8ffd370cfde19d9110b6c71af6e2dc4afc3c1b8d7a5016397ee3e
...

View File

@ -4,7 +4,7 @@ set -e
# enter the current directory
cd "$(dirname $0)"
export PANDOC_DIR=pandoc/cl
export PANDOC_DIR="/pandoc/cl"
if [ -z $1 ]; then
@ -21,44 +21,46 @@ fi
if [ $kind = 'user' ]; then
export files="
$kind/intro.md
$kind/concept.md
$kind/interface.md
$kind/search.md
$kind/person.md
$kind/person-vendee.md
$kind/activite.md
$kind/document.md
$kind/thirdparty.md
$kind/menage.md
$kind/parcours.md
$kind/social_actions.md
$kind/notifications.md
$kind/tasks.md
$kind/workflows.md
$kind/choisir_une_adresse.md
intro.md
concept.md
interface.md
search.md
person.md
person-vendee.md
activite.md
document.md
thirdparty.md
menage.md
parcours.md
social_actions.md
notifications.md
tasks.md
workflows.md
choisir_une_adresse.md
"
elif [ $kind = 'admin' ]; then
export files="
$kind/generation-documents.md
generation-documents.md
"
else
echo "kind '$kind' is not valid";
exit 1;
fi
cd $kind
export ARGS="
--from markdown
--number-sections
--resource-path ./$kind
--metadata-file ./$kind/metadata.yaml
`#--lua-filter "${PANDOC_DIR}/format-link.lua`
--resource-path ./.
--metadata-file ./metadata.yaml
`#--lua-filter "../${PANDOC_DIR}/format-link.lua`
"
export PDF_TEMPLATE="./pandoc/template/eisvogel.tex"
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"
--lua-filter "../${PANDOC_DIR}/boxes.lua"
"
@ -70,18 +72,18 @@ elif [ $target = "pdf" ]; then
pandoc $ARGS $LATEX_ARGS \
--to pdf \
--pdf-engine xelatex \
-o "./$kind-manual.pdf" \
-o "./../$kind-manual.pdf" \
$files
elif [ $target = "html" ]; then
# check target directory exists
if [ ! -d "./build/html" ]; then
if [ ! -d "./../build/html" ]; then
echo "create build/html directory"
mkdir -p "./build/html"
mkdir -p "./../build/html"
fi
pandoc $ARGS \
--to html \
-o ./build/html/index.html \
-o ./../build/html/index.html \
$files
fi

View File

@ -3,7 +3,7 @@
# Activités (échanges)
<!-- fr/activity/?accompanying_period_id={id} -->
![Liste des échanges liés à un parcours](user/img/fr_activity__accompanying_period_id_2705.png)
![Liste des échanges liés à un parcours](./img/fr_activity__accompanying_period_id_2705.png)
Les activités (ou échanges) dans Chill servent à consigner des activités ou des échanges ayant eu lieu et de les associer à des usagers et/ou à des parcours d'accompagnement. Par activité, nous entendons un entretien individuel, une démarche via un
partenaire extérieur, un appel téléphonique relatif à la personne, un courriel, etc.

View File

@ -9,7 +9,7 @@ Que ce soit dans un ménage, dans un tiers ou encore pour localiser un échange,
Lorsque le formulaire d'adresse s'ouvre, vous pouvez soit sélectionner une adresse prédéfinie soit en saisir une nouvelle. Il est en effet possible de pré-charger une liste d'adresses dans Chill. Suivant votre installation, cela a peut-être été fait pour votre région, votre département ou le pays entier.
![Création d'une d'adresse](user/img/choisir-une-adresse.png)
![Création d'une d'adresse](./img/choisir-une-adresse.png)
La case à cocher "Adresse confidentielle" permet d'indiquer qu'une adresse doit apparaitre par défaut floutée dans le logiciel ou tout document exporté du logiciel.

View File

@ -17,7 +17,7 @@ Les pages du logiciel se divisent entre ces trois domaines, chaque domaine étan
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)
![Les 3 bandeaux dans Chill](./img/banner_all.png)
Au-dessus des bandeaux se trouve la barre d'outil principale, qu'on retrouve dans chaque page du logiciel.

View File

@ -6,17 +6,17 @@ Un dossier social comporte souvent un certain nombre de documents, propre au tra
Tout comme les activités/échanges, les documents peuvent être enregistré à la personne ou bien au parcours d'accompagnement. L'accès aux documents enregistrés se fait par l'entrée "Documents" via le menu "usager" ou via le menu "parcours d'accompagnement". Les documents enregistrés sont téléchargeables: on peut les retrouver à tout moment par cette liste de documents.
![Liste des documents](user/img/fr_person_2811_document.png)
![Liste des documents](./img/fr_person_2811_document.png)
## Ajouter un document
![Ajouter un document](user/img/fr_person_2811_document_new.png)
![Ajouter un document](./img/fr_person_2811_document_new.png)
Pour ajouter un document, dans la liste des documents, cliquer sur le bouton "Créer un nouveau document". Il est demandé de rentrer un titre, une date (par défaut la date de jour), une catégorie de document et une courte description. Ensuite, le document (un document au format pdf, un document de traitement de texte, ...) peut être glissé-déposé ou retrouvé sur un ordinateur en cliquant dans la zone de téléversement.
## Générer un document
![Générer un document dans un parcours](user/img/generer_document_parcours.png)
![Générer un document dans un parcours](./img/generer_document_parcours.png)
Il est possible de générer ses propres documents à partir de modèles pré-établis et des données saisies dans chaque dossier social, que ce soit un dossier d'un usager ou d'un parcours. Les modèles sont des fichiers "templates" qui sont préparés par les administrateurs du logiciel et qui sont généralement propres à une organisation.

View File

@ -6,7 +6,7 @@
[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)
![Une page de Chill](./img/a_chill_page.png)
De haut en bas, il y a:
@ -27,4 +27,4 @@ Dans le premier bandeau, il y a:
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)
![Les boutons utilisés dans Chill](./img/chill_buttons.png)

View File

@ -17,7 +17,7 @@ Chaque usager se voit attribué une **position** dans un ménage, configurée pa
<!-- /fr/person/household/{household_id}/summary -->
![Résumé d'un ménage](user/img/fr_person_household_376_summary.png)
![Résumé d'un ménage](./img/fr_person_household_376_summary.png)
On accède à la page de résumé du ménage via le menu "usager" ou bien en cliquant sur l'icône représentant le ménage dans la recherche par personne. La page de résumé du ménage présente l'adresse actuelle du ménage, les membres du ménage et la composition du ménage.
@ -92,14 +92,14 @@ L'historique des adresses du ménage peut être accédé dans le menu du ménage
<!-- /fr/person/household/{household_id}/addresses -->
![Historique des adresses d'un ménage](user/img/fr_person_household_376_addresses.png)
![Historique des adresses d'un ménage](./img/fr_person_household_376_addresses.png)
Une liste des parcours d'accompagnement du ménage peut être également affichée en cliquant dans le menu du ménage sous "parcours d'accompagnement".
## Filiations
<!-- /fr/person/household/{household_id}/relationship -->
![Filiations d'un ménage](user/img/menage_filiations.png)
![Filiations d'un ménage](./img/menage_filiations.png)
La page "Filiations" propose une vue d'ensemble sous forme de graphe des filiations au sein d'un ménage, c'est-à-dire les liens de parenté entre ses membres. Cette page permet non seulement de visualiser les filiations mais aussi de les éditer. En cliquant sur "Créer un lien de filiation", puis en sélectionnant 2 personnes, il est possible de définir les liens de filiations entre ces 2 personnes: mère/père-fille/fils, frère/soeur-frère/soeur, oncle/tante-neveu/nièce.

View File

@ -8,7 +8,7 @@ Les notifications sont des messages envoyés par un utilisateur à un ou plusieu
On y accède soit depuis la page d'accueil de Chill, sous l'onglet "Mes notifications", soit n'importe où dans l'application via le
menu "utilisateur" en haut à droite de l'écran. Selon la configuration choisie par les administrateurs du logiciel, les notifications sont aussi envoyées par courriel au travailleur social concerné.
![Boîte de réception des notifications](user/img/fr_notification_inbox.png)
![Boîte de réception des notifications](./img/fr_notification_inbox.png)
## Créer une notification
<!-- fr/notification/create?entityClass=Chill%5CPersonBundle%5CEntity%5CAccompanyingPeriod&entityId=2705-->
@ -27,12 +27,12 @@ Les notifications envoyées, par exemple, à partir d'un parcours, sont listées
Il y a en outre des notifications automatiquement envoyées lors de certaines manipulations.
![Créer une notification](user/img/notification_parcours.png)
![Créer une notification](./img/notification_parcours.png)
## Discuter dans une notification
<!-- fr/notification/{notification_id}/show -->
![Discussion dans une notification](user/img/fr_notification_126_show.png)
![Discussion dans une notification](./img/fr_notification_126_show.png)
Lorsqu'une notification est reçue, il est possible d'engager une discussion avec son destinataire dans la page de la notification. Cela permet de laisser des messages entre travailleurs, comme dans un système de discussion en ligne.

View File

@ -7,11 +7,11 @@ Fournir un soutien social significatif est souvent une combinaison complexe d'ob
Vous pouvez le considérer comme le troisième grand module de l'application. Comme pour les domaines "usager" et "ménage", les pages concernant un parcours sont facilement identifiables par son bandeau en haut de l'écran.
![Bandeau d'un parcours d'accompagnement](user/img/banner_course.png)
![Bandeau d'un parcours d'accompagnement](./img/banner_course.png)
## Résumé du parcours
![Résumé du parcours](user/img/parcours_dashboard.png)
![Résumé du parcours](./img/parcours_dashboard.png)
<!-- /fr/parcours/{id} -->
@ -83,19 +83,19 @@ Les informations requises pour **confirmer** un parcours sont les suivantes :
* Il doit être attribué à au moins un service.
* Il doit être localisé.
![Confirmer le parcours](user/img/parcours_confirm.png)
![Confirmer le parcours](./img/parcours_confirm.png)
Toutes ces informations requises sont énumérées au bas du formulaire tant qu'elles ne sont pas remplies. Cela sert à vous rappeler ce que vous devez faire pour confirmer le parcours.
### Usagers concernés
![Usagers concernés](user/img/concerned_persons.png)
![Usagers concernés](./img/concerned_persons.png)
Un parcours peut être mis en place pour apporter un soutien à plusieurs usagers (par exemple, un soutien est apporté à une mère et son enfant).
### Localisation du parcours
![Localisation](user/img/parcours_localisation.png)
![Localisation](./img/parcours_localisation.png)
Chaque parcours **doit** être localisé et ceci peut être fait de deux manières.

View File

@ -1,7 +1,7 @@
## Informations socio-professionnelles
<!-- fr/vendee/vendeeperson/{person_id}/infosociopro/ -->
![Informations socio-professionnelles](user/img/fr_vendee_vendeeperson_2811_infosociopro_view.png)
![Informations socio-professionnelles](./img/fr_vendee_vendeeperson_2811_infosociopro_view.png)
La page des informations socio-professionnelles de l'usager rassemble des informations professionnelles (salarié, en recherche d'emploi, ...), le niveau d'étude, des informations de mobilité (permis de conduire, moyen de transport) et les caisses de retraites. Pour ce dernier point, une caisse principale et plusieurs caisses complémentaires peuvent être ajoutées.
@ -10,7 +10,7 @@ Cette page est accessible via le menu "usager".
## Informations médicales
<!-- fr/vendee/vendeeperson/{person_id}/infomedicale/ -->
![Informations médicales](user/img/fr_vendee_vendeeperson_2811_infomedicale_view.png)
![Informations médicales](./img/fr_vendee_vendeeperson_2811_infomedicale_view.png)
La page des informations médicales compte des informations de santé telles que le nom du médecin traitant, les caisses de sécurité sociale et mutuelle, et éventuelles allocations (MDPH, AAH, etc.).
@ -30,9 +30,9 @@ Lorsque l'usager est un mineur (<18 ans), des informations supplémentaires peuv
La page des informations familiales peut être plus ou moins détaillée selon la situation du mineur. S'il y a des dispositifs tels que délégation, tuteur, JAF, enfant confié, etc., d'autres champs se déplient dans le formulaire.
![Situation familiale](user/img/fr_vendee_vendeepersonmineur_2821_infofamille_view.png)
![Situation familiale](./img/fr_vendee_vendeepersonmineur_2821_infofamille_view.png)
La page de la scolarité contient des informations sur l'établissement scolaire, l'enseignant référent, la formation en alternance le cas échéant, et d'autres informations scolaires.
![Scolarité](user/img/fr_vendee_vendeepersonmineur_2821_scolarite_view.png)
![Scolarité](./img/fr_vendee_vendeepersonmineur_2821_scolarite_view.png)

View File

@ -11,7 +11,7 @@ Pour chaque usager, on peut définir des parcours d'accompagnements. Enfin, à c
## Créer un usager
<!-- fr/person/new -->
![Créer un usager](user/img/fr_person_new.png)
![Créer un usager](./img/fr_person_new.png)
Pour ajouter un usager, cliquez sur "Sections" > "Ajout d'un usager", depuis:
@ -34,7 +34,7 @@ Chill va rechercher les doublons potentiels pour un usager qui est créé. La re
## Détails de l'usager
<!-- fr/person/{id}/general -->
![Page de détails de l'usager](user/img/fr_person_2811_general.png)
![Page de détails de l'usager](./img/fr_person_2811_general.png)
La fiche de l'usager contient toutes les informations détaillées de l'usager, à savoir:
@ -61,7 +61,7 @@ En conséquence, on n'attache pas l'adresse de domicile directement à un usager
## Adresses de résidences
<!-- /fr/person/{id}/residential-address/list -->
![Adresse de résidence pour un usager](user/img/fr_person_2811_residential-address_list.png)
![Adresse de résidence pour un usager](./img/fr_person_2811_residential-address_list.png)
Chaque usager peut avoir une ou plusieurs adresses de résidences. On y accède en cliquant sur "Adresses de résidence" dans le menu à droite.
@ -77,7 +77,7 @@ Lors de l'ajout d'une adresse de résidence, il y a le choix entre:
## Personnes ressources
<!-- /fr/person/{id}/resources/list -->
![Personnes ressources d'un usager](user/img/fr_person_2811_resources_list.png)
![Personnes ressources d'un usager](./img/fr_person_2811_resources_list.png)
Les personnes ressources sont des autres usagers ou des tiers (#sec:tiers) associés au dossier de l'usager. Une personne-ressource peut être un ami ou un voisin (un autre usager), un professionnel de la santé (un tiers), etc. Les autres membres du ménage de la personne sont plutôt à saisir dans la partie "ménage". Si la personne-ressource n'est pas enregistrée, on peut également l'ajouter en tant que description libre.

View File

@ -7,7 +7,7 @@ Dans le bandeau supérieur, il y a une barre de recherche des usagers. On peut y
Si vous n'avez pas trouvé l'usager, vous pouvez cliquer sur le bouton "Recherche avancé". Dans la page de recherche avancée, on peut rechercher sur base de la date de naissance, un fragment de numéro de téléphone, etc.
![Recherche avancée d'un usager](user/img/advanced_search.png)
![Recherche avancée d'un usager](./img/advanced_search.png)
## Motifs de recherche

View File

@ -20,7 +20,7 @@ Bien que les types d'actions soient limités par les problématiques du parcours
<!-- /fr/personne/accompagnement-période/{id}/travail -->
![Action d'accompagnement](user/img/action_accompagnement.png)
![Action d'accompagnement](./img/action_accompagnement.png)
Comme de nombreuses autres sections de l'application Chill, une liste des actions d'accompagnement social peut être trouvée en cliquant sur <**Actions d'accompagnement**> dans le menu latéral jaune d'un parcours.