Include form field labels and hints in form_schema

Ideas
1

1. What is the general goal of the feature?
Originally suggested here by @dmenne

What: Provide form labels and hints in all supported languages to consumers of ODK Central data, e.g. though ruODK.

How: The output of ODK Central's form schema (api docs on form schema) could add labels and hints.

{
    "name": "age",
    "path": "/age",
    "type": "int",
    "label": {"en": "Age", "de": "Alter"},
    "hint": {"en": "...", "de": "..."}
  },

Note on example schema above: Nesting languages inside label and hint would provide a stable schema at the top level and push the changing number of languages to the second nesting level.

2. What are some example use cases for this feature?
As a data analyst building data products directly from ODK Central data, I want to use human readable form labels and/or hints in the languages supported by the form.

3. What can you contribute to making this feature a reality?
Support in ruODK::form_schema()

2

@Mtyszler has contributed a function form_schema_ext to ruODK (v0.9.2), which extracts form field labels and choices in every given language.

Once ruODK docs are rebuilt, the reference to form_schema_ext should appear at https://docs.ropensci.org/ruODK/reference/index.html

Ping @dmenne

2 Likes
3

Thanks to @Mtyszler and @Florian_May

Dieter

1 Like
4

And here it is: https://docs.ropensci.org/ruODK/reference/form_schema_ext.html
We should include a packaged version of the extended form schema to show in the example.

1 Like