Skip to content

chore: documents how Web Forms determines form and UI language - #2121

Open
latin-panda wants to merge 1 commit into
masterfrom
web-forms-language-selection
Open

latin-panda wants to merge 1 commit into
masterfrom
web-forms-language-selection

Conversation

@latin-panda

Copy link
Copy Markdown
Contributor

closes #

addresses #2100

What is included in this PR?

Updates docs about how Web Forms determines languages

What new issues will need to be opened because of this PR?

none

What is left to be done in the addressed issue?

nothing

What problems did you encounter?

none

Comment thread docs/web-forms-intro.rst

For language matching to work, include the language code in parentheses in your language names (for example ``English (en)``), as described in :doc:`form-language`. A language without a code (for example ``Frans``) can still be selected manually, but it cannot be matched to the browser language or remembered across forms; interface text and date formats then follow the browser language. Regional codes such as ``English (en-US)`` are matched exactly when possible; otherwise, any variant of the same base language matches.

.. dropdown:: Detailed language selection scenarios

@latin-panda latin-panda Oct 16, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The main audience for this section is devs, QA, and more experienced form designers.
We can use this grid for answering questions, or testing in the future

Comment thread docs/web-forms-intro.rst
Beyond the form's question text, two other kinds of text follow their own language rules:

- **Interface text** (buttons and status dialogs) is available in English, espa帽ol, fran莽ais, and bahasa Indonesia. Web Forms uses the one that matches the form language being displayed, falling back to English. If you would like to contribute additional languages, follow the `ODK Central translation guide <https://docs.google.com/document/d/1C0MS_ytAEBHwbMkdR-QrtDrWAAh_EkJo2QRr4XyIOpk>`_ and if you have questions, post in the `translation category <https://forum.getodk.org/c/development/translation/14>`_ on the ODK Forum.
- **Date formats** in calendar widgets follow the form language being displayed, preferring the browser's regional variant of it when there is one. For example, a browser set to Australian English sees Australian date formats in an English form. If date formats are not available for the form language, English formats are used.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is PrimeVue, but not many will know which part of the UI is PrimeVue, so I just mentioned the calendar, which is the component with the most text that get translated

Comment thread docs/web-forms-intro.rst
}
</style>

.. csv-table::

@latin-panda latin-panda Oct 16, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@latin-panda

Copy link
Copy Markdown
Contributor Author

@lognaturel could you please review? :)

form-lang-docs.mp4

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant