Skip to content

Commit

Permalink
fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-cit committed Jul 28, 2024
1 parent 31bdba6 commit 90d3e1c
Show file tree
Hide file tree
Showing 19 changed files with 47 additions and 48 deletions.
2 changes: 1 addition & 1 deletion src/field/external_gps/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If GPS antenna height is set to a non-zero value, it is also displayed next to t
![GPS antenna height setup in Mergin Maps mobile app](./mobile-app-gps-antenna-height.jpg "GPS antenna height setup in Mergin Maps mobile app")

:::tip
GPS antenna height can be recorded during the survey by using the [extra position variable](../../layer/position_variables/) `@position_gps_antenna_height` as a [default value](../../layer/settingup_forms_settings/#default-values).
GPS antenna height can be recorded during the survey by using the [extra position variable](../../layer/position_variables/) `@position_gps_antenna_height` as a [default value](../../layer/form-configuration/#default-values).
:::

## External GPS on Android
Expand Down
4 changes: 2 additions & 2 deletions src/field/mobile-features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Surveyed features are added to the active layer, which is shown just above the b
Once the geometry of a feature is recorded, a form will open and you will be able to record the values of attributes.

:::tip
Attribute forms can be set up in QGIS. For more details, see [Setting Up Form Widgets](../../layer/settingup_forms/) and [Advanced Form Configuration](../../layer/settingup_forms_settings/).
Attribute forms can be set up in QGIS. For more details, see [Setting Up Form Widgets](../../layer/form-widgets/) and [Advanced Form Configuration](../../layer/form-configuration/).
:::

### Capture points
Expand Down Expand Up @@ -68,7 +68,7 @@ The recording interval can be defined also in metres as distance travelled.
:::

### Add non-spatial features
[Non-spatial features](../../layer/working_with_nonspatial_data/) can also be added using <MobileAppName />. If you are using a non-spatial table for [value relations](../../layer/settingup_forms/#value-relation) you can add and edit values in the app.
[Non-spatial features](../../layer/non-spatial-data/) can also be added using <MobileAppName />. If you are using a non-spatial table for [value relations](../../layer/form-widgets/#value-relation) you can add and edit values in the app.

1. Tap the **More** button and navigate to **Layers**
![Mergin Maps mobile app Layers panel](./input-layers.jpg "Mergin Maps mobile app Layers panel")
Expand Down
4 changes: 2 additions & 2 deletions src/field/tracking/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Tracking needs to be enabled in QGIS when [preparing your <MainPlatformName /> p

4. Don't forget to save and synchronise your project!

Enabled tracking means that a new line layer for tracking will be created in your <MainPlatformName /> project called `tracking_layer.gpkg`. This layer is created with a set of fields with set up [default values](../../layer/settingup_forms_settings/#default-values):
Enabled tracking means that a new line layer for tracking will be created in your <MainPlatformName /> project called `tracking_layer.gpkg`. This layer is created with a set of fields with set up [default values](../../layer/form-configuration/#default-values):


| Field name | Data Type | Default variable | Description |
Expand All @@ -31,7 +31,7 @@ Enabled tracking means that a new line layer for tracking will be created in you
| `total_distance` | Real | `$length` | Tracked distance |
| `tracked_by` | String | `@mergin_username` | Name of the current <MainPlatformNameLink /> user |

You can add new fields as needed, however, they should be set up with automatically generated [default values](../../layer/settingup_forms_settings/#default-values) as <MobileAppName /> will not open the form for manual inputs. You may use some of the QGIS functions, [extra position variables](../../layer/position_variables/) or [extra QGIS variables](../../layer/plugin-variables/).
You can add new fields as needed, however, they should be set up with automatically generated [default values](../../layer/form-configuration/#default-values) as <MobileAppName /> will not open the form for manual inputs. You may use some of the QGIS functions, [extra position variables](../../layer/position_variables/) or [extra QGIS variables](../../layer/plugin-variables/).

## Using position tracking in Mergin Maps mobile app

Expand Down
6 changes: 3 additions & 3 deletions src/gis/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Various online and offline maps can be used as background layers for navigation
- Define the <QGISHelp ver="3.22" link="user_manual/introduction/qgis_configuration.html?highlight=properties#data-sources-properties" text="layers capabilities" /> in the **Data Sources** in Project Properties.
- [Identifiable](./search_data/#setting-identifiable-layers-in-qgis-project) layers can be queried in <MobileAppName />. If you want to be able to search for attribute values in a layer, it needs to be identifiable and searchable.
- **read-only** layers cannot be modified. If a vector layer is not intended to be used as a survey layer, set it as read-only.
- [non-spatial](../layer/working_with_nonspatial_data/) layers need to be set as searchable to enable browsing, searching, or editing.
- [non-spatial](../layer/non-spatial-data/) layers need to be set as searchable to enable browsing, searching, or editing.

![QGIS Layer Capabilities](./qgis_project_properties.jpg "QGIS Layer Capabilities")

Expand Down Expand Up @@ -53,7 +53,7 @@ To set the project extent:
<SinceBadge type="Plugin" version="2022.3.2" /><SinceBadge type="App" version="1.5.1" />
The quality of photographs and pictures that are saved in the <MainPlatformName /> project can be set up in the **<MainPlatformName />** tab in **Project properties**. When pictures are added using <MobileAppName /> (uploaded or taken with the camera), they will be resized accordingly.

By default, the quality is set to *Original* - the original pictures are stored. If you want to resize the pictures, you can choose from *High*, *Medium*, or *Low* quality. The [EXIF metadata](../layer/exif_metadata/) of the original files are kept.
By default, the quality is set to *Original* - the original pictures are stored. If you want to resize the pictures, you can choose from *High*, *Medium*, or *Low* quality. The [EXIF metadata](../layer/exif/) of the original files are kept.

Don't forget to save and sync your project!

Expand Down Expand Up @@ -105,7 +105,7 @@ Vector layers can be used as survey layers in <MobileAppName />. You can apply s
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.

### Forms
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/settingup_forms/) and [Advanced Form Configuration](../layer/settingup_forms_settings/)
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/).

### Settings for Mergin Maps mobile app preview panel
What appears in the <MobileAppName /> preview panel can be defined in the **Display** tab in **Layer Properties**:
Expand Down
11 changes: 5 additions & 6 deletions src/gis/photo-names/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# How to Set Photo Names Format
<SinceBadge type="Plugin" version="2023.2.0" /> <SinceBadge type="App" version="v2.2.0" />

<SinceBadge type="Plugin" version="2023.2.0" />
[[toc]]

Names of the photos that are captured in the field using <MobileAppName /> can be customised. The name format can be set in QGIS with <QGISPluginName />.

To use this option, make sure that the [photo widget](../../layer/settingup_forms_photo/#attachment-widget-in-qgis) of the fields you use for taking pictures is set up correctly, i.e. using the attachment widget, storing relative paths and, if needed, with a [custom folder](../../layer/settingup_forms_photo/#how-to-set-up-a-custom-folder-for-storing-photos) for storing photos.
To use this option, make sure that the [photo widget](../../layer/photos/#attachment-widget-in-qgis) of the fields you use for taking pictures is set up correctly, i.e. using the attachment widget, storing relative paths and, if needed, with a [custom folder](../../layer/photos/#how-to-set-up-a-custom-folder-for-storing-photos) for storing photos.

To set up custom photo names:
1. Open your <MainPlatformNameLink /> project in QGIS and navigate to **Project Properties**
Expand All @@ -29,7 +28,7 @@ To set up custom photo names:

4. Set up the photo name format for other fields and layers.

The **Preview** in **Mergin Maps** tab includes the [custom folder for photos](../../layer/settingup_forms_photo/#how-to-set-up-a-custom-folder-for-storing-photos), if you have set it up. Otherwise you will see only the sample name of a photo.
The **Preview** in **Mergin Maps** tab includes the [custom folder for photos](../../layer/photos/#how-to-set-up-a-custom-folder-for-storing-photos), if you have set it up. Otherwise you will see only the sample name of a photo.

![Mergin Maps QGIS Plugin photo name setup with custom folder](./plugin-photo-name-format-folder.jpg "Mergin Maps QGIS Plugin photo name setup with custom folder")
![Mergin Maps QGIS Plugin Custom photo name setup without custom folder](./plugin-photo-name-format.jpg "Mergin Maps QGIS Plugin Custom photo name setup without custom folder")
Expand All @@ -43,9 +42,9 @@ Therefore, we recommend using combinations of variables that will ensure that th

:white_check_mark: The file extension (`.jpg`) is added automatically.

:white_check_mark: When using a field value in the expression, make sure that it is a field that will be filled out during the survey, e.g. by using [constraints](../../layer/settingup_forms_settings/#constraints). If the field is empty, the expression won't work!
:white_check_mark: When using a field value in the expression, make sure that it is a field that will be filled out during the survey, e.g. by using [constraints](../../layer/form-configuration/#constraints). If the field is empty, the expression won't work!

:white_check_mark: If you want to use a [numeric field](../../layer/settingup_forms/#numbers) or other non-text fields in your expression, you need to convert it to a string first using the `to_string()` function
:white_check_mark: If you want to use a [numeric field](../../layer/form-widgets/#numbers) or other non-text fields in your expression, you need to convert it to a string first using the `to_string()` function

:no_entry_sign: The expression is evaluated with the **current** field values. The name of the photo will stay the same even if you change the value of the field later.

Expand Down
2 changes: 1 addition & 1 deletion src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The ecosystem consist of various components:
- [Best Practice Tips for Layers and Forms](./layer/best-practice/)
- [Setting Up Widgets in Attributes Form](./layer/form-widgets/)
- [Attributes Form Configuration](./layer/form-configuration/)
- [Attributes Form Layout](./layer/settingup_forms_settings/)
- [Attributes Form Layout](./layer/form-layout/)
- [Capturing Photos](./layer/photos/)
- [How to Attach Multiple Photos to Features](./layer/attach-multiple-photos-to-features/)
- [How to Link Multiple Records to One Feature (1-N Relations)](./layer/one-to-n-relations/)
Expand Down
2 changes: 1 addition & 1 deletion src/layer/attach-multiple-photos-to-features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To see this setup in practice, you can download the following project:

To link multiple photos to a single feature, we need a **unique field** to link following tables:
- Survey layer containing spatial information
- A non-spatial table containing path to the photos (see [how to setup simple photo forms](../settingup_forms_photo.md))
- A non-spatial table containing path to the photos (see [how to setup simple photo forms](../photos/))

:::danger WARNING
**Do not use the FID field to link these tables**. FIDs can be changed during synchronisation, which can result in having photos linked to the incorrect feature. You can learn more about synchronisation in [Behind Data Synchronisation](../../manage/synchronisation/#synchronisation).
Expand Down
4 changes: 2 additions & 2 deletions src/layer/exif/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Clone <MerginMapsProject id="documentation/exif-metadata" /> to see how it works
## How to use EXIF metadata
To store EXIF metadata values in the fields of your survey layer:
1. In QGIS, open the **Properties** of your survey layer and navigate to the **Attributes Form** tab.
2. Now we need to set the [default values](./settingup_forms_settings/#default-values) of fields that should store EXIF metadata.
2. Now we need to set the [default values](../form-configuration/#default-values) of fields that should store EXIF metadata.

[Supported EXIF functions](#supported-exif-functions) are listed below. In general, EXIF functions looks like this:
`read_exif('<ABSOLUTE_PATH_TO_IMAGE>', '<EXIF_TAG_STRING>')`

This expression requires the **absolute path** to an image. The absolute path can be defined using the field where the image is stored (here: `photo`, this is a [text field with attachment widget](./settingup_forms_photo/)) and the `@project_home` variable that refers to the project home folder.
This expression requires the **absolute path** to an image. The absolute path can be defined using the field where the image is stored (here: `photo`, this is a [text field with attachment widget](../photos/)) and the `@project_home` variable that refers to the project home folder.

For example, the default value expression for the direction of the image (EXIF tag `GPSImgDirection`) can be defined as follows:

Expand Down
12 changes: 6 additions & 6 deletions src/layer/form-configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Our mobile app was redesigned. We are in the process of updating this content to reflect these changes.
:::

In addition to setting up [edit widgets](./settingup_forms.md) and designing [form layout](./form-layout/), extra configuration can be done to the fields in QGIS to make the data collection easier and more consistent.
In addition to setting up [edit widgets](../form-widgets/) and designing [form layout](../form-layout/), extra configuration can be done to the fields in QGIS to make the data collection easier and more consistent.

<YouTube id="jc4p1PpXj3k" />

Expand Down Expand Up @@ -40,8 +40,8 @@ When you survey a new point in <MobileAppName />, you will see the values are au
### Examples of useful default values
There are some commonly used default values that can be useful in your field survey. As they are filled in automatically, they can be hidden from attributes form.

* It is convenient to know when a feature was created and when it was last updated. Use fields with **Date** or **Date&Time** data types with the `now()` function to record these information. You can change the formatting using [Date/Time](./settingup_forms/#date-and-time) widget.
* Similarly, the name of the <MainPlatformName /> user who created or modified the feature can be recorded using the `@mergin_username` [QGIS plugin variable](./plugin-variables/). These field should have the **Text (string)** data type.
* It is convenient to know when a feature was created and when it was last updated. Use fields with **Date** or **Date&Time** data types with the `now()` function to record these information. You can change the formatting using [Date/Time](../form-widgets/#date-and-time) widget.
* Similarly, the name of the <MainPlatformName /> user who created or modified the feature can be recorded using the `@mergin_username` [QGIS plugin variable](../plugin-variables/). These field should have the **Text (string)** data type.
* The coordinates of a point feature can be recorded as well using the `$x` and `$y` function in QGIS. To record the coordinate accurately, these fields should have the **Decimal number (real)** data type. If the coordinates are in meters, values can be rounded to, say, 2-3 decimal places. When working with geographic coordinates that use degrees, you may want to round the coordinates to 8 decimal places. Use the *apply default value on update* option so that you have correct values when the position of the point feature changes.


Expand All @@ -55,7 +55,7 @@ There are some commonly used default values that can be useful in your field sur
| `round($y,2)` | `6134520.89` | **yes** | The Y coordinate of a point feature, rounded to 2 decimal places.|

### Open local files using default values
Default values can also be used to open local files (e.g. a PDF file) from within the form. This file needs to be packaged with the project, so it should be stored somewhere in the [project folder](../manage/project/#mergin-maps-project-folder).
Default values can also be used to open local files (e.g. a PDF file) from within the form. This file needs to be packaged with the project, so it should be stored somewhere in the [project folder](../../manage/project/#mergin-maps-project-folder).

There is a public project <MerginMapsProject id="documentation/forms-display-images-and-files" /> you can download or clone to see how the setup works.
- A PDF file named `my-pdf.pdf` is stored in the main project folder.
Expand All @@ -74,7 +74,7 @@ In the <MobileAppNameShort />, you can tap the *Open File* link to open the PDF
![Open a local PDF file in Mergin Maps mobile app](./mobile-forms-open-file-default-value.jpg "Open a local PDF file in Mergin Maps mobile app")

::: tip Open local files using the HTML widget
Local files can be displayed in the form also using [the HTML widget](./form-layout/#using-html-widget-to-open-local-files).
Local files can be displayed in the form also using [the HTML widget](../form-layout/#using-html-widget-to-open-local-files).

In the <MerginMapsProject id="documentation/forms-display-images-and-files" /> project, you can explore and compare both alternatives.
:::
Expand Down Expand Up @@ -106,7 +106,7 @@ Cascade or drill-down forms enable to list values in a field depending on a valu
Clone <MerginMapsProject id="documentation/form_cascade" /> to follow this example!
:::

In this project, we will work with the point layer named **car**. The survey tab in the form contains information about cars, such as **Car-Type**, **Car-Manufacturer**, or **Car-Model**. These attributes refer to non-spatial tables using [value relations](./settingup_forms/#value-relation).
In this project, we will work with the point layer named **car**. The survey tab in the form contains information about cars, such as **Car-Type**, **Car-Manufacturer**, or **Car-Model**. These attributes refer to non-spatial tables using [value relations](../form-widgets/#value-relation).
![QGIS drill-down forms](./qgis_forms_cascade01.jpg "QGIS drill-down forms")

To make the survey easier, we will set the drill-down form so that the values in the drop-down menus are filtered based on the previously selected values. For example, if **Car type (truck/car): Trucks** is selected, the **Car-Manufacturer** field will offer only truck manufacturers *DAF Trucks*, *Scania*, *MAN*. Likewise, the next drop-down menu for **Car-Model** will change accordingly based on the **Car-Manufacturer** selection, showing only relevant car models.
Expand Down
Loading

0 comments on commit 90d3e1c

Please sign in to comment.