Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document odksurvey.js funtionns #257

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Document odksurvey.js funtionns #257

wants to merge 9 commits into from

Conversation

permission-error
Copy link
Contributor

@permission-error permission-error commented Oct 18, 2023 •
edited
Loading

@permission-error
Copy link
Contributor Author

Oooops ci caught some wrong spellings. Am going to look through and make a fix

@permission-error
Copy link
Contributor Author

@wbrunette @elmps2018 I noticed CI is failing due to names of methods which is assumed to be wrongly spelled by circle ci

/home/circleci/work/tmpx-src/injected-interfaces.rst:743: Spell check: isArray: ["is Array", "disarray", "is-array", "array"]: isArray.
/home/circleci/work/tmpx-src/injected-interfaces.rst:747: Spell check: varToTest: ["varistor"]: varToTest: The variable to be tested for array type..
/home/circleci/work/tmpx-src/injected-interfaces.rst:765: Spell check: getHashString: ["hamstringing", "astringent"]: getHashString.
/home/circleci/work/tmpx-src/injected-interfaces.rst:781: Spell check: getFormsProviderUri: getFormsProviderUri.
/home/circleci/work/tmpx-src/injected-interfaces.rst:785: Spell check: platInfo: ["plat Info", "plat-info", "platina"]: platInfo: Platform information, typically containing app-specific details..
/home/circleci/work/tmpx-src/injected-interfaces.rst:794: Spell check: convertHashStringToSurveyUri: convertHashStringToSurveyUri.
/home/circleci/work/tmpx-src/injected-interfaces.rst:798: Spell check: hashString: ["hash String", "hash-string", "hamstringing", "hamstring", "stringhalt", "shattering"]: hashString: The hash string to be converted..
/home/circleci/work/tmpx-src/injected-interfaces.rst:806: Spell check: getFormPath: ["reformatting"]: getFormPath.
/home/circleci/work/tmpx-src/injected-interfaces.rst:818: Spell check: openInstance: ["open Instance", "open-instance", "happenstance", "instance"]: openInstance.
/home/circleci/work/tmpx-src/injected-interfaces.rst:826: Spell check: initialValuesElementKeyToValueMap: initialValuesElementKeyToValueMap: A mapping of element keys to initial values for pre-filling form fields (optional)..
/home/circleci/work/tmpx-src/injected-interfaces.rst:833: Spell check: addInstance: ["add Instance", "add-instance", "instance", "distance"]: addInstance.
/home/circleci/work/tmpx-src/injected-interfaces.rst:840: Spell check: initialValuesElementKeyToValueMap: initialValuesElementKeyToValueMap (Object): A mapping of element keys to initial values for pre-filling form fields (optional)..
/home/circleci/work/tmpx-src/injected-interfaces.rst:847: Spell check: openLink: ["open Link", "open-link", "opening", "online", "hyperlink"]: openLink.
/home/circleci/work/tmpx-src/injected-interfaces.rst:852: Spell check: relativeOrFullUrl: ["relativistically"]: relativeOrFullUrl (String): The URL to be opened..
/home/circleci/work/tmpx-src/injected-interfaces.rst:859: Spell check: fileAttachmentAction: ["compartmentalization"]: fileAttachmentAction.
/home/circleci/work/tmpx-src/injected-interfaces.rst:864: Spell check: intentAction: ["intent Action", "intent-action", "interaction", "intentional", "intention", "interdiction"]: intentAction (String): The intent action for the specific file attachment action..
/home/circleci/work/tmpx-src/injected-interfaces.rst:867: Spell check: existingFileAttachmentFieldContent: existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional)..
/home/circleci/work/tmpx-src/injected-interfaces.rst:874: Spell check: captureImage: ["capture Image", "capture-image", "Septuagesima"]: captureImage.
/home/circleci/work/tmpx-src/injected-interfaces.rst:881: Spell check: existingFileAttachmentFieldContent: existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional)..
/home/circleci/work/tmpx-src/injected-interfaces.rst:888: Spell check: captureSignature: ["capture Signature", "capture-signature", "countersignature"]: captureSignature.
/home/circleci/work/tmpx-src/injected-interfaces.rst:895: Spell check: existingFileAttachmentFieldContent: existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional)..
/home/circleci/work/tmpx-src/injected-interfaces.rst:902: Spell check: captureAudio: ["capture Audio", "capture-audio", "judicature"]: captureAudio.
/home/circleci/work/tmpx-src/injected-interfaces.rst:909: Spell check: existingFileAttachmentFieldContent: existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional)..
/home/circleci/work/tmpx-src/injected-interfaces.rst:916: Spell check: captureVideo: ["capture Video", "capture-video", "candidature"]: captureVideo.
/home/circleci/work/tmpx-src/injected-interfaces.rst:923: Spell check: existingFileAttachmentFieldContent: existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional)..
/home/circleci/work/tmpx-src/injected-interfaces.rst:930: Spell check: chooseImage: ["choose Image", "choose-image", "choosiness"]: chooseImage.
/home/circleci/work/tmpx-src/injected-interfaces.rst:937: Spell check: existingFileAttachmentFieldContent: existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional)..
/home/circleci/work/tmpx-src/injected-interfaces.rst:944: Spell check: chooseAudio: ["choose Audio", "choose-audio", "audiocassette"]: chooseAudio.
/home/circleci/work/tmpx-src/injected-interfaces.rst:951: Spell check: existingFileAttachmentFieldContent: existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional)..
/home/circleci/work/tmpx-src/injected-interfaces.rst:958: Spell check: chooseVideo: ["choose Video", "choose-video", "choosiness"]: chooseVideo.
/home/circleci/work/tmpx-src/injected-interfaces.rst:965: Spell check: existingFileAttachmentFieldContent: existingFileAttachmentFieldContent (Object): Existing file attachment field content, including content type and URI (optional)..

