doc/description_interface.rst
author ymh <ymh.work@gmail.com>
Mon, 02 Dec 2013 18:17:21 +0100
changeset 158 03fea67e18e9
parent 156 894a01c6a2b2
permissions -rw-r--r--
correction orthographiques
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
158
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
    10
Connexion
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
    11
=========
121
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.
158
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
    17
Ce dialogue de connexion s'affiche lorsque l'utilisateur essaye d'accéder à une des pages de l'application et qu'il n'est pas connecté.
137
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
158
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
    27
Cet écran donne la liste des notices et permet la recherche.
156
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    28
La recherche se fait sur l'identifiant d'une notice, le(s) titre(s) d'une notice et les auteurs (personnes ou institutions).
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    29
156
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    30
Les notices sont affichées dans l'ordre de leur identifiant (tri lexicographique ascendant) lorsque qu'aucune recherche n'est faite. Elles sont triées par tri de pertinence lorsqu'une recherche a été effectuée.
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    31
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    32
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
    33
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
    34
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
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
    37
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
    38
  
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    39
    * identifiant
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    40
    * titres (dans toutes les langues)
156
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    41
    * auteurs (personnes et entités)
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    42
158
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
    43
Le champ de recherche permet l'utilisation d'un mini langage de requête décrit à l'adresse suivante : http://pythonhosted.org/Whoosh/querylang.html
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
    44
Les points à noter à ce sujet sont :
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    45
  
156
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    46
    * La recherche ne tient pas compte des accents
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    47
    * L'opérateur par défaut est le ``OR``.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    48
    * 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
    49
156
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    50
Opérateurs de recherche : AND, OR, NOT
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    51
--------------------------------------
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    52
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    53
    * Les opérateurs de recherche AND, OR et NOT doivent s'écrire en majuscules.
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    54
    * ``032221`` cherche ``032221`` dans les titres et les auteurs et les identifiants.
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    55
    * ``032221 021099`` trouvera les deux notices avec ces deux identifiants.
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    56
    * ``language education`` cherche les mots ``language`` OU ``education`` dans les titres et les auteurs et les identifiants.
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    57
    * ``language AND education`` cherche les mots ``language`` ET ``education`` dans les titres et les auteurs et les identifiants.
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    58
    * ``language NOT education`` cherche le mot ``language`` SANS le mot ``education`` dans les titres et les auteurs et les identifiants.
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    59
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    60
Guillemets
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    61
----------
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    62
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    63
    * On peut mettre entre guillemets deux ou plusieurs termes pour chercher exactement sur cette expression
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    64
    * ``"school factors"`` cherche exactement l'expression "school factors" (et non pas "school OR factor", ni "school AND factor")
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    65
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    66
Parenthèses
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    67
-----------
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    68
 
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    69
    * ``(language AND education) OR maternelle`` cherche les notices contenant soit les mots ``language`` ET ``education``, soit le mot ``maternelle``
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    70
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    71
Troncature et joker ('*' et '?')
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    72
--------------------------------
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    73
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    74
    * le caractère ``*`` remplace n'importe quel nombre de lettres à la fin d'un terme. Le caractère ``?`` remplace un caractère et un seul, à la fin ou au milieu d'un terme de recherche.
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    75
    * ``lang*`` cherche tous les mots qui commencent par "lang" (language, langage, langagier, etc.)
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    76
    * ``l?ng`` trouvera à la fois "lang" et "long"
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    77
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    78
Champs de recherche
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    79
-------------------
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    80
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    81
    * ``titles:education`` cherche ``education`` uniquement dans les titres
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    82
    * ``authors:caillods`` cherche ``caillods`` uniquement dans les auteurs
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    83
    * ``years:2005`` cherche toutes les notices dont l'année est 2005 (ne cherche pas 2005 dans le titre)
894a01c6a2b2 merge pull request
ymh <ymh.work@gmail.com>
parents: 146
diff changeset
    84
    * ``education AND years:2005`` cherche ``education`` pour toutes les notices dont la date est 2005
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    85
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    86
.. _interface-detail:
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    87
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    88
Visionnage d'une notice
121
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
    89
=======================
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
    90
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    91
.. image:: _static/p4l_detail.png
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    92
    :width: 600pt
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    93
158
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
    94
Cet écran donne accès à l'affichage du détail d'une notice. Deux boutons permettent soit de passer à l'écran d'édition de la notice, soit de pouvoir l'effacer.
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    95
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
    96
Par contre, tout effacement d'une notice est définitif.
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    97
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    98
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
    99
.. _interface-edit:
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
   100
121
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
   101
Édition d'une notice
0d2a35462576 Add doc
ymh <ymh.work@gmail.com>
parents:
diff changeset
   102
====================
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
   103
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
   104
.. image:: _static/p4l_edit.png
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
   105
    :width: 600pt
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
   106
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
   107
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
   108
Un bouton d'annulation permet d'interrompre l'édition d'une fiche à tout moment.
158
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
   109
Les modifications d'une fiche (ou bien sa création) ne seront sauvegardées seulement après avoir appuyer sur le bouton de sauvegarde.
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
   110
158
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
   111
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 fonctionnalités du navigateur annulera sans prévenir l'édition en cours.
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
   112
Tous les changements non sauvegardés seront perdus.
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
   113
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
   114
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
   115
158
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
   116
Deux boutons sont disponibles pour accéder au détail de la notice ou bien à son effacement. Dans ce dernier cas un dialogue de confirmation sera affiché avant l'effacement définitif de la notice.
137
bb8bf2688d7e - Finish and correct documentation
ymh <ymh.work@gmail.com>
parents: 121
diff changeset
   117
158
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
   118
03fea67e18e9 correction orthographiques
ymh <ymh.work@gmail.com>
parents: 156
diff changeset
   119