Skip to content

Commit

Permalink
Add notes and warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
bruhnild committed Jan 3, 2025
1 parent 8cd5ffb commit 5fea1a1
Show file tree
Hide file tree
Showing 10 changed files with 381 additions and 354 deletions.
9 changes: 3 additions & 6 deletions docs/import-data/import-from-touristic-data-systems.rst
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,6 @@ If you use an url that filters a unique category, you can change its name. Examp
'type1': "GeotrekTypeName",
}

URL to get Esp

.. _multiple-imports:

Multiple imports
Expand All @@ -218,7 +216,7 @@ Multiple imports
When you need to import data for the same object found in 2 different parsers, you can to force the aggregation of both values in many to many relationship case.
It can be interesting with portals for example.

Param for the aggregation : ``m2m_aggregate_fields``
Parameters for the aggregation : ``m2m_aggregate_fields``

Here is an example with 2 parsers :

Expand Down Expand Up @@ -259,10 +257,9 @@ In the following example, ``Provider_1Parser`` and ``Provider_2Parser`` will eac
provider = "provider_2"
.. danger::
It is recommended to use ``provider`` from the first import - Do not add a ``provider`` field to preexisting parsers that already imported objects, or you will have to manually set the same value for ``provider`` on all objects already created by this parser.

.. danger::
If a parser does not have a ``provider`` value, it will not take providers into account, meaning that it could delete objects from preceeding parsers even if these other parsers do have a ``provider`` themselves.
- It is recommended to use ``provider`` from the first import - Do not add a ``provider`` field to preexisting parsers that already imported objects, or you will have to manually set the same value for ``provider`` on all objects already created by this parser.
- If a parser does not have a ``provider`` value, it will not take providers into account, meaning that it could delete objects from preceeding parsers even if these other parsers do have a ``provider`` themselves.

The following example would cause ``NoProviderParser`` to delete objects from ``Provider_2Parser`` and ``Provider_1Parser``.

Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ You can explore **Geotrek-admin** in action through the demonstration website:

**Geotrek-admin** is built on Django and leverages a PostGIS database for handling geographical data. It serves as the data source for Geotrek-rando, Geotrek-widget, and other tools of the Geotrek ecosystem.

Learn more about Geotrek-admin in the :ref:`general documentation (french) <qu-est-ce-que-geotrek>`.
.. seealso::
Learn more about Geotrek-admin in the :ref:`general documentation (french) <qu-est-ce-que-geotrek>`.

.. toctree::
:caption: 💡 A propos
Expand Down
9 changes: 4 additions & 5 deletions docs/tutorials/topologies-issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,13 @@ Résumé des actions pouvant causer le problème
---------------------------------------------

.. example:: Suppression d'un tronçon utilisé par un itinéraire
:collapsible:

Lorsque vous supprimez un tronçon déjà utilisé par un itinéraire, un "trou" est créé dans la continuité des tronçons de l'itinéraire. Cela provoque une rupture immédiate du tracé de l'itinéraire, le rendant incorrect.

Pour corriger ce problème, il est nécessaire de recréer un tronçon à l'endroit du "trou" et de reconfigurer l'itinéraire afin qu'il intègre ce nouveau tronçon. De même, si vous modifiez l'extrémité d'un tronçon utilisé par un itinéraire, cette modification peut créer une discontinuité, rendant le tracé de l'itinéraire incohérent.


.. example:: Ajout d'un tronçon intersectant un itinéraire existant
:collapsible:

Lorsque vous ajoutez un tronçon qui vient intercepter l’un des tronçons déjà utilisés par un itinéraire, cela ne provoque pas automatiquement de rupture de l’itinéraire, car Geotrek recalculera normalement la topologie des tronçons pour s’ajuster aux changements.

Expand Down Expand Up @@ -72,10 +70,11 @@ Il est malheureusement plus facile de détecter les problèmes que de les corrig
5. Comment corriger le problème ?
==================================

Les solutions varient en fonction de la nature du problème :
.. example:: Les solutions varient en fonction de la nature du problème :

- Géométrie invalide : Lorsque la géométrie d'un itinéraire est invalide, il n’existe pas de correction automatique. La seule solution consiste à retracer manuellement l'itinéraire.
- Topologie invalide (géométrie intacte) : Si la topologie est invalide mais que la géométrie reste correcte, il est possible de lancer une commande pour réparer la topologie. La commande ``reorder_topologies`` est documentée :ref:`ici <reorder-topologies>`. Celle-ci peut corriger la plupart des erreurs de topologie. Pour toute assistance, n’hésitez pas à nous contacter pour lancer cette commande sur votre serveur.

