Skip to content
Merged
Show file tree
Hide file tree
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
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# Mergin Maps Documentation

- [Staging/Dev deployment](https://dev.merginmaps.com/docshttps://dev.merginmaps.com/docs)
- [Staging/Dev deployment](https://dev.merginmaps.com/docs)
- [Production deployment](https://merginmaps.com/docs)

Source code for documentation hosted on [merginmaps.com/docs](https://merginmaps.com/docs)
Expand All @@ -13,6 +13,8 @@ Source code for documentation hosted on [merginmaps.com/docs](https://merginmaps

Use GitHub Pull Requests to propose changes, we will review and merge your changes!

<div><img align="left" width="45" height="45" src="https://raw.githubusercontent.com/MerginMaps/docs/main/src/.vuepress/public/slack.svg"><a href="https://merginmaps.com/community/join">Join our community chat</a><br/>and ask questions!</div>

## Development Workflow

- For new features coming in the next release create pull request to `dev` branch.
Expand Down
34 changes: 34 additions & 0 deletions src/.vuepress/components/CommunityJoin.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<template>
<div>
<img :src="$withBase('/slack.svg')" alt="Join Community">
<span>
<a href='https://merginmaps.com/community/join' target="_blank" rel="noopener noreferrer">
Join
</a>
our community chat and
<a href='https://merginmaps.com/community/join' target="_blank" rel="noopener noreferrer">
ask
</a>
questions!
</span>
</div>
</template>

<style scoped>
div {
margin-left: 20px;
width: 100%;
display: flex;
}

img {
border: none;
height: 48px;
}

span {
margin-top: 15px;
margin-left: 10px;
}

</style>
17 changes: 17 additions & 0 deletions src/.vuepress/public/slack.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions src/howto/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ How to contribute to the project?
We are happy to help to promote work or co-author and place on our websites or give
special offer for Mergin Maps Cloud for project contributors.

<CommunityJoin />

## Use and Review

Write a review of the application on App Store or Android Google Play
Expand Down
Binary file added src/howto/project/input_forms_many-photos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/howto/project/input_forms_many-relations1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/howto/project/input_forms_many-relations2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/howto/project/input_forms_one-to-many.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
78 changes: 74 additions & 4 deletions src/howto/project/settingup_forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ You can follow the examples in this section by cloning the following projects:
- <MerginMapsProject id="documentation/form_setup" />
- <MerginMapsProject id="documentation/form_cascade" />
- <MerginMapsProject id="documentation/test_qrcode" />
- <MerginMapsProject id="documentation/forms_one-to-many-relations" />
- <MerginMapsProject id="documentation/forms_multiple_photos" />
:::


Expand Down Expand Up @@ -99,7 +101,7 @@ To use the numeric widget in your form from Input:

![slider](./input_forms_number1.png)

## Slider
## Slider

For setting up a slider, ensure your field type is an integer.

Expand Down Expand Up @@ -145,9 +147,9 @@ To have a more advanced form with drill-down menu option, see cascade form setup
## QR code reader
To be able to use your camera in forms to scan QR codes and populate the text in the field

### QGIS
### QGIS

To be able to scan QR codes in your forms, your field or the alias for the field should contain **qrcode** (the text is not case sensitive and it can be be in combination of lower or upper case letters). For an example, see the <MerginMapsProject id="documentation/test_qrcode" />
To be able to scan QR codes in your forms, your field or the alias for the field should contain **qrcode** (the text is not case sensitive and it can be be in combination of lower or upper case letters). For an example, see the <MerginMapsProject id="documentation/test_qrcode" />

### Input

Expand All @@ -164,7 +166,7 @@ To use the QR code scanner in the form from Input:
![slider](./input_forms_qrcode.jpg)


## Datetime
## Datetime

If you want to record time and date when you capture the feature, you need to make sure you have a field with **Date** or **Date and Time** type present in your survey layer. Note that all GIS data formats support these types of field. It is assumed, you use Geopackage layer, hence this field type is supported.

Expand Down Expand Up @@ -310,3 +312,71 @@ To use the drop-down widget in the form from Input:
![slider](./input_forms_valuerelation1.png)
![slider](./input_forms_valuerelation2.png)
![slider](./input_forms_valuerelation3.png)

## 1-N relations

It is often the case that you have a set of spatial features and you want to record some parameters every now and then. For example, there is a GIS layer representing the manholes and the surveyors carry out regular inspections of the manholes. Instead of duplicating the manhole layer and recording each inspection, you can create a non-spatial table and store each inspection as a new line.

The image below shows the manholes locations:

![Manhole locations](./input_forms_many-relations_concept1.png)

The manhole point layer has the following attribute table:

![Manhole locations](./input_forms_many-relations_concept2.png)

In a separate table (which is non-spatial), we can record the inspections:

![Manhole locations](./input_forms_many-relations_concept3.png)

In QGIS, we are using the **Manhole ID** from the point layer and the inspection table, to create a 1-N relationship between the two tables.

Another example is when you try to capture multiple photos for a single feature.

In the sections below, you can see how this type of relations can be set up in QGIS and utilised in the Input app.

### Project preparation in QGIS

See the example projects:
- Assigning multiple inspections to a single feature: <MerginMapsProject id="documentation/forms_one-to-many-relations" />
- Adding multiple photos to a single feature: <MerginMapsProject id="documentation/forms_multiple_photos" />

To configure 1-N relations in QGIS:
- From the main menu, select **Projects** > **Properties ...**
- In the new window, select the **Relations** tab
- Select **Add Relation** to create a new one
- A new window will appear, where we can define the parent and child layers and the fields to link the two layers:
- For **Name** type **Inspection**
- For the **Referenced(parent)** layer, select **manhole_locations**
- For **Field 1** of the **Referenced(parent)** layer, select **Manhole**
- For the **Referencing(child)** layer, select **inspections**
- For **Field 1** of the **Referencing(child)** layer, select **Manhole ID**

![1-N relations in QGIS](./input_forms_many-relations1.png)

This should now allow you to add multiple inspections for each manhole location (**manhole_locations** point layer). The inspections records will be stored in the **inspections** table.

When you open the form for an existing record in the **manhole_locations** point layer, you should be able to see the existing inspection records and optionally add, delete or edit the records:

![1-N relations in QGIS - form view](./input_forms_many-relations2.png)

The same project when you open add inspection to a manhole in Input will look like the image below:

![Many photos to a single feature](./input_forms_one-to-many.png)

### Link multiple photos to a single feature

Another use-case for having multiple photos linked to a single feature is using 1-N relation.

To set up a project in QGIS, similar to the previous example, we need a unique field to link the following two tables:
- Survey layer (containing spatial information)
- A non-spatial table containing path to the photos

The key part when linking the above to table is to avoid using **FID** field in the GeoPackage. Mergin uses the FID to consolidate changes and therefore can change the FIDs. This will result in having photos linked to the incorrect feature on the map.

For that, we can create a new field and use the **uuid()** as the default value. To learn more about how this can be configured, you can see <MerginMapsProject id="documentation/forms_multiple_photos" />.

Input detects the type of 1-N relation is for "Attachment" widget and displays the image viewer for the relations.

![Many photos to a single feature](./input_forms_many-photos.png)

1 change: 1 addition & 0 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Enjoy the feeling when you make sense of your geo-data on maps
- Setup and analyze the project on desktop with QGIS. :computer:
- All open-source and easily integrated to your existing toolset :bulb:

<CommunityJoin />

## Get started

Expand Down
Binary file added src/project/input_forms_one-to-many_concept3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.