summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorÉtienne Loks <etienne.loks@iggdrasil.net>2020-11-25 18:33:21 +0100
committerÉtienne Loks <etienne.loks@iggdrasil.net>2021-02-28 12:15:21 +0100
commitfda191a63534f13470844bf5d7462f260801e318 (patch)
treeb705d83ff7d325af919fe4cfb096fc8e672f15e7 /docs
parent8329893fd6cb21e20d5fd7bf36ff3318c5d2385c (diff)
downloadIshtar-fda191a63534f13470844bf5d7462f260801e318.tar.bz2
Ishtar-fda191a63534f13470844bf5d7462f260801e318.zip
Doc: variables
Diffstat (limited to 'docs')
-rw-r--r--docs/fr/source/annexe-tech-3-variables.rst194
-rw-r--r--docs/fr/source/principes.rst3
2 files changed, 127 insertions, 70 deletions
diff --git a/docs/fr/source/annexe-tech-3-variables.rst b/docs/fr/source/annexe-tech-3-variables.rst
index bd17a6636..6e2f39271 100644
--- a/docs/fr/source/annexe-tech-3-variables.rst
+++ b/docs/fr/source/annexe-tech-3-variables.rst
@@ -23,57 +23,57 @@ Ci-dessous la liste des variables pour chaque type d'éléments.
Champs adresse
==============
-Les champs adresse sont une liste de variables partagées par plusieurs éléments :
-
-- `address` :
-- `address_complement` :
-- `postal_code` :
-- `town` :
-- `precise_town` :
-- `country` :
-- `alt_address` :
-- `alt_address_complement` :
-- `alt_postal_code` :
-- `alt_town` :
-- `alt_country` :
-- `phone` :
-- `phone_desc` :
-- `phone2` :
-- `phone_desc2` :
-- `phone3` :
-- `phone_desc3` :
-- `raw_phone` :
-- `mobile_phone` :
-- `email` :
-- `alt_address_is_prefered` :
+Les champs adresse sont une liste de variables partagées par plusieurs éléments :
+
+- `address` : adresse
+- `address_complement` : complément d'adresse
+- `postal_code` : code postal
+- `precise_town__` : commune (`name` nom de la commune, `numero_insee` code INSEE, `cached_label` nom commune avec numéro du département entre parenthèses)
+- `town` : nom de la commune (saisie libre)
+- `country` : nom de pays
+- `alt_address` : adresse alternative
+- `alt_address_complement` : complément d'adresse de l'adresse alternative
+- `alt_postal_code` : code postal de l'adresse alternative
+- `alt_town` : nom de la commune (saisie libre) de l'adresse alternative
+- `alt_country` : nom de pays de l'adresse alternative
+- `phone` : numéro de téléphone
+- `phone_desc` : numéro de téléphone - description
+- `phone2` : numéro de téléphone (2)
+- `phone_desc2` : numéro de téléphone (2) - description
+- `phone3` : numéro de téléphone (3)
+- `phone_desc3` : numéro de téléphone (3) - description
+- `mobile_phone` : numéro de mobile
+- `email` : courriel
+- `alt_address_is_prefered` : (booléen) l'adresse alternative est préférée
Champs géographiques
====================
-Les champs géographiques sont une liste de variables partagées par plusieurs éléments :
+Les champs géographiques sont une liste de variables partagées par plusieurs éléments :
-- `x` :
-- `y` :
-- `z` :
-- `estimated_error_x` :
-- `estimated_error_y` :
-- `estimated_error_z` :
-- `spatial_reference_system` :
-- `point` :
-- `point_2d` :
-- `point_source` :
-- `point_source_item` :
-- `multi_polygon` :
-- `multi_polygon_source` :
-- `multi_polygon_source_item` :
+- `spatial_reference_system` : système de référence spatial des coordonnées
+- `x` : coordonnée x
+- `y` : coordonnée y
+- `z` : coordonnée z
+- `estimated_error_x` : erreur estimée sur la coordonnée x
+- `estimated_error_y` : erreur estimée sur la coordonnée y
+- `estimated_error_z` : erreur estimée sur la coordonnée z
+- `point` : champ base de données du point (3D) - déduit automatiquement depuis les coordonnées
+- `point_2d` : champ base de données du point (2D) - déduit automatiquement depuis les coordonnées
+- `point_source` : origine des coordonnées (**P** précis, **T** commune, **M** polygone)
+- `point_source_item` : source des coordonnées - géré automatiquement
+- `multi_polygon` :
+- `multi_polygon_source` : origine du polygone (**P** précis, **T** commune, **M** polygone)
+- `multi_polygon_source_item` : source du polygone - géré automatiquement
+Le détail du fonctionnement de ces champs est explicité dans :ref:`« Principes > Notions avancées > Données géographiques » <donnees-geographiques>`.
Personne
========
-Chaque personne dispose des champs adresse (cf. ci-dessus), ainsi que des champs suivants :
+Chaque personne dispose des champs adresse (cf. ci-dessus), ainsi que des champs suivants :
- `title` : titre
- `salutation` : formule d'appel
@@ -86,16 +86,73 @@ Chaque personne dispose des champs adresse (cf. ci-dessus), ainsi que des champs
- `attached_to__` : organisation actuelle (-> organisation)
- `cached_label` : nom généré depuis la formule `person_raw_name` du profil
+Auteur
+======
+
+- `person` : personne (-> personne)
+- `author_type` : type d'auteur (`label` libellé, `txt_idx` identifiant textuel)
+- `cached_label` : cache textuel « nom, prénom de la personne - type d'auteur » - à utiliser pour l'affichage
+
+Organisation
+============
+
+Chaque organisation dispose des champs adresse (cf. ci-dessus), ainsi que des champs suivants :
+
+- `name` : nom
+- `organization_type__` : type de contact (`label` libellé, `txt_idx` identifiant textuel)
+- `cached_label` : nom généré - nom ou si non disponible « type d'organisation - adresse - commune »
+
+
+Documentation
+=============
+
+- `title` : titre
+- `associated_file` : fichier associé
+- `image` : image associée
+- `thumbnail` : vignette associée (généré automatiquement depuis une image)
+- `associated_url` : adresse web associée (avec ``http://``)
+- `index` : index
+- `external_id` : identifiant interne
+- `reference` : référence
+- `internal_reference` : référence interne
+- `source_type` : type de document (`label` libellé, `txt_idx` identifiant textuel, `code` code)
+- `publisher__` : éditeur (-> organisation)
+- `licenses__` : liste de licence d'utilisation (`label` libellé, `txt_idx` identifiant textuel)
+- `tags` : liste d'étiquettes (`label` libellé, `txt_idx` identifiant textuel)
+- `language` : langue
+- `issn` : code ISSN
+- `isbn` : code ISBN
+- `source` : source / document parent (-> Document)
+- `source_free_input` : source / document parent - saisie libre
+- `support_type` : type de support (`label` libellé, `txt_idx` identifiant textuel)
+- `format_type` : format (`label` libellé, `txt_idx` identifiant textuel)
+- `scale` : échelle
+- `authors__` : liste d'auteurs (-> auteur)
+- `authors_raw` : saisie libre des auteurs
+- `creation_date` : date de création de l'élément en base de données
+- `receipt_date` : date de réception
+- `receipt_date_in_documentation` : date de réception en documentation
+- `item_number` : nombre d'élément
+- `description` : description
+- `container_id` : ID du contenant contenant le document
+- `container_ref_id` : ID du contenant de référence du document
+- `comment` : commentaire
+- `additional_information` : information additionnelles
+- `duplicate` : a des doublons
+- `complete_identifier` : identifiant complet personnalisé
+- `custom_index` : index personnalisé
+- `qrcode` : QR code
Opération
=========
-Chaque opération dispose des champs géographiques (cf. ci-dessus), ainsi que des champs suivants :
+Chaque opération dispose des champs géographiques (cf. ci-dessus), ainsi que des champs suivants :
- `code_patriarche` : code patriarche (ou équivalent)
- `year` : année de l'opération
- `common_name` : nom générique
- `operation_code` : code de l'opération
+- `old_code` : ancien code
- `start_date` : date de début du chantier
- `excavation_end_date` : date de fin du chantier
- `end_date` : date de cloture de l'opération
@@ -108,30 +165,31 @@ Chaque opération dispose des champs géographiques (cf. ci-dessus), ainsi que d
- `associated_file__` : dossier archéologique associé (-> dossier archéologique)
- `operation_type__` : type d'opération (`label` libellé, `txt_idx` identifiant textuel)
- `surface` : surface totale (m²)
-- `remains__` : vestiges (`label` libellé, `txt_idx`: identifiant textuel)
+- `remains` : liste des vestiges (`label` libellé, `txt_idx` identifiant textuel)
- `cached_remains` : cache textuel de la liste des vestiges - à utiliser pour l'affichage
-- `towns` :
-- `cost` :
-- `periods` :
-- `scheduled_man_days` :
-- `optional_man_days` :
-- `effective_man_days` :
-- `report_processing` :
-- `old_code` :
-- `fnap_financing` :
-- `fnap_cost` :
-- `zoning_prescription bool` :
-- `large_area_prescription bool` :
-- `geoarchaeological_context_prescription bool` :
-- `cira_rapporteur` :
-- `negative_result bool` :
-- `cira_date` :
-- `operator_reference` :
-- `address` :
-- `comment` :
-- `scientific_documentation_comment` :
-- `documents__` :
-- `main_image__` :
+- `towns` : liste des communes liées (-> commune, `name` nom de la commune, `numero_insee` code INSEE, `cached_label` nom commune avec numéro du département entre parenthèses)
+- `cached_towns_label` : cache textuel de la liste des communes - à utiliser pour l'affichage
+- `periods` : liste des périodes (`label` libellé, `txt_idx` identifiant textuel)
+- `cached_periods` : cache textuel des périodes - à utiliser pour l'affichage
+- `scheduled_man_days` : hommes-jours prévus
+- `optional_man_days` : hommes-jours optionnels
+- `effective_man_days` : hommes-jours effectifs
+- `cost` : coût de l'opération
+- `report_processing` : état de traitement du rapport (`label` libellé, `txt_idx` identifiant textuel)
+- `fnap_financing` : financement FNAP (%)
+- `fnap_cost` : financement FNAP (€)
+- `zoning_prescription` : booléen - prescription sur zonage
+- `large_area_prescription` : booléen - prescription sur une vaste surface
+- `geoarchaeological_context_prescription` : booléen - prescription sur un contexte géoarchéologique
+- `negative_result` : booléen - résultat considéré comme négatif
+- `cira_rapporteur` : rapporteur CIRA (-> personne)
+- `cira_date` : date d'avis CIRA
+- `operator_reference` : référence d'opérateur
+- `address` : adresse
+- `comment` : commentaire
+- `scientific_documentation_comment` : commentaire sur la documentation scientifique
+- `documents__` : documents associés (-> document)
+- `main_image__` : image principale de l'opération (-> document)
- `cached_label` :
- `archaeological_sites` :
- `top_sites` :
@@ -142,14 +200,12 @@ Chaque opération dispose des champs géographiques (cf. ci-dessus), ainsi que d
- `documentation_received` :
- `finds_deadline` :
- `finds_received bool` :
-- `drassm_code` :
+- `drassm_code` : code DRASSM
- `seizure_name` :
- `official_report_number` :
- `protagonist__` :
- `applicant_authority__` :
- `minutes_writer__` :
-- `cached_towns_label` :
-- `cached_periods` :
-- `complete_identifier` :
-- `custom_index` :
-- `qrcode` :
+- `complete_identifier` : identifiant complet personnalisé
+- `custom_index` : index personnalisé
+- `qrcode` : QR code
diff --git a/docs/fr/source/principes.rst b/docs/fr/source/principes.rst
index 542b9307d..9f1770f71 100644
--- a/docs/fr/source/principes.rst
+++ b/docs/fr/source/principes.rst
@@ -133,7 +133,7 @@ Ishtar gère les relations entre UE. Cela permet notamment de définir des UE em
Mobilier - Traitement
---------------------
-Un traitement est défini comme une action portée par un responsable sur du mobilier archéologique dans un lieu donné. Dans ce cadre, un lavage, une restauration, un prélèvement pour analyse, une radiographie, une étude, un conditionnement, un prêt pour expo ou une mise en dépôt sont tous des traitements (que le gestionnaire de mobilier est libre d'enregistrer ou non).
+Un traitement est défini comme une action portée par un responsable sur du mobilier archéologique dans un lieu donné. Dans ce cadre, un lavage, une restauration, un prélèvement pour analyse, une radiographie, une étude, un conditionnement, un prêt pour exposition ou une mise en dépôt sont tous des traitements (que le gestionnaire de mobilier est libre d'enregistrer ou non).
Un traitement peut mener à ce que plusieurs objets ou lots deviennent un seul lot ou objet (un remontage par exemple : N à 1), ou à l'inverse qu'un objet suite à un traitement en devienne plusieurs (1 à N).
@@ -174,6 +174,7 @@ Les documents sont gérés de manière transversale et peuvent être librement a
Notions avancées
================
+.. _donnees-geographiques:
Données géographiques
---------------------