Skip to content

modified how tos #552

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

Merged
merged 5 commits into from
May 1, 2025
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
Binary file modified documentation/assets/images/howto_legendoptions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 8 additions & 12 deletions documentation/how-to/map-interaction.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,15 @@ On double-tap or long-press on a layer, you get offered the following possibilit

!![](../assets/images/howto_legendoptions.png)

- *Expand legend item* to show/hide the layer's sub-items.
- *Show on map* to control visibility.
- *Show labels* to control the visibility of the labels.
- *Expand legend item* to show/hide the layer's sub-items.
- *Opacity Slider* to control the transparency of the layer.
- *Zoom to layer* to have all the layer items on the map.
- *Reload data* to get the current data of a layer with remote sources.
- *Reload icon* to get the current data of a layer with remote sources.
- *Show feature list* to show all the layer's features in the identification list.
- *Setup tracking* to set up tracking mode of layer.

Additionally, you have the option to adjust the layer opacity for each individual layer using the "Opacity" slider.

!![](../assets/images/opacity-slider.png)

## Sort layer features
:material-monitor: Desktop preparation
Expand All @@ -37,18 +36,15 @@ If you'd like to configure the order of features in 'Show feature list' in QFiel

!![](../assets/images/accesing-sort-feature-list-op1.png)

- In form view, you can access sorting functionality by clicking on the expression button located at the top of the features list and select the 'Sort' option.
- When being in the form view, you can access the sorting functionality by clicking on the expression button located at the top of the features list and select the 'Sort' option.

!![](../assets/images/accesing-sort-feature-list-op2.png)

## Identify features
:material-tablet: Fieldwork

Tap on a feature on the map to identify it. If several features are
located where you tapped (either because there are multiple features
really close one to another, or because several layers are overlapping),
they will all be listed in the menu that opens on the right of the
screen.
Tap on a feature on the map to identify it.
If several features are located where you tapped (either because there are multiple features really close one to another, or because several layers are overlapping), they will all be listed in the menu that opens on the right of the screen.

!![](../assets/images/howto_identification.png)

Expand Down Expand Up @@ -79,4 +75,4 @@ Often it is not required to be able to query every layer. Some layers
are only present as basemap, and their attributes are not of interest.

You can manage this layer list in QGIS desktop in
*Project > Project Properties > Identify Layers* and uncheck the base layers.
*Project > Project Properties > Data sources > Identify Layers* and uncheck the base layers.
38 changes: 17 additions & 21 deletions documentation/how-to/map-styling.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,17 @@ tx_slug: documentation_how-to_map-styling

# Map styling

All style settings from QGIS are directly supported by QField. This
includes all renderer types like graduated, categorized, rule based,
All style settings from QGIS are directly supported by QField.
This includes all renderer types like graduated, categorized, rule based,
2.5D as well as data defined symbology.

## Display Expression
:material-monitor: Desktop preparation

In QField, objects are identified with a name. The expression to
generate this name can be defined by opening the attribute table in QGIS
and switching to the form view. Choose the appropriate field or an
expression in the list there. Starting from QGIS 3, this can be done
directly from the
*Vector Layer Properties > Display* page.
In QField, objects are identified with a name.
The expression to generate this name can be defined by opening the attribute table in QGIS and switching to the form view.
Choose the appropriate field or an expression in the list there.
Starting from QGIS 3, this can be done directly from the *Vector Layer Properties > Display* page.

The display expression is also used to search in layers.

Expand All @@ -27,20 +25,18 @@ identification string throughout QField.](../assets/images/define_display_expres
## Read only, non-identifiable and searchable layers
:material-monitor: Desktop preparation

Some layers in a project are just there for pure visual purpose. Such
layers should not show up when a user taps somewhere to identify
Some layers in a project are just there for pure visual purpose.
Such layers should not show up when a user taps somewhere to identify
objects.

Some other layers serve as source of information and shouldn't be
modified by the user. It is possible to protect layers from editing
attributes or adding and deleting features.
modified by the user.
It is possible to protect layers from editing attributes or adding and deleting features.

It is also possible to configure which layers are searchable.

To configure identify, readonly and searchable behavior, go to the
*Project > Properties > Data Sources*
page and activate the checkboxes to match your
desired behavior.
To configure identify, read-only and searchable behavior, go to the
*Project > Properties > Data Sources* page and activate the checkboxes to match your desired behavior.

!![Configuration of layers that will not be identifiable, not modifiable
and/or not searchable.](../assets/images/project_configuration_readonly.png)
Expand All @@ -49,18 +45,18 @@ and/or not searchable.](../assets/images/project_configuration_readonly.png)
:material-monitor: Desktop preparation

QField enables you to use all the custom fonts you might want and need.

There are two different possibilities to register additional fonts:

