diff --git a/documentation/assets/images/process_selected_features.png b/documentation/assets/images/process_selected_features.png new file mode 100644 index 000000000..e1ef84709 Binary files /dev/null and b/documentation/assets/images/process_selected_features.png differ diff --git a/documentation/assets/images/processing_algorithms.png b/documentation/assets/images/processing_algorithms.png new file mode 100644 index 000000000..fa5c7e74e Binary files /dev/null and b/documentation/assets/images/processing_algorithms.png differ diff --git a/documentation/assets/images/processing_parameters.png b/documentation/assets/images/processing_parameters.png new file mode 100644 index 000000000..2b4e9b905 Binary files /dev/null and b/documentation/assets/images/processing_parameters.png differ diff --git a/documentation/how-to/processing.en.md b/documentation/how-to/processing.en.md new file mode 100644 index 000000000..7ac0b125c --- /dev/null +++ b/documentation/how-to/processing.en.md @@ -0,0 +1,26 @@ +--- +title: Processing Algorithms +tx_slug: documentation_how-to_processing +--- + +# Processing Algorithms + +QField offers access to a number of processing algorithms to modify digitized features and their geometries. + +## Showing available algorithms + +Running algorithms against your features is done through the features list drawer. First, identify one or more features by tapping on the map canvas and toggle multi-selection mode by long pressing on one of the identified features. Once you've checked all features to be processed, click on the 3-dot menu and select the _Process Selected Feature(s)_ item. + +!![process selected features](../assets/images/process_selected_features.png "") + +The processing algorithms drawer will by default filter out of the list of available algorithms to only show those flagged as favorites. Clicking on the _All algorithms_ tab will show the full list where you can add or remove favorites. + +!![processing algorithms](../assets/images/processing_algorithms.png "") + +## Running an algorithm + +When an algorithm has been selected, a list of parameters will be displayed, regrouped into general and advanced ones within two distinct tabs. A third tab is available to access the algorithm's help content. For most algorithms, a live preview of the manipulated geometry will be overlayed on top of the map canvas offering an immediate feedback while parameters. + +!![processing parameters](../assets/images/processing_parameters.png "") + +Once parameters are set to your liking, click on the check button within the drawer's title bar to run the algorithm. diff --git a/mkdocs.yml b/mkdocs.yml index b55bd5bac..a49acf427 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -92,6 +92,7 @@ nav: - how-to/movable-project.md - how-to/pg-service.md - how-to/plugins.md + - how-to/processing.md - Technical reference: - reference/index.md - reference/data-format.md