Chill-project/manuals
7
0
Fork 1
Code Issues 4 Pull Requests 3 Actions Projects Releases 14 Wiki Activity

Publier la documentation de Chill en ligne après chaque mise à jour (#14)
Some checks failed
continuous-integration/drone/push Build is failing
Details
Build and Push MkDocs Docker Image / build-and-push (push) Successful in 2m40s
Details

Browse Source 
Reviewed-on: #14
Co-authored-by: Julien Fastré <julien.fastre@champs-libres.coop>
Co-committed-by: Julien Fastré <julien.fastre@champs-libres.coop>
This commit is contained in:
Julien Fastré
2025-06-30 16:16:24 +00:00
committed by Julien Fastré
parent f531de0351
commit 4c330d7b87
128 changed files with 1345 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
user/docs/English/activity.md Normal file
View File

@@ -0,0 +1,47 @@
\newpage
# Activities (exchanges)
<!-- en/activity/?accompanying_period_id={id} -->
![List of exchanges related to a course](user/img/en_activity__accompanying_period_id_2705.png)
Activities (or exchanges) in Chill are used to record activities or exchanges that have taken place and to link them to users and/or support pathways. By activity, we mean an individual interview, an approach via an external
partner, a telephone call relating to the person, an e-mail, etc.
The information to be encoded is different according to the type of activity.
For example, for a telephone call, you can specify the duration of the call, the caller and take a note. For a meeting, you can associate a location (the place where the meeting took place), the parties present at the meeting, notes, documents, etc.
In this way, this information can be centralised and then easily shared between the social workers.
The types of activities and their corresponding fields (location, duration, travel time, documents, presence of the person, users, etc.) can be configured in the administration area.
## Activity in persons or trajectories?
The activities can be encoded in the person or in the support path. It is up to you to choose whether to encode activities in the context of a support pathway or in the context of a person. However, as soon as a person is mentioned in an activity, this activity can be found in the list of activities of the person.
Example: In the support path of the user Gabrielle Durant, I create an activity concerning an email where I also mention another user encoded in Chill: Dominique Duchemin. The activity will be visible in Gabrielle Durant's support path, but also in her user file and in Dominique Duchemin's file.
We can therefore access the list of activities of a person via the "user" menu and the list of activities of a support path via the "support path" menu.
## Create and modify an activity
In the list of activities, click on the "Create" button to create a new activity. First choose the type of activity/exchange, then fill in the relevant information. If the activity has been created in a pathway, the social issues and related support actions will be filled in. Depending on the type of activity, you will be able to fill in the parties involved, the date, the location, the duration of the activity, the possible travel time (in case of a trip), documents, the subject, a free note, etc.
The subject is taken from a predefined list, established in the administration area of the software.
Any type of document can be added to an activity: a text document, a pdf, a photo, etc.
The parties involved, users, third parties or users (social worker), are added by searching for people already encoded in Chill or by creating them on the fly. If the activity has been created in a pathway, you can easily add parties involved by clicking on the proposed names. The proposals are based on the parts mentioned in the accompanying course.
::: { .info }
It is possible to transform an appointment into an activity. (TODO)
:::
Users can create a [private comment](./private_comments.md) per activity, which will only be seen by them.
Once an activity has been created, it is always possible to modify it to make corrections or additions.
## Effects of the selection of issues or actions on trajectories

33
user/docs/English/aside_activities.md Normal file
View File

@@ -0,0 +1,33 @@
/newpage
# Side activities
To allow a user to also keep track of activities that are not directly related to a support trajectory or to a person, there is a side activity section.
A side activity could be a team meeting, a training, but also a phone call or email.
## Listing page
<!-- /fr/asideactivity -->
A user can navigate to his/her list of side activities from within their user menu by clicking on <**My side activities**>. Similar to other sections of the Chill app, you will find here a list that offers a first quick overview of each activity. You can view the activity in more detail, edit, or delete it.
## Creating a side activity
<!-- /fr/asideactivity/new -->
![Creation aside activity](/user/img/new_aside_activity.png)
The form fields of a side activity are self-explanatory. It is important to note however that a user can create a side activity for another user. Multiple users can also be linked, think of a meeting for example.
A side activity can be created for the future, but they can also still be created for activities that already took place. As such it shouldn't be seen as a planning tool, but more to keep record of side activities.
All fields are required, except for any additional note you might want to add.
## Detail page
<!-- /fr/asideactivity/{id}/view -->
Within the detail page the most important thing to note is the option to **duplicate** a side activity. For example, a meeting that is held weekly with more or less the same people can therefore easily be duplicated, while still allowing modifications to be made.

13
user/docs/English/bulk_reassign.md Normal file
View File

@@ -0,0 +1,13 @@
# Bulk reassign support trajectories
The need may arise for the support trajectories followed by one user to be reassigned to another user. Example cases could be a user being absent for an extended amount of time, switching functions, etc.
For such situations a functionality has been provided to reassign support trajectories in bulk to another user.
To make use of this functionality the user can click on 'Trajectories per user' in the section menu.
A first select field will be visible. Use this to select the user whose trajectories have to be reassigned. A complete list of the trajectories will be provided.
In a second step the user to whom the trajectories on the current page have to reassigned can be selected. Clicking on the button 'reassign' will complete this action and show the remaining trajectories. The action can be repeated.
Each individual trajectory is displayed with the edit button, allowing it to be individually reassigned within the trajectory edit form. Navigate to the [referrer](./support_trajectory.md#referrer) section to reassign this trajectory. During a bulk reassign this trajectory will no longer be taken into account, as it no longer belongs to the initial user.

3
user/docs/English/documents.md Normal file
View File

@@ -0,0 +1,3 @@
/newpage
TODO: translate from french

98
user/docs/English/household.md Normal file
View File

@@ -0,0 +1,98 @@
/newpage
# Households {#sec:household}
## What is a household?
A household is a set of users living 'under the same roof'. This can be members of a family, members of a blended family, members of a foster family, etc.
<!-- Living "under the same roof" OR living at the same address? -->
A household is characterised by an address, which corresponds to the home address of its members. This address can change (in case of a move): it is therefore defined between a start date and an end date and there may be a history of household addresses. Similarly, a user may change household and have a history of households.
## Household summary
<!-- /en/person/household/{household_id}/summary -->
![Household Summary](user/img/en_person_household_376_summary.png)
The household summary page is accessed via the "person" menu or by clicking on the household icon in the person search. The household summary page shows the current household address, the household members and the composition of the household.
The household address history can be accessed in the household menu under the heading "Address history". The address history shows all successive household addresses and allows for additions.
<!-- /en/person/household/{household_id}/addresses -->
![Household address history](user/img/en_person_household_376_addresses.png)
A list of the household's trajectories can also be displayed by clicking in the household menu on <**trajectories**>.
### Create a household
If there is no household in the list of households for a user, then the software allows you to create a new household. At this stage, you can create a new household or join an existing one. The software will automatically propose possible households by making some suggestions.
#### Which households are suggested?
The software tries to establish links between the persons concerned by the change of household, and other households.
The links made are as follows:
* For each person affected by the change, the software checks whether he or she is present in another support trajectory, with other persons. If these persons are themselves associated with a household, then the software proposes to join that existing household.
* The software also examines the location of the support trajectories in which the person, concerned by the change, is located. If a support trajectory is located at a reference address, the software looks to see if there are other households living at that address. If it finds any, these households will also be suggested.
At this stage, you can enter an address; this will immediately locate the created household. The software will suggest you to re-use known addresses.
#### Which addresses are suggested?
The software suggests you to re-use the temporary location of the support trajectories associated with the household members.
For each person who is going to "change household", the software examines whether he is currently associated with a trajectory. If this trajectory has a temporary address, then this address will be included in the suggestions.
### Join a household
There are several possible ways of getting a person to join a household:
- when creating a social trajectory for a person who is not in a household, the software suggests that he/she should join a household. The action then positions him/her in a household, whether it is an existing household or one to be created.
- When you are on the household summary page, you can always search for and add a person. To do this, use the "Add a member" button at the bottom of the page.
### Positions in the household
<!-- note that the positions "children outside the household", etc., are configurations -->
Each member of the household is detailed in the "household summary" page. The person can have a certain position in the household: adult or child, as well as being the owner of a household. At any time it is possible to remove a person from a household, or to reposition him/her in the household (e.g. to make him/her the owner).
If necessary, it is also possible to view a former membership, i.e. a person who used to belong to the household but is no longer part of it.
## Add members to the household, leave a household, join a household
At the bottom of the household summary page, the <**Add a member**> button allows you to add a user to the household. When clicking on this button, in the following pages, one can:
- add one or more existing persons, or create new ones;
- position each person in the household, i.e. specify whether he/she is a child or an adult, and possibly qualify him/her as a household member;
- enter the date when the person joins the household, and possibly a comment;
- and, finally, save.
In the list of household members, using the buttons on the right, one can
- leave the household: in this case, the person can join another household or leave without joining a household. Again, a change date is encoded.
- reposition the member: i.e. change the position (adult, child, ...) of the member.
- fill in the membership: i.e. change the date and the comment of the change
## Affiliations
<!-- /en/person/household/{household_id}/relationship -->
![Affiliations of a houshold](user/img/menage_filiations.png)
The "affiliations" page provides an overview in graph form of the affiliations within a household, i.e. the relationships between its members. This page allows not only to view the relationships but also to edit them. By clicking on <**Create a relationship**>, then selecting 2 persons, it is possible to define the relationship between these 2 persons: mother/father-daughter/son, brother/sister-brother/sister, uncle/aunt-nephew/niece.
In addition, the graph also shows the support trajectories associated with each household member. By displaying the trajectory, persons who may be linked to these trajectories, but belong to other households can be displayed. The elements of the graph can be moved by clicking and dragging. Finally, the graph can be exported as an image.
In short, this page summarises a household and its relationships in an easy-to-understand diagram.
## Family composition
The family composition is a qualification of the household as a household type, e.g. couple with children, couple without children, single mother, single woman, etc. This composition is valid until a certain date and with a maximum of one year.
As with the addresses of a household, it is possible to view the history of the composition of a household.

9
user/docs/English/metadata.yaml Normal file
View File

@@ -0,0 +1,9 @@
---
title: Chill user manual
lang: en-EN
toc: true
header-includes: |
\usepackage{awesomebox}
...

38
user/docs/English/notifications.md Normal file
View File

@@ -0,0 +1,38 @@
\newpage
# Notifications
<!-- en/notification/inbox -->
![Notification inbox](user/img/en_notification_inbox.png)
Notifications are messages sent by one user to one or more others. The purpose of notifications is to quickly exchange information about ongoing social cases between social workers. For example, notifications can be used to inform a caseworker about a case.
They can be accessed either from the Chill homepage, under the "My notifications" tab, or anywhere in the application via the "user" menu at the top right of the screen. Depending on the configuration chosen by the software administrators, notifications are also sent by email to the social worker concerned.
## Create a notification
<!-- en/notification/create?entityClass=Chill%5CPersonBundle%5CEntity%5CAccompanyingPeriod&entityId=2705-->
![Create a notification](user/img/notification_parcours.png)
Notifications can be sent from several places in the software. A notification consists of a subject (such as an email), one or more recipients, a message and the information from which the notification is sent. For example, when sending a notification as part of a course, the general course information is also copied.
It is possible to send a notification:
- from the summary page of a support trajectory
- from an activity/exchange
Notifications sent, for example, from a support trajectory, are listed in the trajectory summary.
<TODO: Are there any other places where notifications are used? -->
In addition, there are notifications that are automatically sent when certain actions are taken.
## Discuss in a notification
<!-- en/notification/{notification_id}/show -->
![Discussion in a notification](user/img/en_notification_126_show.png)
When a notification is received, it is possible to start a discussion with the recipient in the notification page. This allows messages to be left between workers, as in an online chat system.
In the list of notifications, when you click on a notification, you can unfold the content of the notification and access the discussion with the "View associated comment thread" icon.

98
user/docs/English/person.md Normal file
View File

@@ -0,0 +1,98 @@
\newpage
# Person file {#sec:person}
The person file contains all the information specific to the person: surname, first name, contact information, addresses, etc. It is the basis of the person's electronic social file.
It can be accessed by searching for a person on the homepage or in the toolbar. It can also be accessed from other pages by clicking on a person's name and then clicking on "Open person file".
<!-- TODO a déplacer vers une autre section, sur le concept de l'usager? -->
A person can be part of one or more households. For each person, it is possible to define support trajectories. Finally, each person is linked to exchanges in which the person is involved.
## Create a person
<!-- fr/person/new -->
![Create a person](user/img/fr_person_new.png)
To add a person, click on "Sections" > "Add a person", in the top toolbar.
In the creation page, enter the requested information. Only the surname, first name(s) and gender are mandatory. Then click on "Create person". You can then choose between simply creating the person, creating the person and associating him/her with a household or creating the person and creating an associated support trajectory.
::: { .info }
Please note that there is a standard format for entering telephone numbers. Enter your numbers without spaces, "/" bars or "-" dashes.
<!-- TODO d'autres contraintes sur les numéros de tel? -->
:::
## Person detail page
<!-- fr/person/{id}/general -->
![Person detail page](user/img/fr_person_2811_general.png)
The person record contains all the detailed information of the person, namely:
- surname, first name(s), gender;
- nationality, languages spoken, number of children, marital status
- date and place of birth;
- contact information.
This information can be filled in as you go along, or left blank. At the bottom of the page, the "Edit" button allows you to edit this information. Remarks can also be added.
Some of this information is recalled in the person's banner and in other places in the software when the person's name is clicked on.
## Person addresses
Chill supports two types of addresses:
* home addresses, which are the permanent, official addresses of a person (home address);
* residence addresses, which are temporary addresses of a person, at which he/she resides only for a certain period of time, and which is not intended to be official.
Therefore, the official address is not attached directly to a person, but to his or her household. Only residential addresses can be entered in the person's file.
## Home address
<!-- /fr/person/{id}/residential-address/list -->
![Person home address](user/img/fr_person_2811_residential-address_list.png)
Each person can have one or more home addresses. These are accessed by clicking on "Home addresses" in the right-hand menu.
These addresses are not supposed to be official home addresses, declared to the authorities. They are, for example, a temporary residence in a nursing home, accommodation with an acquaintance or friend for a specific period of time, etc.
When adding a residence address, there is a choice between
- taking an address from another person (from another person);
- taking an address from a third party;
- create a new address [address](#sec:choose-an-address).
## Resource persons
<!-- /fr/person/{id}/resources/list -->
![resource persons](user/img/fr_person_2811_resources_list.png)
Resource persons are other persons or third parties associated with the person's file. A contact person may be a friend or neighbour (another person), a health professional (a third party), etc. Other members of the person's household should be entered in the "household" section instead. If the contact person is not encoded, he/she can also be added as a free description.
<!-- ## Historique
<!-- /fr/person/{id}/timeline
TODO -->
## Treating doubles
<!-- /fr/person/{id}/duplicate/view -->
It is possible that a person has been encoded more than once. The "Dealing with duplicates" page allows you to identify and deal with possible duplicates of a person. The page lists persons with similar names and suggests merging them.
::: { .info }
This page is used to process duplicates, but Chill also automatically detects potential duplicates when encoding a new person.
:::
## Other person menu entries
There are several entries in the person menu that link to other parts of the software, keeping the link to the person. These entries are:
* Support trajectories: list of the trajectories in which the person is involved;
* Activities (or exchanges): list of activities in which the person is involved;
* Documents: list of documents in which the person is involved;
* Tasks: list of tasks in which the person is involved;
* Households: management of the person's household.

7
user/docs/English/private_comments.md Normal file
View File

@@ -0,0 +1,7 @@
## Private comments
Private comments can be created for [activities](./activity.md#create-and-modify-an-activity), [social actions](./social_actions.md#private-comment) and appointments.
Each user can post one private comment per item (eg. per activity). This comment can of course be edited within the edit forms of the concerning item.
Naturally, users can only see their own private comments and not those of other users.

10
user/docs/English/search.md Normal file
View File

@@ -0,0 +1,10 @@
\newpage
# Recherche
In the top banner, there is a person search bar. You can search for persons by surname and first name, the search engine being tolerant of different spellings. For example, if you search for "Mathieu", you will also find first names corresponding to "Matthieu".
If you have not found the person, you can click on the "Advanced search" button. In the advanced search page, you can search on the basis of date of birth, a fragment of telephone number, etc.
![Advanced search for a person](user/img/advanced_search.png)

75
user/docs/English/social_actions.md Normal file
View File

@@ -0,0 +1,75 @@
/newpage
# Social support actions
Social support actions are actions taken within a trajectory and concerning a certain social issue.
Social support actions are easily recognizable throughout the application by the orange title banner.
__note__: Social actions can only be created for **confirmed** trajectories.
## Listing page
<!-- /fr/person/accompanying-period/{id}/work -->
![social_action](/user/img/action_accompagnement.png)
Similar to many other sections within the Chill application, a list of social support actions can be found by clicking on <**social support actions**> in the yellow side-menu of a trajectory.
A concise overview of important information is given for each action in the list.
So long a trajectory is in the **confirmed** state each action can be modified, deleted or a [workflow](/user/English/workflow.md) can be created.
## Creating a social support action
<!-- /fr/person/accompanying-period/{id}/work/new -->
To create a social support action a user will be guided through several steps,
1. Pick one social issue. If the concerning social issue is not amongst the provided choices the user can add it by selecting it from the dropdown menu.
2. Pick a social action. All actions displayed are linked to the previously selected social issue.
3. One or more concerning persons can be selected.
4. Specify a start date.
5. Specify an ending date (optional).
## Modifying a social support action
Once a social support action has been created it is not considered to be a static recording. The modification form allows for much more information to be added in later stages so as to make it a 'working document'.
### Comment
Here the user is free to give whatever extra information necessary.
### Private comment
Users can create a [private comment](./private_comments.md) per social action, which will only be seen by them.
### Motives and goals
Social support actions are never random. They are taken with certain motives or to attain a certain goal.
By clicking on a badge (+) within the dropdown menu of this section, the user can add the motive or goal of the action. By clicking on it again (-) it can be removed.
Multiple goals can be selected.
### Results or outcome
Once a motive or goal is identified it is also possible to specify a result or outcome of the action concerning this specific goal. Similarly they can be selected from a dropdown menu and removed again.
Multiple outcomes can be selected.
### Evaluations, forms or correspondence
Multiple evaluations or forms can be added to a social support action. It is specified which evaluation can be started and clicking on the badge (+) will open a form for the user to fill in.
The form allows a starting date, due date and ending date to be set, as well as a reminder. An extra comment box can be used to give more details and a [document](/user/English/documents.md) can be generated or uploaded.
### Concerned persons
Concerned persons within the trajectory are listed here and the user can select who was involved in this specific social support action.
### Treating thirdparties
If an external partner executed the social action, they can be identified here.
Think of them as the main actor.
### Intervening thirdparties
These are external partners that participate(d) in the social action, but are not the main actors.

195
user/docs/English/support_trajectory.md Normal file
View File

@@ -0,0 +1,195 @@
/newpage
# Social support trajectory
Providing meaningful social support is often an intricate combination of goals, actions, involved actors, documents, etc... With its social support module, Chill aims to give it's users a tool which they can keep track of trajectories.
You can look at it as the third big module within the application. Like the person and household modules it can be easily identified by the banner at the top of the screen.
![Trajectory banner](/user/img/banner_course.png)
## Trajectory overview
![Trajectory dashboard](/user/img/parcours_dashboard.png)
<!-- /fr/parcours/{id} -->
The overview page assembles the most important information and latest activity within a trajectory, allowing you to take certain quick actions like clicking on associated person badges, linked activities or social actions, sending a new notification, etc...
In short it is the trajectory dashboard from where you can navigate to specific sections.
## Creation of a social support trajectory
<!-- /fr/parcours/{id}/edit -->
A new trajectory can be created from the section menu. Doing so will direct you to a blank trajectory form for you to fill-out.
> Sections > Create a new trajectory
A trajectory can also be created from within a person file and will immediately link it to this person. You will see the person added in the first section **concerned persons**
> Yellow person menu > Trajectories > Create a trajectory button
### Different states of a trajectory
It is important to distinguish three main states for a trajectory. A badge can be found in the top right corner of the banner or list-item to identify this state.
* **DRAFT**: the trajectory form has missing information and can therefore not be confirmed (badge color: gray) *
* **CONFIRMED**: all required information has been provided and further actions, activities,... can be added (badge color: dark blue).
* **CLOSED**: the social support trajectory has come to closure, the reason can be defined (badge color: red).
Within your user menu you will find a menu entry to direct you to,
* a listing page of **all** the trajectories to which you are the referrer.
* a listing page of all your **DRAFT** trajectories (ones you created, but have not yet confirmed).
While the above three are considered the main states, there are additional properties that distinguish the state of a trajectory. They are the following,
* **Confidential**: A confidential trajectory can only be viewed by the referrer. Other users will not have access to it's information.
* **Intensity**: TODO The intensity can be set to *regular* or *punctual*
* **Emergency**: This state can be toggled when urgent actions are required within this trajectory.
### Required information
The information required to **confirm** a trajectory is the following:
* It is linked to at least one [concerned person](#concerned-person).
* It has at least one linked [social issue](#social-issue).
* It is assigned to at least one [service](#service).
* It has to be [localised](#trajectory-localisation).
![Confirm trajectory](/user/img/parcours_confirm.png)
All of these requirements are listed at the bottom of the form when you have failed to fulfill them. This serves as a reminder to what you should do in order to confirm the trajectory.
### Concerned person
![Concerned persons](/user/img/concerned_persons.png)
A trajectory can be put started to provide support to multiple persons (eg. support is given to a mother and her two children).
### Trajectory localisation
![Localisation](/user/img/parcours_localisation.png)
Every trajectory **has** to be localised and this can be done in one of two ways.
1. You can indicate a temporary address by clicking the designated button. The address will not automatically be adapted when a concerned person moves. Therefore a message is displayed to remind you as a user that the second option, here listed, is preferable.
2. You can link it to a concerned person's **home address** by clicking the map-marker icon in the concerned persons section. If the person moves it will also be automatically adapted within the trajectory.
__Note__: While a trajectory is linked to a concerned person's address...
* it is not possible to dissociate this person from the trajectory.
* the person cannot be moved from a household without indicating another address.
#### Why localize a trajectory ?
Localising a trajectory allows for the following:
* The automatic assignment of a referrer.
* Inclusion in the list of trajectories to be discussed within meetings held by concerning services.
* The generation of localised statistics.
* The management of access rights.
#### Locate the trajectory with a concerned person
If a concerned person has an address, it is possible to locate the trajectory with this person.
When a trajectory is located with a person:
* the trajectory "follows" the person's address when he moves;
* it is not possible to dissociate the concerned person from the trajectory;
In addition,
* the person cannot leave the trajectory as long as the trajectory is located near him/her
* the person cannot leave the household without leaving an address, as long as he/she is located with at least one trajectory.
#### Temporary location
A temporary address may be assigned to a trajectory.
In this case, this location is associated with the route, and will not be automatically changed if a person moves. To avoid this situation, a warning message reminds persons that it is preferable to indicate a real location for the trajectory.
### Origin of the application for support
Within this section you will find a pre-defined list of possible origins (eg. the application was done by telephone)
### Administrative location
The administrative location is the place where the trajectory is processed. This is useful for organisations with several different locations.
### The applicant
This can be an already existing person/thirdparty or a new applicant can be created from within the search modal. Click on the button <**create 'your-search-name'**> to do so.
### Social issue
Using the dropdown menu multiple social issues can be identified. Link at least one to be able to confirm the trajectory.
### Services
Identify at least one service that is concerned with this trajectory. Multiple services can be selected. This will have an impact on who has the right to access the trajectory files.
### Referrer
The referrer is the colleague to whom you can refer yourself concerning this trajectory. They are responsible for the follow-up and they have specific rights linked to the state of the trajectory.
* They can mark it as confidential.
* They can mark it as urgent.
* They can change the intensity.
__Note__: These three states cannot be modified if a trajectory does not have a referrer assigned.
Likewise a referrer cannot be removed from a confidential trajectory.
### External partners
A trajectory is setup to provide support to one or more concerned persons. Naturally, there may also be one or more thirdparties or persons involved to offer this support. These partners can be added in this section by searching for their name.
When a partner does not yet exist they can be created from within the search modal by pressing the button **<create 'your-search-name'>**.
<!-- ## Trajectory history
<!-- /fr/parcours/{id}/history
TODO -->
## Social support actions
<!-- /fr/person/accompanying-period/{id}/work -->
When a trajectory is confirmed (i.e., it is in the state "Confirmed"), it is possible to add social actions to this trajectory. These are the actions that are taken to realize the support. Please read the documentation about [social actions](/user/English/social_actions.md) for in detail information.
## Comments
<!-- /fr/parcours/{id}/comments -->
Comments can be added to a trajectory to notify co-workers of additional information for which there may not be a designated section. A comment can be **pinned** to the trajectory dashboard by clicking on the flag icon.
__note__: Only one comment can be pinned to the dashboard, but all comments will remain available within the comment section to view,modify, re-pin, or delete.
## Tasks
<!-- /fr/task/single-task/by-course/{id} -->
Just as within the person module, tasks can be created and assigned within a trajectory. Please read the documentation about [tasks](/user/English/tasks.md) for in detail information.
## Documents
<!-- /fr/parcours/{id}/documents -->
Just as within the person module, documents can be attached to a trajectory. The only difference here is that a trajectory document can also be generated from a template. This template can be selected from the dropdown menu.
Please read the documentation about [documents](/user/English/documents.md) for in detail information.
## Close a trajectory
<!-- /fr/parcours/{id}/close -->
At any time a trajectory can be closed by clicking on the sidebar menu entry **<close trajectory'>**.
You will be taken to a small form in which you can specify the date of closure and the reason.
## Re-open a trajectory
When a trajectory is closed the menu will adapt itself to offer the user the possibility to re-open it. No further actions are required after clicking this button.

43
user/docs/English/tasks.md Normal file
View File

@@ -0,0 +1,43 @@
/newpage
# Tasks
## Listing page
<!-- /fr/task/single-task/by-course/{id} -->
Clicking on the <**task**> menu entry in the person or trajectory side-menu will bring you to the listing page.
Here you have an overview of all tasks related to this particular person or trajectory.
At the top of the list you find a searchbar and several filtering options,
* Future tasks or tasks without due date
* Tasks that are almost due
* Tasks with a passed due date
* New tasks
* Tasks that are in progress
* Closed tasks
* Removed tasks
Listed tasks are displayed with their title, a badge identifying the state in which the task can be found (new, in progress, closed,...) and their starting date, date on which a reminder will be sent and their due date. Your task reminders can be found on the homepage widget, or displayed in your user menu.
A separate user menu entry will take you directly to a listing page of all your tasks that have surpassed their due date and have not been closed. This menu entry is easily identifiable by the exclamation mark triangle (!).
## Creating a new task
<!-- /fr/task/single-task/new -->
![Creation task](/user/img/new_task.png)
To create a new task you will be given a form to fill in.
The fields are self-explanatory but do note that only the title is required.
## Detail page
<!-- /fr/task/single-task/{id}/show -->
You can view the task in more detail by clicking on the **eye** icon button. On the detail page you will see the description of the task, but also the task history. The history gives you an overview of state changes and who undertook them on which day. This allows users to easily keep track of tasks.
Within the detail page, as well as in the listing page you have the ability to navigate to an edit page where you can modify the task. A task can also be deleted and it's current state can be changed using the dropdown button <**change state**>.

59
user/docs/English/thirdparty.md Normal file
View File

@@ -0,0 +1,59 @@
/newpage
# Thirdparty
Within the context of social support you will most likely work together with plenty of professional external partners.
Chill allows you to easily link them to a user and their social support trajectory, giving you a complete overview of each partner involved.
All thirdparty information can be consulted by going to the section menu in the top-right corner and selecting **thirdparties**.
At the top of the list a searchbar allows you to easily find the thirdparty you are looking for on the basis of their name.
## Create a thirdparty
At the bottom of the page you will find the button to create a new thirdparty.
In doing so you will see a distinction being made between creating a thirdparty as a **legal entity** or a **natural person**.
Choose 'legal entity' if you want to add a thirdparty that is, for example, a doctor's practice or an organization.
A 'natural person' would be any professional person that you would like to add as a thirdparty, eg. a psychologist.
It is important to note that within a **legal entity** you can add **contacts**.
These are most likely individual professionals working within the organization or associated with it.
----------
### Legal entity
![Legal entity](/user/img/thirdparty_morale.png)
Creating a **legal entity** takes you to a form which you can complete with the following information.
* **Name**
* **Acronym** (eg. CPAS)
* **Service/department**: you can target a specific department or service within the larger entity (eg. elderly support).
* **Contact information** (phonenumber, email)
* **Address**:
Aside from adding a complete address there are two options to take into account.
> **Incomplete address**: In choosing to enter an incomplete address you will only specify a general location (town or city).
> **Confidential**: The address can be identified as confidential. (eg. the address of a safehouse should not be readily viewable. It will be blurred in overview pages and you will have the option to reveal it.)
* **Contacts**: Contacts are natural persons associated with the legal entity. You can specify their title and role within the entity and add their contact information. As with the address above there is an option to make it a confidential contact. Their information will thus be blurred throughout the application and can be revealed when needed. Each contact can be deleted individually and these changes will be saved when saving the entire entity.
![Thirdparty contact](/user/img/thirdparty_contact.png)
* **Comment**
* **Active/inactive**: a thirdparty can be set to inactive (eg. they are no longer operational).
---------
### Natural person
A natural person is a thirdparty that stands on it's own. Although a thirdparty contact is in fact also a natural person, they are two distinct entities in Chill.
Within the form the following can be specified,
* **Civil title** (eg. Mrs., Mayor, ...)
* **Name**
* **Professional role** (eg. secretary, nurse)
* **Support category**: the category under which their services fall.
* **Contact information**: phonenumer, email, address. Contact information can be identified as confidential.
* **Comment**
* **Active/Inactive**

3
user/docs/English/workflow.md Normal file
View File

@@ -0,0 +1,3 @@
/newpage
TODO translate from french