map annotations

Author: alex-cit

src/.vitepress/sidebar/en.js

@@ -89,6 +89,7 @@ export default {
         { text: 'Synchronisation in Mergin Maps Mobile App', link: '/field/autosync/' },
         { text: 'Measurement Tools', link: '/field/measure/' },
         { text: 'Layers in Mergin Maps Mobile App', link: '/field/layers/' },
+        { text: 'Map Annotations', link: '/field/map-annotations/' },
         { text: 'How to Add, Edit, Delete Features', link: '/field/mobile-features/' },
         { text: 'How to Reuse Last Entered Values', link: '/field/reuse-last-values/' },
         { text: 'How to Stake Out Points', link: '/field/stake-out/' },

src/field/map-annotations/index.md

@@ -0,0 +1,48 @@
+# Map Annotations in Mergin Maps Mobile App
+[[toc]]
+
+Map annotations can be used to draw something on the map, in addition to the regular field collection of [features](../mobile-features/).
+
+## Set up map annotations in QGIS project
+
+Map annotations need to be enabled in QGIS when [preparing your <MainPlatformName /> project](../../gis/features/#map-annotations).
+
+1. Open your <MainPlatformName /> project in QGIS
+2. Navigate to **Project** > **Properties** 
+   ![QGIS Project Properties](../../gis/qgis-project-properties.jpg "QGIS Project Properties")
+
+3. In the <MainPlatformName /> tab, check the **Enable map annotations layer** option.
+   ![Enable map annotations in QGIS Mergin Maps project](../../gis/features/project-map-annotations.jpg "Enable map annotations in QGIS Mergin Maps project")
+
+   You can also change the colour set to define the colours that will be available in the <MobileAppNameShort />.
+
+4. Save the changes. 
+
+   A new layer named `map_annotations_layer` will be added to the project. This layer is used to store the annotations.
+
+5. Save and synchronise your project!
+
+::: tip 
+If you do not see this option in the **Project properties**, check for [plugin upgrades](../../setup/install-mergin-maps-plugin-for-qgis/#plugin-upgrade).
+:::
+
+## Map annotations in the mobile app
+To use map annotations in the <MobileAppNameShort />, make sure they are [enabled in the project](#set-up-map-annotations-in-qgis-project).
+
+1. Tap the **Map annotations** button
+   ![Map annotations button in Mergin Maps mobile app](./mobile-map-annotations-button.jpg "Map annotations button in Mergin Maps mobile app")
+
+2. The **Annotations** bar appears.
+   - Draw your annotations on the map by freehand or using a stylus.
+   
+   You choose from 7 annotation colours. The colour set can be changed in the [project properties](#set-up-map-annotations-in-qgis-project) in QGIS.
+   ![Map annotations in Mergin Maps mobile app](./mobile-map-annotations.jpg "Map annotations in Mergin Maps mobile app")
+
+   - Made a mistake? Use the **Eraser** button to remove your annotations.
+   ![Erase map annotations in Mergin Maps mobile app](./mobile-map-annotations-eraser.jpg "Erase map annotations button in Mergin Maps mobile app")
+
+4. Sync your changes to <MainPlatformNameLink />.
+   
+   In QGIS, the annotations will be displayed in the `map_annotations_layer`.
+   ![Map annotations in Mergin Maps project in QGIS](./qgis-map-annotations.jpg "Map annotations in Mergin Maps project in QGIS")
+

src/field/map-annotations/mobile-map-annotations-button.jpg

@@ -1,3 +1,7 @@
+---
+outline: [1,3]
+---
+
 # QGIS Project Preparation
 [[toc]]
 
@@ -95,6 +99,15 @@ Tracking your position when doing the field survey with <MobileAppName /> can be
 
 You can read more about this functionality in [How to Use Tracking in Mergin Maps mobile app](../../field/tracking/).
 
+### Map annotations
+<SinceBadge type="Plugin" version="2025.X" />
+
+Map annotations for the <MobileAppNameShort /> can be enabled in the **<MainPlatformName />** tab in **Project properties**. Here, you can also set the colours that will be available for annotations.
+
+![Enable map annotations in QGIS Mergin Maps project](./project-map-annotations.jpg "Enable map annotations in QGIS Mergin Maps project")
+
+You can read more about this functionality in [Map Annotations](../../field/map-annotations/).
+
 ### Map themes
 [Map Themes](../setup_themes/) make possible to switch between different background maps in <MobileAppName /> (e.g. cartography maps and aerial imagery)
 

src/field/map-annotations/mobile-map-annotations-button.xcf

@@ -89,6 +89,7 @@ The ecosystem consist of various components:
 - [Synchronisation in <MobileAppName />](./field/autosync/)
 - [Measurement Tools](./field/measure/)
 - [Layers in <MobileAppName />](./field/layers/)
+- [Map Annotations in <MobileAppName />](./field/map-annotations/)
 - [How to Add, Edit, Delete Features](./field/mobile-features/)
 - [How to Reuse Last Entered Values](./field/reuse-last-values/)
 - [How to Stake Out Points](./field/stake-out/)