doc/description_interface.rst
author ymh <ymh.work@gmail.com>
Tue, 26 Nov 2013 23:53:33 +0100
changeset 153 50f01260eef4
parent 146 3d20cdc9be3d
child 156 894a01c6a2b2
permissions -rw-r--r--
Correction on admin script configuration. make sure that args is used instead of command eveywhere.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
121
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
**************************
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
Description de l'interface
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
**************************
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
     5
L'application est constituée de 4 écrans.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
     6
Ces écrans sont des pages html5.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
     7
Ces pages utilisent le framework css Bootstrap (http://getbootstrap.com/).
121
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
     9
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    10
Connection
121
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
==========
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    13
.. image:: _static/p4l_connect.png
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    14
    :width: 600pt
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    15
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    16
Toutes les pages de l'application sont protégées par un système de login/mot de passe.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    17
Ce dialogue de connection s'affiche lorsque l'utilisateur essaye d'accéder à une des pages de l'application et qu'il n'est pas connecté.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    18
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    19
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    20
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    21
Liste des notices
121
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
=================
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    24
.. image:: _static/p4l_list.png
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    25
    :width: 600pt
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    26
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    27
Cet écram donne la liste des notices et permet la recherche.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    28
La recherche se fait sur l'identifiant d'une notice, le(s) titre(s) d'une notice et les autheurs (personnes ou institutions).
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    29
146
3d20cdc9be3d Change notice list order on a search to the order returned by the indexation engine. Fix #5 (https://github.com/IRI-Research/plan4learning/issues/5)
ymh <ymh.work@gmail.com>
parents: 137
diff changeset
    30
Sans recherche, les notices sont affichées dans l'ordre de leur identifiant (tri lexicographique ascendant).
3d20cdc9be3d Change notice list order on a search to the order returned by the indexation engine. Fix #5 (https://github.com/IRI-Research/plan4learning/issues/5)
ymh <ymh.work@gmail.com>
parents: 137
diff changeset
    31
Par contre lorsque'une recherche à été lancée, les notices sont affichées dans l'ordre retourné par le moteur d'indexation.
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    32
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    33
En haut de la liste un bouton permet l'ouverture du dialogue de création d'une nouvelle notice.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    34
Pour chaque notice de la liste 2 boutons sont proposés : vue de du détail de la liste ou bien édition. 
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    35
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    36
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    37
En haut de la page se trouve un champ de recherche permettant le filtrage des notices.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    38
C'est une recherche de type full-text qui porte sur les champs suivants des notices :
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    39
  
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    40
    * identifiant
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    41
    * titres (dans toutes les langues)
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    42
    * années de publication
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    43
    * autheurs (personnes et entités)
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    44
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    45
Le champ de recherche permet l'utilisation d'un mini language de requête décrit à l'adresse suivante : http://pythonhosted.org/Whoosh/querylang.html
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    46
Les points à noter à ce ce sujet sont :
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    47
  
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    48
    * L'opérateur par défaut est le ``OR``.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    49
    * la valeur du spécifieur ``field`` doit être dans la liste suivante : ``identifier``, ``titles``, ``years``, ``authors``.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    50
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    51
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    52
.. _interface-detail:
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    53
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    54
Visionnage d'une notice
121
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
=======================
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    57
.. image:: _static/p4l_detail.png
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    58
    :width: 600pt
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    59
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    60
Cet écran donne accès à l'affichage du deetail d'une notice. Deux boutons permettent soit de passer à l'écran d'édition de la notice, soit de pouvoir l'éfacer.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    61
Un dialogue de confirmation de l'effacement sera affiché préalablement à l'utilisateur.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    62
Par contre, tout effacement d'une notice est définitif.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    63
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    64
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    65
.. _interface-edit:
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    66
121
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
Édition d'une notice
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
====================
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    69
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    70
.. image:: _static/p4l_edit.png
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    71
    :width: 600pt
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    72
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    73
Cet écran permet l'édition d'une notice (nouvelle ou bien existante).
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    74
Un bouton d'annulation permet d'interrompre l'édition d'une fiche à tout moment.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    75
Les modifications d'une fiche (ou bien sa création) ne seront sauvegardées seulement après avoir appuyer sur le boouton de sauvegarde.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    76
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    77
Toute navigation hors de cet écran que ce soit en cliquant sur l'un des lien ou un des boutons de l'interface ou que ce soit en utilisant les fonctionalité du navigateur annulera sans prévenir l'édition en cours.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    78
Tout les changements non sauvegardés seront perdus.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    79
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    80
Tous les champs sont éditables, a part les champs "identifiant" et "URI" qui sont en lecture seule.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    81
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    82
Deux boutons sont disponibles pour accéder au deetail de la notice ou bien à son effacement. Dans ce dernier cas un dialogue de confirmation sera affiché anant l'effacement définitif de la notice.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    83
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    84