Skip to content

Commit

Permalink
[Doc] Improve doc
Browse files Browse the repository at this point in the history
  • Loading branch information
babastienne committed Jan 6, 2025
1 parent 2d61fb5 commit 9bc0de6
Showing 1 changed file with 33 additions and 34 deletions.
67 changes: 33 additions & 34 deletions docs/advanced-configuration/map-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -244,15 +244,14 @@ Example::
PATH_SNAPPING_DISTANCE = 2.0

.. note::
- Change the distance. Better to keep it like this.
- Not used when ``TREKKING_TOPOLOGY_ENABLED = True``
- Used only when ``TREKKING_TOPOLOGY_ENABLED = True``

SNAP_DISTANCE
~~~~~~~~~~~~~~~

Distance of snapping for the cursor in pixels on Leaflet map.

Example::
Default value::

SNAP_DISTANCE = 30

Expand All @@ -261,45 +260,47 @@ PATH_MERGE_SNAPPING_DISTANCE

Minimum distance to merge two paths.

Example::
Default value::

PATH_MERGE_SNAPPING_DISTANCE = 2

.. note::
- Change the distance. Should be higher or the same as ``PATH_SNAPPING_DISTANCE``.
- Used when ``TREKKING_TOPOLOGY_ENABLED = True``.
- Should be higher or the same as ``PATH_SNAPPING_DISTANCE``.
- Used only when ``TREKKING_TOPOLOGY_ENABLED = True``.

TREK_POINTS_OF_REFERENCE_ENABLED
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Points of reference are enabled on form of treks.

Example::
Default value::

TREK_POINTS_OF_REFERENCE_ENABLED = True

Default::

False

OUTDOOR_COURSE_POINTS_OF_REFERENCE_ENABLED
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Points of reference are enabled on form of otudoor courses.

Example::
Default value::

OUTDOOR_COURSE_POINTS_OF_REFERENCE_ENABLED = True

Default::

False

TOPOLOGY_STATIC_OFFSETS
~~~~~~~~~~~~~~~~~~~~~~~~

Land objects are added on other objects (path for example) with offset, avoiding overlay.

DEFAULT

.. code-block:: python
TOPOLOGY_STATIC_OFFSETS = {'land': -5,
'physical': 0,
'circulation': 15,
'competence': 5,
'signagemanagement': -10,
'workmanagement': 10}
Example::

TOPOLOGY_STATIC_OFFSETS = {'land': -5, 'physical': 0, 'competence': 5, 'signagemanagement': -10, 'workmanagement': 10}
Expand All @@ -308,9 +309,6 @@ Example with more overlays::

TOPOLOGY_STATIC_OFFSETS = {'land': -7, 'physical': 0, 'competence': 7, 'signagemanagement': -14, 'workmanagement': 14}

.. note::
You should not change it to avoid overlay except if you want to have more overlays.

**All settings used to generate altimetric profile :**

.. code-block:: python
Expand All @@ -329,8 +327,14 @@ Example with more overlays::
ALTIMETRIC_AREA_MARGIN = 0.15
.. note::
- All these settings can be modified but you need to check the result every time
- The only one modified most of the time is ``ALTIMETRIC_PROFILE_COLOR``
For all these settings, we recommand you to check the result every time. Be careful, altimetric profiles are stored in cache so you need to force the re-generation of the computed images. To do so, you need to update the geometry of an object and save it, it'll re-create image and help verify your configuration.

After validation of your modifications, to force Geotrek to re-create all the altimetric profiles, you need to delete cached files in the folder ``/opt/geotrek-admin/var/media/profiles``.

.. code-block:: bash
cd /opt/geotrek-admin/var/media/profiles``
rm *
Disable darker map backgrounds
-------------------------------
Expand All @@ -340,17 +344,18 @@ MAPENTITY_CONFIG for map background

Since IGN map backgrounds are very dense and colourful, a dark opacity is applied. In order to disable, change this MapEntity setting:

Example::

MAPENTITY_CONFIG['MAP_BACKGROUND_FOGGED'] = False

Default::
Default value::

True
MAPENTITY_CONFIG['MAP_BACKGROUND_FOGGED'] = True

Map screenshots
----------------

When you generate a PDF in Geotrek-admin, a screenshot of the map with the object location is done. This section list all the available parameters to configure this screenshot. Therefore, if you change one of those values, pdfs will be rendered differently.

Display related objects
~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python
SHOW_SENSITIVE_AREAS_ON_MAP_SCREENSHOT = True
Expand All @@ -362,15 +367,9 @@ Map screenshots
MAP_CAPTURE_SIZE
~~~~~~~~~~~~~~~~~

Show objects on maps of PDF
Allow to change the size in pixels of the screenshot.

Example::

MAP_CAPTURE_SIZE = 800

.. note::
- Size in pixels of the capture.
- Be careful with your pdfs.
- If you change this value, pdfs will be rendered differently


0 comments on commit 9bc0de6

Please sign in to comment.