Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/img/web-forms/geopoint-maps-appearance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/img/web-forms/geopoint-placement-map-appearance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/img/web-forms/geoshape.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/img/web-forms/geotrace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/img/web-forms/map-advanced-panel.png
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alyblenkin could you please put this image in the same frame as the others?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! Added to this folder

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 28 additions & 9 deletions docs/web-forms-intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,13 @@ Question types
To know which question types are currently supported in Web Forms, see `the Github feature matrix <https://github.com/getodk/we
b-forms?tab=readme-ov-file#feature-matrix>`_. While most supported functionality is very similar to Collect's, this section describes question types with more complex functionality or that differ from Collect.

Web Forms currently supports 3 geo question types and appearances:
Web Forms currently supports 5 geo question types and appearances:

* :ref:`Geopoint <geopoint-widget>`
* :ref:`Maps appearance <geopoint-maps>`
* :ref:`Placement-map appearance <placement-map-widget>`

**Coming soon**

- Geoshape
- Geotrace
- Editing all map appearances
* :ref:`Geoshape <geotrace-widget>`
* :ref:`Geotrace <geoshape-widget>`

Geopoint without appearance
~~~~~~~~
Expand All @@ -80,21 +76,44 @@ Once location permissions are granted to Web Forms, it will start reading locati
Geopoint with `maps` appearance
~~~~~~~~

The `maps` appearance allows users to capture their current location while viewing it on a map. After tapping **Get location** and granting permissions, the map automatically zooms to the user’s current location. The user taps **Save point** to save the location. Once saved, the marker turns green to indicate success and the bottom panel displays **Point saved**. The user can remove the saved point and try again if needed.
The `maps` appearance allows users to capture their current location while viewing it on a map. After tapping **Get location** and granting permissions, the map automatically zooms to the user’s current location and saves the location. The marker turns green to indicate success and the bottom panel displays Point saved. The user can remove the saved point and try again if needed.

.. image:: /img/web-forms/geopoint-maps-appearance.*
:alt: Web forms geopoint with maps appearance

Geopoint with `placement-map` appearance
~~~~~~~~

The `placement-map` appearance is similar to `maps`, but also allows the user to manually move the marker. If location permissions are granted, the map zooms to the user’s current location. The user can save the current location or manually place the marker by long-pressing on the map. The marker can be dragged to adjust the position. The user can remove the marker and try again at any time before moving on.
The `placement-map` appearance is similar to `maps`, but also allows the user to manually move the marker. If location permissions are granted, the map zooms to the user’s current location. The marker is saved by tapping on the map. The marker can be dragged to adjust the position. The user can remove the marker and try again at any time before moving on.

For both `maps` and `placement-map` appearances, location capture stops when the user scrolls away from the question.

.. image:: /img/web-forms/geopoint-placement-map-appearance.*
:alt: Web forms geopoint with placement-map appearance

Geoshape
~~~~~~~~

A series of points that form a closed polygon. Points can be added by tapping the screen to place each point. Each coordinate is represented by small circles with outlines. These are connected by lines. The last point that was entered has a darker outline. Use the trash bin icon to delete the entire shape or the undo button to go back a step.

.. image:: /img/web-forms/geoshape.*
:alt: Web forms geoshape

Geotrace
~~~~~~~~

A series of points. Identical to geoshape except that the first and last point may be different and at least 2 points are required.

Points can be added by tapping the screen to place each point. Each coordinate is represented by small circles with outlines. These are connected by lines. The last point that was entered has a darker outline.

.. image:: /img/web-forms/geotrace.*
:alt: Web forms geotrace

For scenarios requiring precise coordinate adjustments, an advanced panel is available for manual data entry. Expanding this panel allows to specify the latitude, longitude, altitude, and accuracy for specific points. Additionally, use the import option to replace the existing trace or shape with external data.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alyblenkin, this is to explain the advanced feature, it came up yesterday during my 1-1 with @lognaturel
What do you think?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slight tweak:

For scenarios requiring precise coordinate adjustments, an advanced panel can be used for manual data entry. Expanding this panel allows users to specify the latitude, longitude, altitude, and accuracy for points. If the user already has the geodata from an external source, they can paste or import the file to replace the existing trace or shape.


.. image:: /img/web-forms/map-advanced-panel.*
:alt: Web forms advanced panel for geoshape and geotrace

Image
~~~~~~~~

Expand Down