mwater / mwater-forms

Forms controls for mWater

mWater Forms

Mobile-friendly survey/form components, compiled from a XForms-inspired JSON schema.

Features

• 12+ Question types
• Conditions & validations
• Full localization of surveys
• Entity references

Response Lifecycle

See [Response Lifecycle](docs/Response Lifecycle.md)

Schema versioning

The schema is stored in _schema field of the form and is an integer.

The package exports schemaVersion which is the current (and maximum) version that it compiles. It also exports minSchemaVersion which is the earliest version supported

Schema versioning checklist

• Change schema
• Increment schema version in index.coffee
• Add new version to acceptable _schema enum in schema
• Publish with new major number
• Increment version in mwater-form-designer
• npm install new version of mwater-forms in mwater-form-designer
• Publish mwater-form-designer
• npm install new version of mwater-forms in mwater-server
• Push new server
• npm install new version of mwater-forms in mwater-app
• Deploy new app
• npm install new version of mwater-forms in mwater-portal
• npm install new version of mwater-form-designer in mwater-portal
• Deploy new portal

Entity support

Questions can be linked to entities to support a variety of scenarios:

• Form creates an entity of a certain type with properties mapped to questions
• Form creates an entity of a certain type with properties mapped to questions
• Selecting an entity in an entity question pre-fills answers
• Selecting an entity in an entity question causes other answers to be used to update the entity selected

mwater-forms's Issues

Add Compact Dry Plate question with automatic count functionality

For native Android app, we should tie the compact dry count interface to a special question type. Perhaps we should make an Automated Water Test Analysis type so that we can add others later as we accommodate new tests.

This might be the time to consider implementing the automatic count on server for non-androids.

Handle non-firing or firing with null alpha as compass not supported

According to the spec, if the event fires a single time with null values for alpha etc., it is not supported.

So: If fires with null values, or if never fires, do not display compass and stick to "34 meters NE" style display.

Add URL support to text question

Add regex validation to question class

Create question compiler

Explanation when mandatory question is not answered

When a user tries to move to the next section but has not answered a mandatory question, that question is highlighted in red but no written explanation or instructions are given. This could be confusing to some users.
Suggest adding a mandatory note, in red, stating that the user must answer all questions in red in order to proceed.

Custom date questions

For some surveys, the exact date is not important but only the year or the year and month (credit card expiration date is a good example of this from the consumer forms world). Would like an option for date questions that only asks:
-year
-month (where current year is assumed)
-month + year

The response could be saved using the midpoint of the month or year selected to facilitate future analysis of the data.

Replace mobiscroll date control

The mobiscroll date picker is less practical than a calendar and has a few minor rendering issues in bootstrap 3. We urgently need a new date picker/calendar control that is very mobile-friendly.

Some possibilities:

http://tarruda.github.io/bootstrap-datetimepicker/ ?

http://www.malot.fr/bootstrap-datetimepicker/ ?

http://www.eyecon.ro/bootstrap-datepicker/ ?

Entering text in comment field prevents focus transfer to comments

Enter text in text box. Click on comments box. Will not transfer focus.

Due to re-render. Use template state preserver from pojo-backbone-view for questions.

Display validation messages when validation fails

validate() returns a string which should be displayed. If validate() returns true, display no message, but still mark as invalid

Create JSON schema for form language

We would like to be able to validate the JSON form language. Create a JSON schema for it and add to project.

Use Phonegap compass if available

Don't Know should be a checkbox on non-radio questions

The Don't Know alternate current appears as a single radio button on non-radio question types, which is confusing. It should default to a checkbox on all questions except for radio questions.

Make required questions more obvious

The star at the end of required questions is too subtle. Either increase the size or boldness, or change the symbology to something else.

Switch LocationFinder to use ls-cache for storing cache data

Right now, depends on local storage working.

No arrow should display before compass and GPS are available

There is an arrow facing up before it knows where I am.

Add cancelling of location setting in LocationView

When waiting, a cancel button would be nice.

Refactor LocationView.updateAccuracyStrength

Make it not so ugly. Include age in the logic.

If can't get high accuracy location and low accuracy was too poor, do not continue to wait

Right now if bad low accuracy comes back and high accuracy fails, it says "Waiting for GPS" forever.

Switch TextListQuestion to use TemplateStatePreserver from pojo-backbone-view

Add Mask feature for structured numeric and text entry fields

Some fields require data validation that involves specific ranges for each character. For example:
Program number must be in aaa-a###-## format.
A mask feature should define the number of characters and validation requirements for each character in a question response.

Add _schema to form object

Also add other form-level options

Add hints to choices

(and rename from options)

Determine where to store form level GPS and timestamp

Several where to store questions:

_id, code, completed date, completed by, roles, location started, when started.

Regex validation should allow blank unless required

Add image-loading and no-image available as base64 images or icons

