Skip to content

Commit 5bd160f

Browse files
authored
Merge pull request #552 from opengisch/modify_howtos
modified how tos
2 parents 6396c6d + 48e7b05 commit 5bd160f

9 files changed

+108
-91
lines changed
Loading

documentation/how-to/map-interaction.en.md

+8-12
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,15 @@ On double-tap or long-press on a layer, you get offered the following possibilit
1717

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

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

27-
Additionally, you have the option to adjust the layer opacity for each individual layer using the "Opacity" slider.
28-
29-
!![](../assets/images/opacity-slider.png)
3029

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

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

40-
- 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.
39+
- 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.
4140

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

4443
## Identify features
4544
:material-tablet: Fieldwork
4645

47-
Tap on a feature on the map to identify it. If several features are
48-
located where you tapped (either because there are multiple features
49-
really close one to another, or because several layers are overlapping),
50-
they will all be listed in the menu that opens on the right of the
51-
screen.
46+
Tap on a feature on the map to identify it.
47+
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.
5248

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

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

8177
You can manage this layer list in QGIS desktop in
82-
*Project > Project Properties > Identify Layers* and uncheck the base layers.
78+
*Project > Project Properties > Data sources > Identify Layers* and uncheck the base layers.

documentation/how-to/map-styling.en.md

+17-21
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,17 @@ tx_slug: documentation_how-to_map-styling
55

66
# Map styling
77

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

1212
## Display Expression
1313
:material-monitor: Desktop preparation
1414

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

2220
The display expression is also used to search in layers.
2321

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

30-
Some layers in a project are just there for pure visual purpose. Such
31-
layers should not show up when a user taps somewhere to identify
28+
Some layers in a project are just there for pure visual purpose.
29+
Such layers should not show up when a user taps somewhere to identify
3230
objects.
3331

3432
Some other layers serve as source of information and shouldn't be
35-
modified by the user. It is possible to protect layers from editing
36-
attributes or adding and deleting features.
33+
modified by the user.
34+
It is possible to protect layers from editing attributes or adding and deleting features.
3735

3836
It is also possible to configure which layers are searchable.
3937

40-
To configure identify, readonly and searchable behavior, go to the
41-
*Project > Properties > Data Sources*
42-
page and activate the checkboxes to match your
43-
desired behavior.
38+
To configure identify, read-only and searchable behavior, go to the
39+
*Project > Properties > Data Sources* page and activate the checkboxes to match your desired behavior.
4440

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

5147
QField enables you to use all the custom fonts you might want and need.
52-
5348
There are two different possibilities to register additional fonts:
5449

55-
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.
50+
1. By adding fonts (.ttf or .otf) on the device in the folder `<drive>:/Android/data/ch.opengis.qfield/files/QField/fonts`.
51+
Those will be made accessible to all projects and individual datasets.
5652
2. By adding fonts (`.ttf` or `.otf`) in a `fonts` subfolder of the folder
57-
containing a given project file (`.qgs` or `.qgz`); those fonts will only
58-
be accessible when viewing that project.
53+
containing a given project file (`.qgs` or `.qgz`).
54+
Those fonts will only be accessible when viewing that project.
5955

6056
## Custom SVG symbols
6157
:material-monitor: Desktop preparation
6258

63-
It is possible to embed SVG symbols directly within a QGIS projects.
59+
It is possible to embed SVG symbols directly within a QGIS project.
6460

6561
1. Choose the layer which will support SVG symbology and open its
6662
properties dialog.

documentation/how-to/map-themes.en.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ tx_slug: documentation_how-to_map-themes
44
---
55

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

1110
This is what *Map themes* are for.
1211

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

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

20-
1. Style the map and layers to your requirements
21-
2. Save it as a named Map Theme
22-
3. Load the project on your device and change the active Map Theme
19+
1. Style the map and layers to your requirements.
20+
2. Save it as a named Map Theme.
21+
3. Load the project on your device and change the active Map Theme.
2322

2423
## Change the active Map Theme
2524
:material-tablet: Fieldwork

documentation/how-to/measuring-tool.en.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,27 @@ tx_slug: documentation_how-to_measuring-tool
55

66
# Measuring tool
77

8-
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.
8+
QField offers measurement functionalities out of the box, you have the flexibility to change the units for measuring distance and area in your projects.
9+
You can do this by navigating to the 'Project' menu in QGIS, selecting 'Properties...' in the 'General' section.
910

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

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

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

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

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

2323
## Elevation profiling
2424

25-
When the measuring tool is enabled, an *Elevation Profile* tool button appears at the top-right corner of the screen. Toggling
26-
this on will open the elevation profiling panel, which will show the terrain elevation as well as intersecting vector
27-
features along the measured geometry.
25+
When the measuring tool is enabled, an *Elevation Profile* tool button appears at the top-left corner of the screen.
26+
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.
2827

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

3130
For ease of use, QField defaults to using the Mapzen Global Terrain dataset to provide worldwide 30-meter resolution elevation profiles.
32-
It is however possible to customize terrain settings through project and individual map layer properties within QGIS when
33-
building projects.
31+
It is however possible to customize terrain settings through project and individual map layer properties within QGIS when building projects.

documentation/how-to/movable-project.en.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ tx_slug: documentation_how-to_movable-project
66
# Portable project
77

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

1211

1312
## Configure a portable project

documentation/how-to/navigation.en.md

+21-11
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,38 @@ QField offers navigation functionalities to help orient yourself in the field an
99

1010
## Activating navigation
1111

12-
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.
12+
Navigation is enabled when [a destination point has been set](#setting-a-destination-point) and positioning is active.
13+
When turned on, a set of navigation overlays - a destination marker, a navigation panel, and a navigation control button - appear on the screen.
1314

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

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

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

2021
## Setting a destination point
2122
:material-tablet: Fieldwork
2223

23-
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.
24+
There is several options to set a navigaation destination point.
25+
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.
2426

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

27-
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.
29+
You can also set the destination point by typing in specific coordinates in the search bar and tapping on the resulting flag navigation icon.
30+
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.
2831

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

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

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

35-
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).
38+
Finally, you can also set a destination selecting a specific feature, a purple feature bar title appears as part of the navigation information panel.
39+
For single points, a destination name is displayed (matching a given vector layer's display name field / expression).
3640

37-
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).
41+
For multipoint or {multi,single}{line,polygon}, new navigation buttons are located on the left and right of the destination name.
42+
Those buttons allow users to cycle through vertices of the feature picked as navigation destination.
43+
Tapping and holding onto these buttons will cycle through vertices (comes in handy when you have a feature with a large vertex count).
3844

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

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

4450
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.
4551

46-
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.
52+
To activate this auto tracking feature, you can simply tap on the positioning button and the navigation control button.
53+
Both buttons should show their auto tracking mode active by having their background color turn to blue and purple.
4754

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

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

55-
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.
62+
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.
63+
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.
5664

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

59-
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.
67+
The precise view will turn green when the current location is considered to have hit the target.
68+
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.
69+
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.
6070

6171
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*.
6272

0 commit comments

Comments
 (0)