From b06520afb0a169425092985c6a7c6785944d3ee6 Mon Sep 17 00:00:00 2001 From: Emma Date: Thu, 6 Jun 2024 00:11:56 +0200 Subject: 📝 documentation: general update v4 + miscellaneous corrections MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/fr/source/_static/admin-profil.png | Bin 0 -> 62955 bytes docs/fr/source/_static/cartographie_operations.jpg | Bin 0 -> 87601 bytes docs/fr/source/_static/comptes.png | Bin 0 -> 24239 bytes docs/fr/source/_static/federation-profil.png | Bin 0 -> 25415 bytes docs/fr/source/_static/federation-recherche.png | Bin 0 -> 18841 bytes .../_static/formulaire-lieu-de-conservation.png | Bin 0 -> 34086 bytes docs/fr/source/_static/geo-affichage.jpg | Bin 0 -> 49894 bytes docs/fr/source/_static/geo-affichage.png | Bin 0 -> 169556 bytes docs/fr/source/_static/geo-diagramme.png | Bin 0 -> 73834 bytes docs/fr/source/_static/geo-fiche.png | Bin 0 -> 38850 bytes docs/fr/source/_static/geo-formulaire.jpg | Bin 0 -> 100171 bytes docs/fr/source/_static/geo-formulaire.png | Bin 0 -> 184056 bytes docs/fr/source/_static/geo-recherche.jpg | Bin 0 -> 66098 bytes docs/fr/source/_static/geo-recherche.png | Bin 0 -> 252945 bytes docs/fr/source/_static/groupement.jpg | Bin 0 -> 52902 bytes docs/fr/source/_static/iggdrasil.png | Bin 0 -> 125565 bytes docs/fr/source/_static/import-erreur.jpg | Bin 0 -> 46561 bytes docs/fr/source/_static/imports.png | Bin 0 -> 39905 bytes docs/fr/source/_static/parcelles-01.jpg | Bin 0 -> 42849 bytes docs/fr/source/_static/parcelles-02.jpg | Bin 0 -> 49944 bytes docs/fr/source/_static/preventif-admin-section.jpg | Bin 0 -> 38046 bytes docs/fr/source/_static/preventif-admin-section.png | Bin 0 -> 71839 bytes docs/fr/source/_static/preventif-admin.png | Bin 0 -> 40998 bytes .../fr/source/_static/preventif-utilisation-01.png | Bin 0 -> 15976 bytes .../fr/source/_static/preventif-utilisation-02.jpg | Bin 0 -> 68210 bytes .../fr/source/_static/preventif-utilisation-02.png | Bin 0 -> 96299 bytes .../fr/source/_static/preventif-utilisation-03.png | Bin 0 -> 55749 bytes .../fr/source/_static/preventif-utilisation-04.jpg | Bin 0 -> 79764 bytes .../fr/source/_static/preventif-utilisation-04.png | Bin 0 -> 112608 bytes docs/fr/source/_static/table-export.png | Bin 0 -> 31480 bytes docs/fr/source/administrateur-applicatif.rst | 70 +---- docs/fr/source/administrateur-serveur.rst | 5 +- docs/fr/source/annexe-2-permission-action.rst | 14 +- .../source/annexe-5-module-operateur-preventif.rst | 98 +++++++ docs/fr/source/annexe-tech-3-variables-gen.rst | 1 - docs/fr/source/annexe-tech-4-jinja-filters.rst | 1 - docs/fr/source/annexe-tech-5-formules.rst | 68 +++++ docs/fr/source/annexe-tech-5-manage-commands.rst | 45 ---- .../annexe-tech-6-configuration-syndication.rst | 233 ---------------- docs/fr/source/annexe-tech-6-manage-commands.rst | 44 +++ .../annexe-tech-7-configuration-syndication.rst | 235 ++++++++++++++++ docs/fr/source/fonctionnalites.rst | 142 ++++++++++ docs/fr/source/index.rst | 8 +- docs/fr/source/interface-utilisateur.rst | 275 +++++++++++++++++++ docs/fr/source/principes.rst | 133 ++++++--- docs/fr/source/utilisateur.rst | 296 --------------------- 46 files changed, 978 insertions(+), 690 deletions(-) create mode 100644 docs/fr/source/_static/admin-profil.png create mode 100644 docs/fr/source/_static/cartographie_operations.jpg create mode 100644 docs/fr/source/_static/comptes.png create mode 100644 docs/fr/source/_static/federation-profil.png create mode 100644 docs/fr/source/_static/federation-recherche.png create mode 100644 docs/fr/source/_static/formulaire-lieu-de-conservation.png create mode 100644 docs/fr/source/_static/geo-affichage.jpg create mode 100644 docs/fr/source/_static/geo-affichage.png create mode 100644 docs/fr/source/_static/geo-diagramme.png create mode 100644 docs/fr/source/_static/geo-fiche.png create mode 100644 docs/fr/source/_static/geo-formulaire.jpg create mode 100644 docs/fr/source/_static/geo-formulaire.png create mode 100644 docs/fr/source/_static/geo-recherche.jpg create mode 100644 docs/fr/source/_static/geo-recherche.png create mode 100644 docs/fr/source/_static/groupement.jpg create mode 100644 docs/fr/source/_static/iggdrasil.png create mode 100644 docs/fr/source/_static/import-erreur.jpg create mode 100644 docs/fr/source/_static/imports.png create mode 100644 docs/fr/source/_static/parcelles-01.jpg create mode 100644 docs/fr/source/_static/parcelles-02.jpg create mode 100644 docs/fr/source/_static/preventif-admin-section.jpg create mode 100644 docs/fr/source/_static/preventif-admin-section.png create mode 100644 docs/fr/source/_static/preventif-admin.png create mode 100644 docs/fr/source/_static/preventif-utilisation-01.png create mode 100644 docs/fr/source/_static/preventif-utilisation-02.jpg create mode 100644 docs/fr/source/_static/preventif-utilisation-02.png create mode 100644 docs/fr/source/_static/preventif-utilisation-03.png create mode 100644 docs/fr/source/_static/preventif-utilisation-04.jpg create mode 100644 docs/fr/source/_static/preventif-utilisation-04.png create mode 100644 docs/fr/source/_static/table-export.png create mode 100644 docs/fr/source/annexe-5-module-operateur-preventif.rst create mode 100644 docs/fr/source/annexe-tech-5-formules.rst delete mode 100644 docs/fr/source/annexe-tech-5-manage-commands.rst delete mode 100644 docs/fr/source/annexe-tech-6-configuration-syndication.rst create mode 100644 docs/fr/source/annexe-tech-6-manage-commands.rst create mode 100644 docs/fr/source/annexe-tech-7-configuration-syndication.rst create mode 100644 docs/fr/source/fonctionnalites.rst create mode 100644 docs/fr/source/interface-utilisateur.rst delete mode 100644 docs/fr/source/utilisateur.rst diff --git a/docs/fr/source/_static/admin-profil.png b/docs/fr/source/_static/admin-profil.png new file mode 100644 index 000000000..a85e1fb00 Binary files /dev/null and b/docs/fr/source/_static/admin-profil.png differ diff --git a/docs/fr/source/_static/cartographie_operations.jpg b/docs/fr/source/_static/cartographie_operations.jpg new file mode 100644 index 000000000..0e9e3d4d3 Binary files /dev/null and b/docs/fr/source/_static/cartographie_operations.jpg differ diff --git a/docs/fr/source/_static/comptes.png b/docs/fr/source/_static/comptes.png new file mode 100644 index 000000000..c1050f933 Binary files /dev/null and b/docs/fr/source/_static/comptes.png differ diff --git a/docs/fr/source/_static/federation-profil.png b/docs/fr/source/_static/federation-profil.png new file mode 100644 index 000000000..d599df951 Binary files /dev/null and b/docs/fr/source/_static/federation-profil.png differ diff --git a/docs/fr/source/_static/federation-recherche.png b/docs/fr/source/_static/federation-recherche.png new file mode 100644 index 000000000..13366ac33 Binary files /dev/null and b/docs/fr/source/_static/federation-recherche.png differ diff --git a/docs/fr/source/_static/formulaire-lieu-de-conservation.png b/docs/fr/source/_static/formulaire-lieu-de-conservation.png new file mode 100644 index 000000000..6a7b3ed18 Binary files /dev/null and b/docs/fr/source/_static/formulaire-lieu-de-conservation.png differ diff --git a/docs/fr/source/_static/geo-affichage.jpg b/docs/fr/source/_static/geo-affichage.jpg new file mode 100644 index 000000000..2e7fe1997 Binary files /dev/null and b/docs/fr/source/_static/geo-affichage.jpg differ diff --git a/docs/fr/source/_static/geo-affichage.png b/docs/fr/source/_static/geo-affichage.png new file mode 100644 index 000000000..90d205238 Binary files /dev/null and b/docs/fr/source/_static/geo-affichage.png differ diff --git a/docs/fr/source/_static/geo-diagramme.png b/docs/fr/source/_static/geo-diagramme.png new file mode 100644 index 000000000..dc80b8ea3 Binary files /dev/null and b/docs/fr/source/_static/geo-diagramme.png differ diff --git a/docs/fr/source/_static/geo-fiche.png b/docs/fr/source/_static/geo-fiche.png new file mode 100644 index 000000000..4fdf47c45 Binary files /dev/null and b/docs/fr/source/_static/geo-fiche.png differ diff --git a/docs/fr/source/_static/geo-formulaire.jpg b/docs/fr/source/_static/geo-formulaire.jpg new file mode 100644 index 000000000..c67a24bcf Binary files /dev/null and b/docs/fr/source/_static/geo-formulaire.jpg differ diff --git a/docs/fr/source/_static/geo-formulaire.png b/docs/fr/source/_static/geo-formulaire.png new file mode 100644 index 000000000..53eb17832 Binary files /dev/null and b/docs/fr/source/_static/geo-formulaire.png differ diff --git a/docs/fr/source/_static/geo-recherche.jpg b/docs/fr/source/_static/geo-recherche.jpg new file mode 100644 index 000000000..1f7ee6cd2 Binary files /dev/null and b/docs/fr/source/_static/geo-recherche.jpg differ diff --git a/docs/fr/source/_static/geo-recherche.png b/docs/fr/source/_static/geo-recherche.png new file mode 100644 index 000000000..601a5060c Binary files /dev/null and b/docs/fr/source/_static/geo-recherche.png differ diff --git a/docs/fr/source/_static/groupement.jpg b/docs/fr/source/_static/groupement.jpg new file mode 100644 index 000000000..c73414337 Binary files /dev/null and b/docs/fr/source/_static/groupement.jpg differ diff --git a/docs/fr/source/_static/iggdrasil.png b/docs/fr/source/_static/iggdrasil.png new file mode 100644 index 000000000..6605593fa Binary files /dev/null and b/docs/fr/source/_static/iggdrasil.png differ diff --git a/docs/fr/source/_static/import-erreur.jpg b/docs/fr/source/_static/import-erreur.jpg new file mode 100644 index 000000000..9e222c98b Binary files /dev/null and b/docs/fr/source/_static/import-erreur.jpg differ diff --git a/docs/fr/source/_static/imports.png b/docs/fr/source/_static/imports.png new file mode 100644 index 000000000..8b29104e2 Binary files /dev/null and b/docs/fr/source/_static/imports.png differ diff --git a/docs/fr/source/_static/parcelles-01.jpg b/docs/fr/source/_static/parcelles-01.jpg new file mode 100644 index 000000000..1fe7c7071 Binary files /dev/null and b/docs/fr/source/_static/parcelles-01.jpg differ diff --git a/docs/fr/source/_static/parcelles-02.jpg b/docs/fr/source/_static/parcelles-02.jpg new file mode 100644 index 000000000..7255a9305 Binary files /dev/null and b/docs/fr/source/_static/parcelles-02.jpg differ diff --git a/docs/fr/source/_static/preventif-admin-section.jpg b/docs/fr/source/_static/preventif-admin-section.jpg new file mode 100644 index 000000000..0572daec1 Binary files /dev/null and b/docs/fr/source/_static/preventif-admin-section.jpg differ diff --git a/docs/fr/source/_static/preventif-admin-section.png b/docs/fr/source/_static/preventif-admin-section.png new file mode 100644 index 000000000..b17fe00ac Binary files /dev/null and b/docs/fr/source/_static/preventif-admin-section.png differ diff --git a/docs/fr/source/_static/preventif-admin.png b/docs/fr/source/_static/preventif-admin.png new file mode 100644 index 000000000..719a1b3ae Binary files /dev/null and b/docs/fr/source/_static/preventif-admin.png differ diff --git a/docs/fr/source/_static/preventif-utilisation-01.png b/docs/fr/source/_static/preventif-utilisation-01.png new file mode 100644 index 000000000..50e77fcb9 Binary files /dev/null and b/docs/fr/source/_static/preventif-utilisation-01.png differ diff --git a/docs/fr/source/_static/preventif-utilisation-02.jpg b/docs/fr/source/_static/preventif-utilisation-02.jpg new file mode 100644 index 000000000..1b9644c77 Binary files /dev/null and b/docs/fr/source/_static/preventif-utilisation-02.jpg differ diff --git a/docs/fr/source/_static/preventif-utilisation-02.png b/docs/fr/source/_static/preventif-utilisation-02.png new file mode 100644 index 000000000..5bce9c7c0 Binary files /dev/null and b/docs/fr/source/_static/preventif-utilisation-02.png differ diff --git a/docs/fr/source/_static/preventif-utilisation-03.png b/docs/fr/source/_static/preventif-utilisation-03.png new file mode 100644 index 000000000..c59c47762 Binary files /dev/null and b/docs/fr/source/_static/preventif-utilisation-03.png differ diff --git a/docs/fr/source/_static/preventif-utilisation-04.jpg b/docs/fr/source/_static/preventif-utilisation-04.jpg new file mode 100644 index 000000000..6eff623a0 Binary files /dev/null and b/docs/fr/source/_static/preventif-utilisation-04.jpg differ diff --git a/docs/fr/source/_static/preventif-utilisation-04.png b/docs/fr/source/_static/preventif-utilisation-04.png new file mode 100644 index 000000000..54ffc38c4 Binary files /dev/null and b/docs/fr/source/_static/preventif-utilisation-04.png differ diff --git a/docs/fr/source/_static/table-export.png b/docs/fr/source/_static/table-export.png new file mode 100644 index 000000000..4ef821727 Binary files /dev/null and b/docs/fr/source/_static/table-export.png differ diff --git a/docs/fr/source/administrateur-applicatif.rst b/docs/fr/source/administrateur-applicatif.rst index e0e7c6e07..c77ddd4c5 100644 --- a/docs/fr/source/administrateur-applicatif.rst +++ b/docs/fr/source/administrateur-applicatif.rst @@ -4,8 +4,8 @@ Administration applicative ========================== -:Auteur: Étienne Loks -:Date: 2023-11-16 +:Auteurs: Étienne Loks, Valérie-Emma Leroux, Perrine Pautrat +:Date: 2024-06-06 :Copyright: CC-BY 3.0 ---------------------------------- @@ -14,9 +14,9 @@ Administration applicative La configuration d'Ishtar se fait essentiellement par le biais de « l'interface d'administration ». Cette interface propose une vue brute des tables en base de données. Même si cette interface propose une ergonomie simple et pratique, utiliser cette interface peut nécessiter d'avoir connaissance de notions de base d'une base de données pour pouvoir opérer des choix pertinents. -L'interface d'administration nécessite d'avoir un compte administrateur pour y accéder. Les utilisateurs disposant de ce droit ont une icône « roue dentée » sur la barre de menu à l'extrémité droite. Sauf configuration spécifique, cette interface est aussi disponible via l'adresse « https://monsite-ishtar.net/admin/ » (ajouter `/admin/` à l'adresse de base). +L'interface d'administration nécessite d'avoir un compte administrateur pour y accéder. Les utilisateurs disposant de ce droit ont une icône « engrenage » sur la barre de menu à l'extrémité droite. Sauf configuration spécifique, cette interface est aussi disponible via l'adresse « https://monsite-ishtar.net/admin/ » (ajouter `/admin/` à l'adresse de base). -L'interface d'administration présente la liste des différentes tables par ordre alphabétique regroupées par application. +L'interface d'administration présente la liste des différentes tables par ordre alphabétique regroupées par module. La section *Ishtar - Commun* regroupe les éléments transversaux : *API* (éléments concernant en particulier la fédération et les vitrines), *Annuaire* (utilisateurs, comptes, droits, …), *Archive* (archivage de la base de données), *Documents*, *Données personnalisées /formulaires personnalisés*, *Géographie*, *Imports* (imports et types d'imports), *Paramètres généraux* (autres paramétrages). .. warning:: Pour des questions de performance, Ishtar utilise intensément un système de cache. Il arrive parfois que celui-ci tarde à se mettre à jour. Il peut arriver que des modifications en administration prennent plusieurs minutes à être prises en compte. @@ -162,7 +162,7 @@ Chacun de ces droits est décliné en deux modalités : - droits sur tous les éléments ; - droit sur les éléments rattachés. -Un élément est dit « rattaché » à une personne en fonction de règles précises spécifiées dans l':ref:`annexe 2 - détail des permissions `. La notion de rattachement permet de spécifier finement les permissions pour des personnes qui sont directement associées à l'élément. Par exemple cela permet donner les droits de modification du mobilier d'une opération au responsable scientifique de cette opération. +Un élément est dit « rattaché » à une personne en fonction de règles précises spécifiées dans l':ref:`annexe 2 - détail des permissions `. La notion de rattachement permet de spécifier finement les permissions pour des personnes qui sont directement associées à l'élément. Par exemple cela permet de donner les droits de modification du mobilier d'une opération au responsable scientifique de cette opération. En pratique, globalement, les groupes de droits permettent d'accéder à certaines actions : @@ -230,65 +230,9 @@ Pour chaque type d'élément principal, il est possible de configurer le profil - l'identifiant complet (optionnel) : cet identifiant est un identifiant de gestion paramétrable. Cet identifiant peut par exemple se distinguer de l'identifiant externe pour incorporer des codes matières. - clés pour index personnalisé : un index personnalisé peut être défini en fonction d'une ou plusieurs clés reprenant les champs. Par exemple une clé opération peut être utilisée pour générer un index numérotant de 1 à n le mobilier sur une opération. -Pour définir identifiant externes et identifiant complet, on utilise des formules. Deux types de syntaxes sont utilisées : une :ref:`syntaxe simple ` et une :ref:`syntaxe Jinja ` (nom de la bibliothèque utilisée). Ces deux syntaxes utilisent des variables relatives à l'élément. L'utilisation de ces variables est explicitée dans l':ref:`annexe technique 3 - variables `. - - - -Formules --------- - -.. _formules-syntaxe-simple: - -Syntaxe simple -************** - -Cette syntaxe permet d'utiliser directement les variables en utilisant la notation accolade simple ``{}``. Par exemple : :: - - OA-{code_patriarche} - -Cette notation se traduira ainsi par des rendus comme : `OA-061234` ou `OA-44789`. - - -.. _formules-syntaxe-jinja: - -Syntaxe Jinja -************* - -Cette syntaxe permet de faire de faire des substitutions de manière plus fine qu'avec la syntaxe simple. Cette syntaxe est utilisée systématiquement pour les patrons de document, un sous-ensemble de cette syntaxe (variables et structures conditionnelles) peut-être utilisée optionnellement pour les identifiants personnalisés. - -Variables -+++++++++ - -L'accès aux `variables ` se fait par la notation double accolade ``{{ }}``. -Ainsi par exemple, pour accéder aux variables `nom_de_ma_clef_1` et `nom_de_ma_clef_2` : :: - - Je, soussigné, {{nom_de_ma_clef_1}}, vous accorde un prêt de {{nom_ma_clef_2}}. - - -Conditions -++++++++++ - -Des structures conditionnelles peuvent être mises en place. Cela permet notamment de tester si une valeur a été renseignée et de permettre de contextualiser l'affichage en fonction de cela. Exemple : :: - - Ce traitement sous - {% if responsable %}la responsabilité de {{responsable}} - {% else %}une responsabilité à définir - {% endif %} se tiendra... - -Les structures conditionnelles se structurent autour des mots clés ``if``, ``else`` et ``endif``. On utilise ``{%`` et ``%}`` autour de ces mots clés. La section ``else`` est facultative. - - -Parcours de liste -+++++++++++++++++ - -Certaines clés peuvent parfois renvoyer à des listes d'éléments, chacun ayant des attributs. On peut alors parcourir cette liste d'élément de cette manière : :: - - {% for element in liste_elements %} - {{element.nom}} - {{element.prenom}} - {% endfor %} - -Cela se structure autour des mots clés ``for``, ``in`` et ``endfor``. Au lieu de doubles accolades, ``{%`` et ``%}`` encadrent ces mots clés. +Pour définir identifiant externe et identifiant complet, on utilise des formules. Deux types de syntaxes sont utilisées : une :ref:`syntaxe simple ` et une :ref:`syntaxe Jinja ` (du nom de la bibliothèque utilisée). Ces deux syntaxes sont présentées dans l':ref:`annexe technique 5 - formules `. +Elles utilisent des variables relatives à l'élément. L'utilisation de ces variables est explicitée dans l':ref:`annexe technique 3 - variables `. Journalisation RGPD diff --git a/docs/fr/source/administrateur-serveur.rst b/docs/fr/source/administrateur-serveur.rst index de2991d40..28311fc1d 100644 --- a/docs/fr/source/administrateur-serveur.rst +++ b/docs/fr/source/administrateur-serveur.rst @@ -5,9 +5,10 @@ Administration serveur ====================== :Auteur: Étienne Loks -:Date: 2023-06-12 +:Date: 2024-06-05 :Copyright: CC-BY 3.0 +---------------------------------- Ce document présente les instructions d'installation et de mise à jour d'Ishtar. @@ -65,7 +66,7 @@ Un ensemble de questions vous sera posé afin de déterminer les paramètres qui .. _`documentation de Django`: https://docs.djangoproject.com/fr/2.2/howto/deployment/wsgi/ L'installateur vous demandera un identifiant / mot de passe pour le compte administrateur. -Une fois l'instance préparée, une base de données a été créée avec un nom du type ishtar-le_nom_de_mon_instance (le nom que vous avez donné), Ishtar est joignable à l'adresse donnée par la variable URL et les données de cette instance sont stockées dans le répertoire /srv/ishtar/le_nom_de_mon_instance. +Une fois l'instance préparée, une base de données est créée avec un nom du type ishtar-le_nom_de_mon_instance (le nom que vous avez donné), Ishtar est joignable à l'adresse donnée par la variable URL et les données de cette instance sont stockées dans le répertoire /srv/ishtar/le_nom_de_mon_instance. Initialisation de la base de données diff --git a/docs/fr/source/annexe-2-permission-action.rst b/docs/fr/source/annexe-2-permission-action.rst index 84e2408bd..7576121eb 100644 --- a/docs/fr/source/annexe-2-permission-action.rst +++ b/docs/fr/source/annexe-2-permission-action.rst @@ -49,13 +49,13 @@ L'utilisateur bénificiera du droit rattaché à un import si : Permission lecture ------------------ -Cette permission d'accéder aux fiches imports depuis les fiches d'éléments créés ou mis à jour. Depuis cette fiche ce droit permet de visualiser les CSV rattachés aux imports. +Cette permission autorise l'accès aux fiches imports depuis les fiches d'éléments créés ou mis à jour. Depuis cette fiche ce droit permet de visualiser les CSV rattachés aux imports. Permission ajout ---------------- -Cette permission permet de créer de nouveaux imports. +Cette permission autorise la création de nouveaux imports. Le droit « Imports rattachés : ajout » ne permet de créer des imports que pour les types d'imports pour lesquels l'utilisateur est listé. @@ -66,16 +66,16 @@ Le droit « Imports rattachés : ajout » ne permet de créer des imports que po Permission modification ----------------------- -Cette permission permet : +Cette permission accorde : -- d'accéder à la liste des imports, -- de modifier un import existant, -- d'analyser, de faire les correspondances, de lancer l'importation d'un import. +- l'accès à la liste des imports, +- la modification d'un import existant, +- la possibilité d'analyser, de faire les correspondances, de lancer l'import. Permission suppression ---------------------- -Cette permission permet de supprimer les imports **et** par conséquent les éléments auxquels sont associés ces imports. +Cette permission autorise la suppression des imports **et** par conséquent les éléments auxquels sont associés ces imports. diff --git a/docs/fr/source/annexe-5-module-operateur-preventif.rst b/docs/fr/source/annexe-5-module-operateur-preventif.rst new file mode 100644 index 000000000..109f22f83 --- /dev/null +++ b/docs/fr/source/annexe-5-module-operateur-preventif.rst @@ -0,0 +1,98 @@ +.. -*- coding: utf-8 -*- + +.. _annexe-5-module-operateur-preventif: + +======================================================= +Annexe 5 - Fonctionnement du module opérateur préventif +======================================================= + +:Auteurs: Étienne Loks, Valérie-Emma Leroux, Perrine Pautrat +:Date: 2024-06-05 +:Copyright: CC-BY 3.0 + +---------------------------------- + +Ce module est une extension du module dossier, il permet de faciliter la rédaction de plans d'intervention et le suivi des coûts. + +Configuration +============= + +La configuration se fait au niveau des pages d'administration. Celle-ci peut être initialement un peu fastidieuse mais elle permet d'être efficace en saisie tout en limitant les erreurs. + +1. Pour rendre disponible le module opérateur préventif, il faut au préalable l'activer via la configuration du profil d'instance (depuis les pages d'administration : *https://mon-instance-ishtar.org/admin/ishtar_common/ishtarsiteprofile/*). + +.. figure:: _static/preventif-admin.png + :align: center + + Configuration du profil pour le module opérateur préventif + +Ensuite il faut configurer les différents prix correspondants au contrat tarifaire actuel. Tous ces éléments sont regroupés sous « *Ishtar - Dossier / Préventif* ». + +.. figure:: _static/preventif-admin-section.jpg + :width: 85% + :align: center + + Modèles du module opérateur préventif + + +2. Vérifiez que les « Types d'équipements/de services » comprennent tous les éléments qui vous concernent. Ajoutez ceux manquants. S'il manque beaucoup d'éléments, n'hésitez pas à passer par un export/import CSV. + +3. Créer un nouveau contrat tarifaire depuis celui qui a été créé par défaut : + +* Pour cela cliquer sur **ajouter** à côté de « *Contrat tarifaire* », ajouter celui-ci en précisant bien dans son nom la date (exemple : « Tarifs 2021 »). +* Puis, sur la page listant les contrats tarifaires, cliquer sur le bouton « **Copier le contrat tarifaire** » en haut à droite. Recopier le contrat « Prix par défaut » sur celui que vous venez de créer. + +4. Adaptez les coûts des « Emplois » de votre contrat tarifaire (« Filtre / Contrat tarifaire » à droite du tableau). Ajoutez/retirez en si nécessaire, en prenant bien en compte les différences de contrat (CDI ou non), le coût terrain, le coût post-fouille ainsi que les nombres journaliers terrain/post-fouille par défaut (ces nombres apparaîtront automatiquement lors de la création d'un nouveau plan d'intervention). + +5. Adaptez les coûts des « Coût équipement/service » de votre contrat tarifaire (« Filtre / Contrat tarifaire » à droite du tableau). Ajoutez/retirez en si nécessaire, en prenant bien en compte si ces coûts sont forfaitaires ou doivent être chiffrés par unité (le cas échéant la spécifier), renseignez la spécificité de ce tarif si nécessaire (exemple : lundi au jeudi) ainsi que l'éventuelle quantité par défaut (ces nombres apparaîtront automatiquement lors de la création d'un nouveau plan d'intervention). Il y a possibilité d'ajouter un parent qui permet de faire des chaînages sur l'interface, par exemple : l'ajout d'un coût de « Pelle mécanique » ajoute automatiquement un coût « Amenée » et « Repli ». Il peut être plus simple d'éditer ces coûts via import/export CSV. + +> Attention : à chaque fois qu'une évolution de tarif devra être appliquée, il est important de recréer un nouveau contrat et de recopier le précédent en vigueur. Sans cela toutes les coûts précédemment entrés seront faussés. + + +Utilisation +=========== + +Une fois le module activé, une nouvelle action est disponible sur la fiche de dossier : « **Plan d'intervention** ». + +.. figure:: _static/preventif-utilisation-01.png + :width: 85% + :align: center + + Bouton d'édition d'un plan d'intervention + +Lors de la création, il est demandé quel contrat tarifaire sera utilisé. Ce contrat tarifaire peut-être changé ensuite (via un bouton « **Changer le contrat tarifaire** »), néanmoins changer ce contrat retire tous les coûts enregistrés. + +On accède ensuite au formulaire d'édition. + +La première partie permet de renseigner des informations générales sur la fouille, certaines communes aux formulaires d'édition des dossiers (exemple : *Date de début de la fouille*), d'autres spécifiques aux plans d'intervention. + +.. figure:: _static/preventif-utilisation-02.jpg + :align: center + + Formulaire de plan d'intervention + +La seconde partie correspond aux coûts. Un onglet en haut permet de passer des coûts *planifiés* aux coûts *travaillés* (ou réels), soyez vigilant sur l'onglet activé en édition. En dessous, sont listés les différents emplois (terrain et post/fouille) ainsi que les différentes sections techniques. Ce formulaire est initialement vide. + +.. figure:: _static/preventif-utilisation-03.png + :align: center + + Formulaire de plan d'intervention : coûts + +Sauf chantier particulier, cliquer sur « **Ajouter les coûts par défaut** » est pertinent : cela permet d'ajouter les coûts classiques d'un chantier comme paramétré en administration, il n'y ensuite plus qu'à ajuster les différents coûts dans chaque section. Soyez vigilants de bien renseigner la quantité *et* le cas échéant le nombre de jours (ou semaines, ou ...). Attention à bien valider après vos modifications. + +Les différents coûts permettront de générer des documents pour faciliter la rédaction du plan d'intervention. + +Une fois le chantier finalisé, si l'on souhaite opérer un suivi sur les coûts, il est possible de rentrer les coûts réels. Une fois sélectionné l'onglet « Travaillé », il est souvent opportun de cliquer sur le bouton « Copier les coûts planifiés » afin de ne pas ressaisir ces entrées. Il suffit ensuite d'ajuster. + +> Note : contrairement aux autres formulaires Ishtar, la validation du formulaire n'entraîne pas automatiquement un retour à la fiche. En effet ce formulaire peut nécessiter de nombreuses validations avant que l'on souhaite retourner à la fiche, aussi il faut explicitement cliquer sur le bouton « **Retourner au dossier** » en bas à droite afin de retourner effectivement à la fiche dossier. + +Consultation +============ + +Les données saisies ont une utilisation immédiate dans les documents générés mais sont aussi disponibles sur la fiche du dossier via un onglet « Préventif ». + +.. figure:: _static/preventif-utilisation-04.jpg + :align: center + + Onglet préventif de la fiche dossier + diff --git a/docs/fr/source/annexe-tech-3-variables-gen.rst b/docs/fr/source/annexe-tech-3-variables-gen.rst index 2694c6657..b9c206c0e 100644 --- a/docs/fr/source/annexe-tech-3-variables-gen.rst +++ b/docs/fr/source/annexe-tech-3-variables-gen.rst @@ -9,7 +9,6 @@ Annexe technique 3 - Variables :Auteurs: Étienne Loks, Ishtar team :Date: 2024-05-10 :Copyright: CC-BY 3.0 -:Ishtar Version: v4.1.10 ---------------------------------- diff --git a/docs/fr/source/annexe-tech-4-jinja-filters.rst b/docs/fr/source/annexe-tech-4-jinja-filters.rst index 9dc499312..96d003db2 100644 --- a/docs/fr/source/annexe-tech-4-jinja-filters.rst +++ b/docs/fr/source/annexe-tech-4-jinja-filters.rst @@ -9,7 +9,6 @@ Annexe technique 4 - Filtres pour les patrons de documents :Auteurs: Étienne Loks, Valérie-Emma Leroux :Date: 2022-03-08 :Copyright: CC-BY 3.0 -:Ishtar Version: v3.1.0 ---------------------------------- diff --git a/docs/fr/source/annexe-tech-5-formules.rst b/docs/fr/source/annexe-tech-5-formules.rst new file mode 100644 index 000000000..6e5a95851 --- /dev/null +++ b/docs/fr/source/annexe-tech-5-formules.rst @@ -0,0 +1,68 @@ +.. -*- coding: utf-8 -*- + +.. _annexe-tech-5-formules + +============================= +Annexe technique 5 - Formules +============================= + +:Auteurs: Étienne Loks +:Date: 2024-06-05 +:Copyright: CC-BY 3.0 + +---------------------------------- + + +.. _formules-syntaxe-simple: + +Syntaxe simple +============== + +Cette syntaxe permet d'utiliser directement les variables en utilisant la notation accolade simple ``{}``. Par exemple : :: + + OA-{code_patriarche} + +Cette notation se traduira ainsi par des rendus comme : `OA-061234` ou `OA-44789`. + + +.. _formules-syntaxe-jinja: + +Syntaxe Jinja +============= + +Cette syntaxe permet de faire des substitutions de manière plus fine qu'avec la syntaxe simple. Cette syntaxe est utilisée systématiquement pour les patrons de document, un sous-ensemble de cette syntaxe (variables et structures conditionnelles) peut-être utilisée optionnellement pour les identifiants personnalisés. + +Variables +--------- + +L'accès aux :ref:`annexe technique 3 - variables `. se fait par la notation double accolade ``{{ }}``. +Ainsi par exemple, pour accéder aux variables `nom_de_ma_clef_1` et `nom_de_ma_clef_2` : :: + + Je, soussigné, {{nom_de_ma_clef_1}}, vous accorde un prêt de {{nom_ma_clef_2}}. + + +Conditions +---------- + +Des structures conditionnelles peuvent être mises en place. Cela permet notamment de tester si une valeur a été renseignée et de permettre de contextualiser l'affichage en fonction de cela. Exemple : :: + + Ce traitement sous + {% if responsable %}la responsabilité de {{responsable}} + {% else %}une responsabilité à définir + {% endif %} se tiendra... + +Les structures conditionnelles se structurent autour des mots clés ``if``, ``else`` et ``endif``. On utilise ``{%`` et ``%}`` autour de ces mots clés. La section ``else`` est facultative. + + +Parcours de liste +----------------- + +Certaines clés peuvent parfois renvoyer à des listes d'éléments, chacun ayant des attributs. On peut alors parcourir cette liste d'élément de cette manière : :: + + {% for element in liste_elements %} + {{element.nom}} - {{element.prenom}} + {% endfor %} + +Cela se structure autour des mots clés ``for``, ``in`` et ``endfor``. Au lieu de doubles accolades, ``{%`` et ``%}`` encadrent ces mots clés. + + diff --git a/docs/fr/source/annexe-tech-5-manage-commands.rst b/docs/fr/source/annexe-tech-5-manage-commands.rst deleted file mode 100644 index d9471e7df..000000000 --- a/docs/fr/source/annexe-tech-5-manage-commands.rst +++ /dev/null @@ -1,45 +0,0 @@ -.. -*- coding: utf-8 -*- - -.. _annexe-tech-5-manage-commands: - -================================================ -Annexe technique 5 - Commandes de gestion en CLI -================================================ - -:Auteurs: Étienne Loks -:Date: 2021-06-21 -:Copyright: CC-BY 3.0 -:Ishtar Version: v3.1.0 - ----------------------------------- - - -Les commandes de gestion en CLI nécessite un accès en ligne de commande au serveur. -Une fois connecté en SSH à celui-ci, on se rend dans le répertoire de l'instance sur -laquelle on souhaite intervenir (par défaut : `/srv/ishtar/`) et -l'on lance la commande souhaité via un appel au de ce répertoire `manage.py` suivi du -nom de la commande. Exemple : - -.. code-block:: bash - - root@ishtar-server:# cd /srv/ishtar/prod_deb - root@ishtar-server:# python3 ./manage.py relations_update_cache_tables - - -import_geofla_csv ------------------ - -Import des communes depuis les données IGN (cf. :ref:`Annexe technique 2`). - -import_insee_comm_csv ---------------------- - -Import des communes depuis les données INSEE (cf. :ref:`Annexe technique 1`). - -relations_update_cache_tables ------------------------------ - -Cette commande met à jour les tables de cache des relations. Cette commande doit être -impérativement lancée lorsque l'on change le type de gestion des relations depuis le -profil afin de mettre à jour les tables correpondantes. - diff --git a/docs/fr/source/annexe-tech-6-configuration-syndication.rst b/docs/fr/source/annexe-tech-6-configuration-syndication.rst deleted file mode 100644 index 0cc27b436..000000000 --- a/docs/fr/source/annexe-tech-6-configuration-syndication.rst +++ /dev/null @@ -1,233 +0,0 @@ -.. -*- coding: utf-8 -*- - -.. _annexe-tech-6-configuration-syndication: - -==================================================== -Annexe technique 6 - Configuration de la fédération -==================================================== - -:Auteurs: Étienne Loks -:Date: 2023-02-16 -:Copyright: CC-BY 3.0 -:Ishtar Version: v4.0 - -La fédération de données entre instances Ishtar est une fonctionnalité -puissante mais assez complexe à mettre en place. La documentation -ci-dessous détaille pas à pas les différentes étapes pour mettre en -place cela. - -Selon que l’on soit l’instance qui partage des données ou celle qui -consulte des données les enjeux sont différents : - -L’instance qui partage des données (dite « source ») doit paramétrer : - -- les types de données à partager ; -- les sous-ensembles de ces données à partager ; -- les attributs que l’on souhaite exposer / cacher ; -- à qui l’on va partager les données (nécessitant la création d’un - compte système avec un jeton d’accès et le paramétrage de l’adresse - IP du serveur vers lequel les données vont être envoyées). - -L’instance source est configurée en administration via les entrées « API - -Accès distant ». - -L’instance qui consulte les données (dite « destination ») doit paramétrer : - -- le serveur « source » qui fournit les données, son adresse web d’Ishtar - et un jeton d’accès ; -- la correspondance entre les listes de vocabulaire contrôlé de son - instance et les listes de vocabulaire contrôlé de l’instance source. - Cette correspondance est nécessaire pour traduire les recherches par - critères de manière pertinente. - -L’instance destination est configurée en administration via les entrées « -API - Recherche ». - -Pour illustrer une fédération de données, nous allons prendre l’exemple -suivant : - -L’instance Charente-Maritime veut partager un ensemble de données avec -l’instance Nouvelle-Aquitaine. - -Le serveur dit « source » est celui de Charente-Maritime. - -Le serveur dit « destination » est celui de Nouvelle-Aquitaine. - -Configuration du serveur source -=============================== - -Cette configuration est à faire si vous souhaitez donner un accès en -lecture à vos données depuis une autre instance Ishtar. Dans notre -exemple, il s’agit du serveur Charente-Maritime. - -Préalablement à cette configuration vous avez besoin de l’adresse IP du -serveur de l’autre instance Ishtar. - -Création d’un utilisateur système ---------------------------------- - -Contrairement à la création d’utilisateur classique, on crée un -utilisateur système. Celui-ci n’aura pas accès à l’instance Ishtar -directement. Créer cet utilisateur en interface « Administration de base -de données » : « Authentification et autorisation > Utilisateurs > Ajout -». Utiliser un identifiant qui n’existe pas encore en base de données, -exemple « federation-nouvelle-aquitaine ». Le mot de passe ne sera pas -utilisé : en choisir un particulièrement complexe. - -|image0| - -Associer un jeton d’authentification à un utilisateur système -------------------------------------------------------------- - -Associer ensuite à ce compte un jeton d’authentification. Depuis -l’interface « Administration de base de données » : « Accueil > Jeton -d’authentification > Jetons > Ajout ». Le compte est retrouvé via -l’icône loupe. - -Une fois le jeton créé, aller à la liste des jetons puis mettre de côté -la clé du jeton. - -|image1| - -Par exemple sur la capture d’écran, la clé est -``a14b32f31029216da11621ba5ddb0431997ca61d``. Une fois la configuration -terminée, cette clé sera à transmettre à l’administrateur de l'instance Ishtar destination. - -Associer l’adresse IP du serveur destination à l’utilisateur système --------------------------------------------------------------------- - -Depuis « Ishtar - Commun > API - Accès distant - Utilisateurs > Ajout », -on associe l’utilisateur système à l’adresse IP du serveur. - -|image2| - -Pour notre exemple, le serveur de Nouvelle-Aquitaine a l’adresse -``8.8.8.8``. - -Ouvrir l’accès à un ou plusieurs types de contenu -------------------------------------------------- - -Pour chaque type de contenu que l’on souhaite ouvrir (Opération, Unité -d’Enregistrement, Mobilier, …), ajouter une entrée via : « Ishtar - -Commun > API - Accès distant - Modèles de recherche > Ajout ». - -|image3| - -On sélectionne notre utilisateur système, le type de contenu, ainsi -qu’éventuellement une requête filtrante. Cette requête correspond à une -chaîne de caractères correspondant à recherche. Seuls les éléments -correspondants à cette requête seront partagés. Si l’on ne renseigne pas -cette requête filtrante tous les éléments seront renvoyés. - -Filtrer la fiche de contenu ---------------------------- - -Il est possible de cacher certains champs sur la fiche que l’on partage. -Pour chaque champ que l’on souhaite cacher, ajouter une entrée via « -Ishtar - Commun > API - Accès distant - Filtres de fiche > Ajout ». Le -formulaire doit rempli en deux fois. On se contente d’abord de choisir -le type de contenu que l’on veut filtrer. - -|image4| - -Valider avec le bouton « Enregistrer et continuer les modifications ». - -Une fois ce premier enregistrement, l’aide disponible sous le champ « -Clé » liste les différentes clés correspondant au contenu que l’on -souhaite filtrer. - -|image5| - -Sur cet exemple, on souhaite filtrer l’affichage de l’image principale. -Note : si l’on souhaite qu’aucune image ne soit affichée, il faut -ajouter chaque champ « image ». - -Configuration du serveur destination -==================================== - -Cette configuration est à faire si vous souhaitez accéder à des données -d’une autre instance Ishtar depuis votre propre instance. Dans notre -exemple, il s’agit du serveur Nouvelle-Aquitaine. - -Préalablement à cette configuration vous avez besoin du jeton -d’authentification donné par le serveur source ainsi que l’adresse web -pour accéder à celui-ci. - -Créer la source externe ------------------------ - -Cette source externe se crée en interface « Administration de base de -données » : « Ishtar - Commun > API - Recherche - Sources externes > -Ajout ». - -|image6| - -Sur le formulaire reprendre l’adresse web du serveur source ainsi que le -jeton d’authentification qui vous a été fourni. Le nom renseigné doit -être explicite, il apparaîtra sur les écrans de recherche de -l’interface. On renseigne explicitement chaque utilisateur qui aura -accès à cette source externe. - -Synchroniser les listes de vocabulaire contrôlées depuis la source ------------------------------------------------------------------- - -Une fois la source externe créée il est nécessaire de récupérer les -listes de vocabulaire contrôlées de cette source (le serveur source). Pour -cela, on se rend sur la page listant les sources externes : « Ishtar - -Commun > API - Recherche - Sources externes ». Sélectionner la source -externe concernée, l’action « Mettre à jour les types depuis la source » -et valider (le bouton « Aller »). - -|image7| - -Cette action peut prendre un certain temps. Si des changements sont -faits sur les listes de vocabulaire contrôlé sur la source cette étape -ainsi que les suivantes sont à effectuer de nouveau. - -Mettre à jour les correspondances ---------------------------------- - -Pour chaque liste de vocabulaire contrôlée, des correspondances sont -faites automatiquement entre les termes identiques. Lorsque deux -instances partagent la même langue et ont des cas d’utilisation -semblable, une bonne partie des listes de vocabulaire sont mises en -correspondance automatiquement. Afin de visualiser les correspondances -et de compléter les correspondances manquantes, on génère un document de -correspondance. Celui-ci se présente sous la forme d’un document tableur -LibreOffice. Pour cela, on reste sur la page listant les sources -externes : « Ishtar - Commun > API - Recherche - Sources externes ». -Sélectionner la source externe concernée et l’action « Générer le document -de correspondance », valider (bouton « Aller »). - -|image8| - -Ouvrir le document généré avec LibreOffice et parcourir les différents -onglets pour effectuer les éventuelles correspondances manquantes. Là -où des cellules sur la troisième colonne « Local » sont vides, choisir -l’élément manquant dans la liste. - -|image9| - -Une fois ces modifications faites, enregistrer le document et -le déposer sur le serveur sur la source externe concernée. - -|image10| - -Enregistrer la source externe puis sélectionner la source externe -concernée et l’action « Mettre à jour les associations depuis un document -de correspondance », valider. - -|image11| - -.. |image0| image:: _static/annexe-technique-06-01.png -.. |image1| image:: _static/annexe-technique-06-02.png -.. |image2| image:: _static/annexe-technique-06-03.png -.. |image3| image:: _static/annexe-technique-06-04.png -.. |image4| image:: _static/annexe-technique-06-05.png -.. |image5| image:: _static/annexe-technique-06-06.png -.. |image6| image:: _static/annexe-technique-06-07.png -.. |image7| image:: _static/annexe-technique-06-08.png -.. |image8| image:: _static/annexe-technique-06-09.png -.. |image9| image:: _static/annexe-technique-06-10.png -.. |image10| image:: _static/annexe-technique-06-11.png -.. |image11| image:: _static/annexe-technique-06-12.png diff --git a/docs/fr/source/annexe-tech-6-manage-commands.rst b/docs/fr/source/annexe-tech-6-manage-commands.rst new file mode 100644 index 000000000..7604aa170 --- /dev/null +++ b/docs/fr/source/annexe-tech-6-manage-commands.rst @@ -0,0 +1,44 @@ +.. -*- coding: utf-8 -*- + +.. _annexe-tech-6-manage-commands: + +================================================ +Annexe technique 6 - Commandes de gestion en CLI +================================================ + +:Auteurs: Étienne Loks +:Date: 2024-06-06 +:Copyright: CC-BY 3.0 + +---------------------------------- + + +Les commandes de gestion en CLI nécessitent un accès en ligne de commande au serveur. +Une fois connecté en SSH à celui-ci, on se rend dans le répertoire de l'instance sur +laquelle on souhaite intervenir (par défaut : `/srv/ishtar/`) et +on lance la commande souhaitée via un appel à `manage.py` suivi du +nom de la commande. Exemple : + +.. code-block:: bash + + root@ishtar-server:# cd /srv/ishtar/prod_deb + root@ishtar-server:# python3 ./manage.py relations_update_cache_tables + + +import_geofla_csv +----------------- + +Import des communes depuis les données IGN (cf. :ref:`Annexe technique 2`). + +import_insee_comm_csv +--------------------- + +Import des communes depuis les données INSEE (cf. :ref:`Annexe technique 1`). + +relations_update_cache_tables +----------------------------- + +Cette commande met à jour les tables de cache des relations. Cette commande doit être +impérativement lancée lorsque l'on change le type de gestion des relations depuis le +profil afin de mettre à jour les tables correpondantes. + diff --git a/docs/fr/source/annexe-tech-7-configuration-syndication.rst b/docs/fr/source/annexe-tech-7-configuration-syndication.rst new file mode 100644 index 000000000..69a714c71 --- /dev/null +++ b/docs/fr/source/annexe-tech-7-configuration-syndication.rst @@ -0,0 +1,235 @@ +.. -*- coding: utf-8 -*- + +.. _annexe-tech-7-configuration-syndication: + +=================================================== +Annexe technique 7 - Configuration de la fédération +=================================================== + +:Auteurs: Étienne Loks, Valérie-Emma Leroux, Perrine Pautrat +:Date: 2024-06-06 +:Copyright: CC-BY 3.0 + +---------------------------------- + +La fédération de données entre instances Ishtar est une fonctionnalité +puissante mais assez complexe à mettre en place. La documentation +ci-dessous détaille pas à pas les différentes étapes pour mettre en +place cela. + +Selon que l’on soit l’instance qui partage des données ou celle qui +consulte des données les enjeux sont différents : + +L’instance qui partage des données (dite « source ») doit paramétrer : + +- les types de données à partager ; +- les sous-ensembles de ces données à partager ; +- les attributs que l’on souhaite exposer / cacher ; +- à qui l’on va partager les données (nécessitant la création d’un + compte système avec un jeton d’accès et le paramétrage de l’adresse + IP du serveur vers lequel les données vont être envoyées). + +L’instance source est configurée en administration via les entrées « API - +Accès distant ». + +L’instance qui consulte les données (dite « destination ») doit paramétrer : + +- le serveur « source » qui fournit les données, son adresse web d’Ishtar + et un jeton d’accès ; +- la correspondance entre les listes de vocabulaire contrôlé de son + instance et les listes de vocabulaire contrôlé de l’instance source. + Cette correspondance est nécessaire pour traduire les recherches par + critères de manière pertinente. + +L’instance destination est configurée en administration via les entrées « +API - Recherche ». + +Pour illustrer une fédération de données, nous allons prendre l’exemple +suivant : + +L’instance Charente-Maritime veut partager un ensemble de données avec +l’instance Nouvelle-Aquitaine. + +Le serveur dit « source » est celui de Charente-Maritime. + +Le serveur dit « destination » est celui de Nouvelle-Aquitaine. + +Configuration du serveur source +=============================== + +Cette configuration est à faire si vous souhaitez donner un accès en +lecture à vos données depuis une autre instance Ishtar. Dans notre +exemple, il s’agit du serveur Charente-Maritime. + +Préalablement à cette configuration vous avez besoin de l’adresse IP du +serveur de l’autre instance Ishtar. + +Création d’un utilisateur système +--------------------------------- + +Contrairement à la création d’utilisateur classique, on crée un +utilisateur système. Celui-ci n’aura pas accès à l’instance Ishtar +directement. Créer cet utilisateur en interface « Administration de base +de données » : « Authentification et autorisation > Utilisateurs > Ajout +». Utiliser un identifiant qui n’existe pas encore en base de données, +exemple « federation-nouvelle-aquitaine ». Le mot de passe ne sera pas +utilisé : en choisir un particulièrement complexe. + +|image0| + +Associer un jeton d’authentification à un utilisateur système +------------------------------------------------------------- + +Associer ensuite à ce compte un jeton d’authentification. Depuis +l’interface « Administration de base de données » : « Accueil > Jeton +d’authentification > Jetons > Ajout ». Le compte est retrouvé via +l’icône loupe. + +Une fois le jeton créé, aller à la liste des jetons puis mettre de côté +la clé du jeton. + +|image1| + +Par exemple sur la capture d’écran, la clé est +``a14b32f31029216da11621ba5ddb0431997ca61d``. Une fois la configuration +terminée, cette clé sera à transmettre à l’administrateur de l'instance Ishtar destination. + +Associer l’adresse IP du serveur destination à l’utilisateur système +-------------------------------------------------------------------- + +Depuis « Ishtar - Commun > API - Accès distant - Utilisateurs > Ajout », +on associe l’utilisateur système à l’adresse IP du serveur. + +|image2| + +Pour notre exemple, le serveur de Nouvelle-Aquitaine a l’adresse +``8.8.8.8``. + +Ouvrir l’accès à un ou plusieurs types de contenu +------------------------------------------------- + +Pour chaque type de contenu que l’on souhaite ouvrir (Opération, Unité +d’Enregistrement, Mobilier, …), ajouter une entrée via : « Ishtar - +Commun > API - Accès distant - Modèles de recherche > Ajout ». + +|image3| + +On sélectionne notre utilisateur système, le type de contenu, ainsi +qu’éventuellement une requête filtrante. Ce filtre correspond à une +chaîne de caractères définissant une requête valable dans la barre de +recherche d'Ishtar. Seuls les éléments correspondant à cette requête +seront partagés. Si l’on ne renseigne pas cette requête filtrante, +tous les éléments de la base de données seront renvoyés. + +Filtrer la fiche de contenu +--------------------------- + +Il est possible de cacher certains champs sur la fiche que l’on partage. +Pour chaque champ que l’on souhaite cacher, ajouter une entrée via « +Ishtar - Commun > API - Accès distant - Filtres de fiche > Ajout ». Le +formulaire doit être rempli en deux fois. On se contente d’abord de choisir +le type de contenu que l’on veut filtrer. + +|image4| + +Valider avec le bouton « Enregistrer et continuer les modifications ». + +Une fois ce premier enregistrement, l’aide disponible sous le champ « +Clé » liste les différentes clés correspondant au contenu que l’on +souhaite filtrer. + +|image5| + +Sur cet exemple, on souhaite filtrer l’affichage de l’image principale. +Note : si l’on souhaite qu’aucune image ne soit affichée, il faut +ajouter chaque champ « image ». + +Configuration du serveur destination +==================================== + +Cette configuration est à faire si vous souhaitez accéder à des données +d’une autre instance Ishtar depuis votre propre instance. Dans notre +exemple, il s’agit du serveur Nouvelle-Aquitaine. + +Préalablement à cette configuration vous avez besoin du jeton +d’authentification donné par le serveur source ainsi que l’adresse web +pour accéder à celui-ci. + +Créer la source externe +----------------------- + +Cette source externe se crée en interface « Administration de base de +données » : « Ishtar - Commun > API - Recherche - Sources externes > +Ajout ». + +|image6| + +Sur le formulaire reprendre l’adresse web du serveur source ainsi que le +jeton d’authentification qui vous a été fourni. Le nom renseigné doit +être explicite, il apparaîtra sur les écrans de recherche de +l’interface. On renseigne explicitement chaque utilisateur qui aura +accès à cette source externe. + +Synchroniser les listes de vocabulaire contrôlées depuis la source +------------------------------------------------------------------ + +Une fois la source externe créée il est nécessaire de récupérer les +listes de vocabulaire contrôlées de cette source (le serveur source). Pour +cela, on se rend sur la page listant les sources externes : « Ishtar - +Commun > API - Recherche - Sources externes ». Sélectionner la source +externe concernée, l’action « Mettre à jour les types depuis la source » +et valider (le bouton « Aller »). + +|image7| + +Cette action peut prendre un certain temps. Si des changements sont +faits sur les listes de vocabulaire contrôlé sur la source cette étape +ainsi que les suivantes sont à effectuer de nouveau. + +Mettre à jour les correspondances +--------------------------------- + +Pour chaque liste de vocabulaire contrôlée, des correspondances sont +faites automatiquement entre les termes identiques. Lorsque deux +instances partagent la même langue et ont des cas d’utilisation +semblable, une bonne partie des listes de vocabulaire sont mises en +correspondance automatiquement. Afin de visualiser les correspondances +et de compléter les correspondances manquantes, on génère un document de +correspondance. Celui-ci se présente sous la forme d’un document tableur +LibreOffice. Pour cela, on reste sur la page listant les sources +externes : « Ishtar - Commun > API - Recherche - Sources externes ». +Sélectionner la source externe concernée et l’action « Générer le document +de correspondance », valider (bouton « Aller »). + +|image8| + +Ouvrir le document généré avec LibreOffice et parcourir les différents +onglets pour effectuer les éventuelles correspondances manquantes. Là +où des cellules sur la troisième colonne « Local » sont vides, choisir +l’élément manquant dans la liste. + +|image9| + +Une fois ces modifications faites, enregistrer le document et +le déposer sur le serveur sur la source externe concernée. + +|image10| + +Enregistrer la source externe puis sélectionner la source externe +concernée et l’action « Mettre à jour les associations depuis un document +de correspondance », valider. + +|image11| + +.. |image0| image:: _static/annexe-technique-06-01.png +.. |image1| image:: _static/annexe-technique-06-02.png +.. |image2| image:: _static/annexe-technique-06-03.png +.. |image3| image:: _static/annexe-technique-06-04.png +.. |image4| image:: _static/annexe-technique-06-05.png +.. |image5| image:: _static/annexe-technique-06-06.png +.. |image6| image:: _static/annexe-technique-06-07.png +.. |image7| image:: _static/annexe-technique-06-08.png +.. |image8| image:: _static/annexe-technique-06-09.png +.. |image9| image:: _static/annexe-technique-06-10.png +.. |image10| image:: _static/annexe-technique-06-11.png +.. |image11| image:: _static/annexe-technique-06-12.png diff --git a/docs/fr/source/fonctionnalites.rst b/docs/fr/source/fonctionnalites.rst new file mode 100644 index 000000000..282b0f4e5 --- /dev/null +++ b/docs/fr/source/fonctionnalites.rst @@ -0,0 +1,142 @@ +.. -*- coding: utf-8 -*- + +=============== +Fonctionnalités +=============== + +:Auteurs: Étienne Loks, Valérie-Emma Leroux, Perrine Pautrat +:Date: 2024-06-06 +:Copyright: CC-BY 3.0 + +--------------------- + +Fonctionnalités principales +=========================== + +À compléter. + +Données géographiques +--------------------- +Affichage sur la fiche +~~~~~~~~~~~~~~~~~~~~~~ +L'affichage de la carte sur les fiches permet de sélectionner les éléments géographiques que l'on souhaite voir apparaître ainsi que le cas échéant les unités d'enregistrement et/ou le mobilier associés. + +Un fond photographique IGN (flux Géoportail) est disponible en plus de la cartographie OpenStreetMap, via l'icône de couches sur la droite. + +.. image:: _static/geo-affichage.jpg + +Dans l'onglet *Données géographiques* de la fiche, une table regroupe le détail des éléments géographiques associés à l'élement concerné. En sus de la consultation, cette table permet d'ajouter (bouton « *+ élément géographique* ») des éléments géographiques, les modifier (icône « *crayon* » sur la première colonne à gauche du tableau) ou les supprimer (icône « *poubelle* » sur la dernière colonne à droite du tableau). + +.. image:: _static/geo-fiche.png + + +Affichage en recherche +~~~~~~~~~~~~~~~~~~~~~~ +Sur le panneau de recherche des éléments géographiques, il est possible d'afficher les lignes ou polygones associés aux éléments à la place du simple marqueur. + +.. image:: _static/geo-recherche.jpg + +Attention cet affichage est coûteux en ressources au niveau du navigateur quand beaucoup d'éléments sont disponibles. + +Formulaire +~~~~~~~~~~ + +Les données géographiques ne sont pas éditables sur les formulaires des éléments pivots, il faut passer par un formulaire spécifique d'ajout/modification. + +Le formulaire d'ajout propose d'abord le type de géométrie de l'élément géographique que l'on souhaite ajouter. Ce type n'est plus modifiable ensuite. Les types disponibles sont *Coordonnées*, *Point*, *Point 3D*, *Points multiples*, *Lignes multiples*, *Polygones multi-parties*. Le premier type correspond à la saisie de coordonnées numériques, tandis que les suivants correspondent à une vectorisation directement dans l'interface cartographique. + +Une fois le type choisi, le second volet du formulaire d'ajout dispose de plusieurs sections. + +Une section « *Éléments reliés* » permet de préciser les éléments pivots reliés à notre nouvel élément géographique. Cette section est similaire à la section disponible pour les documents, permettant aussi de spécifier s'il s'agit d'un élément géographique principal. En création, l'élément depuis lequel on ajoute est automatiquement ajouté en tant qu'élément relié. Par ailleurs un élément pivot avec un seul élément géographique associé a automatiquement cet élément pour élément géographique principal. + +Une section « *Géographie* » permet de dessiner la géométrie sur une carte ou selon le type choisi, de spécifier les coordonnées. Une sous-section « *Tampon* » (buffer) permet de préciser l'incertitude. + +La section « *Métadonnées* » reprend les champs cités plus haut dans le paragraphe **Nouvelles données attributaires**. + +Le formulaire de modification n'a qu'un seul volet, il reprend tous les éléments du second volet de création. + +.. image:: _static/geo-formulaire.jpg + +.. _imports-sig: + +Imports +~~~~~~~ + +Un type d'import spécifique a été créé pour les données géographiques. +Cet importeur prend en charge les fichiers CSV (pour les géométries traduites en champ texte WKT ou des coordonnées) et les fichiers SIG Shapefile et Geopackage. + +> **Note** : lors de la création d'un nouvel import SIG, contrairement aux imports tableaux, le nombre de lignes d'entête est par défaut mis à 0. En effet les fichiers Shapefile et Geopackage n'ont pas d'entêtes. Aussi pour un fichier SIG tableau CSV, il faut bien penser à changer ce nombre de lignes d'entête. + +À la création d'un nouvel import SIG, si le fichier est de type Shapefile ou Geopackage, les champs *Codage* et *Séparateur CSV* ne sont pas pris en compte. + +Droits +~~~~~~ + +Des droits d'accès, modification spécifiques ont été mis en place pour l'accès aux données géographiques. Ces droits permettent de restreindre l'affichage de la carte, l'accès aux formulaires, boutons d'ajout et de suppression. +Lors de la migration, le profil administrateur a tous les droits associés ajoutés. Pour les autres profils, en amont de la migration, nous vous proposons un paramétrage à affiner en concertation avec vous. + +Fonctionnalités avancées +======================== + +Imports +------- + +Les principes régissant les imports dans Ishtar sont détaillés dans la :ref:`section principes `. + +Au niveau du menu « *Imports* », on accède directement à la liste des imports. L'ajout de nouvel import se fait depuis la liste des imports en cours via le bouton « *+ import (table)* » ou le bouton « *+ import (SIG)* », en fonction du type d'import souhaité. Les imports classiques se font via « *+ import (table)* ». En ce qui concerne les imports SIG cf. :ref:`ci-dessus `. + +L'indicateur d'avancement est précis. En effet, la phase de post-traitement est parfois longue et donc, au lieu de rester bloquée à 100%, une jauge s'affiche lorsque celle-ci est en cours. + +Il est possible de corriger les paramètres d'un import si celui-ci n'a pas encore été importé via l'action « *Modifier* ». + +.. image:: _static/imports.png + +Une vérification du codage de caractère est faite lors de l'import d'un fichier CSV. Celle-ci est faite au moment de l'ajout. Cette vérification n'est pas infaillible mais permet d'identifier certaines erreurs d'inattention. + +.. image:: _static/import-erreur.jpg + +Journal des modifications +------------------------- + +À chaque fois qu'une nouvelle version d'Ishtar est déployée un message s'affiche en haut de l'interface utilisateur pour l'inviter à aller regarder les derniers changements dans ce journal. La liste des changements est nécessairement synthétique voire pour certains de nature technique (généralement ces derniers sont rassemblés sous le paragraphe technique et ne sont pas destinés aux utilisateurs non techniciens). Nous vous invitons à consulter l'assistance ou le forum pour des clarifications éventuelles.Dans la liste des changements, un renvoi vers certains numéros de tickets sont fait avec la notation `#1234`. Pour des raisons de confidentialité, tous ces tickets ne sont pas publics. + +Fédération +---------- + +La fédération d'instances Ishtar permet à une instance Ishtar (source) de partager en lecture un sous-ensemble de ses données avec d'autres instances Ishtar (destination). Les données ainsi partagées deviennent accessibles par les instances destinations via l'interface de recherche classique avec un accès aux fiches (certains champs peuvent être cachés par l'instance source), ainsi qu'une possibilité d'export (les champs exportables sont choisis par l'instance source). + +Le partage de données entre instances se fait via une API (protocole inter-ordinateur) sécurisée par une clé et une adresse IP (seule l'adresse IP de la destination peut accéder aux données). + +Configuration +************* + +Une documentation est accessible dans la documentation en ligne d'Ishtar : [Documentation Ishtar - Annexe technique 6 - Configuration de la fédération](https://ishtar.readthedocs.io/fr/main/annexe-tech-6-configuration-syndication.html). + +Utilisation +*********** + +Pour consulter une base fédérée, il est nécessaire que, côté administration de l'instance (cf. documentation citée ci-dessus), la fédération ait été paramétrée, que votre compte utilisateur ait été explicitement ajouté aux comptes ayant accès à cette fédération et que vous ayez activé l'accès aux données fédérées dans votre profil. Une case à cocher « *Source externe - nom de la source externe* » est disponible sur son profil, il suffit de la cocher, de se déconnecter puis se reconnecter. + +.. figure:: _static/federation-profil.png + :width: 85% + :align: center + + Modification du profil + +> Note : il est conseillé de créer un profil explicitement dédié à la consultation des données externes (via la duplication de profil). En effet, les appels multiples à un serveur externe sont à même de provoquer des lenteurs. + +L'accès aux données fédérées se fait alors de manière transparente via un nouvel onglet apparaissant sous la recherche. Chaque recherche est alors faite à la fois sur la base locale ainsi que sur la(les) base(s) fédérée(s). Au niveau des onglets, un badge annonce le nombre d'éléments disponibles dans chaque base pour la recherche actuelle. Les exports CSV des données fédérées se font selon les formats proposés par l'instance source. Les fiches des élements fédérés sont disponibles mais pour respecter la gouvernance des données, l'ouverture des fiches liées est désactivée et certains champs peuvent ne pas apparaître s'ils ont été filtrés par l'instance source. + +.. figure:: _static/federation-recherche.png + :width: 85% + :align: center + + Onglets d'accès aux résultats de recherche dans les différentes bases + +Plan d'intervention (module opérateur préventif) +------------------------------------------------ + +L'utilisation de ce module est explicitée avec sa configuration dans l'annexe +:ref:`annexe 5 - module opérateur préventif `. + + diff --git a/docs/fr/source/index.rst b/docs/fr/source/index.rst index af134de06..064427c30 100644 --- a/docs/fr/source/index.rst +++ b/docs/fr/source/index.rst @@ -11,7 +11,8 @@ Les sections suivantes décrivent les principes généraux du logiciel et explic :caption: Utilisation principes - utilisateur + interface-utilisateur + fonctionnalites Installation/configuration -------------------------- @@ -52,5 +53,6 @@ Ces annexes sont à destination de l'administrateur serveur ou concernent des us annexe-tech-2-ign-communes annexe-tech-3-variables-gen annexe-tech-4-jinja-filters - annexe-tech-5-manage-commands - annexe-tech-6-configuration-syndication + annexe-tech-5-formules + annexe-tech-6-manage-commands + annexe-tech-7-configuration-syndication diff --git a/docs/fr/source/interface-utilisateur.rst b/docs/fr/source/interface-utilisateur.rst new file mode 100644 index 000000000..30b0fe9f8 --- /dev/null +++ b/docs/fr/source/interface-utilisateur.rst @@ -0,0 +1,275 @@ +.. -*- coding: utf-8 -*- + +===================== +Interface utilisateur +===================== + +:Auteur: Étienne Loks +:Date: 2018-10-02 +:Copyright: CC-BY 3.0 + + +--------------------- + + +Interface générale +================== + +L'interface générale se découpe en 4 zones : + +1. zone de profil +2. menu d'actions +3. zone centrale +4. zone d'alerte et de sélection épinglée + +.. image:: _static/interface-generale.png + +La capture d'écran ci-dessous reprend l'interface « bureau ». L'interface mobile reprend les mêmes éléments dans une version compacte : la zone de profil est accessible via l'icône « hamburger » à droite, le menu d'action est repris en haut en position centrale. + + +Zone de profil +-------------- + +La zone de profil reprend, dans l'ordre : + +- le nom de l'instance Ishtar (ici « Démo »), +- le nom de l'utilisateur et le nom du profil en cours d'utilisation - en cliquant sur ces noms, on accède à un sous-menu permettant de modifier son profil, changer son mot de passe, se déconnecter et consulter le journal des modifications. +- si plusieurs langues sont disponibles, une icône « drapeau » qui permet de changer la langue, +- si on a les droits administrateur, une icône « engrenage » qui permet d'accéder aux pages spécifiques d'administration (cf. documentation administrateur). + +Menu d'actions +-------------- + +Ce menu reprend les différentes pages disponibles en fonction des droits dont dispose l'utilisateur et des modules activés dans Ishtar. +Visible à tout moment il permet visuellement d'identifier immédiatement le contexte. +Ce menu est organisé de manière hiérarchique : + +- le premier niveau reprend les éléments généraux : « Opération », « Unité d'Enregistrement », « Mobilier », etc. ainsi que des sections génériques telles que « Imports » ou « Annuaire ». +- le second niveau fournit le détail des actions disponibles en fonction du premier niveau sélectionné. Classiquement pour les éléments généraux (si l'on dispose des droits adéquats), il y des actions de « Recherche », « Ajout », « Modification » et « Suppression ». Si des sous-élements sont disponibles (par exemple, les « Contenants » dans le menu « Lieu de conservation »), ils sont accessibles après ces actions de base. +- le troisième niveau rend disponible les actions des sous-éléments. + +La sélection d'un élément du premier niveau charge automatiquement la page de la première action du second niveau. De même la sélection d'un sous-menu dans le second niveau charge automatiquement la première action du troisième niveau correspondant. + +Zone centrale +------------- + +La zone centrale est totalement contextuelle. Néanmoins si certaines pages d'action ont une logique particulière, la plupart des pages d'action sur les éléments généraux s'ouvrent sur une « :ref:`zone de recherche ` » et les actions d'ajout, modification et suppression suivent ensuite une logique de « :ref:`formulaires de saisie pas-à-pas ` » (ou wizards). Le détail de ces pages est décrit dans les sections suivantes de cette documentation. + +Zone d'alerte et de sélection épinglée +-------------------------------------- + +Cette zone reprend les éventuelles alertes (cf. :ref:`Zone de recherche > Marques-pages et alertes `), mise en place par l'utilisateur ainsi que (si l'affichage de ceux-ci est activé) les éléments actuellement épinglés (cf. :ref:`Utilisation avancée > Éléments épinglés `). + +.. _zone-de-recherche: + +Zone de recherche +================= + +La zone de recherche comporte une barre de recherche et un tableau de résultat. + + +Recherche textuelle et par critères +----------------------------------- + +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). + +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. + +Plus précisément : + +- l'index de recherche d'une opération comprend les propriétés des sites(entités) archéologiques lié(e)s ; +- l'index de recherche d'un(e) site(entité) archéologique comprend les propriétés des opérations liées ; +- l'index de recherche d'une Unité d'Enregistrement comprend les propriétés des opérations et des sites(entités) archéologiques lié(e)s ; +- l'index de recherche du mobilier comprend les propriétés des opérations, des sites(entités) archéologiques et des Unités d'Enregistrement lié(e)s. + +En revanche tous les champs de la base ne sont pas indexés, ceci afin que les résultats restent cohérents. + +Les index de recherche permettent de faire des recherches en s'affranchissant des pluriels et de la casse. + +**Exemple** : des recherches sur les termes « AMPHORE », « AMPHORES » et « amphores » renverront bien tous les éléments concernant des amphores. + +.. note:: Par choix de ne pas intégrer des résultats trop éloignés de la recherche initiale, les fautes de frappe et d'orthographe ne sont pas prises en charge. Les recherches par orthographe approximative sont plus adaptées à des interfaces grand public qu'à des bases de données métier. Concrètement lorsque l'on cherche avec le terme « amphore », les résultats deviennent peu pertinents si par exemple nous sont renvoyés des éléments évoquant un « phare » dans sa description. En revanche la recherche libre comprend tout terme de recherche avec le sens « Commence par ». Ainsi une recherche sur ``amp`` renverra autant les amphore que les ampoules. + +Adjoindre plusieurs termes correspond à faire une recherche avec l'opérateur logique *ET*. + +**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. + +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. + +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. + +**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. + +.. _bookmarks: + +Marques-pages et alertes +------------------------ + +Les marques-pages permettent de stocker une recherche pour la retrouver plus aisément plus tard. Ceux-ci sont alors directement disponibles depuis le menu qui s'ouvre lorsque l'on clique sur l'icône marque-page de la barre de recherche. + +Techniquement le contenu d'un marque-page correspond à la chaîne de texte utilisé dans la zone de recherche. Ainsi (contrairement aux :ref:`paniers `) c'est la requête qui est stockée et donc la liste d'éléments est à même de varier au cours du temps. + +On peut stocker indifféremment des requêtes en recherche libre ou en recherche par critère. + +Une alerte est un marque-page mis en évidence : il est toujours disponible en haut à gauche de l'interface (à gauche de la zone 4 sur l'image de l'interface générale) avec un badge contenant le nombre d'éléments contenu. En cliquant sur cette alerte, on accède directement au tableau de cette recherche. + +Tableaux +-------- + +Les tableaux se présentent de la même manière que les tableaux web « classiques » avec possibilité d'afficher plus ou moins de lignes de tableaux (entre 10 et 100), possibilité de tri par colonne et pagination. + +Dans Ishtar, la première colonne est systématiquement une icône permettant d'accéder à la :ref:`fiche ` associé à l'élément de cette ligne du tableau. + +En tant qu'administrateur, sur certains tableaux, des actions rapides en haut à droite permettent des actions sur les éléments actuellement sélectionnés. + +En bas à gauche du tableau, un bouton permet d'afficher le tableau en pleine page pour une meilleure lisibilité. + +À la suite de ce bouton différents boutons d'export en CSV du tableau courant sont disponibles. Ces exports peuvent être configurés en administration. + +.. _sheet: + +Fiches +------ + +En s'ouvrant, les fiches se placent au-dessus de la page courante (généralement au dessus d'un tableau). + +Entête +++++++ + +Une fiche se compose tout d'abord d'une entête. Cette entête est composée de : + +- un titre : ce titre reprend la dénomination précise de l'élément. En cliquant sur ce titre, la fiche se replie. +- de flèches de navigations (si pertinent) : dans le cadre d'une fiche ouverte depuis un tableau, ces flèches permettent de naviguer entre les éléments du tableau. Il n'est possible pour l'instant que de naviguer parmi les éléments actuellement affichés dans le tableau. +- d'une croix de fermeture de la fiche. + +Barre d'outil ++++++++++++++ + +Juste en dessous de l'entête une barre d'outil est présente. + +Tout à gauche, lorsque plusieurs versions d'une même fiche sont disponibles, il est possible de naviguer parmi les différentes versions de cette fiche. + +Ensuite sur la droite, différentes actions sont disponibles. Ces actions dépendent du type d'élément sélectionné. Généralement on y trouve : + +- une icône « épingle » : elle permet d'épingler l'élément de la fiche (cf. :ref:`épinglage `). +- une icône « crayon » : si l'on dispose des droits adéquats, elle permet de modifier/compléter cette fiche. On accède au premier volet des pages d'assistants dédié à l'édition de ce type d'élément. +- des icônes « + » : ces icônes permettent d'associer facilement un type particulier d'élément à l'élément de la fiche courante. Par exemple « + doc./image » permet d'associer un document/une image à l'élément de la fiche. +- un menu « exporter » : les éléments de ce menu permettent un export dans différement format de la fiche actuelle. + +Contenu de la fiche ++++++++++++++++++++ + +Les fiches présentent globalement les informations relatives à un élément. + +Lorsque ces informations sont en relations avec d'autres éléments qui disposent eux aussi des fiches une icône « i » d'information est affiché à côté permettant ainsi de sauter de fiche en fiche. + +Navigation entre fiches ++++++++++++++++++++++++ + +Un rappel des fiches ouvertes est disponible sur la droite. En cliquant sur un élément de cette liste, la page scrolle jusque la fiche correspondante. + +.. _wizard: + +Formulaires de saisie pas-à-pas +=============================== + +Dans Ishtar, pour la plupart des éléments complexes, les formulaires de saisie pas-à-pas se présentent sous la forme d'« assistant logiciel ». Un assistant logiciel, découpe la saisie en plusieurs pages. Ces pages permettent une structuration logique de l'information. Ainsi en fonction des modules activés et des informations renseignées le contenu et l'affichage des panneaux est dynamique. + +**Exemple** : lors de la saisie d'une opération préventive, d'une opération programmée, d'une saisie judiciaire, les panneaux affichés sont différents. + +Les panneaux enchaînent les formulaires jusqu'au dernier panneau de récapitulatif qui demandera confirmation des changements opérés. Tant que la validation finale n'est pas faite aucune donnée n'est enregistrée en base de données. + +Jusqu'à la validation finale, les données de formulaire sont enregistrées dans la session de l'utilisateur. L'utilisateur peut tout à fait avoir plusieurs saisies d'éléments de nature différente en parallèle. Attention à la déconnexion ou à expiration de la session ces données de formulaires sont effacées. + +Fil d'Ariane +------------ + +Tout en haut des pages des formulaires de saisie pas-à-pas, un fil d'Ariane est affiché. Celui-ci permet de naviguer rapidement entre les différents panneaux. En modification la navigation est libre. En saisie, certains panneaux requérant des informations obligatoires ne peuvent pas être passés : le fil d'Ariane s'adapte automatiquement et affiche les étapes jusqu'au prochain panneau obligatoire. + +Tableau / Zone de formulaire +---------------------------- + +En saisie, en général, deux types de panneau sont disponibles : un type « tableau » et un type « zone de formulaire ». + +Les types de page « tableau » permettent de sélectionner un élément tout en profitant des possibilités de recherche, filtre, tri évoqués précédemment. Ces types de pages permettent de sélectionner l'élément que l'on souhaite modifier ou l'élément parent de l'élément que l'on souhaite créer. + +Les types de page « zone de formulaire » sont des formulaires web classiques. Ils offrent quelques facilitées tel que la saisie de dates en cliquant dans un calendrier, des conversions d'unités dynamiques, etc. Certains contrôles de formulaire sont réalisés de manière dynamique (par exemple une saisie textuelle dans un champ qui attend un chiffre), d'autres sont réalisés après envoi au serveur (par exemple, utilisation d'un index déjà utilisé par ailleurs). + +Zone de validation +------------------ + +La zone de validation se situe tout en bas de la page. +Les boutons « Valider » et « Annuler » sont toujours disponibles. + +« Valider » permet de valider le panneau en cours et de passer au panneau suivant. Si c'est le dernier panneau, le panneau de récapitulatif, la création/modification/suppression est validée. En création/modification, l'utilisateur est redirigé vers la fiche de l'élément qui vient d'être créé/modifié. + +« Annuler » permet d'annuler toute la saisie en cours : les données de session seront effacées. + +« Valider et confirmer » (qui s'insère entre « Valider » et « Annuler ») permet de valider le panneau actuel et d'aller directement au panneau récapitulatif. + +Utilisation avancée +=================== + +.. _basket: + +Paniers +------- + +Les paniers sont un autre type de sélection d'éléments. Contrairement aux marques-pages, ils concernent une liste d'éléments fixe. + +Pour effectuer certaines actions, il est nécessaire de préalablement constituer un panier (notamment pour ce qui concerne les traitements). + +Ce regroupement virtuel peut être aussi un outil de travail, par exemple en constituant une liste d'éléments « à traiter ». Un marque-page (voire une alerte) pouvant être faite sur le contenu d'un panier, cela permet de conserver sous la main cette sélection d'éléments. + +Pour l'heure les paniers ne concernent que le mobilier. + +.. _pinned: + +Éléments épinglés +----------------- + +Les éléments épinglés constituent les éléments « par défaut » en terme de recherche. +L'épinglage d'élément est un outil de travail permettant de travailler dans un contexte donné. + +L'épinglage est disponible directement dans la barre d'outil des fiches et au niveau de la barre de recherche. + +Action rapide +------------- + +Pour les administrateurs, des actions rapides sont directement accessibles depuis les tableaux. Ces actions se situent en haut à droite du tableau. Elles concernent les éléments actuellement sélectionnés dans le tableau. Les icônes d'action rapide ne sont actives que lorsque cela est pertinent : si une action n'est applicable qu'à un seul élément, en sélectionner aucun ou plusieurs désactive l'icône de l'action en question. + +Ces actions rapides permettent notamment de faire de l'édition de groupe, de l'empaquetage, etc. + +.. + TODO: expliciter les droits ? les notions de propriétés ? diff --git a/docs/fr/source/principes.rst b/docs/fr/source/principes.rst index ca721ab62..ac902fe4b 100644 --- a/docs/fr/source/principes.rst +++ b/docs/fr/source/principes.rst @@ -8,6 +8,8 @@ Principes :Date: 2020-11-23 :Copyright: CC-BY 3.0 +---------------------------------- + Ce document présente les grands principes qui structurent Ishtar. Présentation @@ -44,36 +46,88 @@ Fonctionnalités La version actuelle permet d'accomplir les tâches suivantes : -- saisie des opérations, -- saisie des unités d'enregistrement (UE), -- saisie du mobilier archéologique, -- association à de la documentation, -- production automatique d'inventaires conformes (UE, mobilier, documents), -- gestionnaire de médias (stockage et gestion des photos, pdf des rapports, etc.), -- personnalisation des formulaires (ajouts de champs personnalisés, choix de l'affichage des champs Ishtar), -- imports paramétrables et archivables, incluant éventuellement les liens vers des images, depuis des fichiers tabulaires (format csv, fichier zip pour les images), -- recherche avancée (recherche plein texte et par critère, enregistrement de recherche, gestion d'alertes), -- exports (csv) suite à une recherche ou par élément sélectionné (opération, UE, mobilier), -- production de documents formatés (patrons au format odt), -- production de fiches types pour les opérations, UE ou mobilier (format odt et pdf), -- tableau de bord produisant automatiquement des statistiques et des graphiques, -- connexion (jointure) avec un SIG (testé avec QGIS), - -Module administratif -******************** - -- saisie des dossiers, -- ajout d'actes administratifs (courriers, arrêtés, etc.), -- production automatique de courriers administratifs (accusés de réception, etc.), - -Module lieux de conservation -**************************** - -- gestion des mouvements de mobilier, -- production automatique de documents tels conventions de prêts, fiches d'état, etc. -- conditionnement, -- sélection par « panier », -- gestion des contenants et étiquetage : il n'est pas prévu qu'Ishtar génère directement des étiquettes (pdf) mais plutôt des fichiers csv pouvant être utilisés selon tout format d'étiquette via « publi-postage » dans un logiciel tiers (libre-office, excel, etc.). +**Module Base (« opérations ») et fonctionnalités transversales** + +* saisie des opérations, +* saisie des unités d'enregistrement (UE), +* saisie du mobilier archéologique, +* association à de la documentation, +* gestion des médias (stockage et gestion des photos, pdf des rapports, etc.), +* production automatique d'inventaires conformes (UE, mobilier, documents), +* imports paramétrables et archivables, incluant éventuellement les liens vers des images, depuis des fichiers tabulaires (format csv, fichier zip pour les images), +* recherches diverses, en texte libre ou par paramètres, avec affichage des résultats sous forme de tableaux, galeries d'images et statistiques paramétrables, +* exports (csv) suite à une recherche ou par élément sélectionné (opération, UE, mobilier), +* génération automatiques de documents d'après des patrons au format odt (format OpenDocument lisible par Libre/Open Office et Word), +* production de fiches types pour les opérations, UE ou mobilier (format odt et pdf), +* personnalisation des formulaires (ajouts de champs personnalisés, choix de l'affichage des champs Ishtar), +* fédération d’instances : Une instance source peut partager en lecture un sous-ensemble de ses données avec des instances destinataires, avec possibilité d’export (Partage contrôlable et sécurisé) + +**Module Dossiers/administratif** + +* saisie des dossiers, +* ajout d'actes administratifs (courriers, arrêtés, etc.), +* production automatique de courriers administratifs (accusés de réception, etc.), + +**Module Opérateur préventif (extension du module dossier)** + +* rédaction de plan d’intervention, +* gestion / suivi des coûts (coûts forfaitaires ou à l’unité, en fouille, post-fouille, estimés et réels). + +**Module Site/Entité archéologique** + +* saisie de données archéologiques connues, +* association à des opérations en cours, +* exports (csv) suite à une recherche ou par élément sélectionné. + +**Module Unités d’enregistrements** + +* saisie des unités d'enregistrement (UE) en lien avec une OA, +* association à un numéro de parcelle. + +**Module Mobilier** + +* saisie du mobilier, +* association à une UE, +* association a de la documentation. + +**Module Lieux de conservation** + +* gestion des mouvements de mobilier, +* production automatique de documents tels conventions de prêts, fiches d'état, etc. +* conditionnement, +* sélection par « panier », +* gestion des contenants et étiquetage (patrons odt), + +**Module Conservation** + +* ajout de champs propres à la conservation dans le formulaire mobilier, +* gestion des traitements (on peut documenter tous les évènements d'un mobilier après sa mise au jour, que ce soit une radiographie, une restauration ou un prêt pour une exposition, ...), +* gestion des demandes de traitement (enregistrement des demandes reçues, exemple demande de prêt pour étude ou exposition), +* génération automatique de documents administratifs liés (convention de dépôt, etc.), + +**Module Archéologie sous-marine** + +* ajout de champs propres à l'archéologie sous-marine dans les différents formulaires, + +**Module Cartographie** + +.. image:: _static/cartographie_operations.jpg + :class: image-right + :alt: exemple cartographie des opérations d'une instance Ishtar + +* gestion des différents système de coordonnées de référence (SRC) via leurs codes EPSG, +* gestion des coordonnées (mobilier, unités d'enregistrements, sites, opérations archéologiques, communes) sous forme de point et/ou polygone, +* affichage des résultats de recherche sous forme cartographique, +* connexion (jointure) avec un SIG (testé avec QGIS). + +**Module Musée** + +* ajout de champs propres à la régie des collections muséales dans le formulaire mobilier. + +**Portail** + +* portail public vitrine (mini-CMS fonctionnant avec une API Ishtar, permettant l'affichage de paniers de mobilier avec leurs notices). + Modules / configuration ======================= @@ -82,11 +136,11 @@ Selon le périmètre fonctionnel dans lequel Ishtar est utilisé, il convient d' .. note:: L'activation / désactivation d'un module ne change jamais la structure des données. Il est tout à fait possible d'activer ponctuellement un module sans que cela n'altère les données en base. -Des dépendances entre modules existent. Ces dépendances sont logiques et se comprennent aisément si l'on a intégré la structure de la base de données d'Ishtar (cf. :ref:`structure-de-la-base-de-données`). En cas de doute, si une dépendance est manquante lors de l'activation du module un message explicite est donné. +Des dépendances entre modules existent. Ces dépendances sont logiques et se comprennent aisément si l'on a intégré la structure de la base de données d'Ishtar (cf. :ref:`structure-de-la-base-de-données`). Si une dépendance est manquante lors de l'activation du module un message explicite est donné. -L'activation des modules est faite en administration sur la page de configuration d'instance Ishtar (cf. :ref:`documentation administrateur `). +L'activation des modules est faite en administration sur la page de configuration d'instance Ishtar (cf. :ref:`documentation administration applicative `). -Par ailleurs au niveau de la configuration d'instance Ishtar un certain de nombre de paramètres de fonctionnement Ishtar peuvent être ajustés. Ceux-ci sont détaillés dans la :ref:`documentation administrateur `. +Par ailleurs au niveau de la configuration d'instance Ishtar un certain de nombre de paramètres de fonctionnement Ishtar peuvent être ajustés. Ceux-ci sont détaillés dans la :ref:`documentation administration applicative `. .. warning:: Contrairement à l'activation des modules, certains paramètres ont une incidence importante sur les données stockées dans Ishtar, notamment en ce qui concerne la gestion des identifiants mobiliers, des identifiants documents, etc. En tant qu'administrateur, si vous souhaitez une configuration différente de la configuration par défaut d'Ishtar, il est nécessaire de modifier ces paramètres en amont. @@ -96,7 +150,7 @@ Structure de la base de données =============================== La base de données n'est pas détaillée table par table dans cette documentation mais nous allons vous présenter les grandes notions utilisées. -La structure présentée peut apparaître rigide mais c'est un mal nécessaire pour une certaine standardisation de données archéologiques. Par ailleurs les concepts sont très larges et d'expérience s'adapte très bien à la plupart des contextes. +La structure présentée peut apparaître rigide mais c'est un mal nécessaire pour une certaine standardisation des données archéologiques. Par ailleurs les concepts sont très larges et d'expérience s'adapte très bien à la plupart des contextes. .. image:: _static/graphique_structure_ishtar.png @@ -107,7 +161,7 @@ Opération archéologique L'opération archéologique est le cœur du modèle de données d'Ishtar. Au sein d'Ishtar, l'opération archéologique est définie comme une action (ou un projet d'action) permettant d'acquérir des données archéologiques, sous la responsabilité d'une personne (exemples : découverte fortuite, diagnostic, fouille programmée, prospection, etc.) et dans un lieu si possible défini. -Si l'opération est au centre du modèle de données d'Ishtar plutôt que le site ou l'entité archéologique, c'est parce que ce dernier est une interprétation (comme toute interprétation, sujette à évolution dans le temps) des données, alors que l'opération est l'information qui permet au mieux de regrouper un corpus documentaire cohérent mettant en lien des documents (plans, rapports, photos, etc.) et du mobilier. +Si l'opération est au centre du modèle de données d'Ishtar plutôt que le site (ou l'entité archéologique), c'est parce que ce dernier est une interprétation des données (et comme toute interprétation, sujette à évolution dans le temps), alors que l'opération est l'information qui permet au mieux de regrouper un corpus documentaire cohérent mettant en lien des documents (plans, rapports, photos, etc.) et du mobilier. Il est possible de créer des liens entre des opérations, soit en les associant à un même dossier source (avec le module « administratif », ex. : un permis de construire qui est associé à un diagnostic et une fouille préventive), soit en définissant une relation entre des opérations globales (ex. : PCR, suivi d'autoroutes, etc.) et d'autres plus ponctuelles (phases, tranches, secteurs, etc.). Le regroupement d'opérations est également pratique en contexte de fouilles programmées, où il peut être utile d'avoir des inventaires pour chaque opération par année, mais également une vision globale de la succession des fouilles (opération globale). En contexte de grande opération préventive, ce système peut servir à individualiser des secteurs de fouilles disposant de modes d’enregistrements spécifiques. L'utilisateur a toute latitude pour organiser les opérations entres elles selon ses besoins, du moment que ces éléments clefs représentent bien des lots documentaires et mobilier a priori cohérents. @@ -120,7 +174,7 @@ Malgré le choix de l'opération comme rôle central de son modèle de données, Parcelle -------- -Les parcelles sont gérées précisément au sein d'Ishtar en étant directement rattachées aux UE. Cela permet de faciliter la gestion des questions légales concernant le mobilier (réalisation du « partage » ou responsabilité en cas de restauration). Si la parcelle de l'UE n'est pas connue ou si elle n'est pas sujette a contrainte légale, il est possible d'associer une parcelle virtuelle ou de ne pas renseigner ce champ. +Les parcelles sont gérées précisément au sein d'Ishtar en étant directement rattachées aux UE. Cela permet de faciliter la gestion des questions légales concernant le mobilier (réalisation du « partage » ou responsabilité en cas de restauration). Si la parcelle de l'UE n'est pas connue ou si l'instance n'est pas sujette a contrainte légale, il est possible d'associer une parcelle inconnue ou de ne pas renseigner ce champ. Unité d'enregistrement ---------------------- @@ -145,7 +199,7 @@ Le mobilier tel qu'habituellement compris se découpe en deux sous-éléments au Le mobilier d'origine comprend les informations invariantes tout au long de la vie de l'objet, telle que son contexte de découverte, son inventeur, etc. Le mobilier actuel (généralement juste appelé « mobilier » au sein d'Ishtar) permet de caractériser l'objet tout au long de sa vie. -Le distinguo entre de ces deux notions permet notamment une gestion fine des traitements simples (destructif ou non) et complexes (tri, remontage, etc.) avec une connaissance précise de l'historique de l'objet (lieux, responsables et documentations peuvent être associées à chaque traitement). +Le distinguo entre ces deux notions permet notamment une gestion fine des traitements simples (destructif ou non) et complexes (tri, remontage, etc.) avec une connaissance précise de l'historique de l'objet (lieux, responsables et documentations peuvent être associées à chaque traitement). Sur la figure ci-dessous chaque « Fiche mobilier » correspond à un élément « mobilier actuel » en base de données. Chaque élément et chaque traitement a une fiche associée. @@ -156,7 +210,7 @@ Mobilier - Demande de traitement La gestion des demandes de traitement au sein d'Ishtar est prévue pour permettre d'archiver les documents liés à toute demande ou préparation de traitement. Elle permet de générer automatiquement des documents liés à chaque contexte. -Par exemple, lors de la réception d'une demande de prêt de mobilier pour une expo, créer une demande de traitement dans Ishtar permet d'enregistrer la demande, puis de générer automatiquement (selon les modèles définis sur l'instance) une réponse de refus ou au contraire une convention de prêt (à la suite de quoi, une fois la convention dûment signée, l'on créera le traitement Prêt associé). +Par exemple, lors de la réception d'une demande de prêt de mobilier pour une expo, créer une demande de traitement dans Ishtar permet d'enregistrer la demande, puis de générer automatiquement (selon les patrons de documents définis sur l'instance) une réponse de refus ou au contraire une convention de prêt (à la suite de quoi, une fois la convention dûment signée, l'on créera le traitement Prêt associé). Lors d'un besoin de restauration, créer une demande de traitement dans Ishtar permet de générer une demande de devis, puis éventuellement d'archiver les devis reçus, avant de créer le traitement Restauration avec le prestataire choisi. @@ -181,6 +235,8 @@ Pour alimenter Ishtar en données, on distingue 3 modes opératoires : Chacun de ces modes offrent avantages et inconvénients qu'il faut avoir en tête pour utiliser Ishtar de manière optimale. +.. _principes-import: + Import ------ @@ -339,7 +395,6 @@ L'arbre de prise en compte des éléments parents pour les données géographiqu .. note:: Dans le profil d'instance, il est possible d'activer un degré d'imprécision. Cela permet de mettre un positionnement approximatif des éléments sur la fiche au cas où ces fiches seraient consultables par des tiers non dignes de confiance. Pour ce faire, les coordonnées sont tronquées (X nombres après la virgule) pour l'affichage (les données en base de données restent inchangées). La troncature est opérée sur les coordonnées en WGS 84 (latitude/longitude). - .. TODO: Parler d'historisation diff --git a/docs/fr/source/utilisateur.rst b/docs/fr/source/utilisateur.rst deleted file mode 100644 index c34d08f63..000000000 --- a/docs/fr/source/utilisateur.rst +++ /dev/null @@ -1,296 +0,0 @@ -.. -*- coding: utf-8 -*- - -======================== -Documentation utilisateur -======================== - -:Auteur: Étienne Loks -:Date: 2018-10-02 -:Copyright: CC-BY 3.0 - - ----------------------------- - - -Interface générale -================== - -L'interface générale se découpe en 4 zones : - -1. zone de profil -2. menu d'actions -3. zone centrale -4. zone d'alerte et de sélection épinglée - -.. image:: _static/interface-generale.png - -La capture d'écran ci-dessous reprend l'interface « bureau ». L'interface mobile reprend les mêmes éléments dans une version compacte : la zone de profil est accessible via l'icône « hamburger » à droite, le menu d'action est repris en haut en position centrale. - - -Zone de profil --------------- - -La zone de profil reprend, dans l'ordre : - -- le nom de l'instance Ishtar (ici « Démo »), -- le nom de l'utilisateur et le nom du profil en cours d'utilisation - en cliquant sur ces noms, on accède à un sous-menu permettant de modifier son profil, changer son mot de passe et se déconnecter, -- si plusieurs langues sont disponibles, une icône « drapeau » qui permet de changer la langue, -- si on a les droits administrateur, une icône « engrenage » qui permet à accéder aux pages spécifiques d'administration (cf. documentation administrateur). - -Menu d'actions --------------- - -Ce menu reprend les différentes pages disponibles en fonction des droits dont dispose l'utilisateur et des modules activés dans Ishtar. -Visible à tout moment il permet visuellement d'identifier immédiatement le contexte. -Ce menu est organisé de manière hiérarchique : - -- le premier niveau reprend les éléments généraux : « Opération », « Unité d'Enregistrement », « Mobilier », etc. ainsi que des sections génériques telles que « Imports » ou « Annuaire ». -- le second niveau fournit le détail des actions disponibles en fonction du premier niveau sélectionné. Classiquement pour les éléments généraux (si l'on dispose des droits adéquats), il y des actions de « Recherche », « Ajout », « Modification » et « Suppression ». Si des sous-élements sont disponibles (par exemple, les « Contenants » dans le menu « Lieu de conservation »), ils sont accessibles après ces actions de base. -- le troisième niveau rend disponible les actions des sous-éléments. - -La sélection d'un élément du premier niveau charge automatiquement la page de la première action du second niveau. De même la sélection d'un sous-menu dans le second niveau charge automatiquement la première action du troisième niveau correspondant. - -Zone centrale -------------- - -La zone centrale est totalement contextuelle. Néanmoins si certaines pages d'action ont une logique particulière, la plupart des pages d'action sur les éléments généraux s'ouvrent sur une « :ref:`page de recherche ` » et les actions d'ajout, modification et suppression suivent ensuite une logique de « :ref:`page d'assistant logiciel ` » (ou wizard). Le détail de ces pages est décrit dans les sections suivantes de cette documentation. - -Zone d'alerte et de sélection épinglée --------------------------------------- - -Cette zone reprend les éventuelles alertes (cf. :ref:`Page de recherche > Marques-pages et alertes `), mise en place par l'utilisateur ainsi que (si l'affichage de ceux-ci est activé) les éléments actuellement épinglés (cf. :ref:`Utilisation avancée > Éléments épinglés `). - -.. _page-de-recherche: - -Page de recherche -================= - -La page de recherche comporte une barre de recherche et d'un tableau de résultat. - - -Recherche textuelle et par critères ------------------------------------ - -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 « engrenage » : 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). - -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. - -Plus précisément : - -- l'index de recherche d'une opération comprend les propriétés des sites(entités) archéologiques lié(e)s ; -- l'index de recherche d'un(e) site(entité) archéologique comprend les propriétés des opérations liées ; -- l'index de recherche d'une Unité d'Enregistrement comprend les propriétés des opérations et des sites(entités) archéologiques lié(e)s ; -- l'index de recherche du mobilier comprend les propriétés des opérations, des sites(entités) archéologiques et des Unités d'Enregistrement lié(e)s. - -En revanche tous les champs de la base ne sont pas indexés, ceci afin que les résultats restent cohérents. - -Les index de recherche permettent de faire des recherches en s'affranchissant des pluriels et de la casse. - -**Exemple** : des recherches sur les termes « AMPHORE », « AMPHORES » et « amphores » renverront bien tous les éléments concernant des amphores. - -.. note:: Par choix de ne pas intégrer des résultats trop éloignés de la recherche initiale, les fautes de frappe et d'orthographe ne sont pas prises en charge. Les recherches par orthographe approximative sont plus adaptées à des interfaces grand public qu'à des bases de données métier. Concrètement lorsque l'on cherche avec le terme « amphore », les résultats deviennent peu pertinents si par exemple nous sont renvoyés des éléments évoquant un « phare » dans sa description. En revanche la recherche libre comprend tout terme de recherche avec le sens « Commence par ». Ainsi une recherche sur ``amp`` renverra autant les amphore que les ampoules. - -Adjoindre plusieurs termes correspond à faire une recherche avec l'opérateur logique *ET*. - -**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. - -Recherche par critère -+++++++++++++++++++++ - -En cliquant sur l'icône engrenage, 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 ce formulaire peut avoir été personnalisé sur votre installation Ishtar, permettant de cacher certains champs inutiles ou 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. - -**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. - -.. _bookmarks: - -Marques-pages et alertes ------------------------- - -Les marques-pages permettent de stocker une recherche pour la retrouver plus aisément plus tard. Ceux-ci sont alors directement disponibles depuis le menu qui s'ouvre lorsque l'on clique sur l'icône marque-page de la barre de recherche. - -Techniquement le contenu d'un marque-page correspond à la chaîne de texte utilisé dans la zone de recherche. Ainsi (contrairement aux :ref:`paniers `) c'est la requête qui est stockée et donc la liste d'éléments est à même de varier au cours du temps. - -On peut stocker indifféremment des requêtes en recherche libre ou en recherche par critère. - -Une alerte est un marque-page mis en évidence : il est toujours disponible en haut à gauche de l'interface (à gauche de la zone 4 sur l'image de l'interface générale) avec un badge contenant le nombre d'éléments contenu. En cliquant sur cette alerte, on accède directement au tableau de cette recherche. - -Tableaux --------- - -Les tableaux se présentent de la même manière que les tableaux web « classiques » avec possibilité d'afficher plus ou moins de lignes de tableaux (entre 10 et 100), possibilité de tri par colonne et une pagination. - -Dans Ishtar, la première colonne est systématiquement une icône permettant d'accéder à la :ref:`fiche ` associé à l'élément de cette ligne du tableau. - -En tant qu'administrateur, sur certains tableaux, des actions rapides en haut à droite permettant des actions sur les éléments actuellement sélectionnés. - -En bas du tableau, sur la gauche un bouton permet d'afficher le tableau en pleine page pour une meilleure lisibilité. - -À la suite de ce bouton différents boutons d'export en CSV du tableau courant sont disponibles. Ces exports peuvent être configurés en administration. - -.. _sheet: - -Fiches ------- - -En s'ouvrant, les fiches se placent au-dessus de la page courante (généralement au dessus d'un tableau). - -Entête -++++++ - -Une fiche se compose tout d'abord d'une entête. Cette entête est composée de : - -- un titre : ce titre reprend la dénomination précise de l'élément. En cliquant sur ce titre, la fiche se replie. -- de flèches de navigations (si pertinent) : dans le cadre d'une fiche ouverte depuis un tableau, ces flèches permettent de naviguer entre éléments du tableau. Il n'est possible pour l'instant que de naviguer parmi les éléments actuellement affichés dans le tableau. -- d'une flèche de fermeture de la fiche. - -Barre d'outil -+++++++++++++ - -Juste en dessous de l'entête une barre d'outil est présente. - -Tout à gauche, lorsque plusieurs versions d'une même fiche sont disponibles, il est possible de naviguer parmi les différentes versions de cette fiche. - -Ensuite sur la droite, différentes actions sont disponibles. Ces actions dépendent du type d'élément sélectionné. Généralement on y trouve : - -- une icône « épingle » : elle permet d'épingler l'élément de la fiche (cf. :ref:`épinglage `). -- une icône « crayon » : si l'on dispose des droits adéquats, elle permet d'éditer cette fiche. On accède au premier volet des pages d'assistants dédié à l'édition de ce type d'élément. -- des icônes « + » : ces icônes permettent d'associer facilement un type particulier d'élément à l'élément de la fiche courante. Par exemple « + doc./image » permet d'associer un document/une image à l'élément de la fiche. -- un menu « exporter » : les éléments de ce menu permettent un export dans différement format de la fiche actuelle. - -Contenu de la fiche -+++++++++++++++++++ - -Les fiches présentent globalement les informations relatives à un élément. - -Lorsque ces informations sont en relations avec d'autres éléments qui disposent eux aussi des fiches une icône « i » d'information est affiché à côté permettant ainsi de sauter de fiche en fiche. - -Navigation entre fiches -+++++++++++++++++++++++ - -Un rappel des fiches ouvertes est disponible sur la droite. En cliquant sur un élément de cette liste, la page scrolle jusque la fiche correspondante. - -.. _wizard: - -Page d'assistant logiciel (wizard) -================================== - -Dans Ishtar, pour la plupart des éléments complexes, les pages d'édition se présentent sous la forme d'« assistant logiciel ». Un assistant logiciel, découpe la saisie en plusieurs pages. Ces pages permettent une structuration logique de l'information. Ainsi en fonction des modules activés et des informations renseignées le contenu et l'affichage des panneaux est dynamique. - -**Exemple** : les panneaux disponibles lors de la saisie d'une opération préventive, d'une opération programmée, d'une saisie judiciaire, les panneaux affichés sont différents. - -Les panneaux enchaînent les formulaires jusqu'au dernier panneau de récapitulatif qui demandera confirmation des changements opérés. Tant que la validation finale n'est pas faite aucune donnée n'est enregistrée en base de données. - -Jusqu'à la validation finale, les données de formulaire sont enregistrées dans la session de l'utilisateur. L'utilisateur peut tout à fait avoir plusieurs saisies d'éléments de nature différente en parallèle. Attention à la déconnexion ou à expiration de la session ces données de formulaires sont effacées. - -Fil d'Ariane ------------- - -Tout en haut des pages d'assistant logiciel, un fil d'Ariane est affiché. Celui-ci permet de naviguer rapidement entre les différents panneaux. En modification la navigation est libre. En saisie, certains panneaux requérant des informations obligatoires ne peuvent pas être passés : le fil d'Ariane s'adapte automatiquement et affiche les étapes jusqu'au prochain panneau obligatoire. - -Tableau / Zone de formulaire ----------------------------- - -En saisie, en général, deux types de panneau sont disponibles : un type « tableau » et un type « zone de formulaire ». - -Les types de page « tableau » permettent de sélectionner un élément tout en profitant des possibilités de recherche, filtre, tri évoqués précédemment. Ces types de pages permettent de sélectionner l'élément que l'on souhaite modifier ou l'élément parent de l'élément que l'on souhaite créer. - -Les types de page « zone de formulaire » sont des formulaires web classiques. Ils offrent quelques facilitées tel que la saisie de dates en cliquant dans un calendrier, des conversions d'unités dynamiques, etc. Certains contrôles de formulaire sont réalisés de manière dynamique (par exemple une saisie textuelle dans un champ qui attend un chiffre), d'autres sont réalisés après envoi au serveur (par exemple, utilisation d'un index déjà utilisé par ailleurs). - -Zone de validation ------------------- - -La zone de validation se situe tout en bas de la page. -Les boutons « Valider » et « Annuler » sont toujours disponibles. - -« Valider » permet de valider le panneau en cours et de passer au panneau suivant. Si c'est le dernier panneau, le panneau de récapitulatif, la création/modification/suppression est validée. En création/modification, l'utilisateur est redirigé vers la fiche de l'élément qui vient d'être créé/modifié. - -« Annuler » permet d'annuler toute la saisie en cours : les données de session seront effacées. - -« Valider et confirmer » (qui s'insère entre « Valider » et « Annuler ») permet de valider le panneau actuel et d'aller directement au panneau récapitulatif. - -Utilisation avancée -=================== - -.. _basket: - -Paniers -------- - -Les paniers sont un autre type de sélection d'éléments. Contrairement aux marques-pages, ils concernent une liste d'éléments fixe. - -Pour effectuer certaines actions, il est nécessaire de préalablement constituer un panier (notamment pour ce qui concerne les traitements). - -Ce regroupement virtuel peut être aussi un outil de travail, par exemple en constituant une liste d'éléments « à traiter ». Un marque-page (voire une alerte) pouvant être faite sur le contenu d'un panier, cela permet de conserver sous la main cette sélection d'éléments. - -Pour l'heure les paniers ne concernent que le mobilier. - -.. _pinned: - -Éléments épinglés ------------------ - -Les éléments épinglés constituent les éléments « par défaut » en terme de recherche. -L'épinglage d'élément est un outil de travail permettant de travailler dans un contexte de travail donné. - -**Exemple** : je souhaite travailler sur le mobilier d'une opération précise. En épinglant cette opération, par défaut, toutes les recherches de mobilier se feront sur cette opération. - -L'épinglage est disponible directement dans la barre d'outil des fiches. -L'épinglage est aussi disponible au niveau de la barre de recherche (cette recherche épinglée ne concerne que le tableau d'éléments en cours sans gestion hiérarchique). -Si celui-ci est activé dans son profil, l'épinglage est aussi disponible dans le menu de gestion des sélections épinglées (à droite de la zone 4 sur l'image de l'interface générale). -Si on a activé cette option dans son profil, un élément créé ou modifié est automatiquement épinglé. - -Une gestion hiérarchique des épingles est faite : le fait d'épingler un élément épingle automatiquement ses parents directs. - -**Exemple** : le fait d'épingler un mobilier épingle automatiquement l'Unité d'Enregistrement et l'opération archéologique associée à ce mobilier. - -Menu de gestion des sélections épinglées -++++++++++++++++++++++++++++++++++++++++ - -Ce menu n'est visible que s'il est activé dans son profil. Il propose de sélectionner les éléments que l'on souhaite épingler. Différentes versions de ce menu sont disponibles : - -- « simple » : des menus déroulants permettent d'épingler les éléments qui sont directement rattachés à notre compte utilisateur (en particulier les éléments que l'on a créé) ; -- « avancé - mes éléments » : on épingle ici seulement les éléments rattachés à notre compte utilisateur mais avec des champs fonctionnant en autocomplétion ; -- « avancé - tous les éléments » : on peut épingler tous les éléments avec des champs en autocomplétion. - -Sur chaque menu, il est possible d'accéder aux fiches des différents éléments épinglés (icône « i ») et de détacher l'épingle sur ces éléments (croix rouge). - -Action rapide -------------- - -Pour les administrateurs, des actions rapides sont directement accessibles depuis les tableaux. Ces actions se situent en haut à droite du tableau. Elles concernent les éléments actuellement sélectionnés dans le tableau. Les icônes d'action rapide ne sont actives que lorsque cela est pertinent : si une action n'est applicable qu'à un seul élément, en sélectionner aucun ou plusieurs désactive l'icône de l'action en question. - -Ces actions rapides permettent notamment de faire de l'édition de groupe, de l'empaquetage, etc. - - -.. - TODO: expliciter les droits ? les notions de propriétés ? -- cgit v1.2.3