Doc on front

AdrienHallet · Jun 20, 2019 · 80ce780 · 80ce780
1 parent ea3b725
commit 80ce780
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 1 deletion.
diff --git a/docs/devDoc.rst b/docs/devDoc.rst
@@ -5,3 +5,6 @@ Démarrage rapide
 .. toctree::
    install
    projectStructure
+   libraries
+   tables 
+   modals
diff --git a/docs/libraries.rst b/docs/libraries.rst
@@ -59,7 +59,28 @@ Leaflet
 
 Magnific Popup
 --------------
-`Magnific Popup <http://dimsemenov.com/plugins/magnific-popup/>`_ TODO
+`Magnific Popup <http://dimsemenov.com/plugins/magnific-popup/>`_ permet d'afficher des lightbox et boîtes de dialogue aisément.
+
+Modernizr
+---------
+`Modernizr <https://modernizr.com/>`_ est une collection de features permettant d'augmenter la responsiveness de l'application et d'adapter l'interface de l'application au support.
+
+Morris
+---------
+`Morris <https://morrisjs.github.io/morris.js/>`_ est une bibliothèque graphique permettant la réalisation de graphes simples.
+
+NanoScroller
+---------
+`NanoScroller <https://jamesflorentino.github.io/nanoScrollerJS/>`_ implémente une barre de navigation (type ascenseur) uniforme à travers les différents navigateurs.
+
+PNotify
+---------
+`PNotify <https://sciactive.com/pnotify/>`_ est utilisé pour les toasts (coin supérieur droit) notifiant des différentes actions effectuées par le serveur (ajout, erreur).
+
+Select2
+---------
+`Select2 <https://select2.org/>`_ est une alternative à bootstrap-multiselect plus avancée et performante.
+
 
 
 ========

diff --git a/docs/modals.rst b/docs/modals.rst
@@ -0,0 +1,9 @@
+===============================
+Fenêtres modales et formulaires
+===============================
+
+Les modales/formulaires disposent de ``handlers`` situés dans le dossier ``static`` de leur module respectif. Chacune dispose d'une :
+    * Validation : pour vérifier localement les informations entrées dans les champs et préparer la requête d'envoi
+    * Initialisation : En ajout et en édition pour respectivement vider ou pré-remplir les champs en fonction des informations déjà disponibles
+
+Un ``genericModalHandler`` commun est utilisé par toutes les modales pour les fonctions communes.
diff --git a/docs/tables.rst b/docs/tables.rst
@@ -0,0 +1,9 @@
+===================
+Tables - DataTables
+===================
+
+Les tables disposent de ``handlers`` (ou generator) situés dans le dossier ``static`` de leur module respectif. Chacune dispose d'une :
+    * Configuration : pour les actions autorisées sur la table (impression, tri, recherche, etc) et le format (responsive, etc)
+    * Initialisation : fonction de dessin appelée par le script de la page requérant la transformation de la table HTML en une DataTable. Cette fonction initialise l'appel à l'API et les différents listeners pour les actions.
+
+Un ``genericTableHandler`` commun est utilisé par toutes les tables pour les fonctions communes (transactions au serveur, traduction française des boutons, etc).