Skip to content

Commit

Permalink
adding new html
Browse files Browse the repository at this point in the history
  • Loading branch information
tinok committed Jun 30, 2020
1 parent 4d36e28 commit 893b95b
Show file tree
Hide file tree
Showing 93 changed files with 342 additions and 14 deletions.
Binary file added docs/_images/add_user.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/example_own.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/example_subset.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/permission.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/setting.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/summary1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions docs/_sources/enketo.md.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,41 @@
# What are Enketo webforms?

According to [Enketo.org](https://enketo.org), **Enketo** is the name of an open-source project as well as the name of an open-source web application that uses a popular open-source form format.

Enketo was developed as a follow-up to a 2009 Masters Dissertation at the University of Liverpool on the 'Applicability of [Offline-capable Web Technologies](https://blog.enketo.org/offline-capable-web-applications/) for Information Management in Humanitarian Aid'.

After a year of initial development, it was adopted by [a lab at Columbia University](https://qsel.columbia.edu/products-tools/) and [first launched](https://blog.enketo.org/enketo-is-now-open-source-and-will-be-used-in-formhub/) in 2012. This was the start of a cascade of [adoption](https://enketo.org/about/adoption/) by companies and organizations across the world.

### What Ecosystem does Enketo use?

Enketo is part of the OpenRosa/ODK ecosystem which means:

1. Enketo can be combined with other tools to flexibly create a full-fledged information management system. This has resulted in the adoption of Enketo into KoBoToolBox. It also means that the Enketo Project can focus on just data collection and do this in the best way possible.
2. Enketo does not require a long-term commitment by the user.

### What are the general features?

Surveys deployed with Enketo:
* work offline
* have beautiful themes and widgets
* are printer-friendly
* can use very powerful skip and validation logic
* run on any device, mobile or desktop, as long as it has a fairly modern browser

### How can I access Enketo when on KoBoToolbox?

Whenever you open a form on the webform version within KoBoToolbox, you are actually using Enketo.

### How do I troubleshoot Enketo?
Enketo web forms work on all devices since they open in regular web browsers and allow data collection online or offline. Generally we strongly recommend the latest version of all modern browsers; [see here for more details on browsers working with Enketo](https://github.com/kobotoolbox/enketo-express#browser-support).

**Known issues with offline forms on iOS**

iOS (running on iPhones and iPads) devices have several known limitations with using offline-enabled forms due to the Apple operating system platform. We strive to have the latest version of iOS fully supported.

* Offline data collection works in any modern browser. On iOS we only recommend Chrome or Safari.
* Version 9.x shows "NotFoundError: DOM IDBDatabase Exception 8". Solution: Close all Enketo tabs in your browser, then reopen the form. The error should now be gone forever.
* Version 9.3.1 shows "Attempted to assign to readonly property" when loading offline form
* Version 8.x shows "undefined is not an object (evaluating 'c.resources')". Solution: Update to latest iOS version

If data collection offline is not required and you are seeing an error on iOS, consider using the [online-only version](https://ee.kobotoolbox.org/::ABCD) instead of the offline URL.
4 changes: 3 additions & 1 deletion docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Topics
form_meta
encrypting_forms
custom_format_web
enketo
alternative_enketo
hxl
lower_file_size
Expand Down Expand Up @@ -101,7 +102,8 @@ Topics
excel_analyzer_guide
pulling_data_into_powerbi
upload_to_gis
data_storage
data_storage
row_level_permissions


.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion docs/_sources/is_my_data_safe.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Most users use one of the two server instances that we support: [KoBoToolbox by

We take the protection of collected data very seriously. Data from both servers is hosted by Amazon Web Services (AWS). Both servers are administered using best practice tools and mechanisms to keep data safe from intrusion or loss.

The instance hosted by HHI ([kf.kobotoolbox.org](kf.kobotoolbox.org)) is physically located in the United States of America. **The humanitarian instance financed by OCHA, is hosted at a data center in Ireland.**
The instance hosted by HHI ([kf.kobotoolbox.org](https://kf.kobotoolbox.org)) is physically located in the United States of America. **The humanitarian instance financed by OCHA, is hosted at a data center in Ireland.**

AWS security information can be found on [this page](https://aws.amazon.com/security/). In addition, we do regular database backups to protect against any eventuality. The privacy policy and terms of use are both linked here.

Expand Down
31 changes: 31 additions & 0 deletions docs/_sources/row_level_permissions.md.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,33 @@
# Row-level permissions

The Row-Level Permissions feature allows owners of a project to create three levels of project permissions for users related to viewing submissions. Those three levels are:

1. User can view all submitted data
2. User can view data submitted by a subset of users only
3. User can view data submitted by oneself only

**To make use of this feature, please follow the steps below.**

Make sure that your account settings are set to 'Require authentication to see forms and submitted data'.

![image](/images/row_level_permissions/setting.jpg)

Access the Sharing settings through either the project Summary or Settings tab. For the purposes of this help article, the screenshots show the Sharing Permissions modal that opens from the project Summary tab, but the steps are the same no matter which Sharing settings page you use.

![image](/images/row_level_permissions/summary.jpg)

In the Sharing Permissions modal, click the `ADD USER` button.

![image](/images/row_level_permissions/add_user.jpg)

Enter the name of the user you wish to set the `View submissions` settings for at the top. Then click the checkbox `View submissions` below. If you wish for the user to be able to view all submissions in the project, then no further action is needed. If you wish to restrict the user to view data submitted only by a subset of users, then click the `View submissions only from specific users` checkbox. Enter in the subset of usernames, separated by spaces, in the line below. If you wish for the user to only view data submitted by themselves, then only enter in their username. Once all the desired users are entered, click `GRANT PERMISSIONS`.

![image](/images/row_level_permissions/permission.jpg)

Example of a user having permission to view submitted data from a subset of users:

![image](/images/row_level_permissions/example_subset.jpg)

Example of a user having permission to view only their own submitted data:

![image](/images/row_level_permissions/example_own.jpg)
2 changes: 2 additions & 0 deletions docs/activation_link.html
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ <h1>FAQ: Didn’t Receive My Activation Link After Signing Up<a class="headerlin
<li class="toctree-l1"><a class="reference internal" href="form_meta.html">Form Settings and Meta Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="encrypting_forms.html">Encrypting Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_format_web.html">Custom Formatting in Web Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="enketo.html">What are Enketo webforms?</a></li>
<li class="toctree-l1"><a class="reference internal" href="alternative_enketo.html">Using Alternative Enketo Web Form Styles</a></li>
<li class="toctree-l1"><a class="reference internal" href="hxl.html">Using Hxl Tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="lower_file_size.html">How To Lower the File Size of Collected Media</a></li>
Expand Down Expand Up @@ -196,6 +197,7 @@ <h1>FAQ: Didn’t Receive My Activation Link After Signing Up<a class="headerlin
<li class="toctree-l1"><a class="reference internal" href="pulling_data_into_powerbi.html">Pulling your data into PowerBI</a></li>
<li class="toctree-l1"><a class="reference internal" href="upload_to_gis.html">Exporting and uploading your data to GIS software</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_storage.html">Data Storage</a></li>
<li class="toctree-l1"><a class="reference internal" href="row_level_permissions.html">Row-level permissions</a></li>
</ul>
<p class="caption"><span class="caption-text">KoBoToolbox on Your Computer or Server</span></p>
<ul>
Expand Down
2 changes: 2 additions & 0 deletions docs/add_logo.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ <h2>Tips:<a class="headerlink" href="#tips" title="Permalink to this headline">
<li class="toctree-l1"><a class="reference internal" href="form_meta.html">Form Settings and Meta Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="encrypting_forms.html">Encrypting Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_format_web.html">Custom Formatting in Web Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="enketo.html">What are Enketo webforms?</a></li>
<li class="toctree-l1"><a class="reference internal" href="alternative_enketo.html">Using Alternative Enketo Web Form Styles</a></li>
<li class="toctree-l1"><a class="reference internal" href="hxl.html">Using Hxl Tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="lower_file_size.html">How To Lower the File Size of Collected Media</a></li>
Expand Down Expand Up @@ -220,6 +221,7 @@ <h2>Tips:<a class="headerlink" href="#tips" title="Permalink to this headline">
<li class="toctree-l1"><a class="reference internal" href="pulling_data_into_powerbi.html">Pulling your data into PowerBI</a></li>
<li class="toctree-l1"><a class="reference internal" href="upload_to_gis.html">Exporting and uploading your data to GIS software</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_storage.html">Data Storage</a></li>
<li class="toctree-l1"><a class="reference internal" href="row_level_permissions.html">Row-level permissions</a></li>
</ul>
<p class="caption"><span class="caption-text">KoBoToolbox on Your Computer or Server</span></p>
<ul>
Expand Down
2 changes: 2 additions & 0 deletions docs/advanced_calculate.html
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,7 @@ <h4>Workaround 1: Creating Dummy Questions for Calculation of Final Score in a S
<li class="toctree-l1"><a class="reference internal" href="form_meta.html">Form Settings and Meta Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="encrypting_forms.html">Encrypting Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_format_web.html">Custom Formatting in Web Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="enketo.html">What are Enketo webforms?</a></li>
<li class="toctree-l1"><a class="reference internal" href="alternative_enketo.html">Using Alternative Enketo Web Form Styles</a></li>
<li class="toctree-l1"><a class="reference internal" href="hxl.html">Using Hxl Tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="lower_file_size.html">How To Lower the File Size of Collected Media</a></li>
Expand Down Expand Up @@ -262,6 +263,7 @@ <h4>Workaround 1: Creating Dummy Questions for Calculation of Final Score in a S
<li class="toctree-l1"><a class="reference internal" href="pulling_data_into_powerbi.html">Pulling your data into PowerBI</a></li>
<li class="toctree-l1"><a class="reference internal" href="upload_to_gis.html">Exporting and uploading your data to GIS software</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_storage.html">Data Storage</a></li>
<li class="toctree-l1"><a class="reference internal" href="row_level_permissions.html">Row-level permissions</a></li>
</ul>
<p class="caption"><span class="caption-text">KoBoToolbox on Your Computer or Server</span></p>
<ul>
Expand Down
6 changes: 4 additions & 2 deletions docs/alternative_enketo.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Using Hxl Tags" href="hxl.html" />
<link rel="prev" title="Custom Formatting in Web Forms" href="custom_format_web.html" />
<link rel="prev" title="What are Enketo webforms?" href="enketo.html" />

<link rel="stylesheet" href="_static/custom.css" type="text/css" />

Expand Down Expand Up @@ -106,7 +106,7 @@ <h2>List of available styles in XLSForm:<a class="headerlink" href="#list-of-ava
<ul>
<li>
&larr;
<a href="custom_format_web.html" title="Previous document">Custom Formatting in Web Forms</a>
<a href="enketo.html" title="Previous document">What are Enketo webforms?</a>
</li>
<li>
<a href="hxl.html" title="Next document">Using Hxl Tags</a>
Expand Down Expand Up @@ -164,6 +164,7 @@ <h2>List of available styles in XLSForm:<a class="headerlink" href="#list-of-ava
<li class="toctree-l1"><a class="reference internal" href="form_meta.html">Form Settings and Meta Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="encrypting_forms.html">Encrypting Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_format_web.html">Custom Formatting in Web Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="enketo.html">What are Enketo webforms?</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Using Alternative Enketo Web Form Styles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#list-of-available-styles-in-xlsform">List of available styles in XLSForm:</a></li>
</ul>
Expand Down Expand Up @@ -208,6 +209,7 @@ <h2>List of available styles in XLSForm:<a class="headerlink" href="#list-of-ava
<li class="toctree-l1"><a class="reference internal" href="pulling_data_into_powerbi.html">Pulling your data into PowerBI</a></li>
<li class="toctree-l1"><a class="reference internal" href="upload_to_gis.html">Exporting and uploading your data to GIS software</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_storage.html">Data Storage</a></li>
<li class="toctree-l1"><a class="reference internal" href="row_level_permissions.html">Row-level permissions</a></li>
</ul>
<p class="caption"><span class="caption-text">KoBoToolbox on Your Computer or Server</span></p>
<ul>
Expand Down
2 changes: 2 additions & 0 deletions docs/archiving_projects.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ <h2>Process of unarchiving<a class="headerlink" href="#process-of-unarchiving" t
<li class="toctree-l1"><a class="reference internal" href="form_meta.html">Form Settings and Meta Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="encrypting_forms.html">Encrypting Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_format_web.html">Custom Formatting in Web Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="enketo.html">What are Enketo webforms?</a></li>
<li class="toctree-l1"><a class="reference internal" href="alternative_enketo.html">Using Alternative Enketo Web Form Styles</a></li>
<li class="toctree-l1"><a class="reference internal" href="hxl.html">Using Hxl Tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="lower_file_size.html">How To Lower the File Size of Collected Media</a></li>
Expand Down Expand Up @@ -230,6 +231,7 @@ <h2>Process of unarchiving<a class="headerlink" href="#process-of-unarchiving" t
<li class="toctree-l1"><a class="reference internal" href="pulling_data_into_powerbi.html">Pulling your data into PowerBI</a></li>
<li class="toctree-l1"><a class="reference internal" href="upload_to_gis.html">Exporting and uploading your data to GIS software</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_storage.html">Data Storage</a></li>
<li class="toctree-l1"><a class="reference internal" href="row_level_permissions.html">Row-level permissions</a></li>
</ul>
<p class="caption"><span class="caption-text">KoBoToolbox on Your Computer or Server</span></p>
<ul>
Expand Down
2 changes: 2 additions & 0 deletions docs/audit_logging.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ <h1>Audit Logging Meta Question Type<a class="headerlink" href="#audit-logging-m
<li class="toctree-l1"><a class="reference internal" href="form_meta.html">Form Settings and Meta Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="encrypting_forms.html">Encrypting Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_format_web.html">Custom Formatting in Web Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="enketo.html">What are Enketo webforms?</a></li>
<li class="toctree-l1"><a class="reference internal" href="alternative_enketo.html">Using Alternative Enketo Web Form Styles</a></li>
<li class="toctree-l1"><a class="reference internal" href="hxl.html">Using Hxl Tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="lower_file_size.html">How To Lower the File Size of Collected Media</a></li>
Expand Down Expand Up @@ -211,6 +212,7 @@ <h1>Audit Logging Meta Question Type<a class="headerlink" href="#audit-logging-m
<li class="toctree-l1"><a class="reference internal" href="pulling_data_into_powerbi.html">Pulling your data into PowerBI</a></li>
<li class="toctree-l1"><a class="reference internal" href="upload_to_gis.html">Exporting and uploading your data to GIS software</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_storage.html">Data Storage</a></li>
<li class="toctree-l1"><a class="reference internal" href="row_level_permissions.html">Row-level permissions</a></li>
</ul>
<p class="caption"><span class="caption-text">KoBoToolbox on Your Computer or Server</span></p>
<ul>
Expand Down
2 changes: 2 additions & 0 deletions docs/calculate_questions.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ <h2>List of available calculation operators<a class="headerlink" href="#list-of-
<li class="toctree-l1"><a class="reference internal" href="form_meta.html">Form Settings and Meta Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="encrypting_forms.html">Encrypting Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_format_web.html">Custom Formatting in Web Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="enketo.html">What are Enketo webforms?</a></li>
<li class="toctree-l1"><a class="reference internal" href="alternative_enketo.html">Using Alternative Enketo Web Form Styles</a></li>
<li class="toctree-l1"><a class="reference internal" href="hxl.html">Using Hxl Tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="lower_file_size.html">How To Lower the File Size of Collected Media</a></li>
Expand Down Expand Up @@ -213,6 +214,7 @@ <h2>List of available calculation operators<a class="headerlink" href="#list-of-
<li class="toctree-l1"><a class="reference internal" href="pulling_data_into_powerbi.html">Pulling your data into PowerBI</a></li>
<li class="toctree-l1"><a class="reference internal" href="upload_to_gis.html">Exporting and uploading your data to GIS software</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_storage.html">Data Storage</a></li>
<li class="toctree-l1"><a class="reference internal" href="row_level_permissions.html">Row-level permissions</a></li>
</ul>
<p class="caption"><span class="caption-text">KoBoToolbox on Your Computer or Server</span></p>
<ul>
Expand Down
2 changes: 2 additions & 0 deletions docs/cascading_select.html
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ <h2>Adding cascading question sets in XLS Form (Option 2)<a class="headerlink" h
<li class="toctree-l1"><a class="reference internal" href="form_meta.html">Form Settings and Meta Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="encrypting_forms.html">Encrypting Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_format_web.html">Custom Formatting in Web Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="enketo.html">What are Enketo webforms?</a></li>
<li class="toctree-l1"><a class="reference internal" href="alternative_enketo.html">Using Alternative Enketo Web Form Styles</a></li>
<li class="toctree-l1"><a class="reference internal" href="hxl.html">Using Hxl Tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="lower_file_size.html">How To Lower the File Size of Collected Media</a></li>
Expand Down Expand Up @@ -253,6 +254,7 @@ <h2>Adding cascading question sets in XLS Form (Option 2)<a class="headerlink" h
<li class="toctree-l1"><a class="reference internal" href="pulling_data_into_powerbi.html">Pulling your data into PowerBI</a></li>
<li class="toctree-l1"><a class="reference internal" href="upload_to_gis.html">Exporting and uploading your data to GIS software</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_storage.html">Data Storage</a></li>
<li class="toctree-l1"><a class="reference internal" href="row_level_permissions.html">Row-level permissions</a></li>
</ul>
<p class="caption"><span class="caption-text">KoBoToolbox on Your Computer or Server</span></p>
<ul>
Expand Down
Loading

0 comments on commit 893b95b

Please sign in to comment.