getodk / getodk/docs

Document pulldata and provide examples

Open
#1,019 1 comment 0 reactions 0 assignees View on GitHub
Collect Form design
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

Pulldata is now officially supported: https://opendatakit.github.io/xforms-spec/#fn:pulldata

The documentation should state that it is particularly useful for CSVs and in fact that Collect only supports it for CSVs currently (until https://github.com/opendatakit/javarosa/issues/427 is addressed). The spec describes it in terms of elements but it's really only useful to users who use CSVs so this user-facing documentation should describe it in terms of columns (e.g. `pulldata(, , , )`).

Some useful information can be brought in from https://github.com/opendatakit/docs/issues/73.

Contributor guide

Open the contributing guide

Research direction

Start by locating the user-facing documentation for pulldata in this Sphinx documentation repository, then review the XForms specification link and the related docs issue 73. Add an explanation framed around CSV columns, include examples, and document that Collect currently supports pulldata only for CSVs until javarosa issue 427 is addressed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.