1. By adding fonts (.ttf or .otf) on the device in the folder `<drive>:/Android/data/ch.opengis.qfield/files/QField/fonts` those will be made accessible to all projects and individual datasets.
1. By adding fonts (.ttf or .otf) on the device in the folder `<drive>:/Android/data/ch.opengis.qfield/files/QField/fonts`.
Those will be made accessible to all projects and individual datasets.
2. By adding fonts (`.ttf` or `.otf`) in a `fonts` subfolder of the folder
containing a given project file (`.qgs` or `.qgz`); those fonts will only
be accessible when viewing that project.
containing a given project file (`.qgs` or `.qgz`).
Those fonts will only be accessible when viewing that project.

## Custom SVG symbols
:material-monitor: Desktop preparation

It is possible to embed SVG symbols directly within a QGIS projects.
It is possible to embed SVG symbols directly within a QGIS project.

1. Choose the layer which will support SVG symbology and open its
properties dialog.
Expand Down
11 changes: 5 additions & 6 deletions documentation/how-to/map-themes.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ tx_slug: documentation_how-to_map-themes
---

# Map themes
The beautiful thing about GIS is that maps are dynamic. Layers can
individually be shown and hidden and information can be presented more
or less prominently based on the task at hand.
The beautiful thing about GIS is that maps are dynamic.
Layers can individually be shown and hidden and information can be presented more or less prominently based on the task at hand.

This is what *Map themes* are for.

Expand All @@ -17,9 +16,9 @@ Creating a Map Theme in QGIS is a very simple task.

!![Map Theme Configuration](../assets/images/map_themes_configuration.gif)

1. Style the map and layers to your requirements
2. Save it as a named Map Theme
3. Load the project on your device and change the active Map Theme
1. Style the map and layers to your requirements.
2. Save it as a named Map Theme.
3. Load the project on your device and change the active Map Theme.

## Change the active Map Theme
:material-tablet: Fieldwork
Expand Down
22 changes: 10 additions & 12 deletions documentation/how-to/measuring-tool.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,27 @@ tx_slug: documentation_how-to_measuring-tool

# Measuring tool

QField offers measurement functionalities out of the box, you have the flexibility to change the units for measuring distance and area in your projects. You can do this by navigating to the 'Project' menu, selecting 'Properties...' in the 'General' section.
QField offers measurement functionalities out of the box, you have the flexibility to change the units for measuring distance and area in your projects.
You can do this by navigating to the 'Project' menu in QGIS, selecting 'Properties...' in the 'General' section.

!![](../assets/images/custom-units-measure.png)

To enable the measuring tool, open the main menu and select *Measuring Tool*.
To enable the measuring tool, open the legend and select the ruler symbol in the main menu bar.

!![](../assets/images/measuring_tool.png)

Once the tool is enabled, simply use the digitizing controls located at the lower-right corner of the screen to add and remove
vertices. By default, the measured geometry will be a line; to change to a polygon, simply connect the coordinate cursor to the first
vertex entered.
Once the tool is enabled, use the digitizing controls located at the bottom-right corner of the screen to add and remove vertices.
By default, the measured geometry will be a line; to change to a polygon, simply connect the coordinate cursor to the first vertex entered.

For the segment formed of the two last vertices added, details returned include segment length and its azimuth. When the measured
geometry is a line, the total line length is provided while the perimeter and area are displayed for polygons.
For the segment formed of the two last vertices added, details returned include segment length and its azimuth.
When the measured geometry is a line, the total line length is provided while the perimeter and area are displayed for polygons.

## Elevation profiling

When the measuring tool is enabled, an *Elevation Profile* tool button appears at the top-right corner of the screen. Toggling
this on will open the elevation profiling panel, which will show the terrain elevation as well as intersecting vector
features along the measured geometry.
When the measuring tool is enabled, an *Elevation Profile* tool button appears at the top-left corner of the screen.
Toggling this on will open the elevation profiling panel, which will show the terrain elevation as well as intersecting vector features along the measured geometry.

!![](../assets/images/elevation_profiling.png)

For ease of use, QField defaults to using the Mapzen Global Terrain dataset to provide worldwide 30-meter resolution elevation profiles.
It is however possible to customize terrain settings through project and individual map layer properties within QGIS when
building projects.
It is however possible to customize terrain settings through project and individual map layer properties within QGIS when building projects.
3 changes: 1 addition & 2 deletions documentation/how-to/movable-project.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ tx_slug: documentation_how-to_movable-project
# Portable project

To manually synchronise your QGIS project, you will need a portable
version of your QGIS project file (`.qgs`, `.qgz`). Portable means that all paths are relative
and datasets are reachable from the device.
version of your QGIS project file (`.qgs`, `.qgz`). Portable means that all paths are relative and datasets are reachable from the device.


## Configure a portable project
Expand Down
32 changes: 21 additions & 11 deletions documentation/how-to/navigation.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,38 @@ QField offers navigation functionalities to help orient yourself in the field an

## Activating navigation

