Skip to content

Commit 27638df

Browse files
committed
restructure forms
1 parent 0b796cd commit 27638df

35 files changed

+312
-501
lines changed

REDIRECTS

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ https://help.cloudmergin.com/plugin-installation https://merginmaps.com/docs/set
2828
https://help.cloudmergin.com/plugin-logs https://merginmaps.com/docs/misc/troubleshoot/
2929
https://help.cloudmergin.com/plugin-new-project https://merginmaps.com/docs/manage/create-project/
3030
https://help.cloudmergin.com/plugin-sync-project https://merginmaps.com/docs/manage/plugin/
31-
https://help.cloudmergin.com/plugin-variables https://merginmaps.com/docs/layer/plugin-variables/
31+
https://help.cloudmergin.com/plugin-variables https://merginmaps.com/docs/layer/extra-variables/
3232
https://help.cloudmergin.com/project-advanced https://merginmaps.com/docs/manage/project-advanced/
3333
https://help.cloudmergin.com/project-details https://merginmaps.com/docs/manage/project-history/
3434
https://help.cloudmergin.com/quick-start https://merginmaps.com/docs/tutorials/capturing-first-data/
@@ -62,7 +62,7 @@ https://help.inputapp.io/howto/exif_metadata https://merginmaps.com/docs/layer/e
6262
https://help.inputapp.io/howto/external_gps https://merginmaps.com/docs/field/external_gps/
6363
https://help.inputapp.io/howto/gps_accuracy https://merginmaps.com/docs/field/gps_accuracy/
6464
https://help.inputapp.io/howto/package_qgis_project https://merginmaps.com/docs/manage/create-project/
65-
https://help.inputapp.io/howto/position_variables https://merginmaps.com/docs/layer/position_variables/
65+
https://help.inputapp.io/howto/position_variables https://merginmaps.com/docs/layer/extra-variables/
6666
https://help.inputapp.io/howto/proj https://merginmaps.com/docs/gis/proj/
6767
https://help.inputapp.io/howto/project_config https://merginmaps.com/docs/gis/features/
6868
https://help.inputapp.io/howto/registration https://merginmaps.com/docs/setup/sign-up-to-mergin-maps/
@@ -75,11 +75,11 @@ https://help.inputapp.io/howto/settingup_background_map https://merginmaps.com/d
7575
https://help.inputapp.io/howto/settingup_background_map_rastertile https://merginmaps.com/docs/gis/settingup_background_map/
7676
https://help.inputapp.io/howto/settingup_background_map_vectortile https://merginmaps.com/docs/gis/settingup_background_map/
7777
https://help.inputapp.io/howto/settingup_forms https://merginmaps.com/docs/layer/form-widgets/
78-
https://help.inputapp.io/howto/settingup_forms_cascade https://merginmaps.com/docs/layer/form-configuration/
78+
https://help.inputapp.io/howto/settingup_forms_cascade https://merginmaps.com/docs/layer//value-select/
7979
https://help.inputapp.io/howto/settingup_forms_checkbox https://merginmaps.com/docs/layer/form-widgets/
80-
https://help.inputapp.io/howto/settingup_forms_constraints https://merginmaps.com/docs/layer/form-configuration/
80+
https://help.inputapp.io/howto/settingup_forms_constraints https://merginmaps.com/docs/layer//constraints/
8181
https://help.inputapp.io/howto/settingup_forms_datetime https://merginmaps.com/docs/layer/form-widgets/
82-
https://help.inputapp.io/howto/settingup_forms_defaults https://merginmaps.com/docs/layer/form-configuration/
82+
https://help.inputapp.io/howto/settingup_forms_defaults https://merginmaps.com/docs/layer/default-values/
8383
https://help.inputapp.io/howto/settingup_forms_layout https://merginmaps.com/docs/layer/form-layout/
8484
https://help.inputapp.io/howto/settingup_forms_number https://merginmaps.com/docs/layer/form-widgets/
8585
https://help.inputapp.io/howto/settingup_forms_one-to-many https://merginmaps.com/docs/layer/one-to-n-relations/
@@ -90,7 +90,7 @@ https://help.inputapp.io/howto/settingup_forms_text https://merginmaps.com/docs/
9090
https://help.inputapp.io/howto/settingup_forms_valuemap https://merginmaps.com/docs/layer/form-widgets/
9191
https://help.inputapp.io/howto/settingup_forms_valuerelation https://merginmaps.com/docs/layer/form-widgets/
9292
https://help.inputapp.io/howto/setup_themes https://merginmaps.com/docs/gis/setup_themes/
93-
https://help.inputapp.io/howto/working_with_nonspatial_data https://merginmaps.com/docs/layer/non-spatial-data/
93+
https://help.inputapp.io/howto/working_with_nonspatial_data https://merginmaps.com/docs/layer/overview/
9494
https://help.inputapp.io/input_ui https://merginmaps.com/docs/field/mobile-app-ui/
9595
https://help.inputapp.io/licensing https://merginmaps.com/docs/misc/licensing/
9696
https://help.inputapp.io/privacy N/A -- handled by https://merginmaps.com/privacy-policy/
@@ -140,7 +140,7 @@ https://merginmaps.com/docs/howto/manage/plugin/install/ https://merginmaps.com/
140140
https://merginmaps.com/docs/howto/manage/plugin/plugin-delete-project/ https://merginmaps.com/docs/manage/project-advanced/
141141
https://merginmaps.com/docs/howto/manage/plugin/plugin-new-project/ https://merginmaps.com/docs/manage/create-project/
142142
https://merginmaps.com/docs/howto/manage/plugin/plugin-sync-project/ https://merginmaps.com/docs/manage/plugin/
143-
https://merginmaps.com/docs/howto/manage/plugin/plugin-variables/ https://merginmaps.com/docs/layer/plugin-variables/
143+
https://merginmaps.com/docs/howto/manage/plugin/plugin-variables/ https://merginmaps.com/docs/layer/extra-variables/
144144
https://merginmaps.com/docs/howto/manage/troubleshoot/ https://merginmaps.com/docs/misc/troubleshoot/
145145
https://merginmaps.com/docs/howto/manage/web/dashboard/ https://merginmaps.com/docs/manage/dashboard/
146146
https://merginmaps.com/docs/howto/manage/web/project-advanced/ https://merginmaps.com/docs/manage/project-advanced/
@@ -151,7 +151,7 @@ https://merginmaps.com/docs/howto/manage/web/web-create-project/ https://merginm
151151
https://merginmaps.com/docs/howto/manage/web/working-with-organisations/ https://merginmaps.com/docs/manage/workspaces/
152152
https://merginmaps.com/docs/howto/mergince/ https://merginmaps.com/docs/server/
153153
https://merginmaps.com/docs/howto/mergin-tour/ https://merginmaps.com/docs/tutorials/creating-a-project-in-qgis/
154-
https://merginmaps.com/docs/howto/position_variables/ https://merginmaps.com/docs/layer/position_variables/
154+
https://merginmaps.com/docs/howto/position_variables/ https://merginmaps.com/docs/layer/extra-variables/
155155
https://merginmaps.com/docs/howto/proj/ https://merginmaps.com/docs/gis/proj/
156156
https://merginmaps.com/docs/howto/project/enable_browsing/ https://merginmaps.com/docs/gis/search_data/
157157
https://merginmaps.com/docs/howto/project/enable_digitising/ https://merginmaps.com/docs/gis/enable_digitising/
@@ -162,17 +162,22 @@ https://merginmaps.com/docs/howto/project/selective_sync/ https://merginmaps.com
162162
https://merginmaps.com/docs/howto/project/settingup_background_map/ https://merginmaps.com/docs/gis/settingup_background_map/
163163
https://merginmaps.com/docs/howto/project/settingup_forms/ https://merginmaps.com/docs/layer/form-widgets/
164164
https://merginmaps.com/docs/howto/project/settingup_forms_photo/ https://merginmaps.com/docs/layer/photos/
165-
https://merginmaps.com/docs/howto/project/settingup_forms_settings/ https://merginmaps.com/docs/layer/form-configuration/
165+
https://merginmaps.com/docs/howto/project/settingup_forms_settings/ https://merginmaps.com/docs/layer/overview/
166166
https://merginmaps.com/docs/howto/project/setup_themes/ https://merginmaps.com/docs/gis/setup_themes/
167-
https://merginmaps.com/docs/howto/project/working_with_nonspatial_data/ https://merginmaps.com/docs/layer/non-spatial-data/
167+
https://merginmaps.com/docs/howto/project/working_with_nonspatial_data/ https://merginmaps.com/docs/layer/overview/
168168
https://merginmaps.com/docs/howto/quick-start/ https://merginmaps.com/docs/tutorials/capturing-first-data/
169169
https://merginmaps.com/docs/howto/reuse_last_values/ https://merginmaps.com/docs/field/reuse-last-values/
170170
https://merginmaps.com/docs/howto/sign-up-to-mergin-maps/ https://merginmaps.com/docs/setup/sign-up-to-mergin-maps/
171+
https://merginmaps.com/docs/layer/best-practice/ https://merginmaps.com/docs/layer/overview/
171172
https://merginmaps.com/docs/layer/exif_metadata/ https://merginmaps.com/docs/layer/exif/
172-
https://merginmaps.com/docs/layer/working_with_nonspatial_data/ https://merginmaps.com/docs/layer/non-spatial-data/
173+
https://merginmaps.com/docs/layer/form-configuration/ https://merginmaps.com/docs/layer/overview/
174+
https://merginmaps.com/docs/layer/non-spatial-data/ https://merginmaps.com/docs/layer/overview/
175+
https://merginmaps.com/docs/layer/position_variables/ https://merginmaps.com/docs/layer/extra-variables/
176+
https://merginmaps.com/docs/layer/plugin-variables/ https://merginmaps.com/docs/layer/extra-variables/
173177
https://merginmaps.com/docs/layer/settingup_forms/ https://merginmaps.com/docs/layer/form-widgets/
174178
https://merginmaps.com/docs/layer/settingup_forms_photo/ https://merginmaps.com/docs/layer/photos/
175-
https://merginmaps.com/docs/layer/settingup_forms_settings/ https://merginmaps.com/docs/layer/form-configuration/
179+
https://merginmaps.com/docs/layer/settingup_forms_settings/ https://merginmaps.com/docs/layer/overview/
180+
https://merginmaps.com/docs/layer/working_with_nonspatial_data/ https://merginmaps.com/docs/layer/overview/
176181
https://merginmaps.com/docs/manage/data_sync/ https://merginmaps.com/docs/manage/plugin/
177182
https://merginmaps.com/docs/manage/project-details/ https://merginmaps.com/docs/manage/project-history/
178183
https://merginmaps.com/docs/manage/plugin-multi-server-use/ https://merginmaps.com/docs/server/plugin-mobile-app/

