Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
145 lines (109 sloc) 3.73 KB

Welcome to ODK's Docs!

:dfn:`Open Data Kit` (ODK) is a suite of open source tools that help organizations collect and manage data.

The core ODK tools are:

The specifications and libraries that power the tools are:

  • :doc:`openrosa`, APIs for how ODK clients communicate with ODK servers.
  • ODK XForms spec, a subset of the W3C XForms specification, for use in the ODK ecosystem.
  • ODK JavaRosa, a Java library that renders forms complying with ODK XForms.
  • XLSForm spec, a high-level Excel-based form specification.
  • pyxform, a Python library that converts XLSForms into ODK XForms.

For a complete list of our tools, check out Open Data Kit on GitHub.

How is ODK used?

For a quick start, read :doc:`getting-started`. In most cases, users of ODK:

This requires:

While this is the typical use pattern, it is not the only way to do things. ODK is a very flexible set of tools, and organizations will find their own best practices for adopting it.

.. toctree::
  :maxdepth: 1
  :hidden:

  getting-started

.. toctree::
  :hidden:
  :maxdepth: 1
  :caption: Collect

  collect-intro
  collect-setup
  collect-using
  collect-best-practices

.. toctree::
  :hidden:
  :maxdepth: 2
  :caption: Aggregate

  aggregate-intro
  aggregate-setup
  aggregate-use
  aggregate-best-practices

.. toctree::
  :hidden:
  :maxdepth: 2
  :caption: Briefcase

  briefcase-intro
  briefcase-install
  briefcase-using
  briefcase-and-aggregate

.. toctree::
  :hidden:
  :maxdepth: 2
  :caption: Central

  central-intro
  central-setup
  central-using

.. toctree::
  :hidden:
  :maxdepth: 2
  :caption: Form Building

  form-design-intro
  xlsform
  form-question-types
  form-logic
  form-styling
  form-language
  form-operators-functions
  form-audit-log
  launch-apps-from-collect
  form-tools
  form-best-practices

.. toctree::
  :hidden:
  :maxdepth: 2
  :caption: Contributing

  contributing

.. toctree::
  :hidden:
  :maxdepth: 2
  :caption: Developing with ODK

  openrosa
  javarosa
  launch-collect-from-app
  briefcase-api

.. toctree::
  :hidden:
  :maxdepth: 2
  :caption: Integration

  encrypted-forms

.. toctree::
  :hidden:
  :maxdepth: 2
  :caption: Reference

  security-privacy
  glossary