Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Add status and goals to readme #170

Merged
merged 1 commit into from
Feb 10, 2023
Merged

Conversation

lognaturel
Copy link
Contributor

Similar to enketo/enketo-express#467

We are (hopefully) going to meet some of the short term goals very soon. I think providing visibility into the long-term goal is helpful. The historical notes are to remind ourselves that there were good reasons to have this as a separate system.

I also brought in changes about development/local use from #164 because I've found the current structure confusing. @eyelidlessness I can remove those if it makes merging too annoying.


Enketo Transformer is maintained by [the ODK team](https://getodk.org/about/team.html) (primarily [Trevor Schmidt](https://github.com/eyelidlessness/)). Broader context is available in [the Enketo Express repository](https://github.com/enketo/enketo-express#project-status).

ODK XForms are based off of [W3C XForms](https://en.wikipedia.org/wiki/XForms) which were originally intended to be supported natively by web browsers. Browser support did not happen and the ODK standard drifted too far from the W3C standard to have used it anyway. Enketo chose to transform XForms to HTML5 forms before rendering them. Enketo Transformer performs this work by applying an XSL transform followed by a few post-processing steps in Javascript. This was time-consuming for forms with certain characteristics so the transformation was designed to happen on the backend so it could be cached across client requests.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few post-processing steps

This is fine for now, but I’ll probably edit it with the coming browser compatibility changes. Currently there’s a bit of pre-processing as well but there will be more.

@lognaturel lognaturel merged commit a231a5f into enketo:master Feb 10, 2023
@lognaturel lognaturel deleted the update-readme branch February 10, 2023 01:04
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants