Docs: custom index, custom ids

1 files changed, 155 insertions, 0 deletions

diff --git a/docs/fr/source/annexe-tech-3-variables.rst b/docs/fr/source/annexe-tech-3-variables.rst
new file mode 100644
index 000000000..bd17a6636
--- /dev/null
+++ b/docs/fr/source/annexe-tech-3-variables.rst
@@ -0,0 +1,155 @@
+.. -*- coding: utf-8 -*-
+
+.. _annexe-technique-3-variables:
+
+==============================
+Annexe technique 3 - Variables
+==============================
+
+:Auteur: Étienne Loks
+:Date: 2020-11-24
+:Copyright: CC-BY 3.0
+
+----------------------------------
+
+Ces variables sont utilisées pour les configurations des imports, les patrons de documents et la configuration des identifiants, des index personnalisés.
+
+Ces variables correspondent aux noms des champs utilisés en base de données (exemple : ``code_patriarche`` pour accéder au code patriarche d'une opération) ainsi que des « facilitateurs » qui permettent de disposer de champs plus évolués (exemple : ``get_next_index`` pour accéder au prochain numéro d'index).
+
+On peut passer d'un élément lié à un autre (par exemple, accéder à l'opération d'une unité d'enregistrement) avec la notation double tiret `__` et ensuite accéder aux variables de l'élément lié (exemple : ``operation__code_patriarche`` permet d'accéder au code patriarche de l'opération ).
+
+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` : 
+
+
+Champs géographiques
+====================
+
+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` : 
+
+
+
+Personne
+========
+
+Chaque personne dispose des champs adresse (cf. ci-dessus), ainsi que des champs suivants :
+
+- `title` : titre
+- `salutation` : formule d'appel
+- `surname` : prénom
+- `name` : nom
+- `raw_name` : nom + prénom
+- `contact_type__` : type de contact (`label` libellé, `txt_idx` identifiant textuel)
+- `comment` : commentaire
+- `person_types__` : types de personnes
+- `attached_to__` : organisation actuelle (-> organisation)
+- `cached_label` : nom généré depuis la formule `person_raw_name` du profil
+
+
+Opération
+=========
+
+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
+- `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
+- `report_delivery_date` : date de livraison du rapport
+- `scientist__` : responsable d'opération (-> personne)
+- `operator__` : opérateur (-> organisation)
+- `in_charge__` : responsable
+- `collaborators__` : collaborateurs
+- `creation_date` : date de création de l'élément en base de données
+- `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)
+- `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__` : 
+- `cached_label` : 
+- `archaeological_sites` : 
+- `top_sites` : 
+- `virtual_operation bool` : 
+- `record_quality_type__` : 
+- `abstract` : 
+- `documentation_deadline` : 
+- `documentation_received` : 
+- `finds_deadline` : 
+- `finds_received bool` : 
+- `drassm_code` : 
+- `seizure_name` : 
+- `official_report_number` : 
+- `protagonist__` : 
+- `applicant_authority__` : 
+- `minutes_writer__` : 
+- `cached_towns_label` : 
+- `cached_periods` : 
+- `complete_identifier` : 
+- `custom_index` : 
+- `qrcode` :