This repository has been archived on 2023-11-03. You can view files and clone it, but cannot push or open issues or pull requests.
GINPA/DocUtilisateur/Doc_utilisateur.md

215 lines
10 KiB
Markdown

#GINPA
###Documentation utilisateur
####Sommaire
1. [Objectif](#objectif)
2. [Prérequis](#prerequis)
3. [Choix du/des fichier(s)](#file)
4. [Mode global](#mode_global)
1. [Quitter](#quitter)
2. [Menu](#menu)
3. [Vue précédente & suivante](#vue_pre_sui)
4. [Zoom](#zoom)
5. [Vue de la carte](#vue)
6. [Sélection & désélection d'une zone à supprimer](#selec_deselec)
7. [Prévisualitation](#prevu)
8. [Sauvegarde](#sauvegarde)
9. [Recentrage](#recentrage)
10. [Afficher / masquer points d'intérêts](#affiche_masque)
11. [Afficher / masquer routes](#affiche_masque_route)
5. [Mode point par point](#mode_pbp)
1. [Mode automatique](#automatique)
1. [Lecture / Pause](#lecture_pause)
2. [Changement de mode](#changement_mode)
3. [Redémarrer affichage](#redémarrer_affichage)
4. [Effacer les points](#effacer_points)
2. [Mode manuel](#manuel)
1. [Point suivant](#next)
---
####1. Objectif<a id="objectif"></a>
L'objectif de ce logiciel (GINPA Is Not a Position Analyst) est de pouvoir analyser l'ensemble des déplacements d'une population pour déterminer quelles sont ses points d'intérêts.
Etant conçu dans une optique de respect de la vie privée, il est possible de manipuler graphiquement un fichier de logs afin de supprimer aisément son lieu d'habitation par exemple, ou d'autres points d'intérêts identifiés par GINPA.
Ce document a pour objectif de fournir à l'utilisateur de GINPA l'aide nécessaire pour naviguer entre les différentes fonctionnalités du programme.
---
####2. Prérequis<a id="prerequis"></a>
Les cartes s'adaptants dynamiquements aux fichiers de logs, l'utilisation de GINPA nécessite une connexion internet.
**Attention** : N'essayez pas de quitter le logiciel quand le symbole ![loading.png](./images_doc_utilisateur/loading.png "Icône loading") est affiché !
---
####3. Choix du/des fichier(s)<a id="file"></a>
![folder.png](./images_doc_utilisateur/folder.png "Icône file")
Ce bouton sera présent sur la première page d'accueil de GINPA.
Si vous cliquez dessus, 2 choix s'offre à vous :
- Choisir un seul fichier. Dans ce cas, vous retomberez sur la page d'accueil, avec en plus le nom du fichier selectionné. Vous pourrez alors aller dans le mode que vous désirez, ou selectionner un autre fichier à la place du précédent.
- Choisir plusieurs fichiers, à l'aide de CTRL+clique gauche. Cette fois ci, vous serez directement dirigé vers un mode global n'affichant que les points d'intérêts.
Si vous essayez de rentrer dans un mode sans avoir préalablement séléctionné un fichier, GINPA vous demandera d'en choisir un.
####4. Mode global<a id="mode_global"></a>
![global.png](./images_doc_utilisateur/global.png "Icône mode global")
Le mode global permet une visualisation graphique du fichier de log choisi. Les points d'intérêt sont bleus et leur taille change en fonction de leur importance (l'utilisateur est-il resté un long moment ou non ?).
Dans ce mode, plusieurs fonctionnalité permettent de naviguer ou de supprimer facilerment des ensembles de points.
Lors de la sélection d'un outil, celui-ci apparaitra en rouge pour signaler son utilisation.
![zoom.png](./images_doc_utilisateur/zoom.png "Icône zoom") ![zoomActivated.png](./images_doc_utilisateur/zoom_activated.png "Icône zoom activé")
Les outils qui ne seront pas disponible apparaîtront en blanc.
#####4.1. Quitter<a id="quitter"></a>
![exit.png](./images_doc_utilisateur/exit.png "Icône exit")
Quitte le programme. Une confirmation sera demandée. Tous les changements non sauvegardés seront perdus.
#####4.2. Menu<a id="menu"></a>
![menu.png](./images_doc_utilisateur/menu.png "Icône menu")
Retour au menu principal. Une confirmation sera demandée. Tous les changements non sauvegardés seront perdus.
#####4.3. Vue précédente & suivante<a id="vue_pre_sui"></a>
![vuePrecedente.png](./images_doc_utilisateur/vuePrecedente.png "Icône vue précédente") ![vueSuivante.png](./images_doc_utilisateur/vueSuivante.png "Icône vue suivante")
Permet de revenir à la vue précédente / suivante. Si un zoom est utilisé, la pile des vues suivantes est réinitialisée.
#####4.4. Zoom<a id="zoom"></a>
![zoom.png](./images_doc_utilisateur/zoom.png "Icône zoom")
Permet de grossir une zone particulière de la carte.
*Remarque : il est possible d'utiliser le zoom avec la molette de la souris.*
#####4.5. Vue de la carte<a id="vue"></a>
![vue.png](./images_doc_utilisateur/vue.png "Icône vue")
GINPA propose de changer le mode de vue de la carte. Plusieurs sont disponibles et accessibles via le même bouton. Les vues disponibles sont :
- Roadmap
- Satellite
- Terrain
- Hybride
#####4.6. Sélection et désélection d'une zone à supprimer<a id="selec_deselec"></a>
![select.png](./images_doc_utilisateur/select.png "Icône select") ![deselect.png](./images_doc_utilisateur/deselect.png "Icône deselect")
Lorsque la première icône est activé, il est possible pour l'utilisateur de selectionner une zone. Les points à l'intérieur de cette zone seront à supprimer. Si un agglomérat est sélectionné, les routes liées à celui-ci deviendront roses. Il est possible de voir le résultat que cela donnera si on supprime les points sélectionnés et/ou suggérés grâce aux [modes de prévisualisations](#prevu).
Dans une optique de confort de l'utilisateur, GINPA propose plusieurs façons de sélectionner des structures de points :
- Le clique simple : que ce soit sur un agglomérat ou un point isolé, un simple clique le sélectionnera pour la suppression.
- L'alt+clique : la combinaison alt+clique sur un point appartenant à une route permettra de sélectionner la totalité de la route.
- Le clique appuyé : pour sélectionner une zone **circulaire** dont le centre sera le pointeur de votre souris, laissez simplement le clique appuyé et étirez le rayon du cercle.
- Le ctrl+clique appuyé : même chose que pour le clique appuyé mais pour une zone de sélection **rectangulaire**
Si la deuxième icône est activé, il est possible de retirer des points précédemment séléctionnés, de la même manière.
#####4.7. Prévisualisation<a id="prevu"></a>
![prevu.png](./images_doc_utilisateur/prevu.png "Icône prévisualisation")
La prévisualisation permet d'avoir une idée du rendu final une fois les points ou les agglomérats supprimés. Il existe deux modes de prévisualisation :
- Prévisualisation directe
![prevu1.png](./images_doc_utilisateur/prevu1.png "Icône prévisualisation directe")
La prévisualisation directe donne le rendu final en supprimant uniquement les points sélectionnés par l'utilisateur (indiqués en noir).
- Prévisualisation suggérée
![prevu2.png](./images_doc_utilisateur/prevu2.png "Icône prévisualisation suggérée")
La prévisualisation suggérée donne le rendu final en supprimant les points sélectionnés par l'utilisateur ET ceux suggérés par GINPA (indiqués en rose). L'exemple le plus typique est la suppression d'un point d'intérêt par l'utilisateur : GINPA suggérera alors aussi d'effacer toutes les routes menants à ce point d'intérêt.
#####4.8. Sauvegarde<a id="sauvegarde"></a>
![sauvegarde.png](./images_doc_utilisateur/sauvegarde.png "Icône sauvegarde")
La sauvegarde des logs modifiés s'effectue très simplement. Mettez-vous simplement dans le [mode de prévisualisation](#prevu) désiré et cliquez sur le bouton de sauvegarde. Une fenêtre vous demandera alors le nom du nouveau fichier à générer ainsi que son emplacement.
*Remarque : Le bouton de sauvegarde est désactivé en mode 'normal' (sa couleur est blanche). Veillez à bien être dans le mode de prévisualisation souhaité afin d'enregistrer vos modifications.*
#####4.9. Recentrage<a id="recentrage"></a>
![recentrage.png](./images_doc_utilisateur/recentrage.png "Icône recentrage")
Revient au zoom initial, englobant la totalité des logs du fichier.
#####4.10 Afficher / masquer points d'intérêts<a id="affiche_masque"></a>
![affiche.png](./images_doc_utilisateur/affiche.png "Icône affiche / masque points d'intérêts")
Affiche / masque les points d'intérêts.
#####4.11 Afficher / masquer routes<a id="affiche_masque_route"></a>
![roads.png](./images_doc_utilisateur/road-perspective-of-curves.png "Icône affiche/masque routes")
Affiche/masque les routes.
---
####5 Mode point par point<a id="mode_pbp"></a>
![pbp.png](./images_doc_utilisateur/pbp.png "Icône mode pbp")
Le mode point par point permet de retracer le parcours d'un utilisateur. Il affiche successivement les points empruntés par celui-ci, en affichant aussi les points d'intérêts.
2 modes sont disponibles en affichage point par point. À la fin de ces 2 modes, on retombe sur l'affichage global avec les mêmes fonctionnalités, et une supplémentaire.
#####5.1 Mode automatique<a id="automatique"></a>
![pbp_auto](./images_doc_utilisateur/pbp_auto.png "Icône pbp automatique")
Durant le mode point par point automatique, l'affichage se fait de manière autonome. Il débute en pause.
######5.1.1 Lecture / Pause<a id="lecture_pause"></a>
![display.png](./images_doc_utilisateur/display.png "Icône play")![pause.png](./images_doc_utilisateur/pause.png "Icône pause")
Lorsqu'on clique sur l'icone de lecture, elle se transforme en icone "pause" et inversement.
######5.1.2 Changement de mode<a id="changement_mode"></a>
![swapMode.png](./images_doc_utilisateur/worldwide.png "Icône swapMode")
Arrête l'affichage, et passe en mode global.
######5.1.3 Redémarrer affichage<a id="redémarrer_affichage"></a>
![reset.png](./images_doc_utilisateur/reset.png "Icône redémarrer")
Permet de recommencer du début l'affichage.
######5.1.3 Effacer les points<a id="effacer_points"></a>
![eraser.png](./images_doc_utilisateur/eraser.png "Icône effacer")
Efface les points précédemment affichés.
L'utilisateur peut reprendre la lecture où il s'est arrété.
#####5.2 Mode manuel<a id="manuel"></a>
![pbp_manuel.png](./images_doc_utilisateur/pbp_manuel.png "Icône pbp manuel")
Durant le mode point par point manuel, l'utilisateur doit rester appuyé sur un bouton pour que l'affichage progresse.
######5.2.1 Point suivant<a id="next"></a>
![point_suivant.png](./images_doc_utilisateur/point_suivant.png "Icône point suivant")
Tant que l'utilisateur reste appuyé sur le bouton, l'affichage continu.