- Géométrie invalide : Lorsque la géométrie d'un itinéraire est invalide, il n’existe pas de correction automatique. La seule solution consiste à retracer manuellement l'itinéraire.
- Topologie invalide (géométrie intacte) : Si la topologie est invalide mais que la géométrie reste correcte, il est possible de lancer une commande pour réparer la topologie. La commande ``reorder_topologies`` est documentée :ref:`ici <reorder-topologies>`. Celle-ci peut corriger la plupart des erreurs de topologie. Pour toute assistance, n’hésitez pas à nous contacter pour lancer cette commande sur votre serveur.

6. Quelle suite pour ce sujet ?
================================
Expand Down
4 changes: 3 additions & 1 deletion docs/tutorials/update-basemaps-layers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,4 +178,6 @@ En lançant ensuite l'interface, les fonds configurés seront disponibles. Les f

.. image:: ../images/tutorials/update-basemaps.jpeg

Des ressources complémentaires peuvent être trouvées sur `cet article <https://makina-corpus.com/logiciel-libre/bascule-ign-tutoriel-modification-fonds-plan-geotrek/>`_ .
.. seealso::

Des ressources complémentaires peuvent être trouvées sur `cet article <https://makina-corpus.com/logiciel-libre/bascule-ign-tutoriel-modification-fonds-plan-geotrek/>`_ .
33 changes: 17 additions & 16 deletions docs/user-manual/apis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ Cette API, désormais dans sa version 2 permet à toute structure tierce de réc

L'API Geotrek est le point central pour permettre les interconnexions avec divers services. Grâce à cette interface de données, Geotrek s'est positionné comme un point central dans un écosystème de solutions du monde de la gestion et promotion des activités de pleine nature.

Pour changer les paramètres d'accès de l'API, référez vous à cette section :ref:`API <api>`
.. seealso::

Pour changer les paramètres d'accès de l'API, référez vous à cette section :ref:`API <api>`

APIs externes
=============
Expand All @@ -32,22 +34,17 @@ Depuis cette version, 2 flux sont automatiquement générés par Geotrek-admin a
- [URL_GEOTREK-ADMIN]/api/cirkwi/circuits.xml
- [URL_GEOTREK-ADMIN]/api/cirkwi/pois.xml

Il est possible d'exclure les POI du flux pour ne diffuser que les randonnées. Pour cela, ajouter le paramètre ``?withoutpois=1`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?withoutpois=1``).
.. hint::

Il est possible de filtrer les POI du flux par structure. Pour cela, ajouter le paramètre ``?structures=<identifiant_de_la_structure>`` à la fin de l'URL (``http://XXXXX/api/cirkwi/pois.xml?structures=2``).
Vous pouvez filtrer avec plusieurs structures : en séparant les identifiants par des virgules (``http://XXXXX/api/cirkwi/pois.xml?structures=2,5,3``).
- **Exclure les POI du flux pour ne diffuser que les randonnées**. Pour cela, ajouter le paramètre ``?withoutpois=1`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?withoutpois=1``).

Il est également possible de filtrer les randonnées du flux par structure et par portail.
Pour cela, ajouter le paramètre ``?structures=<identifiant_de_la_structure>`` ou ``?portals=<identifian_de_la_structure>`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?portals=3``).
- **Filtrer les POI du flux par structure**. Pour cela, ajouter le paramètre ``?structures=<identifiant_de_la_structure>`` à la fin de l'URL (``http://XXXXX/api/cirkwi/pois.xml?structures=2``). Vous pouvez filtrer avec plusieurs structures : en séparant les identifiants par des virgules (``http://XXXXX/api/cirkwi/pois.xml?structures=2,5,3``).

Il est également possible d'exclure du flux les randonnées provenant de sources externes à Geotrek-Admin. Ce filtre est notamment nécessaire pour
ne pas renvoyer à Cirkwi les randonnées qui en proviennent déjà. Pour cela, ajouter le paramètre ``?include_externals=false`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?include_externals=false``).
- **Filtrer les randonnées du flux par structure et par portail**. Pour cela, ajouter le paramètre ``?structures=<identifiant_de_la_structure>`` ou ``?portals=<identifian_de_la_structure>`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?portals=3``).

Il est possible de cumuler ces différents filtres, en séparant les valeurs par un ``&`` (``http://XXXXX/api/cirkwi/circuits.xml?portals=3&structures=1&include_externals=false``).
- **Exclure du flux les randonnées provenant de sources externes à Geotrek-admin**. Ce filtre est notamment nécessaire pour ne pas renvoyer à Cirkwi les randonnées qui en proviennent déjà. Pour cela, ajouter le paramètre ``?include_externals=false`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?include_externals=false``).

Il est également possible d'exclure du flux les randonnées provenant de sources externes à Geotrek-Admin. Ce filtre est notamment nécessaire pour ne pas renvoyer à Cirkwi les randonnées qui en proviennent déjà. Pour cela, ajouter le paramètre ``?include_externals=false`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?include_externals=false``).

