Skip to content

Document the hidden-answer appearance for external string question types #1937

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/form-question-types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,18 @@ The external app widget is displayed when the ``appearance`` attribute begins wi

text,ex_string_widget,Ex string widget,ex:change.uw.android.BREATHCOUNT,text type with ex:change.uw.android.BREATHCOUNT appearance (can use other external apps)

Hiding the received value
""""""""""""""""""""""""""""

By default, the received value is shown below the widget button. In some cases, the raw received value is not helpful to display. For example, it may be very long or may represent a list of values. In that case, you can use the ``hidden-answer`` appearance. We generally recommend putting this question in a :ref:`field-list <field-list>` to provide some useful feedback about the received value.

.. rubric:: XLSForm

.. csv-table:: survey
:header: type, name, label, appearance, hint

text,ex_string_widget,Ex string widget,ex:change.uw.android.BREATHCOUNT hidden-answer,text type with ex:change.uw.android.BREATHCOUNT hidden-answer appearance (can use other external apps)


.. _masked-text-widget:

Expand Down