documented prompt Text area #80

khushishikhu · 2021-04-11T19:24:17Z

What is included in this PR?

It includes the prompt for the text area if we go above 255 characters. I have added the way to increase the character limit by adding the note there

What is left to be done in the addressed issue?

Please tell me if I left anything or what more it requires.
Thank you!!

wbrunette · 2021-04-12T00:19:03Z

odkx-src/xlsx-converter-reference.rst

@@ -388,6 +388,21 @@ The following prompt types are available in ODK-X Survey.
      | like to enter.
  * - video
    - | Used to capture a video.
+  * - Text Area
+    - | Used to allow the user to write upto 255 characters set by default


This is incorrect, the text area provides a big text area for users to enter information. The note should be if you anticipate users writing anything longer than 255 characters you need to change the model sheet and change the elementType column. As the documentation states: "For example, as shown in the datatypes XLSX, string variables' length can be adjusted from a default of 255 to other lengths with string(len)." https://docs.odk-x.org/xlsx-converter-reference/#model

This statement was confusing ...

elmps2018 · 2021-04-12T00:13:42Z

odkx-src/xlsx-converter-reference.rst

@@ -393,7 +393,7 @@ The following prompt types are available in ODK-X Survey.

 .. note::

-  To increase the length for a string, you could add a model sheet to your xlsx workbook and set the elementType to be string(<string_length>).For example, if you had a string
+  To increase the length for a string, you could add a model sheet to your xls workbook and set the element-type to be string(<string_length>).For example, if you had a string


It is typically an xlsx workbook. There also needs to be a space between the period and For example.

@elmps2018 I have written xlsx workbook only but then it is not passing the build

elmps2018 · 2021-04-12T00:17:17Z

odkx-src/xlsx-converter-reference.rst

@@ -388,6 +388,21 @@ The following prompt types are available in ODK-X Survey.
      | like to enter.
  * - video
    - | Used to capture a video.
+  * - Text Area
+    - | Used to allow the user to write upto 255 characters set by default


typo "upto" should be "up to." Also not clear how this is different from text/string. Would be good to follow their model, e.g.:

"Used to ask the user a question and allows them to enter text." but then add something like "..to enter text in a text box," (if that is what the prompt does).

elmps2018 · 2021-04-12T00:17:26Z

odkx-src/xlsx-converter-reference.rst

+
+.. note::
+
+  To increase the length for a string, you could add a model sheet to your xls workbook and set the element-type to be string(<string_length>).For example, if you had a string


xlsx workbook
Not sure why this note is with the text area. Is text area a string prompt? Unclear.

Yes, The text area is a string prompt, as we can not write after covering 255 characters.

elmps2018 · 2021-04-12T14:47:04Z

odkx-src/xlsx-converter-reference.rst

@@ -392,7 +392,7 @@ The following prompt types are available in ODK-X Survey.
    - | Used to enter the information in a big text area or pragraphs.

 .. note::
-   if users anticipates for writing anything longer than 255 characters then the user need to change the model sheet and change the elementType column. As the documentation states: "For example, as shown in the datatypes XLSX, string variables' length can be adjusted from a default of 255 to other lengths with string(len)". For example, if you had a string prompt named long_data that you wanted to be 500 characters, you would add the following to your model worksheet.
+   if users anticipates for writing anything longer than 255 characters then the user need to change the model sheet and change the element-type column. As the documentation states: "For example, as shown in the datatypes XLSX, string variables' length can be adjusted from a default of 255 to other lengths with string(len)". For example, if you had a string prompt named long_data that you wanted to be 500 characters, you would add the following to your model worksheet.


At least in the current documentation, the column is named elementType, not "element-type" so I think this change may be incorrect...

yes, I have written "elementType" only but the build is not passing. That shows it as spelling error

you can add the word to https://github.com/odk-x/docs/blob/master/odkx-src/spelling_wordlist.txt and the spell checker will recognize it (there is an issue already to document this that someone is working on odk-x/tool-suite-X#247)

