Skip to content

improve attributes form doc looking at clarity and grammar #543

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

improve attributes form doc looking at clarity and grammar #543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
688062d
Improve clarity and fix typo in sample projects documentation
dangomaps Mar 27, 2025
ac1e2e7
docs: Improve grammar and clarity in attributes form documentation
dangomaps Apr 1, 2025
47b20fe
Update sample-projects.en.md
beanzmo Apr 25, 2025
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
9 changes: 7 additions & 2 deletions documentation/get-started/sample-projects.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,14 @@ tx_slug: documentation_get-started_sample-projects

QField ships with sample projects by default. You can use these projects to explore some of the QField configuration details in QGIS and QFieldSync.

The links below will download an archive of sample projects.
These sample projects demonstrate various field data collection workflows and QField features:

- The Bee Farming project showcases form-based data entry and spatial data collection
- The Wastewater Management project illustrates infrastructure mapping and inspection workflows

Click the buttons below to download the sample project archives:

[Bee Farming Sample Project :material-bee:](../assets/projects/bee_farming_project.zip){ .md-button }
[Wasterwater Management Sample Project :material-bee-flower:](../assets/projects/wasterwater_management_project.zip){ .md-button }
[Wastewater Management Sample Project :material-bee-flower:](../assets/projects/wasterwater_management_project.zip){ .md-button }

You can also explore the sample projects directly in the [QField GitHub repository](https://github.com/opengisch/QField/tree/master/resources/sample_projects).
20 changes: 10 additions & 10 deletions documentation/how-to/attributes-form.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ tx_slug: documentation_how-to_attributes-form

# Attribute form

QField creates forms similar to, but not equal to QGIS.
The field widgets from QGIS are supported on a best effort basis and optimized for the mobile use.
QField creates forms that are similar to QGIS, but with some differences.
QGIS field widgets are supported on a best-effort basis and optimized for mobile use.


| Widget type | Support | Notes |
|--------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Text Edit | :material-check: | - HTML is not supported <br> - Numerical input is enforced based on the type. |
| Text Edit | :material-check: | - HTML is not supported <br> - Numeric input is enforced based on the field type. |
| Check Box | :material-check: | |
| Value Map | :material-check: | |
| Hidden | :material-check: | |
Expand All @@ -31,8 +31,8 @@ The *editable* flag of fields is respected.

### Remember last values

QField offers a much more fine-grained control over the last used values
and ignores the QGIS setting.
QField offers more fine-grained control over the last used values than QGIS,
and uses its own settings instead of the QGIS ones.

### Suppress attribute form

Expand Down Expand Up @@ -65,9 +65,9 @@ The visual identification of the list entries are done via the *Display Expressi

### Key handling

Since the parents primary keys are used as foreign keys on the
referencing child features, these primary keys must be save to use even
after the synchronization back to the original data. Therefore we
Since the parent's primary keys are used as foreign keys in the
referencing child features, these primary keys must be safe to use even
after synchronizing back to the original data. Therefore we
recommend to use stable values such as UUIDs for primary keys.

It is possible to already add children from a parent that is about to be
Expand All @@ -93,7 +93,7 @@ In case of the many-to-one cardinality on many-to-many relations the

### Configuring Ordered Relations for QGIS and QField

The **Ordered Relation Editor** widget allows you to reorder linked child features in a relation editor widget based on a specific ordering field.
The **Ordered Relation Editor** widget enables reordering of linked child features based on a specific ordering field.

#### 1. Install the Plugin

Expand Down Expand Up @@ -180,7 +180,7 @@ doc, \...).

QFieldSync provides the possibility to configure the path of attachments.

- Go to _QFieldSync plugin > Layers Properties_
- Go to _QFieldSync plugin > Layers Properties_

Use expressions to specify the path of the attachments. By default, pictures are saved into the "DCIM" folder, audio recordings are saved into the "audio" folder and videos are saved into "video" with a timestamp as name.

Expand Down
Loading