Document odksurvey.js funtionns by permission-error · Pull Request #257 · odk-x/docs

permission-error · 2023-10-18T17:37:58Z

Tag @elmps2018 @wbrunette

permission-error · 2023-10-18T17:47:29Z

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

permission-error · 2023-10-19T19:48:51Z

@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 · 2023-10-19T20:08:51Z

@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 · 2023-10-19T20:21:15Z

@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 · 2023-10-21T08:24:59Z

@elmps2018 @wbrunette hope this now looks good for review

elmps2018 · 2023-10-23T14:19:13Z

odkx-src/injected-interfaces.rst

+
+  **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.


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

elmps2018 · 2023-10-23T14:19:28Z

odkx-src/injected-interfaces.rst

+
+  **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.


elmps2018 · 2023-10-23T14:20:40Z

odkx-src/injected-interfaces.rst

+
+  **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.


wbrunette

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

elmps2018

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

elmps2018

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

Document odksurvey.js funtionns

fd5f687

permission-error added 5 commits October 21, 2023 09:41

Add spelling exceptions

63e16f8

fix build

4daf419

Fix build

6a06a50

Remove spelling exceptions

bb2fe8d

Fix spelling exceptions

92d9066

elmps2018 requested a review from wbrunette October 23, 2023 14:17

elmps2018 reviewed Oct 23, 2023

View reviewed changes

wbrunette reviewed Oct 25, 2023

View reviewed changes

permission-error added 2 commits October 26, 2023 00:09

Refactor docs

2a1ba9d

Add Instanceid description

9c6ae1c

elmps2018 previously approved these changes Nov 2, 2023

View reviewed changes

Fix merge conflicts

d725cd3

permission-error dismissed elmps2018’s stale review via d725cd3 January 1, 2024 13:09

permission-error requested review from elmps2018 and wbrunette January 1, 2024 13:10

elmps2018 reviewed Jan 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document odksurvey.js funtionns#257

Document odksurvey.js funtionns#257
permission-error wants to merge 9 commits intoodk-x:mainfrom
permission-error:surveyjs

permission-error commented Oct 18, 2023 •

edited

Loading

Uh oh!

permission-error commented Oct 18, 2023

Uh oh!

permission-error commented Oct 19, 2023

Uh oh!

elmps2018 commented Oct 19, 2023

Uh oh!

permission-error commented Oct 19, 2023

Uh oh!

permission-error commented Oct 21, 2023

Uh oh!

elmps2018 Oct 23, 2023

Uh oh!

elmps2018 Oct 23, 2023

Uh oh!

elmps2018 Oct 23, 2023

Uh oh!

wbrunette left a comment

Uh oh!

elmps2018 left a comment

Uh oh!

elmps2018 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		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.


		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.


		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.

Conversation

permission-error commented Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

permission-error commented Oct 18, 2023

Uh oh!

permission-error commented Oct 19, 2023

Uh oh!

elmps2018 commented Oct 19, 2023

Uh oh!

permission-error commented Oct 19, 2023

Uh oh!

permission-error commented Oct 21, 2023

Uh oh!

elmps2018 Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

elmps2018 Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

elmps2018 Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

wbrunette left a comment

Choose a reason for hiding this comment

Uh oh!

elmps2018 left a comment

Choose a reason for hiding this comment

Uh oh!

elmps2018 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

permission-error commented Oct 18, 2023 •

edited

Loading