From c37107c6390de2dc40b3b55f30f6dad0c2df3b66 Mon Sep 17 00:00:00 2001 From: Étienne Loks Date: Tue, 2 Oct 2018 17:05:35 +0200 Subject: Doc: updates --- docs/fr/Makefile | 10 +- .../source/_static/graphique-structure-ishtar.png | Bin 76681 -> 119253 bytes .../source/_static/graphique_structure_ishtar.png | Bin 31738 -> 0 bytes docs/fr/source/_static/traitement.png | Bin 0 -> 122686 bytes docs/fr/source/index.rst | 2 +- docs/fr/source/interface-utilisateur.rst | 119 +-- .../media-src/graphique-structure-ishtar.svg | 881 ++++++++++----------- .../media-src/graphique_structure_ishtar.dot | 52 +- .../media-src/graphique_structure_ishtar.svg | 198 +++++ docs/fr/source/media-src/traitement.xcf | Bin 0 -> 938873 bytes docs/fr/source/principes.rst | 55 +- 11 files changed, 712 insertions(+), 605 deletions(-) delete mode 100644 docs/fr/source/_static/graphique_structure_ishtar.png create mode 100644 docs/fr/source/_static/traitement.png create mode 100644 docs/fr/source/media-src/graphique_structure_ishtar.svg create mode 100644 docs/fr/source/media-src/traitement.xcf (limited to 'docs') diff --git a/docs/fr/Makefile b/docs/fr/Makefile index 24ff3e64e..cf7d5af04 100644 --- a/docs/fr/Makefile +++ b/docs/fr/Makefile @@ -41,13 +41,13 @@ dot: filename=$$(basename -- "$$FILE") ; \ extension="$${filename##*.}" ; \ filename="$${filename%.*}" ; \ - echo $$extension ; \ - echo $$filename ; \ - dot -Tpng source/media-src/$$filename.dot > \ - source/_static/$$filename.png ; \ + dot -Tsvg source/media-src/$$filename.dot > \ + source/media-src/$$filename.svg ; \ + #dot -Tpng source/media-src/$$filename.dot > \ + # source/_static/$$filename.png ; \ done -html: dot +html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." diff --git a/docs/fr/source/_static/graphique-structure-ishtar.png b/docs/fr/source/_static/graphique-structure-ishtar.png index 61707abfc..8e4605032 100644 Binary files a/docs/fr/source/_static/graphique-structure-ishtar.png and b/docs/fr/source/_static/graphique-structure-ishtar.png differ diff --git a/docs/fr/source/_static/graphique_structure_ishtar.png b/docs/fr/source/_static/graphique_structure_ishtar.png deleted file mode 100644 index 997de1f6f..000000000 Binary files a/docs/fr/source/_static/graphique_structure_ishtar.png and /dev/null differ diff --git a/docs/fr/source/_static/traitement.png b/docs/fr/source/_static/traitement.png new file mode 100644 index 000000000..d2707d28c Binary files /dev/null and b/docs/fr/source/_static/traitement.png differ diff --git a/docs/fr/source/index.rst b/docs/fr/source/index.rst index 72f90e6bb..858adff0a 100644 --- a/docs/fr/source/index.rst +++ b/docs/fr/source/index.rst @@ -11,7 +11,7 @@ Contents: .. toctree:: :maxdepth: 3 - installation principes + installation interface-utilisateur interface-administrateur diff --git a/docs/fr/source/interface-utilisateur.rst b/docs/fr/source/interface-utilisateur.rst index e262e0df9..ba3a5b6df 100644 --- a/docs/fr/source/interface-utilisateur.rst +++ b/docs/fr/source/interface-utilisateur.rst @@ -1,121 +1,10 @@ .. -*- coding: utf-8 -*- -============ -Installation -============ +===================== +Interface utilisateur +===================== :Auteur: Étienne Loks -:Date: 2016-08-31 +:Date: 2018-10-02 :Copyright: CC-BY 3.0 -Ce document présente les instructions d'installation d'Ishtar. - -Pour l'instant, elles se limitent à l'installation sous Debian GNU/linux via le paquet Debian. - -.. note:: Sauf mention explicite, chaque commande est exécutée en tant qu'utilisateur root. Les utilisateurs de sudo l'ajouteront à chaque commande faite. - -.. contents:: - -Installation sur poste Debian Wheezy ------------------------------------- - -Un dépôt a été mis en place pour installer sous Debian Wheezy. -Ce dépôt est signé, pour ajouter la clé du dépôt à votre gestionnaire de paquet, lancez la commande :: - - wget -O - http://deb.iggdrasil.net/contact@iggdrasil.net.gpg.key | apt-key add - - -Puis, au choix, ajoutez le dépôt à votre /etc/apt/sources.list :: - - deb http://deb.iggdrasil.net/ wheezy main - deb-src http://deb.iggdrasil.net/ wheezy main - -Ou sauvegardez le fichier `iggdrasil.list`_ dans votre répertoire **/etc/apt/sources.list.d/** :: - - wget -O - http://deb.iggdrasil.net/dists/wheezy/iggdrasil.list > /etc/apt/sources.list.d/iggdrasil.list - -.. _iggdrasil.list: http://deb.iggdrasil.net/dists/wheezy/iggdrasil.list - -Ensuite mettez à jour la base de données de votre gestionnaire de paquet et installez le paquet :: - - apt-get update - apt-get install python-django-ishtar - -Enfin pour créer une nouvelle instance d'Ishtar :: - - INSTANCE=le_nom_de_mon_instance URL=ishtar.my-organization.net ishtar-prepare-instance - -INSTANCE est le nom de l'instance et URL le nom du domaine associé (juste l'url pas de http:// ou https://). - -.. note:: Le nom de domaine doit bien entendu pointer vers l'adresse IP du serveur. Si à l'issue de l'installation, le service n'est pas joignable, verifiez bien votre configuration DNS ou le cas échéant verifez bien auprès du gestionnaire de nom de domaine que c'est le cas. - -D'autres variables sont disponibles : - -- **UWSGI_PORT** : par défaut à 8891, faites bien attention d'incrémenter ce nombre pour chaque nouvelle instance. -- **NGINX_PORT** : si vous voulez que le serveur web réponde sur un port différent, par exemple si vous avez déjà Apache installé. Ensuite pour accéder à l'application il faudra mettre clairement le numéro de port dans l'adresse du logiciel. Exemple : http://ishtar.my-organization.net:8000 -- **DB_HOST**, **DB_PORT**, **DB_PASSWORD**, **DB_NAME** : si vous souhaitez personnaliser la base de données dans laquelle sera stockée Ishtar. Par défaut, elle sera stockée localement, sur le port par défaut de PostgreSQL (5432), le mot de passe sera généré aléatoirement, le nom de la base de données sera : « ishtar-le_nom_de_mon_instance ». - -.. note:: Pour le nom de l'instance, seuls sont permis le tiret bas **_** et les caractères alphanumériques en minuscule. Ce nom doit commencer par un caractères alphabétique. Évitez aussi des noms pouvant entrer en conflit avec des bibliothèques Python existantes (par exemple « test »). - - -.. warning:: - En terme de serveur Web, cette première version de l'installateur fonctionne avec la configuration que nous considérons comme la plus optimisée qui est le couple nginx / uwsgi. À terme, l'installateur prendra aussi en compte Apache. Pour l'instant, si vous avez des services tournant sous Apache, plusieurs options se présentent à vous : - - - faire tourner nginx sur un autre port (cf. la variable NGINX_PORT) ; - - faire fonctionner vos autres services avec nginx (je vous laisse découvrir l'abondante documentation en ligne en cherchant « nginx + le nom de mon service ») ; - - configurer Ishtar pour fonctionner avec Apache (référez vous à la `documentation de Django`_). - -.. _`documentation de Django`: https://docs.djangoproject.com/fr/1.9/howto/deployment/wsgi/modwsgi/ - -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 (ou le nom que vous avez spécifiquement donné), Ishtar est joignable à l'adresse donnée par la variable URL et les données de cette instances sont stockées dans le répertoire /var/lib/python-django-ishtar/le_nom_de_mon_instance. - - -Initialisation de la base de données ------------------------------------- - -Ishtar dispose de beaucoup de tables de paramétrage permettant d'avoir un logiciel au plus proche de vos besoins. -Remplir toutes ces tables est fastidieux, c'est pour cela que des jeux de données de base sont disponibles. -Lors de l'installation du paquet, à l'exception des communes (trop lourdes pour être inclues de base), cette initialisation est faite. Si vous avez opté pour cette installation vous pouvez passer tout de suite à l'initialisation des communes. - -Initialisation des paramètres de base -************************************* - -Pour charger toutes les données par défaut :: - - ISHTAR_PATH=/srv/ishtar # dépend de votre installation - PROJECT_PATH=$ISHTAR_PATH/mon_instance - cd $PROJECT_PATH - for data in $(find ../ -name "initial_*-fr.json"); do - ./manage.py loaddata $data - done - -Sinon regarder le détail de chaque fichier json et charger individuellement. Exemple :: - - cd $PROJECT_PATH - ./manage.py loaddata ../ishtar_common/initial_importtypes-fr.json - -Initialisation des communes -*************************** - -Une liste des communes française peut être téléchargée et chargée :: - - cd /tmp - wget "http://ishtar-archeo.net/fixtures/initial_towns-fr.tar.bz2" - tar xvjf initial_towns-fr.tar.bz2 - - ISHTAR_PATH=/var/lib/python-django-ishtar # dépend de votre installation - # ici pour le paquet Debian - PROJECT_PATH=$ISHTAR_PATH/mon_instance - cd $PROJECT_PATH - ./manage.py loaddata /tmp/initial_towns-fr.json - rm /tmp/initial_towns-fr.* - -Sinon un script est mis à disposition pour charger des communes depuis des données OSM : $ISHTAR_PATH/scripts/import_towns_from_osm.py -Lisez les instructions contenu dans le fichier pour savoir comment procéder. - -.. - TODO: - .. warning:: L'installateur présume que vous avez un nom de domaine dédié pour votre installation. Si cela n'est pas le cas, reportez vous à la section de la documentation concernée. - paramètres de settings utiles :DEFAULT_FROM_EMAIL = "robot@iggdrasil.net", SERVER_EMAIL EMAIL_HOST EMAIL_PORT EMAIL_HOST_USER EMAIL_HOST_PASSWORD EMAIL_USE_TLS - installation depuis les sources - diff --git a/docs/fr/source/media-src/graphique-structure-ishtar.svg b/docs/fr/source/media-src/graphique-structure-ishtar.svg index 5eec820b7..3fbcb72d1 100644 --- a/docs/fr/source/media-src/graphique-structure-ishtar.svg +++ b/docs/fr/source/media-src/graphique-structure-ishtar.svg @@ -12,18 +12,18 @@ xmlns="http://www.w3.org/2000/svg" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - width="554pt" - height="476pt" - viewBox="0.00 0.00 553.54 476.00" + width="647pt" + height="548pt" + viewBox="0.00 0.00 646.54 548.00" version="1.1" - id="svg195" + id="svg5805" sodipodi:docname="graphique-structure-ishtar.svg" inkscape:version="0.92.1 r15371" inkscape:export-filename="/home/etienne/Work/ishtar-project/ishtar/docs/fr/source/_static/graphique-structure-ishtar.png" inkscape:export-xdpi="96" inkscape:export-ydpi="96"> + id="metadata5811"> @@ -35,7 +35,7 @@ + id="defs5809" /> + inkscape:current-layer="svg5805" /> - - Opération archéologique - - Opération archéologique - - - parcelle cadastrale - - Parcelle cadastrale - - - Opération archéologique->parcelle cadastrale - - - - Site archéologique - - Site archéologique - - - Opération archéologique->Site archéologique - - - - - - Unité d'enregistrement - - Unité d'enregistrement - - - parcelle cadastrale->Unité d'enregistrement - - - - - Mobilier d'origine - - Mobilier d'origine - - - Unité d'enregistrement->Mobilier d'origine - - - - - Unité d'enregistrement->Site archéologique - - - - - Mobilier - - Mobilier - - - Mobilier d'origine->Mobilier - - - - - Contenant - - Contenant - - - Mobilier->Contenant - - - - - Traitement - - Traitement - - - Mobilier->Traitement - - - - - Dépôt - - Dépôt - - - Contenant->Dépôt - - - + id="polygon5550" + points="642.539,-544 642.539,4 -4,4 -4,-544 " + transform="translate(4,544)" /> + + Opération archéologique + + Parcelle cadastrale + - Traitement->Mobilier - + id="g6312" + transform="translate(10.5)"> - - - Module Opération - - Module Opération - - - Module Unité d'enregistrement - - Module Unité d'enregistrement - - - Module Opération->Module Unité d'enregistrement - - - - Module Mobilier - - Module Mobilier - - - Module Unité d'enregistrement->Module Mobilier - - - - Module Dépôt - - Module Dépôt - - - Module Mobilier->Module Dépôt - - - - Module Site - - Module Site - - - Module Dépôt->Module Site - + transform="matrix(1.2799828,0,0,0.99951333,-74.454902,543.781)" + style="fill:#7a67ee;fill-opacity:0.62745098;stroke:#7a67ee" + id="polygon5573" + points="221,-432 339,-432 339,-468 221,-468 " /> + Site/entité archéologique + + + + + Unité d'enregistrement + + + + Document + + + + + + + + + + Mobilier d'origine + + + + + + Mobilier + + + + Contenant + + + + Traitement + + + + + + Dépôt + + + + + + + + + + Demande de traitement + + + transform="translate(4,544)" /> + + Module Opération + + Module Site + + Module Unité d'enregistrement + + Module Mobilier + + Module Traitement + + Module Dépôt diff --git a/docs/fr/source/media-src/graphique_structure_ishtar.dot b/docs/fr/source/media-src/graphique_structure_ishtar.dot index f052fe4a7..de319dbff 100644 --- a/docs/fr/source/media-src/graphique_structure_ishtar.dot +++ b/docs/fr/source/media-src/graphique_structure_ishtar.dot @@ -1,5 +1,51 @@ digraph structure_Ishtar { - "Opération archéologique" -> Parcelle -> "Unité d'enregistrement" -> Mobilier; - "Opération archéologique" -> "Site archéologique"; - "Unité d'enregistrement" -> "Site archéologique"; + + node [shape=box; style=filled]; + OA [label="Opération archéologique"]; + Parcelle [label="Parcelle cadastrale"]; + EA [label="Site/Entité archéologique"]; + UE [label="Unité d'enregistrement"]; + MobOrigine [label="Mobilier d'origine"]; + Mobilier; + Contenant; + Depot [label="Dépôt"]; + Traitement; + DemandeTraitement [label="Demande de traitement"]; + + {rank = same; Parcelle; EA} /* alignement parcelle - EA */ + + root=OA; + + /* liaisons vers doc */ + OA -> Document; + EA -> Document; + UE -> Document; + Mobilier -> Document; + Depot -> Document; + Traitement -> Document; + DemandeTraitement -> Document; + + /* liaisons entre concepts */ + OA -> Parcelle [arrowhead=none]; + Parcelle -> UE -> MobOrigine -> Mobilier -> Contenant -> Depot; + OA -> UE; + OA -> EA [dir=both]; + UE -> EA; + Mobilier -> Traitement; + DemandeTraitement -> Traitement; + Traitement -> Mobilier; + + /* liaison entre modules */ + node [shape=ellipse; style=filled]; + "Module Opération" -> "Module Site" -> "Module Unité d'enregistrement" -> "Module Mobilier" -> "Module Traitement" -> "Module Dépôt" [dir=none; style=invis] ; + + + "Module Opération", OA, Parcelle [color=red2]; + Document [color=white]; + "Module Unité d'enregistrement", UE [color=orange1]; + "Module Mobilier", MobOrigine, Mobilier [color=mediumvioletred]; + "Module Dépôt", Contenant, Depot [color=yellowgreen]; + "Module Traitement", Traitement, DemandeTraitement [color=yellow]; + "Module Site", EA [color=slateblue2]; } + diff --git a/docs/fr/source/media-src/graphique_structure_ishtar.svg b/docs/fr/source/media-src/graphique_structure_ishtar.svg new file mode 100644 index 000000000..4cc47e371 --- /dev/null +++ b/docs/fr/source/media-src/graphique_structure_ishtar.svg @@ -0,0 +1,198 @@ + + + + + + +structure_Ishtar + + +OA + +Opération archéologique + + +Parcelle + +Parcelle cadastrale + + +OA->Parcelle + + + +EA + +Site/Entité archéologique + + +OA->EA + + + + + +UE + +Unité d'enregistrement + + +OA->UE + + + + +Document + +Document + + +OA->Document + + + + +Parcelle->UE + + + + +EA->Document + + + + +UE->EA + + + + +MobOrigine + +Mobilier d'origine + + +UE->MobOrigine + + + + +UE->Document + + + + +Mobilier + +Mobilier + + +MobOrigine->Mobilier + + + + +Contenant + +Contenant + + +Mobilier->Contenant + + + + +Traitement + +Traitement + + +Mobilier->Traitement + + + + +Mobilier->Document + + + + +Depot + +Dépôt + + +Contenant->Depot + + + + +Depot->Document + + + + +Traitement->Mobilier + + + + +Traitement->Document + + + + +DemandeTraitement + +Demande de traitement + + +DemandeTraitement->Traitement + + + + +DemandeTraitement->Document + + + + +Module Opération + +Module Opération + + +Module Site + +Module Site + + + +Module Unité d'enregistrement + +Module Unité d'enregistrement + + + +Module Mobilier + +Module Mobilier + + + +Module Traitement + +Module Traitement + + + +Module Dépôt + +Module Dépôt + + + + diff --git a/docs/fr/source/media-src/traitement.xcf b/docs/fr/source/media-src/traitement.xcf new file mode 100644 index 000000000..144182859 Binary files /dev/null and b/docs/fr/source/media-src/traitement.xcf differ diff --git a/docs/fr/source/principes.rst b/docs/fr/source/principes.rst index e3caaa1c9..22ca5004f 100644 --- a/docs/fr/source/principes.rst +++ b/docs/fr/source/principes.rst @@ -97,11 +97,64 @@ Par ailleurs au niveau de la configuration d'instance Ishtar un certain de nombr Structure de la base de données =============================== -La base de données ne va pas être détaillée table par table mais nous allons vous présenter les grandes notions utilisé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. .. image:: _static/graphique-structure-ishtar.png +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. + +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. + + +Site/entité archéologique +------------------------- + +L'opération archéologique a été préférée au site ou l'entité archéologique comme centre des données dans Ishtar parce que les sites/entités sont 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. + +Malgré cela, Ishtar gère pleinement les sites (ou entité - notion paramétrable en administration) archéologiques et la migration depuis une base orientée site est tout à fait envisageable. + +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. + +Unité d'enregistrement +---------------------- + +La notion d'Unité d'enregistrement (UE) est à prendre comme un concept large. Elle se défini comme étant un volume (ou une surface) référencé dans l'espace (précisément ou non), associé à des informations archéologiques et contenant (ou pas) du mobilier. La proue du navire, la tranchée 3, la structure ST25, l'US137 ou le quart NE du carré A3 sont tous des UE valides pour Ishtar. + +Ishtar gère les relations entre UE. Cela permet notamment de définir des UE emboîtées (par exemple : tranchée > structure > US) mais aussi de gérer les relations stratigraphiques entre US. + + +Mobilier - Traitement +--------------------- + +Le mobilier tel qu'habituellement compris se découpe en deux sous-éléments au sein d'Ishtar : + +- le mobilier d'origine ; +- le mobilier (actuel). + +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). + +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. + +.. image:: _static/traitement.png + +Document +-------- + +Les documents sont gérés de manière transversale et peuvent être librement associé à un ou plusieurs éléments (opération, site, UE, traitement, mobilier, etc.) de la base de données. Des méta-données peuvent être renseignées pour chacun de ces documents et une image, un fichier peuvent être le cas échéant adjoint. + + .. TODO: Parler d'historisation -- cgit v1.2.3