Skip to content

Commit 2238fea

Browse files
authored
Merge pull request #648 from opengisch/QF-7111_Document_XLS_Form_Plugin
Adding first section about XLSForm
2 parents 521ac03 + 4f151d6 commit 2238fea

File tree

6 files changed

+64
-1
lines changed

6 files changed

+64
-1
lines changed
71 KB
Loading
51 KB
Loading
24.2 KB
Loading

documentation/get-started/tutorials/my-first-project.en.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tx_slug: documentation_get-started_tutorials_myfirstproject
88

99
This page will go through a step by step example of how to prepare a simple QField project containing a points layer, a line layer and a basemap.
1010
It will include the configuration of a simple attribute form and the styling of the feature layer.
11+
As an alternative if you are familiar with the XLSForm standard and want to re-use an existing forms, you can also use our [XLSForm Converter](../../how-to/advanced-how-tos/xlsforms-plugin.md) to convert forms into QField-ready projects.
1112

1213
## Step-by-step Example
1314

@@ -115,7 +116,7 @@ QGIS creates this for every GeoPackage by default.
115116
3. There exist several types of [widgets](how-to/attributes-form.md). <!-- markdown-link-check-disable-line -->
116117
*Maya does not want to enter the date new every time.*
117118
*What a good thing one can set default values in QGIS*
118-
5. Open the widget display of the ***entrydate*** attribute.
119+
5. Open the widget display of the ***Entrydate*** attribute.
119120
1. If not already done, change the widget type to date/time.
120121
You can customise the appearance of your date by changing the custom display format.
121122
2. To not have to add a new date every time, add a default value using the following expression ***format_date(now(),'dd MMMM yyyy')***.
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: XLSForm Converter
3+
tx_slug: documentation_xlsforms_plugin
4+
---
5+
6+
# XLSForm Converter Plugin for QGIS
7+
8+
Use the **XLSForm Converter** plugin to convert existing XLSForms into QGIS projects.
9+
This tool migrates all configurations from your form into a configured project alongside a geopackage containing your survey layers. The plugin allows you to upload the result directly to QFieldCloud provided you have installed QFieldSync. Once converted, the resulting project is ready to be loaded into QField for use in the field.
10+
11+
## XLSForms
12+
13+
XLSForms is a standard used by several survey products such as [ODK](https://getodk.org/) or [KoboToolbox](https://www.kobotoolbox.org/).
14+
XLSForms is built on a spreadsheet format using Excel as the standard.
15+
In simple terms a survey is made up of several "Questions" that can be presented in different formats (integer, text, lists etc.).
16+
To learn more about the standard please visit the [XLSForm reference website](https://xlsform.org/).
17+
18+
## How to install the plugin
19+
20+
You can install the XLSForm Converter in QGIS through its plugin manager.
21+
22+
!!! Workflow
23+
24+
1. Direct to *Plugins* > *Manage and Install Plugins* > *All*
25+
2. Search for XLSForm Converter and click "Install Plugin".
26+
27+
!![XLSForm Converter Plugin](../../assets/images/xlsform-plugin-interface.png,500px)
28+
29+
Once it is installed it will appear in your processing toolbox
30+
!![Processing](../../assets/images/xlsform-processing.png,300px)
31+
32+
## Convert XLSForm to QGIS Project
33+
34+
To convert a survey form you need to make sure you follow the XLSForm standards and format.
35+
Here is a [template](https://docs.google.com/spreadsheets/d/1v9Bumt3R0vCOGEKQI6ExUf2-8T72-XXp_CbKKTACuko/edit?gid=1052905058#gid=1052905058), you can adapt in case you are more familiar with XLSForms than QGIS.
36+
37+
!!! Workflow
38+
39+
1. In QGIS Open the "Convert XLSForm to QGIS project" process from your Processing Toolbox.
40+
2. Locate the XLSForm spreadsheet file (.xls or .ods).
41+
3. (Optional) In case you want to assign a specific name or a specific language to your project, fill in the dedicated fields.
42+
!![XLSForm Converter Process Interface](../../assets/images/xlsform-processing-windows.png,800px)
43+
4. Select your preferred basemap:
44+
- OpenStreetMap
45+
- Humanitarian OpenStreetMap Team (HOT)
46+
5. (Optional) You can directly turn your project into a QFieldCloud project if you check the according checkbox.
47+
6. (Optional) Under **Advanced Parameters** you can further customize the settings of your project:
48+
- Set your desired project extent
49+
- Define a preferred coordinate reference system.
50+
**Note**: By default the WGS 84: Pseudo Transmercator (EPSG:3857) will be used.
51+
- "Pre-fill project with features' geometries and matching attributes" allows you to take an existing feature with the **exact** table names and add it to the project by default.
52+
7. Choose the location of where your project is stored.
53+
8. Click "Run" and wait.
54+
In case successful, the new project will be saved in your selected project folder.
55+
56+
## More Information
57+
58+
If you want to know about what is all possible with the XLSForm Converter Plugin and what it can be used for, have a look at the resources below:
59+
60+
- [XLSForm Converter Plugin Source Code](https://github.com/opengisch/XLSFormConverter)
61+
- [OPENGIS.ch Blog post](https://www.opengis.ch/2025/06/02/xlsform-converter-unlock-a-world-of-surveys-with-our-brand-new-qgis-plugin/)

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ nav:
9494
- how-to/navigation-and-positioning/tracking.md
9595
- how-to/navigation-and-positioning/external-routing.md
9696
- Advanced How To's:
97+
- how-to/advanced-how-tos/xlsforms-plugin.md
9798
- how-to/advanced-how-tos/standalone-datasets.md
9899
- how-to/advanced-how-tos/sensors.md
99100
- how-to/advanced-how-tos/authentication.md

0 commit comments

Comments
 (0)