{"action":"created","issue":{"url":"https://api.github.com/repos/opendatakit/docs/issues/605","repository_url":"https://api.github.com/repos/opendatakit/docs","labels_url":"https://api.github.com/repos/opendatakit/docs/issues/605/labels{/name}","comments_url":"https://api.github.com/repos/opendatakit/docs/issues/605/comments","events_url":"https://api.github.com/repos/opendatakit/docs/issues/605/events","html_url":"https://github.com/opendatakit/docs/issues/605","id":308174879,"number":605,"title":"Update \"form\" explaination in Glossary","user":{"login":"akshay-ap","id":16358982,"avatar_url":"https://avatars3.githubusercontent.com/u/16358982?v=4","gravatar_id":"","url":"https://api.github.com/users/akshay-ap","html_url":"https://github.com/akshay-ap","followers_url":"https://api.github.com/users/akshay-ap/followers","following_url":"https://api.github.com/users/akshay-ap/following{/other_user}","gists_url":"https://api.github.com/users/akshay-ap/gists{/gist_id}","starred_url":"https://api.github.com/users/akshay-ap/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/akshay-ap/subscriptions","organizations_url":"https://api.github.com/users/akshay-ap/orgs","repos_url":"https://api.github.com/users/akshay-ap/repos","events_url":"https://api.github.com/users/akshay-ap/events{/privacy}","received_events_url":"https://api.github.com/users/akshay-ap/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-03-23T20:50:55Z","updated_at":"2018-03-23T20:56:36Z","closed_at":null,"author_association":"COLLABORATOR","body":"Through recent conversation, it seems like there can be a more clear explanation for the word `form`.\r\n\r\nhttps://opendatakit.slack.com/archives/C5KCRU1L1/p1521481777000547\r\n\r\nIn current docs, the explanation of a `form` in the [glossary](https://docs.opendatakit.org/glossary/) is stated as `A defined set of questions and answer choices displayed by an application that can render forms written in the XForm standard.`. \r\nAccording to me, the correct word should be `blank form`.\r\nI propose to add the explanation as follows:\r\n\r\n `form`: An XML document written in the XForm standard.\r\n\r\n- `blank form`: Stores information about the type of questions, constraints on answers and options (if any) for each question which is rendered by the application. It is generally referred just as `form` in the documentation.\r\n\r\n- `filled form`: Stores the user responses. A filled form may also contain other files like images, audio, video.\r\n"},"comment":{"url":"https://api.github.com/repos/opendatakit/docs/issues/comments/375796026","html_url":"https://github.com/opendatakit/docs/issues/605#issuecomment-375796026","issue_url":"https://api.github.com/repos/opendatakit/docs/issues/605","id":375796026,"user":{"login":"adammichaelwood","id":1776241,"avatar_url":"https://avatars3.githubusercontent.com/u/1776241?v=4","gravatar_id":"","url":"https://api.github.com/users/adammichaelwood","html_url":"https://github.com/adammichaelwood","followers_url":"https://api.github.com/users/adammichaelwood/followers","following_url":"https://api.github.com/users/adammichaelwood/following{/other_user}","gists_url":"https://api.github.com/users/adammichaelwood/gists{/gist_id}","starred_url":"https://api.github.com/users/adammichaelwood/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adammichaelwood/subscriptions","organizations_url":"https://api.github.com/users/adammichaelwood/orgs","repos_url":"https://api.github.com/users/adammichaelwood/repos","events_url":"https://api.github.com/users/adammichaelwood/events{/privacy}","received_events_url":"https://api.github.com/users/adammichaelwood/received_events","type":"User","site_admin":false},"created_at":"2018-03-23T20:56:36Z","updated_at":"2018-03-23T20:56:36Z","author_association":"CONTRIBUTOR","body":"> form: An XML document written in the XForm standard.\r\n\r\nI like this clarity, and the addition of two additional glossary terms. Your wording on `blank` and `filled` could be a little clearer.\r\n\r\nThe only thing I'm uncomfortable about here is that the clarity (form=XML document) eliminates the *idea* of a form, and the rendered form. I think of \"form\" in the abstract, with several manifestations: form definition (blank form), a filled in form, a rendered form (in app)"}}
{"actor":{"display_login":"adammichaelwood"}}