Skip to content

chore: adds docs about pages in web forms #2089

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

Open
latin-panda wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: adds docs about pages in web forms #2089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/form-question-types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2897,7 +2897,7 @@ The ``field-list`` appearance attribute, applied to a group of widgets, displays

.. warning::

Displaying :ref:`repeats` on the same screen (inside a ``field-list`` group) is not supported.
In Collect, displaying :ref:`repeats` on the same screen (inside a ``field-list`` group) is not supported. :doc:`Web Forms <web-forms-intro>` supports it: the whole group, including the repeat, is shown on one screen.

.. seealso::

Expand Down
16 changes: 15 additions & 1 deletion docs/web-forms-intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ We've extensively tested ODK Web Forms and consider it ready for production use

For users who have been using web forms in Central prior to v2026.2.0, here is functionality in Enketo that's coming to Web Forms, in rough order of priority:

* One question per page
* Query parameter defaults
* Jump to first error
* Last-saved
Expand Down Expand Up @@ -208,3 +207,18 @@ You can style text such as notes, labels, hints, options, and validation message

.. image:: /img/web-forms/form-styling.*
:alt: Styling in Web Forms

.. _web-forms-pages:

Pages
------

.. versionadded:: Web Forms v1.1

To use pages in a form, set the ``style`` to ``pages`` in the ``settings`` sheet, as described in `the XLSForm documentation <https://xlsform.org/en/#multiple-webpage-forms>`_.

By default, each question is shown on its own page. To show several questions together on one page, put them in a group with the :ref:`field-list appearance <field-list>`.

Unlike Collect, a ``field-list`` group can also contain a repeat and it is shown on the same page, along with the other questions. You can also apply ``field-list`` to a repeat itself. In that case, each repeat instance becomes a page.

Use the :guilabel:`Back` and :guilabel:`Next` buttons to move between pages. Pages where no question is :ref:`relevant <relevants>` are skipped.