@wbrunette I have added the word and made the PR for that #82 please review that

wbrunette · 2021-04-12T15:07:21Z

odkx-src/xlsx-converter-reference.rst

+    - | Used to enter the information in a big text area or pragraphs.
+
+.. note::
+   if users anticipates for writing anything longer than 255 characters then the user need to change the model sheet and change the elementType column. As the documentation states: "For example, as shown in the datatypes XLSX, string variables' length can be adjusted from a default of 255 to other lengths with string(len)". For example, if you had a string prompt named long_data that you wanted to be 500 characters, you would add the following to your model worksheet.


I like the rest of the changes! But I think this is weird: "As the documentation states: "For example, as shown in the datatypes XLSX, string variables' length can be adjusted from a default of 255 to other lengths with string(len)". as this IS the documentation so seems weird. That was my comment to you to help you update your pull request.

linl33

Thanks for documenting this.

linl33 · 2021-04-12T15:18:01Z

odkx-src/xlsx-converter-reference.rst

@@ -388,6 +388,19 @@ The following prompt types are available in ODK-X Survey.
      | like to enter.
  * - video
    - | Used to capture a video.
+  * - Text Area


This should be the identifier for the prompt type, which is textarea.

linl33 · 2021-04-12T15:18:16Z

odkx-src/xlsx-converter-reference.rst

@@ -388,6 +388,19 @@ The following prompt types are available in ODK-X Survey.
      | like to enter.
  * - video
    - | Used to capture a video.
+  * - Text Area
+    - | Used to enter the information in a big text area or pragraphs.


~~pragraphs~~
paragraphs

linl33 · 2021-04-12T15:21:20Z

odkx-src/xlsx-converter-reference.rst

+    - | Used to enter the information in a big text area or pragraphs.
+
+.. note::
+   if users anticipates for writing anything longer than 255 characters then the user needs to change the model sheet and change the elementType column. It is shown in the datatypes XLSX, string variables' length can be adjusted from a default of 255 to other lengths with string(len). For example, if you had a string prompt named long_data that you wanted to be 500 characters, you would add the following to your model worksheet.


It would be helpful to link to the model section.

elmps2018 · 2021-04-12T16:53:25Z

@khushishikhu I reviewed and merged the spelling list changes.

khushishikhu · 2021-04-12T18:25:44Z

@khushishikhu I reviewed and merged the spelling list changes.

@elmps2018 The words are being added, but still build isn't passing

elmps2018 · 2021-04-12T18:48:21Z

@khushishikhu not sure why this is still not passing after the spelling merged... @wbrunette or @linl33 any ideas?

wbrunette · 2021-04-12T20:03:21Z

@khushishikhu you need to merge your changes to ODK-X master into your current branch to get the updated code in it.

@khushishikhu and @elmps2018 the simpler process is to add your spelling change into the pull request you are proposing so that it is automatically incorporated into the build.

At this point you need to peform a merge from ODK-X master into your branch to avoid any conflicts later.

wbrunette · 2021-04-12T20:58:13Z

@khushishikhu remember you can run the build commands locally on your computer so you don't have to keep pushing small commits. Instead of just running odkx-autobuild there are more commands: https://github.com/odk-x/docs#build-tasks

khushishikhu · 2021-04-12T21:01:55Z

@wbrunette yes sure!! I will take care of this thing from next time. Now the build is passing.

linl33 · 2021-04-13T03:18:43Z

odkx-src/xlsx-converter-reference.rst

+
+  * - | name      
+    - | type   
+    - | element type 


This should be elementType

linl33 · 2021-04-13T03:20:01Z

odkx-src/xlsx-converter-reference.rst

