Doc-fr: JSON field - Custom form

1 files changed, 82 insertions, 2 deletions

diff --git a/docs/fr/source/interface-administrateur.rst b/docs/fr/source/interface-administrateur.rst
index 8e8506b6d..53a7f66a6 100644
--- a/docs/fr/source/interface-administrateur.rst
+++ b/docs/fr/source/interface-administrateur.rst
@@ -5,13 +5,93 @@ Interface administrateur
 ========================
 
 :Auteur: Étienne Loks
-:Date: 2018-10-02
+:Date: 2018-12-04
 :Copyright: CC-BY 3.0
 
 
 .. _configuration-instance-ishtar:
 
 Configuration de l'instance Ishtar
-----------------------------------
+==================================
+
+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 présente la liste des différentes tables par ordre alphabétique regroupées par application.
+
+.. 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.
+
+
+Champs personnalisés
+--------------------
+
+Ishtar propose un certain nombre de champ standards et génériques permettant de disposer dès le départ d'une base solide et aussi pour assurer un certain degré d'inter-opérabilité entre les différentes installations d'Ishtar. Néanmoins nul ne peut prétendre à l'exhaustivité et, notamment dans le cadre d'une utilisation d'Ishtar axée recherche, le besoin se fera probablement sentir d'ajouter des champs.
+
+Dans Ishtar ces champs sont appelés : **Champs personnalisés**. Le format JSON étant utilisé pour stocker ces données, le nom **Données JSON** est aussi utilisé.
+
+Ajouter un champ personnalisé se fait via l'interface d'administration au niveau de la rubrique : *Ishtar - Commun › Données JSON - Champs*.
+
+Les différentes données à rentrer sont :
+
+  * **Nom** : Ce nom sera reprit dans les formulaires et la fiche.
+  * **Type de contenu** : Le type d'objet auquel sera rattaché le champ - Opération, Site, Unité d'Enregistrement et Mobilier.
+  * **Clé** : Valeur de la clé dans le format JSON. Cette clé ne doit impérativement comporter que des lettres minuscules, sans accent ou un tiret bas « _ » (ne pas commencer la clé par le tiret bas et ne pas mettre plusieurs tiret bas d'affilée dans la clé de base). On peut structurer les données personnalisée de manière hiérarchique. Pour les clés hiérarchiques on utilise « __ » entre les sections. Par exemple pour la clé « ma_sousclef » dans la catégorie « ma_categorie », la clé sera notée : *ma_categorie__ma_sousclef*.
+  * **Type** : Les types de données disponibles sont les suivants :
+
+    * Texte,
+    * Texte long : le composant de saisie sera une zone de texte,
+    * Entier : nombre entier positif ou négatif,
+    * Nombre à virgule,
+    * Booléen : case à cocher - Vrai ou Faux,
+    * Date : un composant permettant le choix de date depuis un calendrier est proposé,
+    * Choix : un composant en autocomplétion sur les valeurs existantes est proposé. L'utilisateur a la possibilité de rentrer librement de nouvelles valeurs.
+
+  * **Ordre** : Le numéro saisie permet d'ordonner par défaut ce champ par rapport aux autres champs.
+  * **Section** : La section correspond à un titre de section pour présenter ce champ sur la fiche et permettre des regroupements.
+  * **Utiliser dans les index de recherche** : Si cette case est cochée, la recherche libre indexera le contenu de ce champ.
+  * **Afficher** : Si cette case n'est pas cochée, ce champ ne sera pas affiché sur la fiche.
+
+Sauf si un champ personnalisé est uniquement destiné à des données importées et à un affichage sur la fiche, un champ personnalisé sera dans la plupart des cas intégré à un :ref:`formulaire personnalisé <formulaire-personnalise>`.
+
+.. _formulaire-personnalise:
+
+Formulaires personnalisés
+-------------------------
+
+La plupart des formulaires peuvent être personnalisés dans Ishtar, notamment tous les formulaires des wizards ainsi que les formulaires de recherche. À ce jour, il n'est pas encore possible d'ajouter de nouveaux formulaires.
+
+Les formulaires personnalisés permettent deux choses : enlever les champs disponibles de base dans le formulaire et ajouter des champs JSON dans le formulaire. Chaque formulaire personnalisé peut être mis à disposition pour tous ou seulement certains utilisateurs.
+
+La configuration de ces champs se fait en administration via : *Ishtar - Commun › Formulaires personnalisés*.
+
+La création se fait en deux temps, d'abord un paramétrage des champs de base puis une définition des champs à exclure et des champs JSON à ajouter.
+
+Le paramétrage de base demande les champs suivants :
+
+  * Nom : le nom correspondant au formulaire personnalisé. Ce nom ne sera visible qu'en administration mais pour s'y retrouver, il doit à la fois reprendre le nom du formulaire ainsi que le contexte pour lequel il a été défini. Par exemple : « Mobilier - 020 - Général - Tout utilisateur » ou « Mobilier - 030 - Conservation - Saisie terrain ».
+  * Formulaire : le formulaire à personnaliser. Le nom utilisé permet d'identifier assez simplement le formulaire correspondant car il correspond dans l'ordre (séparé par des tirets) au :
+
+    * type d'objet concerné (par exemple : « Mobilier »),
+    * éventuellement, le numéro d'ordre dans le wizard,
+    * nom du formulaire.
+  * À qui s'applique ce formulaire, cela peut être au choix :
+
+    * à tous les utilisateurs,
+    * à certains utilisateurs en particulier,
+    * à certains types d'utilisateurs.
+
+Une fois ce paramétrage de base enregistré, la configuration précise du formulaire peut se faire :
+
+  * champ à exclure : chaque champ de base présent dans le formulaire actuel peut être sélectionné dans la liste pour être écarté de la saisie.
+  * champs JSON : tous les champs JSON préalablement paramétrés concernant l'élément courant peuvent être sélectionnés. La dénomination permet éventuellement de surcharger le nom par défaut du champ JSON. L'ordre permet de placer le champ dans le formulaire. L'aide permet éventuellement d'ajouter un texte pour aider à la saisie.
+
+.. warning:: Sur les formulaires de création, il est impératif de ne pas exclure des champs obligatoires sans quoi la création devient impossible.
+
+.. note:: En tant qu'administrateur, en modifiant son profil depuis les pages d'administration (*Ishtar - Commun › Profils d'utilisateurs*) et en cochant « Afficher les numéros des champs », les numéros des champs actuels des formulaires s'affichent sur l'interface, cela permet ainsi de placer plus aisément les champs personnalisés.
+
+
+Profil d'instance Ishtar
+------------------------
 
 WIP