Il est possible de cumuler ces différents filtres, en séparant les valeurs par un ``&`` (``http://XXXXX/api/cirkwi/circuits.xml?portals=3&structures=1&include_externals=false``).
- **Cumuler ces différents filtres**, en séparant les valeurs par un ``&`` (``http://XXXXX/api/cirkwi/circuits.xml?portals=3&structures=1&include_externals=false``).

Le référentiel CIRKWI a été intégré dans 3 tables accessibles dans le module de configuration (à ne pas modifier) :

Expand All @@ -57,7 +54,7 @@ Le référentiel CIRKWI a été intégré dans 3 tables accessibles dans le modu

Ensemble des champs paramétrables pour le référentiel CIRKWI

Si vous ne souhaitez pas utiliser les valeurs par défaut ou avez créez vos propres typologies, il faut que vous renseigniez les correspondances entre les catégories de votre Geotrek et celles du référentiel IGN (Cirkwi) dans le module de configuration. Comme indiqué ici : https://github.com/GeotrekCE/Geotrek-admin/issues/806.
Si vous ne souhaitez pas utiliser les valeurs par défaut ou avez créez vos propres typologies, il faut que vous renseigniez les correspondances entre les catégories de votre Geotrek et celles du référentiel IGN (Cirkwi) dans le module de configuration, comme indiqué `dans ce ticket Github <https://github.com/GeotrekCE/Geotrek-admin/issues/806>`_.

* Pratique >> locomotion/loisirs
* Accessibilite >> thematiques/tags
Expand All @@ -66,7 +63,7 @@ Si vous ne souhaitez pas utiliser les valeurs par défaut ou avez créez vos pro

Les correspondances avec les valeurs de ces 3 tables sont donc à renseigner dans les tables Geotrek des Pratiques, Accessibilités, Thèmes et Types de POI.

Ce même flux est aussi utilisable pour alimenter directement la plateforme Cirkwi : https://pro.cirkwi.com/importez-vos-donnees-geotrek-dans-cirkwi/.
Ce même flux est aussi utilisable pour alimenter directement la plateforme Cirkwi (`voir cette page <https://pro.cirkwi.com/importez-vos-donnees-geotrek-dans-cirkwi/>`_).

.. note::

Expand All @@ -89,7 +86,9 @@ Les contenus touristiques peuvent aussi être synchronisés depuis des flux Tour

Il est également possible de mettre en place des passerelles pour importer des POIs, des lieux de renseignement, des aménagements ainsi que des randonnées d'APIDAE vers Geotrek. Il est aussi possible d'enrichir le lien avec les contenus touristiques pour avoir par exemple d'autres catégories.

Pour configurer APIDAE, se référer à cette section :ref:`Import from APIDAE <import-from-apidae>`
.. seealso::

Pour configurer APIDAE, se référer à cette section :ref:`Import from APIDAE <import-from-apidae>`

Geotrek vers APIDAE
~~~~~~~~~~~~~~~~~~~
Expand All @@ -100,7 +99,9 @@ L'API permet de connecter une instance Geotrek pour importer des itinéraires ve

Les randonnées VTT, trail, vélo et les tours itinérants sont également intégrés dans la passerelle.

Pour plus d'information, se référer à la documentation en ligne de `Sitourisme <https://github.com/GeotrekCE/Sitourisme#sitourisme-paca-api>`_.
.. seealso::

Pour plus d'information, se référer à la documentation en ligne de `Sitourisme <https://github.com/GeotrekCE/Sitourisme#sitourisme-paca-api>`_.


Sensitivity module (or Biodiv'Sports)
Expand Down
15 changes: 10 additions & 5 deletions docs/user-manual/editing-objects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ Nous calculons le `dénivelé positif cumulé <https://fr.wikipedia.org/wiki/D%C
Nous échantillonnons le DEM tous les 25m par défaut (voir paramètre ``ALTIMETRIC_PROFILE_PRECISION``),
et nous ajoutons un peu de lissage pour éviter le bruit.

Pour plus de détails :
.. seealso::

* `The smoothing explanation <https://github.com/GeotrekCE/Geotrek-admin/issues/840#issuecomment-30229813>`_
* `The smoothing explanation <https://github.com/GeotrekCE/Geotrek-admin/issues/840#issuecomment-30229813>`_

* `The piece of code to compute positive and negative accumulations <https://github.com/GeotrekCE/Geotrek-admin/blob/v0.27.2/geotrek/altimetry/sql/00_utilities.sql#L113-L132>`_
* `The piece of code to compute positive and negative accumulations <https://github.com/GeotrekCE/Geotrek-admin/blob/v0.27.2/geotrek/altimetry/sql/00_utilities.sql#L113-L132>`_

* `Draping lines with PostGIS <http://blog.mathieu-leplatre.info/drape-lines-on-a-dem-with-postgis.html>`_ (or `french version <http://makina-corpus.com/blog/metier/2013/draper-des-lignes-sur-un-mnt-avec-postgis>`_)
* `Draping lines with PostGIS <http://blog.mathieu-leplatre.info/drape-lines-on-a-dem-with-postgis.html>`_ (or `french version <http://makina-corpus.com/blog/metier/2013/draper-des-lignes-sur-un-mnt-avec-postgis>`_)

Lien entre les POIs et les itinéraires
---------------------------------------
Expand Down Expand Up @@ -87,14 +87,19 @@ Cette information est visible à travers le profil altimétrique pour les tronç

.. figure:: ../images/user-manual/altimetrie.png

Pour importer automatiquement un MNT, se référer à la section :ref:`Import DEM (altimetry) <import-dem-altimetry>`
.. seealso::

Pour importer automatiquement un MNT, se référer à la section :ref:`Import DEM (altimetry) <import-dem-altimetry>`

Attributs aditionnels sur les objets
=====================================

* `Tutoriel - ajout de photos <http://youtu.be/n96O09284ao>`_ :

.. image:: https://img.youtube.com/vi/n96O09284ao/maxresdefault.jpg
:alt: Ajout de photos
:target: https://img.youtube.com/vi/n96O09284ao


Ajout de fichiers
------------------
Expand Down
7 changes: 5 additions & 2 deletions docs/user-manual/interfaces.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Interface, navigation et saisie
Navigation et saisie
====================

Les résultats sont affichés sous forme de carte et liste puis on accède aux détails des objets.
Les résultats sont affichés sous forme de carte et liste, puis on accède aux détails des objets.

`Présentation de l'interface <http://youtu.be/-iVe9cwBZ50>`_ :

Expand Down Expand Up @@ -122,4 +122,7 @@ Toutes les listes de choix (thématiques, pratiques, parcours…) sont administr

Exemple d’édition des pratiques et de leur pictogramme

Voir la section :ref:`Paramétrage des modules <parametrages-des-modules>`
.. seealso::
Voir la section :ref:`Paramétrage des modules <parametrages-des-modules>`


8 changes: 6 additions & 2 deletions docs/user-manual/management-modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,9 @@ Comme pour les autres modules, il sont intersectés avec les autres modules pour

Il est aussi possible de les exporter, de leur attacher des fichiers (images, PDF, tableurs, ZIP...) et d'en consulter l'historique des modifications.

Pour importer automatiquement des éléments d'aménagements, se référer à la section :ref:`Import Infrastructure <import-infrastructure>`
.. seealso::

Pour importer automatiquement des éléments d'aménagements, se référer à la section :ref:`Import Infrastructure <import-infrastructure>`

.. _la-signaletique:

Expand All @@ -93,7 +95,9 @@ Pour une signalétique, il est possible de définir chaque lame et chaque ligne

.. image:: ../images/user-manual/signage.png

Pour importer automatiquement des éléments de signalétiques, se référer à la section :ref:`Import Signage <import-signage>`
.. seealso::

Pour importer automatiquement des éléments de signalétiques, se référer à la section :ref:`Import Signage <import-signage>`

.. _les-interventions:

Expand Down
10 changes: 6 additions & 4 deletions docs/user-manual/static-pages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Les pages statiques sont les pages d'information et de contextualisation de votr

.. figure:: ../images/user-manual/flatpages-gtecrins.jpg

Exemple de page statique (https://www.grand-tour-ecrins.fr/information/1-Le-Grand-Tour-des-Ecrins)
`Exemple de page statique <https://www.grand-tour-ecrins.fr/information/1-Le-Grand-Tour-des-Ecrins>`_

Les pages statiques permettent de fournir à l’internaute et futur randonneur des informations génériques : présentation de votre territoire, structures, partenaires, recommandations, informations pratiques, etc.

Expand Down Expand Up @@ -199,7 +199,9 @@ Comment procéder ?
- remplacer l'ancien code avec le contenu nettoyé dans la fenêtre de l'outil *code*, valider
- refaire la mise en forme

Il existe beaucoup de service web pour nettoyer un contenu de ses balises HTML. Voici les deux premiers résultats provenant d'un moteur de recherche :
.. seealso::

- https://striphtml.com/
- https://www.w3docs.com/tools/string-remove-tags
Il existe beaucoup de service web pour nettoyer un contenu de ses balises HTML. Voici les deux premiers résultats provenant d'un moteur de recherche :

- `Striphtml <https://striphtml.com/>`_
- `W3docs <https://www.w3docs.com/tools/string-remove-tags>`_
Loading

0 comments on commit 5fea1a1

Please sign in to comment.