+    - | Used to enter the information in a big text area or paragraphs.
+
+.. note::
+   if users anticipates for writing anything longer than 255 characters then the user needs to change the model sheet and change the elementType column. It is shown in the datatypes XLSX, string variables' length can be adjusted from a default of 255 to other lengths with string(len). For example, if you had a string prompt named long_data that you wanted to be 500 characters, you would add the following to your model worksheet. To know more refer to https://docs.odk-x.org/xlsx-converter-reference/#model


Please use a ref to link to that section. https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-arbitrary-locations

khushishikhu added 2 commits April 12, 2021 00:46

Update xlsx-converter-reference.rst

1985377

Update xlsx-converter-reference.rst

9fc27ea

wbrunette requested changes Apr 12, 2021

View reviewed changes

Update xlsx-converter-reference.rst

c01b3c7

khushishikhu requested a review from wbrunette April 12, 2021 04:51

Update xlsx-converter-reference.rst

5d9870f

elmps2018 reviewed Apr 12, 2021

View reviewed changes

Update xlsx-converter-reference.rst

fda4776

wbrunette requested changes Apr 12, 2021

View reviewed changes

Update xlsx-converter-reference.rst

bd49dce

linl33 requested changes Apr 12, 2021

View reviewed changes

Update xlsx-converter-reference.rst

becb5b4

Update xlsx-converter-reference.rst

2d970b9

khushishikhu and others added 3 commits April 13, 2021 02:16

Merge https://github.com/khushishikhu/docs into khushishikhu-textarea

17deb28

Update spelling_wordlist.txt

5233520

Merge https://github.com/khushishikhu/docs into khushishikhu-textarea

f9df65d

linl33 reviewed Apr 13, 2021

View reviewed changes

odkx-src/xlsx-converter-reference.rst Outdated

* - | name

- | type

- | element type

Copy link

Member

linl33 Apr 13, 2021

Choose a reason for hiding this comment

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

This should be elementType

linl33 reviewed Apr 13, 2021

View reviewed changes

updated

6dea856

wbrunette approved these changes Apr 14, 2021

View reviewed changes

wbrunette merged commit 0cf3647 into odk-x:master Apr 14, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

documented prompt Text area #80

documented prompt Text area #80

khushishikhu commented Apr 11, 2021

wbrunette Apr 12, 2021

wbrunette Apr 12, 2021

elmps2018 Apr 12, 2021

khushishikhu Apr 12, 2021

elmps2018 Apr 12, 2021

elmps2018 Apr 12, 2021

khushishikhu Apr 12, 2021

elmps2018 Apr 12, 2021

khushishikhu Apr 12, 2021

wbrunette Apr 12, 2021

khushishikhu Apr 12, 2021

wbrunette Apr 12, 2021

linl33 left a comment

linl33 Apr 12, 2021

linl33 Apr 12, 2021

linl33 Apr 12, 2021

elmps2018 commented Apr 12, 2021

khushishikhu commented Apr 12, 2021

elmps2018 commented Apr 12, 2021

wbrunette commented Apr 12, 2021 •

edited

Loading

wbrunette commented Apr 12, 2021

khushishikhu commented Apr 12, 2021

linl33 Apr 13, 2021

linl33 Apr 13, 2021


		.. note::

		To increase the length for a string, you could add a model sheet to your xls workbook and set the element-type to be string(<string_length>).For example, if you had a string

documented prompt Text area #80

documented prompt Text area #80

Conversation

khushishikhu commented Apr 11, 2021

What is included in this PR?

What is left to be done in the addressed issue?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

"Used to ask the user a question and allows them to enter text." but then add something like "..to enter text in a text box," (if that is what the prompt does).

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linl33 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elmps2018 commented Apr 12, 2021

khushishikhu commented Apr 12, 2021

elmps2018 commented Apr 12, 2021

wbrunette commented Apr 12, 2021 • edited Loading

wbrunette commented Apr 12, 2021

khushishikhu commented Apr 12, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wbrunette commented Apr 12, 2021 •

edited

Loading