search

getodk / xforms-spec

The XForms-derived specification used in the ODK ecosystem. If you are interested in building a tool that is compliant with the forms rendered by ODK tools, this is the place to start. ✨⚒✨
https://getodk.github.io/xforms-spec/
31 stars 26 forks source link
data-collection global-development global-health odk odk-xforms xforms-spec

readme

ODK XForms Spec

Published at https://getodk.github.io/xforms-spec/

Requirements for running locally

Install Jekyll (Windows users, see here) and bundler.

Afterwards, to install all dependencies for this repo:

bundle install

Run locally

When editing use jekyll serve or bundle exec jekyll serve to build, start up a webserver and automatically rebuild on http://localhost:4000/xforms-spec/.

Contributing

Pull requests are welcome for any agreed-upon issues! Propose a specification addition or change or join the live conversation in the xforms-spec channel of the ODK Slack.

Specification changes

This specification is not a fixed document and is regularly extended with new features. Occassionally, poor earlier choices are removed, and behavior is clarified or corrected. To propose a small correction or clarification, just open an issue here. For a more significant change in the XForms specification, the following approach should be used:

  1. Post a proposal in the ODK Forum (e.g. under the Development category and tagged with spec-proposal and odk-xforms). If you have a proposed XForm (and/or XLSForm) syntax, please include it.
  2. If the ODK community is interested and a syntax candidate emerges, there will be a vote according to the ODK Voting Rules.
  3. Once the extension is approved any relevant issues will be created in this repo, in pyxform and in the XLSForm documentation and the implementation can go ahead.

If you propose a specification addition that does not make it through the approval process (e.g. because it is considered to be for a too-specific use case), the recommended way to add it to your own application is to use your own custom namespace for any new elements or attributes. This will avoid conflicts with any future features in the ODK XForms Specification (or the W3C XForms specification). If in the future, the situation changes and ODK would like to adopt the feature after all, the common practise would be to include it using your namespace.