Skip to content

Commit

Permalink
docs: add extra resources for odk entities info
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Apr 4, 2024
1 parent 5da7e47 commit 6ef0b8c
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions docs/about/odk-entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ surveying the people in it.
As of time of writing (March 2024), Entities in ODK are working and more
or less implemented, but not yet in wide use or well debugged.

# Use of Entities with FMTM
## Use of Entities with FMTM

In FMTM, we want to:
In osm-fieldwork / FMTM, we want to:

- Be aware of features that have already been mapped
- the ODK map views don't yet support styling features differently
Expand All @@ -31,16 +31,16 @@ In FMTM, we want to:
The ODK core development team has strongly suggested that the FMTM team
use the Entities to achieve the above goals.

## Workflow Using Entities
### Workflow Using Entities

The basic workflow would probably resemble:

- Create an Entity registration form.
- In standard ODK settings, this simply means adding an `entities`
tab to the XLSForm (as per
[the example Entities form created by the ODK team](https://docs.google.com/spreadsheets/d/1xboXBJhIUlhs0wlblCxcQ3DB5Ubpx2AxLDuaXh_JYyw/edit#gid=2050654322).
This seems to create what ODK refers to as a Dataset (in developer-facing documenation only;
they avoid this word in user-facing documentation).
This seems to create what ODK refers to as a Dataset (in developer-facing
documenation only; they avoid this word in user-facing documentation).
- Upload the Entities via the API:
- There is currenltly no way to bulk upload Entities to a Dataset via the API.
- Instead we must upload each Entity individually, including a geometry field
Expand All @@ -62,10 +62,13 @@ The basic workflow would probably resemble:
- Update the entity label to be prefixed with ✅ ❌ for a nicer visual cue.
<https://docs.getodk.org/central-entities/#building-a-form-that-updates-an-entity>

# Resources
## Resources

- [Here's the introductory page from ODK discussing the rationale for and use of Entities](https://docs.getodk.org/central-entities/). It has some example forms you can use to get started figuring out how to use Entities.
- [Here's the introductory page from ODK](https://docs.getodk.org/central-entities/).
discussing the rationale for and use of Entities.
It has some example forms you can use to get started figuring out how to use Entities.
- [Here's the specification for Entities in the XForms language](https://getodk.github.io/xforms-spec/entities).
- [Here's the ODK Central API documentation for dealing with Entities](https://docs.getodk.org/central-api-entity-management/)
- [Here's the ODK Central API documentation for dealing with the "Datasets" they are part of](https://docs.getodk.org/central-api-form-management/#related-datasets)
- [Here's a discussion of how you can attach a draft form to an entity "dataset"](https://docs.getodk.org/central-api-form-management/#linking-a-dataset-to-a-draft-form-attachment)
- [OSM Diary Detailing Entity Usage](https://www.openstreetmap.org/user/spwoodcock/diary/403845)

0 comments on commit 6ef0b8c

Please sign in to comment.