Version 5.1
Ajout d'une note pour les couleurs des lignes des défunts.
feat: ajout du champ mort pour la france dans la fiche défunt et mention du badge sur la fiche de l'emplacement
feat: mise en place de la documentation décrivant l'abstracteur geocimetiere
Merge branch '5.1-mort_pour_la_france' into '5.1-dev' feat: ajout du champ mort pour la france dans la fiche défunt et mention du... See merge request atreal/opencimetiere-documentation!20
fix: syntax and adding a new line in note
Merge branch '10706_EVO_v5.1.0_defunt_verrouille_grise_defunt_exhume_colore' into '5.1-dev' Ajout d'une note pour les couleurs des lignes des défunts. See merge request atreal/opencimetiere-documentation!18
feat: mise en place de la partie pour les utilisateurs concernant le SIG externe
Merge branch '5.1-geocimetiere' into '5.1-dev' feat: mise en place de la documentation décrivant l'abstracteur geocimetiere See merge request atreal/opencimetiere-documentation!19
Merge branch '5.1-dev' into '5.1' Fusion de la branche 5.1-dev atreal dans la branche de documentation 5.1 d'openmairie See merge request openmairie/opencimetiere-documentation!15
| 1 | -Documentation openCimetière version 5.0
|
|
| 1 | +Documentation openCimetière version 5.1
|
|
| 2 | 2 | =======================================
|
| 3 | 3 | |
| 4 | -.. image:: http://readthedocs.org/projects/opencimetiere/badge/?version=5.0
|
|
| 5 | - :target: http://openmairie.readthedocs.io/projects/opencimetiere/fr/5.0/?badge=5.0
|
|
| 4 | +.. image:: http://readthedocs.org/projects/opencimetiere/badge/?version=5.1
|
|
| 5 | + :target: http://openmairie.readthedocs.io/projects/opencimetiere/fr/5.1/?badge=5.1
|
|
| 6 | 6 | :alt: Documentation Status |
| ... | ... | @@ -42,7 +42,7 @@ source_suffix = '.rst' |
| 42 | 42 | master_doc = 'index'
|
| 43 | 43 | |
| 44 | 44 | # General information about the project.
|
| 45 | -project = u'openCimetière 5.0'
|
|
| 45 | +project = u'openCimetière 5.1'
|
|
| 46 | 46 | copyright = u'2004-2022, openMairie'
|
| 47 | 47 | |
| 48 | 48 | # The version info for the project you're documenting, acts as replacement for
|
| ... | ... | @@ -50,9 +50,9 @@ copyright = u'2004-2022, openMairie' |
| 50 | 50 | # built documents.
|
| 51 | 51 | #
|
| 52 | 52 | # The short X.Y version.
|
| 53 | -version = '5.0'
|
|
| 53 | +version = '5.1'
|
|
| 54 | 54 | # The full version, including alpha/beta/rc tags.
|
| 55 | -release = '5.0'
|
|
| 55 | +release = '5.1'
|
|
| 56 | 56 | |
| 57 | 57 | # The language for content autogenerated by Sphinx. Refer to documentation
|
| 58 | 58 | # for a list of supported languages.
|
| ... | ... | @@ -17,4 +17,5 @@ qui ont permis la migration de la version mysql sur la version postgres. |
| 17 | 17 | principes.rst
|
| 18 | 18 | migration_mysql.rst
|
| 19 | 19 | migration.rst
|
| 20 | + sig_externe.rst
|
|
| 20 | 21 |
| 1 | +.. _sig_externe:
|
|
| 2 | + |
|
| 3 | +##################
|
|
| 4 | +La géolocalisation
|
|
| 5 | +##################
|
|
| 6 | + |
|
| 7 | +.. toctree::
|
|
| 8 | + |
|
| 9 | + sig_externe_plugin_connecteur_sig.rst |
| 1 | +.. _sig_externe_plugin_connecteur_sig:
|
|
| 2 | + |
|
| 3 | +#######################
|
|
| 4 | +Plugin 'connecteur SIG'
|
|
| 5 | +#######################
|
|
| 6 | + |
|
| 7 | +Les connecteurs SIG permettent de faire le lien entre openCimetière et différents SIG.
|
|
| 8 | + |
|
| 9 | +Description de la configuration des connecteurs
|
|
| 10 | +###############################################
|
|
| 11 | + |
|
| 12 | +La configuration du plugin est définie dans dyn/sig.inc.php.
|
|
| 13 | + |
|
| 14 | +Exemple :
|
|
| 15 | + |
|
| 16 | +.. code:: php
|
|
| 17 | +
|
|
| 18 | + $conf["sig-default"] = array (
|
|
| 19 | + "2" => array(
|
|
| 20 | + 'connector' => 'generic',
|
|
| 21 | + 'path' => '../obj/',
|
|
| 22 | + 'required_methods' => array('redirection_web',),
|
|
| 23 | + ),
|
|
| 24 | + );
|
|
| 25 | + |
|
| 26 | +Liste des paramètres obligatoires :
|
|
| 27 | + |
|
| 28 | +- **option_sig** doit être positionnée à la valeur "sig_externe" dans openCimetière
|
|
| 29 | +- **connector** défini le type de connecteur (Dans cet exemple, le connecteur geocimetiere_generic.class.php contenu dans le dossier "obj" sera instancié.)
|
|
| 30 | +- **path** défini le chemin du connecteur
|
|
| 31 | +- **required_methods** tableau permettant de spécifier quelles sont les méthodes qui sont utilisé par le connecteur SIG
|
|
| 32 | + |
|
| 33 | +La clé "sig-default" doit être ajoutée au script sig.inc.php.
|
|
| 34 | +La clé du tabeau de configuration du SIG correspond à l'identifiant de la collectivité pour laquelle le connecteur est disponible (si collectivité multi, les collectivités mono auront accès au connecteur SIG).
|
|
| 35 | + |
|
| 36 | +D'autres paramètres spécifiques aux connecteurs pourront être ajoutés au tableau de paramétrage.
|
|
| 37 | + |
|
| 38 | +Description du script
|
|
| 39 | +#####################
|
|
| 40 | + |
|
| 41 | +Le script obj/geocimetiere.class.php permet d'instancier les connecteurs spécifiques.
|
|
| 42 | + |
|
| 43 | +Liste des classes implémentées dans le script :
|
|
| 44 | + |
|
| 45 | +* geocimetiere
|
|
| 46 | +* geocimetiere_base
|
|
| 47 | +* geocimetiere_exception
|
|
| 48 | +* geocimetiere_configuration_exception
|
|
| 49 | +* geocimetiere_connector_exception
|
|
| 50 | +* geocimetiere_connector_method_not_implemented_exception
|
|
| 51 | +* geocimetiere_parameter_exception
|
|
| 52 | + |
|
| 53 | +************
|
|
| 54 | +geocimetiere
|
|
| 55 | +************
|
|
| 56 | + |
|
| 57 | +La classe 'geocimetiere' est une classe d'abstraction, spécifique à openCimetière,
|
|
| 58 | +permettant de gérer les requêtes vers divers webservices SIG et ainsi
|
|
| 59 | +proposer aux utilisateurs des informations géographiques.
|
|
| 60 | +Cette classe est instanciée et utilisée par d'autres scripts pour
|
|
| 61 | +gérer notamment la redirection vers le SIG utilisé afin de consulter les emprises des emplacements.
|
|
| 62 | +Son objectif est d'instancier les classes spécifiques aux SIG aussi appelées
|
|
| 63 | +connecteurs correspondant au paramétrage de la collectivité.
|
|
| 64 | + |
|
| 65 | +Ces connecteurs héritent de la classe 'geocimetiere_base' qui leur sert de modèle.
|
|
| 66 | + |
|
| 67 | +Enfin la classe 'geocimetiere_exception' permet de gérer les erreurs.
|
|
| 68 | +Plusieurs classes en héritent afin de spécifier le type d'exception.
|
|
| 69 | + |
|
| 70 | +*****************
|
|
| 71 | +geocimetiere_base
|
|
| 72 | +*****************
|
|
| 73 | + |
|
| 74 | +Classe parente de tous les connecteurs SIG
|
|
| 75 | + |
|
| 76 | + .. important:: Les classes des connecteurs SIG doivent étendre la classe geocimetiere_base.
|
|
| 77 | + |
|
| 78 | +**********************
|
|
| 79 | +geocimetiere_exception
|
|
| 80 | +**********************
|
|
| 81 | + |
|
| 82 | +Classe gérant les erreurs (une exception est levée pour chacune).
|
|
| 83 | + |
|
| 84 | + |
|
| 85 | +************************************
|
|
| 86 | +geocimetiere_configuration_exception
|
|
| 87 | +************************************
|
|
| 88 | + |
|
| 89 | +Classe d'exceptions utilisée lors d'une erreur dans le paramétrage du connecteur.
|
|
| 90 | + |
|
| 91 | + |
|
| 92 | +********************************
|
|
| 93 | +geocimetiere_parameter_exception
|
|
| 94 | +********************************
|
|
| 95 | + |
|
| 96 | +Classe d'exceptions utilisée lors de la vérification des paramètres
|
|
| 97 | +passés au méthode de l'abstracteur.
|
|
| 98 | + |
|
| 99 | + |
|
| 100 | +********************************
|
|
| 101 | +geocimetiere_connector_exception
|
|
| 102 | +********************************
|
|
| 103 | + |
|
| 104 | +Classe de gestion des exceptions génériques remontées par le connecteur.
|
|
| 105 | + |
|
| 106 | + |
|
| 107 | +*******************************************************
|
|
| 108 | +geocimetiere_connector_method_not_implemented_exception
|
|
| 109 | +*******************************************************
|
|
| 110 | + |
|
| 111 | +Classe de gestion des exceptions sur les methodes du connecteur qui ne sont pas
|
|
| 112 | +implémentées.
|
|
| 113 | + |
|
| 114 | + |
|
| 115 | +Méthodes à implémenter
|
|
| 116 | +######################
|
|
| 117 | + |
|
| 118 | +Dépend du paramètre **required_methods** présent dans la configuration.
|
|
| 119 | + |
|
| 120 | +*********
|
|
| 121 | +Attributs
|
|
| 122 | +*********
|
|
| 123 | + |
|
| 124 | +$sig_parameters
|
|
| 125 | +***************
|
|
| 126 | + |
|
| 127 | +::
|
|
| 128 | + |
|
| 129 | + $sig_parameters : array
|
|
| 130 | + |
|
| 131 | + |
|
| 132 | +*Paramètres de connexion au sig*
|
|
| 133 | + |
|
| 134 | + |
|
| 135 | +$collectivite_parameters
|
|
| 136 | +************************
|
|
| 137 | + |
|
| 138 | + |
|
| 139 | +::
|
|
| 140 | + |
|
| 141 | + $collectivite_parameters : array
|
|
| 142 | + |
|
| 143 | + |
|
| 144 | +*Paramètres de la collectivite*
|
|
| 145 | + |
|
| 146 | +$extra_params
|
|
| 147 | +*************
|
|
| 148 | + |
|
| 149 | + |
|
| 150 | +::
|
|
| 151 | + |
|
| 152 | + $extra_params: array
|
|
| 153 | + |
|
| 154 | + |
|
| 155 | +*Tableau de paramètres supplémentaires*
|
|
| 156 | + |
|
| 157 | +********
|
|
| 158 | +Méthodes
|
|
| 159 | +********
|
|
| 160 | + |
|
| 161 | + |
|
| 162 | +__construct()
|
|
| 163 | +*************
|
|
| 164 | + |
|
| 165 | + |
|
| 166 | +::
|
|
| 167 | + |
|
| 168 | + __construct(array $collectivite)
|
|
| 169 | + |
|
| 170 | + |
|
| 171 | +*Le constructeur instancie le connecteur SIG selon la configuration*
|
|
| 172 | + |
|
| 173 | + |
|
| 174 | +Parameters
|
|
| 175 | +``````````
|
|
| 176 | +array $collectivite
|
|
| 177 | +Configuration du connecteur.
|
|
| 178 | + |
|
| 179 | +redirection_web()
|
|
| 180 | +*****************
|
|
| 181 | + |
|
| 182 | + |
|
| 183 | +::
|
|
| 184 | + |
|
| 185 | + redirection_web(string $contexte= null)
|
|
| 186 | + |
|
| 187 | + |
|
| 188 | +*Redirection vers le SIG dans le contexte de visualisation donnée (valeurs possibles : cimetiere, zone, voie et emplacement. Si null renvoie à l'url de base du SIG)*
|
|
| 189 | + |
|
| 190 | + |
|
| 191 | +Parameters
|
|
| 192 | +``````````
|
|
| 193 | + |
|
| 194 | +(string) $contexte: contexte de redirection.
|
|
| 195 | + |
|
| 196 | + |
|
| 197 | + |
|
| 198 | +Returns
|
|
| 199 | +```````
|
|
| 200 | +(string) L'url du SIG
|
|
| 201 | + |
|
| 202 | +query_db()
|
|
| 203 | +**********
|
|
| 204 | + |
|
| 205 | +::
|
|
| 206 | + |
|
| 207 | + query_db(array $data)
|
|
| 208 | + |
|
| 209 | +Permet au connecteur SIG de consulter la base de données.
|
|
| 210 | + |
|
| 211 | +Paramètres
|
|
| 212 | +``````````
|
|
| 213 | +(string) $query_sql SELECT SQL autorisé sur la base de données.
|
|
| 214 | +(boolean) $force_return Nécessaire au fonctionnement de la requête.
|
|
| 215 | + |
|
| 216 | +Retours
|
|
| 217 | +```````
|
|
| 218 | +(array)|(boolean) Tableau de résultat retourné au connecteur parapheur par la base de données, sinon retourne une booléen False.
|
|
| 219 | + |
| 1 | 1 | .. opencimetiere documentation master file.
|
| 2 | 2 | |
| 3 | 3 | ===============================
|
| 4 | -openCimetière 5.0 documentation
|
|
| 4 | +openCimetière 5.1 documentation
|
|
| 5 | 5 | ===============================
|
| 6 | 6 | |
| 7 | 7 | .. note::
|
| ... | ... | @@ -94,4 +94,9 @@ Des exemples de paramétrage SIG interne sont disponibles dans les scripts `test |
| 94 | 94 | .. |icone-localiser| image:: a_administration-icone-geolocaliser.png
|
| 95 | 95 | |
| 96 | 96 | |
| 97 | +SIG externe
|
|
| 98 | +-----------
|
|
| 99 | + |
|
| 100 | +Lorsque le paramètre *option_localisation* a pour valeur *sig_externe*, il est alors possible d'accès au SIG paramétré dans le contexte de la voie à partir de l'application openCimetière.
|
|
| 97 | 101 | |
| 102 | +Un connecteur peut être raccordé à openCimetière et paramétré à partir du fichier sig.inc.php. (cf la partie guide du développeur pour plus d'informations sur l'abstracteur mis à disposition dans le code source). |
| ... | ... | @@ -70,6 +70,11 @@ Il est possible de géolocaliser le périmètre du cimetière : |
| 70 | 70 | .. image:: a_administration-cimetiere-geolocaliser.png
|
| 71 | 71 | |
| 72 | 72 | |
| 73 | +SIG externe
|
|
| 74 | +-----------
|
|
| 75 | + |
|
| 76 | +Lorsque le paramètre *option_localisation* a pour valeur *sig_externe*, il est alors possible d'accès au SIG paramétré dans le contexte du cimetière à partir de l'application openCimetière.
|
|
| 77 | + |
|
| 73 | 78 | .. _zone:
|
| 74 | 79 | |
| 75 | 80 | La zone
|
| ... | ... | @@ -122,6 +127,10 @@ Il est possible de géolocaliser le périmètre d'une zone : |
| 122 | 127 | |
| 123 | 128 | .. image:: a_administration-zone-geolocaliser.png
|
| 124 | 129 | |
| 130 | +SIG externe
|
|
| 131 | +-----------
|
|
| 132 | + |
|
| 133 | +Lorsque le paramètre *option_localisation* a pour valeur *sig_externe*, il est alors possible d'accès au SIG paramétré dans le contexte de la zone à partir de l'application openCimetière.
|
|
| 125 | 134 | |
| 126 | 135 | .. _voie:
|
| 127 | 136 | |
| ... | ... | @@ -195,3 +204,7 @@ Dans la version 3.0.0, la voie est un polygone et non plus une ligne. |
| 195 | 204 | .. |icone-localiser| image:: a_administration-icone-geolocaliser.png
|
| 196 | 205 | |
| 197 | 206 | |
| 207 | +SIG externe
|
|
| 208 | +-----------
|
|
| 209 | + |
|
| 210 | +Lorsque le paramètre *option_localisation* a pour valeur *sig_externe*, il est alors possible d'accès au SIG paramétré dans le contexte de la voie à partir de l'application openCimetière. |
| ... | ... | @@ -13,6 +13,11 @@ Tous les défunts liés à l'emplacement sont listés dans cet onglet. |
| 13 | 13 | .. image:: a_emplacement-emplacement_concession-onglet-defunt-listing.png
|
| 14 | 14 | |
| 15 | 15 | |
| 16 | +.. note::
|
|
| 17 | + | Un défunt exhumé apparait dans la liste des défunts sur un fond de couleur jaune clair.
|
|
| 18 | + | Un défunt verrouillé (faisant l'objet d'une opération en cours) apparait dans la liste des défunts sur un fond de couleur gris.
|
|
| 19 | + |
|
| 20 | + |
|
| 16 | 21 | Saisir un défunt
|
| 17 | 22 | ----------------
|
| 18 | 23 | |
| ... | ... | @@ -31,6 +36,7 @@ Les informations à saisir sont : |
| 31 | 36 | - le lieu de naissance
|
| 32 | 37 | - la date de décés
|
| 33 | 38 | - le lieu du décès
|
| 39 | +- si le défunt est mort pour la France
|
|
| 34 | 40 | - la parenté
|
| 35 | 41 | - historique du défunt : s'affiche lorsque des opérations sont effectués sur le défunt (non modifiable)
|
| 36 | 42 | - la date d'inhumation
|
| ... | ... | @@ -86,6 +86,8 @@ Ou |
| 86 | 86 | * place constatée
|
| 87 | 87 | * date de constat
|
| 88 | 88 | |
| 89 | +Si un ou plusieurs **morts pour la France** sont inhumés dans l'emplacement, alors un badge d'avertissement s'affiche sur la fiche de l'emplacement.
|
|
| 90 | + |
|
| 89 | 91 | .. _colombarium:
|
| 90 | 92 | |
| 91 | 93 | Le colombarium
|
| ... | ... | @@ -243,6 +245,23 @@ Le polygone peut aussi être dessiné s'il n'y a pas d'emplacement déjà dessin |
| 243 | 245 | |
| 244 | 246 | Une concession peut avoir plusieurs polygones.
|
| 245 | 247 | |
| 248 | +SIG externe
|
|
| 249 | +-----------
|
|
| 250 | + |
|
| 251 | +Lorsque le paramètre *option_localisation* a pour valeur *sig_externe*, il est alors possible d'accès au SIG paramétré dans l'application openCimetière.
|
|
| 252 | + |
|
| 253 | +Pour chaque emplacement, on peut accéder au SIG via un lien sur le listing.
|
|
| 254 | + |
|
| 255 | + |
|
| 256 | +.. image:: a_listing_concession_lien_sig_externe.png
|
|
| 257 | + |
|
| 258 | + |
|
| 259 | +Il est également possible d'y accéder via la fiche de l'emplacement.
|
|
| 260 | + |
|
| 261 | + |
|
| 262 | +.. image:: a_concession_lien_sig_externe.png
|
|
| 263 | + |
|
| 264 | + |
|
| 246 | 265 | ###########################################
|
| 247 | 266 | Affichage du plan en coupe de l'emplacement
|
| 248 | 267 | ###########################################
|
| ... | ... | @@ -264,4 +283,4 @@ Lorsqu'un vide sanitaire est présent sur l'emplacement, il est représenté sur |
| 264 | 283 | |
| 265 | 284 | .. image:: a_emplacement-emplacement_concession-plan-en-coupe-vide-sanitaire.png
|
| 266 | 285 | |
| 267 | -Si il n'y a pas de défunt dans une case de la grille, il est possible de verrouiller cette case en cliquant sur le bouton de verrouillage représenté par un cadenas. Les défunts ne peuvent pas être placer dans une case verrouillée. |
|
| \ No newline at end of file | ||
| 286 | +Si il n'y a pas de défunt dans une case de la grille, il est possible de verrouiller cette case en cliquant sur le bouton de verrouillage représenté par un cadenas. Les défunts ne peuvent pas être placer dans une case verrouillée. |
—
View it on GitLab.
You're receiving this email because of your account on gitlab.com. Manage all notifications · Help