diff --git a/.gitignore b/.gitignore index 72c180f97..743157f5f 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,4 @@ Pipfile.lock .transifexrc /.python-version .cache +.vscode diff --git a/README.md b/README.md index 51e99893d..5cc72af19 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ feel free to use it accordingly and to contribute back your updates via a [pull request](https://github.com/opengisch/QField-docs/pulls). -[cc-by-sa]: http://creativecommons.org/licenses/by-sa/4.0/ +[cc-by-sa]: http://creativecommons.org/licenses/by-sa/4.0/ [cc-by-sa-shield]: https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg [![CC BY-SA 4.0][cc-by-sa-shield]][cc-by-sa] diff --git a/documentation/assets/images/qfc-get-started-brown.png b/documentation/assets/images/qfc-get-started-brown.png new file mode 100644 index 000000000..f41a30bc0 Binary files /dev/null and b/documentation/assets/images/qfc-get-started-brown.png differ diff --git a/documentation/assets/images/qfc-get-started-dashboard.png b/documentation/assets/images/qfc-get-started-dashboard.png new file mode 100644 index 000000000..1704d128b Binary files /dev/null and b/documentation/assets/images/qfc-get-started-dashboard.png differ diff --git a/documentation/assets/images/qfc-get-started-green.png b/documentation/assets/images/qfc-get-started-green.png new file mode 100644 index 000000000..d79135c77 Binary files /dev/null and b/documentation/assets/images/qfc-get-started-green.png differ diff --git a/documentation/assets/images/qfc-get-started-red.png b/documentation/assets/images/qfc-get-started-red.png new file mode 100644 index 000000000..cf556f436 Binary files /dev/null and b/documentation/assets/images/qfc-get-started-red.png differ diff --git a/documentation/assets/projects/advanced-bee-farming.zip b/documentation/assets/projects/advanced-bee-farming.zip deleted file mode 100644 index 204ca3ea9..000000000 Binary files a/documentation/assets/projects/advanced-bee-farming.zip and /dev/null differ diff --git a/documentation/assets/projects/bee_farming_project.zip b/documentation/assets/projects/bee_farming_project.zip new file mode 100644 index 000000000..c30038a8c Binary files /dev/null and b/documentation/assets/projects/bee_farming_project.zip differ diff --git a/documentation/assets/projects/qfield-users-survey.zip b/documentation/assets/projects/qfield-users-survey.zip deleted file mode 100644 index a4908c7c8..000000000 Binary files a/documentation/assets/projects/qfield-users-survey.zip and /dev/null differ diff --git a/documentation/assets/projects/simple-bee-farming.zip b/documentation/assets/projects/simple-bee-farming.zip deleted file mode 100644 index a1928bcbb..000000000 Binary files a/documentation/assets/projects/simple-bee-farming.zip and /dev/null differ diff --git a/documentation/assets/projects/wasterwater_management_project.zip b/documentation/assets/projects/wasterwater_management_project.zip new file mode 100644 index 000000000..03e1fc814 Binary files /dev/null and b/documentation/assets/projects/wasterwater_management_project.zip differ diff --git a/documentation/get-started/concepts.en.md b/documentation/get-started/concepts.en.md index d9c687b7b..a3853bc32 100644 --- a/documentation/get-started/concepts.en.md +++ b/documentation/get-started/concepts.en.md @@ -7,6 +7,7 @@ tx_slug: documentation_get-started_concepts QField is designed with a few key principles in mind. + ## Keeping it simple The requirements in the field are not the same as on a desktop. @@ -20,12 +21,14 @@ Before heading out to the field though, preliminary steps such as layer styling, ## Compatibility with QGIS + Since QField is a mobile optimized version of the QGIS desktop app, your project will appear and feel identical both in QGIS and QField. The rendering engine in QField is the same as the one used in desktop QGIS, ensuring that projects will appear virtually identical in both environments. Configurations options prepared in QGIS beforehand don't need to be recreated, which is why QField uses the same edit widgets as QGIS desktop does. As a result, projects configured on the desktop should work seamlessly on the mobile app. +These principles have so far informed our development and design of QField, and will continue to do so in the future. In the last few years, QField proved to be the fieldworker's best friend and continues to evolve with new features handling an even broader range of needs. ## Mode based diff --git a/documentation/get-started/sample-projects.en.md b/documentation/get-started/sample-projects.en.md index 9931ffdeb..5a34c7f71 100644 --- a/documentation/get-started/sample-projects.en.md +++ b/documentation/get-started/sample-projects.en.md @@ -5,12 +5,11 @@ tx_slug: documentation_get-started_sample-projects # Sample projects -QField ships with three sample (demo) projects by default. You can use these projects to explore some of the QField configuration details in QGIS+QFieldSync. +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 with each project. +The links below will download an archive of sample projects. -[Simple Bee :material-bee:](../assets/projects/simple-bee-farming.zip){ .md-button } -[Advanced Bee :material-bee-flower:](../assets/projects/advanced-bee-farming.zip){ .md-button } -[QField Users :material-map-marker:](../assets/projects/qfield-users-survey.zip){ .md-button } +[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 } You can also explore the sample projects directly in the [QField GitHub repository](https://github.com/opengisch/QField/tree/master/resources/sample_projects). diff --git a/documentation/get-started/third-part-tutorials.en.md b/documentation/get-started/third-part-tutorials.en.md index f065db77b..96beaf3f6 100644 --- a/documentation/get-started/third-part-tutorials.en.md +++ b/documentation/get-started/third-part-tutorials.en.md @@ -7,5 +7,5 @@ tx_slug: documentation_get-started_third-part-tutorials Here you can find some great tutorials created by our community: -- [QField tutorials](https://livelihoods-and-landscapes.github.io/qgis_qfield_tutorials/training_overview.html) from Climate-Smart Landscapes for Promoting Sustainability of Pacific Island Agricultural Systems +- [QField tutorials](https://livelihoods-and-landscapes.com/docs/tutorials.html) from Climate-Smart Landscapes for Promoting Sustainability of Pacific Island Agricultural Systems - [QField Quickstart Udemy course](https://www.udemy.com/course/qfield-quickstart/) by Michael Miller diff --git a/documentation/get-started/tutorials/get-started-qfs.en.md b/documentation/get-started/tutorials/get-started-qfs.en.md index 7b2a665c4..e6a116c72 100644 --- a/documentation/get-started/tutorials/get-started-qfs.en.md +++ b/documentation/get-started/tutorials/get-started-qfs.en.md @@ -3,9 +3,9 @@ title: Get Started tx_slug: documentation_get-started_tutorials_get-started-qfs --- -# QFieldSync plugin +# QFieldSync -The QFieldSync plugin helps preparing and packaging QGIS projects for +The [QFieldSync plugin for QGIS](https://plugins.qgis.org/plugins/qfieldsync/) helps preparing and packaging QGIS projects for QField. QFieldSync supports your project preparation with automating the diff --git a/documentation/how-to/gnss.en.md b/documentation/how-to/gnss.en.md index ef6476aa0..7a5e3d07a 100644 --- a/documentation/how-to/gnss.en.md +++ b/documentation/how-to/gnss.en.md @@ -82,9 +82,9 @@ The formats currently supported are: For example: For the transformation from ETRS89 (reference ellipsoid GPS) to NAP (Dutch) users can download -the file [nlgeo2018.gtx from NSGI](https://www.nsgi.nl/rdnaptrans) and put it in the directory. +the file [nlgeo2018.gtx from NSGI](https://www.nsgi.nl/rdnaptrans) and put it in the directory. -To obtain precise altitude data for Cadastral Surveying in Switzerland, users can access the file correction of the vertical grid shift through [Geoid OGD from Swisstopo](https://cms.geo.admin.ch/ogd/geodesy/Geoid_OGD.zip). +To obtain precise altitude data for Cadastral Surveying in Switzerland, users can access the file correction of the vertical grid shift through [Geoid OGD from Swisstopo](https://cms.geo.admin.ch/ogd/geodesy/Geoid_OGD.zip). Following the download, users are advised to perform a conversion of the file labeled `chgeo04_htrans_lv95.agr` to `chgeo04_htrans_lv95.gtx`. The QGIS processing algorithm `gdal:translate` (convert format) can be used for that. @@ -191,7 +191,7 @@ You can get access to positioning information through additional expression variables accessible in the attribute form. These will only be available when positioning is enabled. -These variables are commonly used as part of [default values expressions](https://docs.qgis.org/latest/en/docs/user_manual/working_with_vector/vector_properties.html#default-values) +These variables are commonly used as part of [default values expressions](https://docs.qgis.org/latest/en/docs/user_manual/working_with_vector/vector_properties.html#default-values) for fields to keep track of the quality of individual measured points. All `@position_*` variables have a corresponding `@gnss_*` variable. @@ -218,6 +218,8 @@ The gnss variables always report the gnss sensor values, even when the crosshair - `@position_direction` - The direction of movement in degrees from true north as reported by the sensor. It is only available when the crosshair is snapped to the sensor. - IE + - `@position_orientation` - Orientation of the device itself, regardless of its movement. + It changes as the device is rotated relative to true north (from 0° to 359°). - `@position_ground_speed` - Groundspeed (in m/s) as reported by the sensor. It is only available when the crosshair is snapped to the sensor. - IE - `@position_magnetic_variation` - The angle between the horizontal component of the magnetic field diff --git a/documentation/how-to/plugins.en.md b/documentation/how-to/plugins.en.md index e222b3167..b3b22f4cf 100644 --- a/documentation/how-to/plugins.en.md +++ b/documentation/how-to/plugins.en.md @@ -3,7 +3,7 @@ title: Plugins tx_slug: documentation_how-to_plugins --- -# Plugins +# QField Plugins QField has a QML/Javascript plugin framework through which additional functionalities and features can be scripted. diff --git a/documentation/reference/qfieldcloud/sdk.en.md b/documentation/reference/qfieldcloud/sdk.en.md index 3efedbacd..2e970d7aa 100644 --- a/documentation/reference/qfieldcloud/sdk.en.md +++ b/documentation/reference/qfieldcloud/sdk.en.md @@ -19,13 +19,13 @@ import requests from qfieldcloud_sdk import sdk client = sdk.Client( - url="https://app.qfield.cloud/api/v1/", - username="user1", - password="pass1", + url="https://app.qfield.cloud/api/v1/" ) +client.login(username='me', password='mysecret') try: projects = client.list_projects() + print(projects) except requests.exceptions.RequestException: print("Oops!") ``` diff --git a/mkdocs.yml b/mkdocs.yml index 149a17d03..28a92e306 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -53,7 +53,7 @@ nav: - QFieldCloud: - get-started/tutorials/get-started-qfc.md - get-started/tutorials/advanced-setup-qfc.md - - get-started/storage-qfc.en.md + - get-started/storage-qfc.md - QFieldSync: - get-started/tutorials/get-started-qfs.md - get-started/faq.md @@ -282,25 +282,25 @@ plugins: QFieldエコシステムのドキュメントへようこそ。QFieldエコシステムは、フィールドワークをシームレスかつ効率的にするために設計された製品群です。このページでは、QField のすべての製品について、包括的でわかりやすいドキュメントを提供しています。初めてお使いになる方でも、経験豊富なプロの方でも、QFieldとその関連ツールの使用に関して知っておくべきことが全て網羅されています。 nav_translations: - Home: Home + Home: ホーム Get started: スタート・ガイド - Tutorials: Tutorials + Tutorials: チュートリアル QFieldCloud: QFieldCloud QFieldSync: QFieldSync How-to guides: ハウツー・ガイド Technical reference: 技術参考情報 - Success stories: Success stories + Success stories: ケーススタディ palette: - scheme: default primary: light green toggle: icon: octicons/moon-24 - name: Switch to dark mode + name: ダークモードにする - scheme: slate primary: blue toggle: icon: octicons/sun-24 - name: Switch to light mode + name: ライトモードにする # Page tree - locale: pt diff --git a/utils/push_to_zoho.py b/utils/push_to_zoho.py index c18a893b4..731134353 100644 --- a/utils/push_to_zoho.py +++ b/utils/push_to_zoho.py @@ -133,7 +133,7 @@ def push_article( req = requests.post(url, json=payload, headers=headers) print("creating: ", permalink, ": ", req.status_code) - if req.status_code == 401: + if req.status_code >= 400: raise RuntimeError(req.text)