Improve documentation on snapping

camptocamp · Nov 24, 2023 · 4ce240e · 4ce240e
1 parent 036b94f
commit 4ce240e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/doc/administrator/editing.rst b/doc/administrator/editing.rst
@@ -122,6 +122,7 @@ Enable snapping
 To be able to snap while editing, the ``snappingConfig`` must be set on the layer metadata.
 The value is a ``json`` object containing the following optional properties:
 
+* activated (boolean): whether snapping is activated by default (default: true);
 * edge (boolean): whether to allow snapping on edges or not;
 * vertex (boolean): whether to allow snapping on vertices or not;
 * tolerance (number): the pixel tolerance.

diff --git a/...2cgeoportal_geoportal/scaffolds/update/{{cookiecutter.project}}/geoportal/CONST_vars.yaml b/...2cgeoportal_geoportal/scaffolds/update/{{cookiecutter.project}}/geoportal/CONST_vars.yaml
@@ -682,9 +682,9 @@ vars:
       - name: snappingConfig
         type: json
         description: >
-          The snapping configuration for the layer. If set, the layer is considered to be
-          "snappable", even if the config itself is empty. Example value: {"tolerance": 50, "edge":
-          false}.
+          The snapping configuration for the layer. If set, even if empty, the layer is considered to be
+          "snappable" and snapping is activated by default. To disable snapping by default, set "activated"
+          to false. Example value: {"tolerance": 50, "edge": false}.
         relevant_for:
           - layer_wms
       - name: geometryValidation