Right now they reference: img/image-loading.png and img/no-image-icon.jpg

OrientationPublisher should unlisten for events

It currently listens to events forever, slowing down the app permanently. It should probably be an object with a destroy method that unlistens to events, or it should realize when no one is listening and unlisten to the window events. The object solution is probably cleaner and more testable. Singletons that produce events are problematic.

Can't change existing image on image question

For auto recordLocation questions, do not use cached location

It could be out of date. Use only high accuracy.

Nav menu improvements

The nav menu is really nice but a few small improvements would make it much more useful:

• Sections are often long enough that the questions in the nav menu stretch below the bottom of the current window. This means that the nav menu is no longer usable for jumping quickly to another section, which is what I find to be the most useful feature. Would it be possible to only show a few questions around your current position, with ellipses, then the other sections? Is this is difficult, an alternative would be to switch to a section-only mode in the menu for more than X questions in a section. This might be equally good from a usability perspective.
• A completely different alternative to the last point would be to make the nav menu always in section-only mode, but click to expand the section into individual questions.
• When you click on a section title in the nav menu, you are brought to the first question of that section, but the section title itself is hidden above, off-screen.
• Clicking on a question title in nav menu aligns the page with the answers to the question, but the question text itself is hidden above the current view.

Correct behavior of LocationView on weak signals

Temporarily Set Rough Location is ambiguous: Does that mean it set the location or that tapping it will set the location?

The original spec was:

When Set is pushed, if has no GPS signal, displays ugly red label "Waiting for GPS" that remains until success or failure.

If has bad signal (low accuracy), displays "Waiting for better GPS accuracy" in yellow label, with small button "Use Anyway" that uses bad accuracy position at which point green label "Location Set Successfully" appears below and fades out after a few seconds

Let's make sure that it doesn't set the location with a non-strong signal at all unless the override is clicked.

Also, the "Waiting for GPS..." when set location is clicked and there is no signal should be an ugly red notification, entirely separate from the smaller red warning on the right when it can't display relative location

Failure to validate does not scroll back up to invalid question

Makes it very difficult to see what is the invalid question.

Analyse success/failure of phones HTML5 compass

So far (using MDN demo page)

• Galaxy S3 4.3 Chrome: Partial (flips between 180&360)
• Galaxy S3 4.3 Stock: Yes
• Techno P5 4.2.2 Chrome: Fail (no idea why)
• Techno P5 4.2.2 Stock: Fail (no idea why)
• Infuse 4G 2.3 Stock: Fail (no idea why)
• Intel Yolo 4.0.4 Chrome: Fail to load (no idea why)
• Intel Yolo 4.0.4 Stock: Partial (jitters a lot, incorrect when laying flat)

Add clicker question

Add a question where the user presses a button each time an event happens and a running tally is displayed. This is important in direct observation studies (like counting the number of people per hour who visit a water source). The physical analog for this would be the handheld clickers used to count people entering concerts or events. Here is an example:

If we take this as the analogy, there should be a prominent click button and a smaller reset button, that comes with a warning popup before erasing the count. Maybe also include in the question edit box an option to determine the number of digits displayed.

Re-enable compass when browser support improves

Hitting clear seems to stop GPS lock in Location View

When setting location fails, can't try again

After entering specify text in text field of DropdownQuestion, two clicks are needed to change dropdown

Is due to re-rendering. Once PojoView fixes same bug, use TemplateStatePreserver?

Help text collapses on re-render

State should be remembered in question

Use watchPosition to set location in LocationView

More granular control than a simple call to getCurrentPosition and easier code.

Add currency conversion feature for survey responses

Develop a set of standard currencies for a money question that could be converted to other currencies using public exchange rate databases. The response could then be viewed and exported in another currency using the exchange rate from that day.

Alternates should validate for required questions

Clean up gulp vs grunt choice

Also remove compass demo and ngrok

Document form json language

It should be documented in docs folder of project in pretty Github-flavoured markdown.

Code is the ultimate resource (especially tests), but we have several other docs in descending accuracy:

https://docs.google.com/spreadsheets/d/14MCkE8P7sTJuPPmrME_FvfrFjmYLzs4WBD2J6WhAZ2Y/edit?usp=sharing

https://docs.google.com/document/d/19LiXRBwaamHh8FjK6iHR9IHol2K_J8xH6EX3JqGdHSI/edit?usp=sharing

Figure out validation of questions before compiling

Fully localize LocationView

Change 'question' to 'answer' in conditions

Template preserving fails on mobile devices

Hides android keyboard on built-in browser.

Improve look of location view

Android stock compass is almost 180 deg wrong on Galaxy S3

Compensation must be incorrect? Raw values are N = alpha 340.

Make code comments blend in

I know that this is a trivial and probably annoying request, but can you make code comments look like this:

# Some comment

instead of

#some comment

so that they blend in?