@elmps2018
Copy link
Contributor

@permission-error I can't remember off the top of my head exactly how, but there is a way to put into the docs spelling exceptions so you can potentially add those. It should be documented somewhere in the docs how to do this.

@permission-error
Copy link
Contributor Author

@permission-error I can't remember off the top of my head exactly how, but there is a way to put into the docs spelling exceptions so you can potentially add those. It should be documented somewhere in the docs how to do this.

Thanks @elmps2018. That hit my head😊 though had no idea how to do it. Let me find out then would possibly have it documented as well

@permission-error
Copy link
Contributor Author

@elmps2018 @wbrunette hope this now looks good for review

@elmps2018 elmps2018 requested a review from wbrunette October 23, 2023 14:17
elmps2018
elmps2018 reviewed Oct 23, 2023
View reviewed changes
odkx-src/injected-interfaces.rst Outdated

**Returns**: The result of the action, typically indicating whether the action was successful.

Adds a new survey instance within the ODK Survey app, generating a new instance ID and allowing users to start data collection for a specific form.
Copy link
Contributor

Choose a reason for hiding this comment

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

ODK-X Survey - please check that -X is used throughout.

odkx-src/injected-interfaces.rst Outdated

**Returns**: The result of the action, typically indicating whether the action was successful.

Opens a link within the ODK Survey app, either using a relative or full URL, allowing for navigation to external web content or internal survey screens.
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto.

odkx-src/injected-interfaces.rst Outdated

**Returns**: The result of the geopoint capture action using a map.

Initiates a geopoint capture action using a map within the ODK Survey app, allowing users to select geographic coordinates interactively.
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto.

wbrunette
wbrunette reviewed Oct 25, 2023
View reviewed changes
Copy link
Member

@wbrunette wbrunette left a comment

Choose a reason for hiding this comment

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

Might be helpful to put a bit more description for the instanceID about what it represents.

elmps2018
elmps2018 previously approved these changes Nov 2, 2023
View reviewed changes
Copy link
Contributor

@elmps2018 elmps2018 left a comment

Choose a reason for hiding this comment

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

@wbrunette was this what you meant in terms of additional detail?

elmps2018
elmps2018 reviewed Jan 1, 2024
View reviewed changes
Copy link
Contributor

@elmps2018 elmps2018 left a comment

Choose a reason for hiding this comment

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

This looks good to me but @wbrunette should check technical details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elmps2018 elmps2018 elmps2018 left review comments

@wbrunette wbrunette Awaiting requested review from wbrunette

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@permission-error @elmps2018 @wbrunette