src/.vitepress/sidebar/en.js

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,8 @@ export default {
6363
text: 'Configure Forms', // required
6464
collapsed: true,
6565
items: [
66-
{ text: 'Overview', link: '/layer/best-practice/' },
66+
{ text: 'Overview', link: '/layer/overview/' },
6767
{ text: 'Widgets', link: '/layer/form-widgets/',
68-
collapsed: false,
6968
items: [
7069
{ text: 'Text', link: '/layer/text/' },
7170
{ text: 'Date and Time', link: '/layer/date-time/' },
@@ -77,11 +76,11 @@ export default {
7776
{ text: 'Photos', link: '/layer/photos/' },
7877
{ text: 'Informational Widgets', link: '/layer/info-widgets/' },
7978
] },
80-
{ text: 'Default Values', link: '/layer/form-configuration/',
79+
{ text: 'Default Values', link: '/layer/default-values/',
8180
collapsed: true,
8281
items: [
8382
{ text: 'Geotagging', link: '/layer/exif/' },
84-
{ text: 'Extra Variables', link: '/layer/plugin-variables/' }
83+
{ text: 'Extra Variables', link: '/layer/extra-variables/' }
8584
] },
8685
{ text: 'Constraints', link: '/layer/constraints/' },
8786
{ text: 'Attributes Form Layout', link: '/layer/form-layout/',

src/gis/features/index.md

Lines changed: 65 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1+
---
2+
outline: [2, 3]
3+
---
4+
15
# QGIS Project Preparation
26
[[toc]]
37

48
Project preparation is done in QGIS. For more information about loading layers, styling the data and creating map themes, visit <QGISHelp ver="3.22" link="user_manual/index.html" text="QGIS documentation page" />.
59

6-
In addition, <MobileAppName /> uses some of the features within the project to help visualise, capture and browse the data. Here is an overview of the project preparations steps.
10+
In addition, <MobileAppName /> uses some of the features within the project to help visualise, capture and browse the data. Here is an overview of the project preparations steps.
711

812
:::tip
913
Our tutorials can guide you through QGIS project preparation step by step.
@@ -13,6 +17,66 @@ In [Creating a Project in QGIS](../../tutorials/creating-a-project-in-qgis/) you
1317
[Further Project Customisation](../../tutorials/further-project-customisation/) will show you how to style layers, add labels, customise the preview panel, define map themes and set up the project extent.
1418
:::
1519

20+
## Survey layers
21+
Vector layers can be used as survey layers in the <MobileAppNameShort />. You can apply styles and set up the forms to make your field survey easier.
22+
23+
Making changes in the data schema of layers can lead to issues in the synchronisation process. Be careful to [**deploy the revised project properly**](../../manage/deploy-new-project/). Design the data schema carefully when creating a layer to avoid the need to change it later.
24+
25+
Here are some practical tips for creating and maintaining layers in your project:
26+
- **Always use GeoPackage for survey layers**. If you use other formats, such as ESRI shapefile, it is not possible to detect changes from other users and they may be overwritten. Overwritten files are stored in a conflict file.
27+
- **Add some extra back-up field attributes** when creating a survey layer with different types (e.g. a couple of texts, int, real, date/time) and hide them in the form design. These can serve as a backup: if you need extra fields later in the survey, just alias these extra fields and add them to form.
28+
- If you do not need a field, **remove it from the form**. You don't need to delete it from the table.
29+
- **Instead of renaming a field, change its alias**.
30+
- **Add new layers to your project as separate GeoPackages**. Do not add a new table to your existing GeoPackage that contains a survey layer. Just to be safe, it is better to have one GeoPackage for each of your survey layers.
31+
- use **GeoTIFF** format for your raster files or store them in a separate GeoPackage database
32+
33+
### Layer symbology
34+
The same symbology as defined in the QGIS project will be used in <MobileAppName />. However, <MobileAppName /> does not include all the SVG markers that are available within QGIS. Therefore, if you are using SVG markers for your layer styling, ensure those are copied to the project folder.
35+
36+
### Forms
37+
During the field survey, it is often necessary to fill out some attributes in the form to record the properties of surveyed features. Forms can make the survey easier, consistent and more effective.
38+
39+
Detailed description of form widgets and form configuration can be found in the [Configure Form](../../layer/overview/) section.
40+
41+
### Settings for Mergin Maps mobile app preview panel
42+
What appears in the <MobileAppName /> preview panel can be defined in the **Display** tab in **Layer Properties**:
43+
- **Display Name**: a field name or an expression.
44+
- **HTML Map Tip**: the content of the preview panel. While QGIS always interprets the content of map tip as being HTML, <MobileAppName /> extends the syntax to allow two more modes: field values and images. If the map tip is not specified, <MobileAppName /> will try to use the first three fields and show their attribute values.
45+
46+
![QGIS layer properties display settings](./qgis_properties_display.jpg "QGIS layer properties display settings")
47+
48+
#### HTML
49+
Sample map tip content that will show render as HTML page:
50+
51+
```
52+
<p><strong>Notes:</strong>[% "notes" %]</p>
53+
```
54+
55+
If the map tip does not contain any special marker, it is assumed that the map tip is HTML content. Only a limited subset of HTML is supported - see [Qt documentation](https://doc.qt.io/qt-5/richtext-html-subset.html)
56+
57+
#### Field values
58+
Sample map tip content that will show "description" and "time" field values:
59+
60+
```
61+
# fields
62+
description
63+
time
64+
```
65+
66+
If the map tip content has `# fields` marker on the first line, the following lines will be understood as field names that should be listed in the preview. At most three fields will be shown. Expressions are not allowed.
67+
68+
#### Image
69+
Sample map tip content that will cause an image to be show specified by file path in field "image_1" (containing path relative to the project folder):
70+
71+
```
72+
# image
73+
file:///[%@project_folder%]/[% "image_1" %]
74+
```
75+
76+
If the map tip has `# image` marker on the first line, the following line is understood as the URL for the image. It can be a regular file on the file system, but it could be even a remote image from the network. Expressions embedded in the image URL will be evaluated (enclosed in `[% 1+1 %]`).
77+
78+
![Preview panel in the mobile app based on Display settings in QGIS](./mobile-app-preview-panel.jpg "Preview panel in the mobile app based on Display settings in QGIS")
79+
1680
## Background layers
1781
Various online and offline maps can be used as background layers for navigation during the field survey. You can find more information in [Background Maps](../settingup_background_map/).
1882

@@ -98,51 +162,4 @@ You can read more about this functionality in [How to Use Tracking in Mergin Map
98162
### Map themes
99163
[Map Themes](../setup_themes/) make possible to switch between different background maps in <MobileAppName /> (e.g. cartography maps and aerial imagery)
100164

101-
## Survey layers
102-
Vector layers can be used as survey layers in <MobileAppName />. You can apply styles and set up the forms to make your field survey easier.
103-
104-
### Layer symbology
105-
The same symbology as defined in the QGIS project will be used in <MobileAppName />. However, <MobileAppName /> does not include all the SVG markers that are available within QGIS. Therefore, if you are using SVG markers for your layer styling, ensure those are copied to the project folder.
106-
107-
### Forms
108-
During the field survey, it is often necessary to fill out some attributes in the form to record the properties of surveyed features. Forms can make the survey easier, consistent and more effective. Detailed description of form widgets and form configuration can be found in [Setting Up Form Widgets](../../layer/form-widgets/) and [Advanced Form Configuration](../../layer/form-configuration/).
109-
110-
### Settings for Mergin Maps mobile app preview panel
111-
What appears in the <MobileAppName /> preview panel can be defined in the **Display** tab in **Layer Properties**:
112-
- **Display Name**: a field name or an expression.
113-
- **HTML Map Tip**: the content of the preview panel. While QGIS always interprets the content of map tip as being HTML, <MobileAppName /> extends the syntax to allow two more modes: field values and images. If the map tip is not specified, <MobileAppName /> will try to use the first three fields and show their attribute values.
114-
115-
![QGIS layer properties display settings](./qgis_properties_display.jpg "QGIS layer properties display settings")
116-
117-
#### HTML
118-
Sample map tip content that will show render as HTML page:
119-
120-
```
121-
<p><strong>Notes:</strong>[% "notes" %]</p>
122-
```
123-
124-
If the map tip does not contain any special marker, it is assumed that the map tip is HTML content. Only a limited subset of HTML is supported - see [Qt documentation](https://doc.qt.io/qt-5/richtext-html-subset.html)
125-
126-
#### Field values
127-
Sample map tip content that will show "description" and "time" field values:
128-
129-
```
130-
# fields
131-
description
132-
time
133-
```
134-
135-
If the map tip content has `# fields` marker on the first line, the following lines will be understood as field names that should be listed in the preview. At most three fields will be shown. Expressions are not allowed.
136-
137-
#### Image
138-
Sample map tip content that will cause an image to be show specified by file path in field "image_1" (containing path relative to the project folder):
139-
140-
```
141-
# image
142-
file:///[%@project_folder%]/[% "image_1" %]
143-
```
144-
145-
If the map tip has `# image` marker on the first line, the following line is understood as the URL for the image. It can be a regular file on the file system, but it could be even a remote image from the network. Expressions embedded in the image URL will be evaluated (enclosed in `[% 1+1 %]`).
146-
147-
![Preview panel in the mobile app based on Display settings in QGIS](./mobile-app-preview-panel.jpg "Preview panel in the mobile app based on Display settings in QGIS")
148165

0 commit comments

Comments
 (0)