Skip to content

Commit

Permalink
docs: add page documenting the new mapper workflow (#1937)
Browse files Browse the repository at this point in the history
* Mapper_frontend Documentation

Added step by step guide for mapper frontend

Signed-off-by: Manjita Pandey <[email protected]>

* Updated workflow steps

* finalised the mapper frontend

* Resolved requested changes

Signed-off-by: Manjita Pandey <[email protected]>

* docs: update to mapper workflow docs on mapper frontend

---------

Signed-off-by: Manjita Pandey <[email protected]>
Co-authored-by: spwoodcock <[email protected]>
  • Loading branch information
manjitapandey and spwoodcock authored Dec 12, 2024
1 parent d645124 commit f8853b4
Show file tree
Hide file tree
Showing 2 changed files with 110 additions and 0 deletions.
109 changes: 109 additions & 0 deletions docs/manuals/mapping.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Mapper Frontend Documentation

The **Mapper Frontend** was developed to provide a simpler, more intuitive
mapping experience.

## Part (A): Setup For Mapping

### Step 1: Install The Custom ODK Collect Mobile App

- The first time you load the project, you should be prompted to download
the custom `.apk` from the sidebar.
- Once downloaded, you should install the custom ODK Collect application.

!!! tip

If you already have ODK Collect installed, you may have to uninstall
it first.

You may have to enable installing from unknown sources in your device
settings too.

### Step 2: Access the Mapper Frontend

- **Option 1:** Click the **Start Mapping** button on the project cards of
explore project page.
- **Option 2:** Click the **Start Mapping** button on the project details page.
- **Option 3:** Go to `https://fmtm.hotosm.org/mapnow/<project_id>` to open
the Mapper Frontend for a specific project.

!!! note

This functionality is designed for mappers in the field, so it is
recommended to use a mobile device to access it.

### Step 3: Configure ODK Collect (once only)

- **Option 1:** Scan the QR code displayed on the Mapper Frontend using
the custom ODK Collect mobile application.

- **Option 2:** Download the QR code and import it into ODK Collect to
load the project. Follow the steps below:

1. Open ODK Collect.
2. Click the project name in the top right corner.
3. Tap the **menu** icon (three horizontal dots).
4. Select **Import QR Code**.
5. Browse to the downloaded QR image and load the project.

!!! tip

For a demonstration of the process above, click the **i** info icon
on the QR Code tab of the mapper frontend.

### Step 4: Load Imagery (optional)

- You can load the reference base imagery by clicking on offline mode option
(second tab on bottom navigation bar).
- Choose the layer you want to load and click on **Show on Map** to visualise
the layer on map.
- The layer can also be stored for offline mapping by clicking
**Store Offline**.

## Part (B): Mapping Features

### Select An Existing Feature

In most cases we are submitting a survey about a feature that already exists.

- Click on a task area: the features within will be displayed.
- Now click on a feature you wish to map: a popup will appear.
- Now click 'Map Feature In ODK': ODK Collect will open, with the
feature pre-selected in the survey (no need to open the ODK map!).
- Complete the survey and submit.

!!! note

You may manually click 'Start Mapping' for a task area.

However, the task will be automatically locked for you
if you map a feature within the task area.

### Mapping A New Feature

Sometimes the feature does not exist on the map yet!

- Click on a task area: a popup will display.
- At the top right, there is a button **Map New Feature**.
- Click on the map to create a new geometry.
- ODK Collect will be opened automatically to fill out the survey
data for the newly created feature.

### Repeat The Process

- Once the form is submitted, you have to get back to FMTM and select the
another feature for mapping.
- You also also have to click the **Sync Status** button to see the feature
turn green.
- Select another feature to map (repeat from step 5)!

!!! note

You need internet access to update the feature status.

In a future release, this process will be handled seamlessly
without user interaction.

## Upcoming improvements

Refer the milestone: <https://github.com/hotosm/fmtm/milestone/50>
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ nav:
- Video Guides: manuals/videos.md
- User Types Explanation: manuals/user-breakdown.md
- Workflow Diagrams: manuals/workflow-diagrams.md
- Mapper Guide: manuals/mapping.md
- Project Manager Guide: manuals/project-managers.md
- XLSForm Design: manuals/xlsform-design.md
- ODKCollect Offline Maps: https://docs.getodk.org/collect-offline-maps
Expand Down

0 comments on commit f8853b4

Please sign in to comment.