diff options
author | Étienne Loks <etienne.loks@iggdrasil.net> | 2024-06-20 16:52:21 +0200 |
---|---|---|
committer | Étienne Loks <etienne.loks@iggdrasil.net> | 2024-06-21 14:31:39 +0200 |
commit | 8793d61e0f01090a83d745fc504066880d86da41 (patch) | |
tree | 520af7dd6146f330751dbd7f7c0e59281472ba70 /docs | |
parent | 67067a34f520f8f0c850df84f014a94359ae197b (diff) | |
download | Ishtar-8793d61e0f01090a83d745fc504066880d86da41.tar.bz2 Ishtar-8793d61e0f01090a83d745fc504066880d86da41.zip |
📝 update documentation: searches
Diffstat (limited to 'docs')
-rw-r--r-- | docs/fr/source/_static/icon-bookmark.png | bin | 0 -> 773 bytes | |||
-rw-r--r-- | docs/fr/source/_static/icon-cog.png | bin | 0 -> 1012 bytes | |||
-rw-r--r-- | docs/fr/source/_static/icon-cross.png | bin | 0 -> 915 bytes | |||
-rw-r--r-- | docs/fr/source/_static/icon-magnifying-glass.png | bin | 0 -> 962 bytes | |||
-rw-r--r-- | docs/fr/source/_static/icon-pin.png | bin | 0 -> 879 bytes | |||
-rw-r--r-- | docs/fr/source/_static/icon-star.png | bin | 0 -> 966 bytes | |||
-rw-r--r-- | docs/fr/source/index.rst | 1 | ||||
-rw-r--r-- | docs/fr/source/interface-utilisateur.rst | 56 |
8 files changed, 41 insertions, 16 deletions
diff --git a/docs/fr/source/_static/icon-bookmark.png b/docs/fr/source/_static/icon-bookmark.png Binary files differnew file mode 100644 index 000000000..a62f93509 --- /dev/null +++ b/docs/fr/source/_static/icon-bookmark.png diff --git a/docs/fr/source/_static/icon-cog.png b/docs/fr/source/_static/icon-cog.png Binary files differnew file mode 100644 index 000000000..20ebf641e --- /dev/null +++ b/docs/fr/source/_static/icon-cog.png diff --git a/docs/fr/source/_static/icon-cross.png b/docs/fr/source/_static/icon-cross.png Binary files differnew file mode 100644 index 000000000..7653e3f74 --- /dev/null +++ b/docs/fr/source/_static/icon-cross.png diff --git a/docs/fr/source/_static/icon-magnifying-glass.png b/docs/fr/source/_static/icon-magnifying-glass.png Binary files differnew file mode 100644 index 000000000..5537988fe --- /dev/null +++ b/docs/fr/source/_static/icon-magnifying-glass.png diff --git a/docs/fr/source/_static/icon-pin.png b/docs/fr/source/_static/icon-pin.png Binary files differnew file mode 100644 index 000000000..19dbfc4f9 --- /dev/null +++ b/docs/fr/source/_static/icon-pin.png diff --git a/docs/fr/source/_static/icon-star.png b/docs/fr/source/_static/icon-star.png Binary files differnew file mode 100644 index 000000000..aaa1c33c7 --- /dev/null +++ b/docs/fr/source/_static/icon-star.png diff --git a/docs/fr/source/index.rst b/docs/fr/source/index.rst index 064427c30..917424f4e 100644 --- a/docs/fr/source/index.rst +++ b/docs/fr/source/index.rst @@ -39,6 +39,7 @@ Ces annexes sont à destination des utilisateurs ou des administrateurs applicat annexe-2-permission-action annexe-3-ex-flux-ope annexe-4-doc-normes + annexe-5-module-operateur-preventif Annexes techniques ------------------ diff --git a/docs/fr/source/interface-utilisateur.rst b/docs/fr/source/interface-utilisateur.rst index 30b0fe9f8..9cb787503 100644 --- a/docs/fr/source/interface-utilisateur.rst +++ b/docs/fr/source/interface-utilisateur.rst @@ -68,24 +68,31 @@ Zone de recherche La zone de recherche comporte une barre de recherche et un tableau de résultat. -Recherche textuelle et par critères ------------------------------------ +Barre de recherche +------------------ La barre de recherche est composée d'une zone de saisie et d'une série d'icônes d'outils de recherche. Dans l'ordre ces icônes permettent de : -- icône « loupe » : lancer la recherche, -- icône « roue crantée » : accéder à la recherche par critère, -- icône « croix » : vider la zone de recherche, -- icône « épingle » : épingler la recherche actuelle pour qu'elle devienne la recherche par défaut pour cette session, -- icône « étoile » : enregistrer une alerte, un marque-page, -- icône « marque-page » : accéder aux marques-pages (les supprimer). +.. |magnifying-glass| image:: _static/icon-magnifying-glass.png +.. |cog| image:: _static/icon-cog.png +.. |cross| image:: _static/icon-cross.png +.. |pin| image:: _static/icon-pin.png +.. |star| image:: _static/icon-star.png +.. |bookmark| image:: _static/icon-bookmark.png + +- |magnifying-glass| lancer la recherche, +- |cog| accéder à la recherche par critère, +- |cross| vider la zone de recherche, +- |pin| épingler la recherche actuelle pour qu'elle devienne la recherche par défaut pour cette session, +- |star| enregistrer une alerte, un marque-page, +- |bookmark| accéder aux marques-pages (les supprimer). Lorsque aucune recherche n'est active par défaut et que la zone de saisie est vide tous les éléments de la base de données sont listés. La zone de recherche permet deux types de recherches distinctes : une recherche libre (sur l'ensemble des champs indexés) et une recherche par critère (champ par champ, pour l'ensemble des champs de la base). Recherche libre -+++++++++++++++ +--------------- Chaque élément de la base de données est indexé afin de pouvoir permettre ce type de recherche de manière performante. Les propriétés et descriptions rattachées aux éléments sont indexées. De même chaque élément parent est compris dans l'index de l'élément enfant. @@ -108,28 +115,45 @@ Adjoindre plusieurs termes correspond à faire une recherche avec l'opérateur l **Exemple** : une recherche avec le terme « ``amphore dressel 1B`` » retournera tous les éléments concernant des amphores Dressel de type 1B. -.. - TODO: Une recherche avec l'opérateur OU... pour l'instant cette recherche pose trop de problèmes - Préfixer un terme par un « moins » : « ``-`` » permet d'exclure des termes de notre recherche. **Exemple** : une recherche avec « ``ancre -amphore`` » permet d'obtenir la liste des ancres en excluant les lots de mobilier comprenant des amphores. +.. + TODO: Une recherche avec l'opérateur OU... pour l'instant cette recherche pose trop de problèmes + Recherche par critère -+++++++++++++++++++++ +--------------------- -En cliquant sur l'icône « roue crantée », on accède à un formulaire permettant de construire simplement sa recherche par critère. Le formulaire de construction de requête dépend bien entendu du type d'élément recherché. Par ailleurs comme les autres formulaires celui-ci peut avoir été personnalisé sur votre installation Ishtar, permettant de cacher l'affichage de certains champs inutiles ou d'ajouter d'autres champs personnalisés. +En cliquant sur l'icône |cog|, on accède à un formulaire permettant de construire simplement sa recherche par critère. Le formulaire de construction de requête dépend bien entendu du type d'élément recherché. Par ailleurs comme les autres formulaires celui-ci peut avoir été personnalisé sur votre installation Ishtar, permettant de cacher l'affichage de certains champs inutiles ou d'ajouter d'autres champs personnalisés. Après sélection d'une ou plusieurs contraintes dans le formulaire, en cliquant sur Ajouter, on les ajoute de manière textuelle sous la forme : « ``attribut="valeur"`` ». Cette forme permet de facilement retoucher une requête de manière textuelle sans passer par le formulaire. **Exemple** : « ``annee="2018"`` » recherchera les éléments de l'année 2018. -.. note:: Dans la recherche par critère, le moteur recherche exactement la valeur entrée. Si l'on souhaite faire une recherche ouverte du type « contient la valeur », il faut ajouter un astérisque ``*`` à la valeur. +.. warning:: Contrairement à la recherche libre, la juxtaposition des termes concernant un même attribut est comprise comme un opérateur *OU*. Ainsi « ``annee="2018" annee="2017"`` » listera les éléments de l'année 2017 ou 2018. Néanmoins pour les attributs différents, cela reste à comprendre comme un opérateur *ET*. Ainsi « ``annee="2018" annee="2017" type-objet="Ancre et corps-mort"`` » listera le mobilier avec un type d'objet « Ancre et corps-mort » et rattaché à une des années 2017 ou 2018. + +Recherche ouverte ++++++++++++++++++ + +Dans la recherche par critère, le moteur recherche exactement la valeur entrée. Si l'on souhaite faire une recherche ouverte du type « contient la valeur », il faut ajouter un astérisque * à la valeur. **Exemple** : « ``denomination="éclat"`` » retournera uniquement les éléments dont la dénomination est exactement Éclat, tandis que « ``denomination="éclat*"`` » renverra tous les éléments dont la dénomination contient le mot éclat, donc par exemple Lots d'éclats, éclat retouché, etc. De la même manière pour les nombres, « ``patriarche="1012"`` » donnera uniquement l'OA1012, alors que ``patriarche="1012*"`` renverra toutes les OA contenant les chiffres 1012, donc par exemple 101201 ou 1010125. -.. warning:: Contrairement à la recherche libre, la juxtaposition des termes concernant un même attribut est comprise comme un opérateur *OU*. Ainsi « ``annee="2018" annee="2017"`` » listera les éléments de l'année 2017 ou 2018. Néanmoins pour les attributs différents, cela reste à comprendre comme un opérateur *ET*. Ainsi « ``annee="2018" annee="2017" type-objet="Ancre et corps-mort"`` » listera le mobilier avec un type d'objet « Ancre et corps-mort » et rattaché à une des années 2017 ou 2018. +Exclusion ++++++++++ + +Pour exclure des éléments de la recherche, ajouter le critère depuis le formulaire puis préfixer le critère par « - ». + +**Exemple** : la recherche « ``-materiau="métal"`` » excluera de la recherche tous le mobilier métallique. + +Plus grand que, plus petit que, avant, après +++++++++++++++++++++++++++++++++++++++++++++ + +Pour des recherches de type plus grand, plus petit (pour les champs de type numérique), avant, après (pour les champs de type date), ajouter le critère depuis le formulaire puis modifier le signe « ``=`` » en « ``=>`` » ou « ``=<`` » selon le résultat souhaité. + +**Exemple** : la recherche « ``annee=>"2019"`` » permet d'obtenir tous les éléments de 2019 et après. .. _bookmarks: |