Navigation is enabled when [a destination point has been set](#setting-a-destination-point) and positioning is active. When turned on, a set of navigation overlays - a destination marker, a navigation panel, and a navigation control button - appear over the map.
Navigation is enabled when [a destination point has been set](#setting-a-destination-point) and positioning is active.
When turned on, a set of navigation overlays - a destination marker, a navigation panel, and a navigation control button - appear on the screen.

!![](../assets/images/navigation.png)

The navigation panel displays useful information such as the destination point coordinates as well as the current distance and bearing to destination.
The navigation panel displays useful information such as the destination point coordinates as well as the current distance and bearing to it.

To disable navigation, clear the destination point by tap and holding on the navigation control button located at the lower right corner.
To disable *navigation*, clear the destination point by pressing long on the navigation control button located at the bottom right corner.

## Setting a destination point
:material-tablet: Fieldwork

QField offers several methods to set a navigation destination point. A quick way is to simply tap and hold on any part of the map and select the *Set as Destination* action within the popped up menu.
There is several options to set a navigaation destination point.
A quick way is to simply tap and hold on any part of the map and select the *Set as Destination* action within the popped up menu.

!![](../assets/images/navigation-add-from-touch.png)

You can also set the navigation destination point by typing in specific coordinates in the search bar and tapping on the resulting flag navigation icon. You can also search for a specific feature and tap on the flag navigation icon which will also be present in the resulting list of features.
You can also set the destination point by typing in specific coordinates in the search bar and tapping on the resulting flag navigation icon.
You can also search for a specific feature and tap on the flag navigation icon which will also be present in the resulting list of features.

!![](../assets/images/navigation-search-bar.png)

You can also set a navigation destination point by opening the feature form menu and selecting the *Set Feature as Destination* action.
You can also set a destination point by opening the feature form menu and selecting the *Set Feature as Destination* action.

!![](../assets/images/navigation-destination-feature-form.png)

Finally, you can also set a navigation destination using a feature, a purple feature bar title appears as part of the navigation information panel. For single points, a destination name is displayed (matching a given vector layer's display name field / expression).
Finally, you can also set a destination selecting a specific feature, a purple feature bar title appears as part of the navigation information panel.
For single points, a destination name is displayed (matching a given vector layer's display name field / expression).

For multipoint or {multi,single}{line,polygon}, new navigation buttons are located at the left and right of the destination name. Those buttons allow users to cycle through vertices of the feature picked as navigation destination. Tap and holding onto these buttons will cycle through vertices (comes in handy when you have a feature with a large vertex count).
For multipoint or {multi,single}{line,polygon}, new navigation buttons are located on the left and right of the destination name.
Those buttons allow users to cycle through vertices of the feature picked as navigation destination.
Tapping and holding onto these buttons will cycle through vertices (comes in handy when you have a feature with a large vertex count).

!![](../assets/images/navigation-polygon.webp)

Expand All @@ -43,7 +49,8 @@ For multipoint or {multi,single}{line,polygon}, new navigation buttons are locat

QField allows for its map to automatically keep track of the current device location and destination and re-center the map extent around those two points.

To activate this auto tracking feature, you can simply tap on the positioning button and the navigation control button. Both buttons should show their auto tracking mode active by having their background color turn to blue and purple.
To activate this auto tracking feature, you can simply tap on the positioning button and the navigation control button.
Both buttons should show their auto tracking mode active by having their background color turn to blue and purple.

!![](../assets/images/navigation-auto-tracking.png)

Expand All @@ -52,11 +59,14 @@ This can be described as a simple *staking mode* functionality.
## "Stakeout" precise view
:material-tablet: Fieldwork

QField's "stakeout" precise view panel appears when the distance between the current location and the destination is less than a pre-defined threshold (by default 5 meters) and the positioning device has an accuracy that is less than half of that threshold. The precise view visibility threshold value can be modified by long-pressing on the bottom-right navigation button and selecting the *Precise View Settings* menu item.
QField's "stakeout" precise view panel appears when the distance between the current location and the destination is less than a pre-defined threshold (by default 5 meters) and the positioning device has an accuracy that is less than half of that threshold.
The precise view visibility threshold value can be modified by pressing long on the bottom-right navigation button and selecting the *Precise View Settings* menu item.

!![](../assets/images/navigation-precise-view.webp)

The precise view will turn green when the current location is considered to have hit the target. This state considers both the positioning device accuracy as well as the precise view threshold value, whereas QField will consider having hit the target when the distance between the current location and the destination *minus* the positioning device's accuracy is less than 1/10th of the precise view threshold. E.g.: if your precise view threshold is set to 1 meter and your positioning device accuracy is 0.05 meter, the view would turn green when the position is less than 15cm from the destination.
The precise view will turn green when the current location is considered to have hit the target.
This state considers both the positioning device accuracy as well as the precise view threshold value, whereas QField will consider having hit the target when the distance between the current location and the destination *minus* the positioning device's accuracy is less than 1/10th of the precise view threshold.
E.g.: if your precise view threshold is set to 1 meter and your positioning device accuracy is 0.05 meter, the view would turn green when the position is less than 15cm from the destination.

When the distance to destination falls within the precise view threshold, QField emits an audio feedback in the form of a ping with reducing intervals as the current location gets closer to the destination. The audio feedback can be disabled by long-pressing on the bottom-right navigation button, selecting the *Precise View Settings* menu item, and unchecking *Enable Audio Proximity Feedback*.

Expand Down
Loading