Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update mapping.md #2012

Open
wants to merge 3 commits into
base: development
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 26 additions & 6 deletions docs/manuals/mapping.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
# Mapper Frontend Documentation

The **Mapper Frontend** was developed to provide a simpler, more intuitive
The **Mapper's page** 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.
the custom `.apk` from the upper right corner of your browser window
usually represented by three horizontal lines (☰).

- Once downloaded, you should install the custom ODK Collect application.
For installation, locate the downloaded ODK APK file usually found on
downloads section of your file manager and tap install.

!!! tip

Expand All @@ -19,7 +23,19 @@ mapping experience.
You may have to enable installing from unknown sources in your device
settings too.

### Step 2: Access the Mapper Frontend
### Step 2: Add metadata on odk application(Optional)
Copy link
Member

@spwoodcock spwoodcock Dec 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this section should be removed, as its not something the user should have to configure manually. All the fields you mention are already included by default.

Sure we don't actually inject an email or phoje number into the field yet (as they are not available, we may never do this), but they are enabled anyway


The metadata like username, email, phone number and device ID can be added
on odk from settings. This addition allows FMTM to track submission by
username and filter data by mapppers.

- Go to settings of odk project.
- Click on User and device identity.
- Click on form metadata and add username, phone number and email address.
**Note:** The username may be prepopulated with the osm username of
FMTM. Please confirm or update the username if necessary

### Step 3: Access the Mapper Frontend

- **Option 1:** Click the **Start Mapping** button on the project cards of
explore project page.
Expand All @@ -30,9 +46,10 @@ mapping experience.
!!! note

This functionality is designed for mappers in the field, so it is
recommended to use a mobile device to access it.
recommended to use a mobile device to access it. Furthermore, mappers
are encouraged to use Chrome based browser for field mapping activity.

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

- **Option 1:** Scan the QR code displayed on the Mapper Frontend using
the custom ODK Collect mobile application.
Expand All @@ -46,12 +63,15 @@ mapping experience.
4. Select **Import QR Code**.
5. Browse to the downloaded QR image and load the project.

If you missed the QR code pop-up, You can get the it anytime from
QR code tab on bottom navigation bar of the mapper's page.

!!! 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)
### Step 5: Load Imagery (optional)

- You can load the reference base imagery by clicking on offline mode option
(second tab on bottom navigation bar).
Expand Down
Loading