From 5c75ff06f64f744e73831429ea8273e1277b9337 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9cile=20Vuilleumier?= Date: Fri, 24 Nov 2023 11:37:34 +0100 Subject: [PATCH] Improve documentation on snapping --- doc/administrator/editing.rst | 1 + .../{{cookiecutter.project}}/geoportal/CONST_vars.yaml | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/administrator/editing.rst b/doc/administrator/editing.rst index d5b038c0f8..f2f8c471f6 100644 --- 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/geoportal/c2cgeoportal_geoportal/scaffolds/update/{{cookiecutter.project}}/geoportal/CONST_vars.yaml b/geoportal/c2cgeoportal_geoportal/scaffolds/update/{{cookiecutter.project}}/geoportal/CONST_vars.yaml index 3e08814d67..3110c60842 100644 --- a/geoportal/c2cgeoportal_geoportal/scaffolds/update/{{cookiecutter.project}}/geoportal/CONST_vars.yaml +++ b/geoportal/c2cgeoportal_geoportal/scaffolds/update/{{cookiecutter.project}}/geoportal/CONST_vars.yaml @@ -642,9 +642,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