getodk / validate

ODK Validate is a Java application for confirming that a form is valid and compliant with the ODK XForms specification. Contribute and make the world a better place! ✨🔍✨
https://docs.getodk.org/validate/
Other
9 stars 26 forks source link

Document calling validation from an external application #18

Closed lognaturel closed 7 years ago

lognaturel commented 7 years ago

2 refactors the code so that it can be called by an external application. Add a section to the README after "Running the project" titled "Calling Validate from external applications" with a description of the ErrorListener interface and the various validate methods.

@kayr would be great if you could take this one! 😊

mitchellsundt commented 7 years ago

Note that ODK Validate already is run by the online XLSForm converter on the opendatakit.org site. Any changes should be verified to not impact that usage, or to modify the usage so that this functionality is not broken.

The XLSForm online repos are at:

https://github.com/uw-ictd/pyxform_interface

And, I forget whether the following repo is in use or if we are pulling from the main pyxform repo now:

https://github.com/uw-ictd/pyxform

kayr commented 7 years ago

Thanx for the heads-up, I have tested from command line java -jar validate.jar path/to/xform.xml and got output with no UI. Double clicking the jar launched the UI. So usage should remain as before via the command-line interface.

lognaturel commented 7 years ago

Thank you, @mitchellsundt, I made sure it wouldn't break https://github.com/XLSForm/pyxform but I totally forgot about the online tool. It looks like it calls out to pyxform directly so we're ok. Thanks for that extra check @kayr.