Skip to content

Commit

Permalink
Add initial documentation coverage for processing algorithms (#514)
Browse files Browse the repository at this point in the history
  • Loading branch information
nirvn authored Feb 7, 2025
1 parent fa18aa5 commit f298029
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions documentation/how-to/processing.en.md
Original file line number Diff line number Diff line change
@@ -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 "")

By default, only the algorithms which are flagged as favorites will be shown. 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.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,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
Expand Down

0 comments on commit f298029

Please sign in to comment.