Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
2326154
Update terminology from 'Data Column Name' to 'Question Name'
salomegarnier Jul 17, 2026
4e94972
Update references from 'Data Column Name' to 'question name'
salomegarnier Jul 17, 2026
453b7af
Rename 'Data Column Name' to 'Question Name'
salomegarnier Jul 17, 2026
030233d
Clarify question name reference in XLSForm code
salomegarnier Jul 17, 2026
dce47b6
Correct question referencing terminology in documentation
salomegarnier Jul 17, 2026
5122ced
Clarify impact of changing question names and labels
salomegarnier Jul 17, 2026
f0415f7
Update data column name to question name in documentation
salomegarnier Jul 17, 2026
5f2d065
Correct question reference format in documentation
salomegarnier Jul 17, 2026
17d9da8
Clarify terminology for parent and child questions
salomegarnier Jul 17, 2026
4fbf907
Update matrix_response.md
salomegarnier Jul 17, 2026
9b37c07
Revise export format labels and descriptions
salomegarnier Jul 17, 2026
00708df
Update translation guidelines in collecting_data_multiple_languages.md
salomegarnier Jul 17, 2026
80d17c2
Update glossary terms and references
salomegarnier Jul 17, 2026
95c5c05
Clean up related terms in glossary entry
salomegarnier Jul 17, 2026
b7cd5cd
Correct links for question and choice names
salomegarnier Jul 17, 2026
440379e
Update link to question name documentation
salomegarnier Jul 17, 2026
3db8116
Update image reference and terminology in documentation
salomegarnier Jul 17, 2026
8a4ee5d
Update XML value references to choice names
salomegarnier Jul 17, 2026
9233ebb
Update terminology from 'XML value' to 'choice name'
salomegarnier Jul 17, 2026
f64698c
Update choice descriptions for question types
salomegarnier Jul 17, 2026
4aac4ae
Update terminology for 'XML value' to 'choice name'
salomegarnier Jul 17, 2026
c366c73
Update description for choice_value_edit restriction
salomegarnier Jul 17, 2026
5cae9a2
Update format description for Select One and Many
salomegarnier Jul 17, 2026
00087c2
Update export recommendations for data analysis
salomegarnier Jul 17, 2026
02b4b2b
Update HXL tag export description in question_options.md
salomegarnier Jul 17, 2026
2df2932
Update language selection and terminology in documentation
salomegarnier Jul 17, 2026
a493697
Clarify terminology for defining choice names
salomegarnier Jul 17, 2026
2c4b75c
Update viewing_validating_data.md
salomegarnier Jul 17, 2026
0ca0a43
Update display option from XML values to question names
salomegarnier Jul 17, 2026
2a79986
Update terminology for answer choices in matrix response
salomegarnier Jul 17, 2026
acc8334
Update format reference for data download options
salomegarnier Jul 17, 2026
78df320
Clarify edit instructions for select type questions
salomegarnier Jul 17, 2026
d0cc543
Add files via upload
salomegarnier Jul 17, 2026
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 source/calculate_questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Calculation expressions are constructed using a combination of question referenc
To learn more about each of these components, see <a href="https://support.kobotoolbox.org/form_logic.html">Introduction to form logic in the Formbuilder</a>.
</p>

To display the result of the calculation in a note, use the [question referencing](https://support.kobotoolbox.org/form_logic.html#question-referencing) format `${data_column_name}`, replacing `data_column_name` with the [data column name](https://support.kobotoolbox.org/question_options.html#data-column-name) of the Calculate question. You can also use this format to reference the result of the calculation in a question label or in your form’s logic.
To display the result of the calculation in a note, use the [question referencing](https://support.kobotoolbox.org/form_logic.html#question-referencing) format `${question_name}`, replacing `question_name` with the [question name](https://support.kobotoolbox.org/question_options.html#question-name) of the Calculate question. You can also use this format to reference the result of the calculation in a question label or in your form’s logic.

![Question reference](images/calculate_questions/reference.png)

Expand Down
8 changes: 4 additions & 4 deletions source/cascading_select.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Cascading select questions allow you to create dynamic forms where the options i
To import cascading select questions into the Formbuilder, you first need to prepare your choice list in Excel or another spreadsheet program. You can use this <a href="https://docs.google.com/spreadsheets/d/1C_uDOkjjbv5Kx3lyOY7ORwM-muW6BKVzdaPMB1X8-2A/edit?gid=0#gid=0">Cascade Import Template</a> to get started.

The choice table must include the following columns:
- **list_name:** Unique identifier for a question’s list of choices. This will also be the Data Column Name for the created question.
- **list_name:** Unique identifier for a question’s list of choices. This will also be the [question name](https://support.kobotoolbox.org/glossary.html#question-name) for the created question.
- **name:** Unique identifier for each choice within a list.
- **label:** Text that appears on the form for each choice.

Expand All @@ -42,7 +42,7 @@ Once your choice list is ready, you can import it in the Formbuilder by followin
![Insert cascading select example](images/cascading_select/insert_cascading_select.png)

<p class="note">
<strong>Note:</strong> If you change the question label in the Formbuilder, ensure the Data Column Name in its settings still matches the <strong>list_name</strong> from your choice list table.
<strong>Note:</strong> If you change the question label in the Formbuilder, ensure the <strong>question name</strong> in its settings still matches the <strong>list_name</strong> from your choice list table.
</p>

## Advanced cascading select management using XLSForm
Expand All @@ -66,7 +66,7 @@ If the choice list for the child question is empty, the child list is not seeing
<br>
<details>
<summary><strong>Cascades break after you edit the form</strong></summary>
Renaming a question or editing choice lists can change the backend code the cascade relies on. When renaming a question, ensure the <strong>Data Column Name</strong> remains the same as the corresponding <strong>list_name</strong>. For large choice list edits, either rebuild the cascade from scratch or download the XLSForm, make your changes there, and upload it back.
Renaming a question or editing choice lists can change the backend code the cascade relies on. When renaming a question, ensure the <strong>question name</strong> remains the same as the corresponding <strong>list_name</strong>. For large choice list edits, either rebuild the cascade from scratch or download the XLSForm, make your changes there, and upload it back.
</details>
<br>
<details>
Expand All @@ -77,7 +77,7 @@ To learn more about advanced cascading select using XLSForm, see <a href="https:
<br>
<details>
<summary><strong>Survey element cannot be found</strong></summary>
An error indicating a survey element cannot be found typically means the internal code does not match the cascade's expectations. To fix this, open the question's settings, locate the <strong>Data Column Name</strong>, and revert it to the original value (which should match the corresponding <strong>list_name</strong>) before redeploying your form.
An error indicating a survey element cannot be found typically means the internal code does not match the cascade's expectations. To fix this, open the question's settings, locate the <strong>question name</strong>, and revert it to the original value (which should match the corresponding <strong>list_name</strong>) before redeploying your form.
</details>


8 changes: 4 additions & 4 deletions source/collecting_data_multiple_languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For larger or more complex multilingual forms, XLSForm is often the more efficie
To learn more about setting up translations in XLSForm, see <a href="https://support.kobotoolbox.org/language_xls.html">Adding translations in XLSForm</a>.
</p>

Most elements displayed to respondents can be translated. These include **question labels, hints, choice labels, constraint messages**, and **required messages.** Elements that define the structure of the form, such as [data column names](https://support.kobotoolbox.org/glossary.html#data-column-name) and [XML values](https://support.kobotoolbox.org/glossary.html#xml-value), cannot be translated and should remain in the language you use for form development and data analysis.
Most elements displayed to respondents can be translated. These include **question labels, hints, choice labels, constraint messages**, and **required messages.** Elements that define the structure of the form, such as [question names](https://support.kobotoolbox.org/glossary.html#question-name) and [choice names](https://support.kobotoolbox.org/glossary.html#choice-name), cannot be translated and should remain in the language you use for form development and data analysis.

<p class="note">
<strong>Note:</strong> XLSForm makes it easy to add translations in bulk using machine translation or online translation tools. Machine translations should always be reviewed by a fluent speaker to ensure accuracy, cultural appropriateness, and correct context. This helps maintain the quality and reliability of your translated content.
Expand Down Expand Up @@ -75,7 +75,7 @@ To view your data table in a different language:

1. In your project, go to **DATA > Table.**
2. In the top right corner, click <i class="k-icon-settings"></i> **Display Options.**
3. Under **Display labels or XML values?**, select the language you want to use.
3. Under **Column headers**, select the language you want to use.

![Display options table view](images/collecting_data_multiple_languages/table_view.png)

Expand Down Expand Up @@ -117,6 +117,6 @@ To export your data report in a different language:
<strong>Note:</strong> All form data is exported in the selected language, regardless of the language used for data collection, except for open text responses.
</p>

You can also view or export your data using [XML values](https://support.kobotoolbox.org/glossary.html#xml-value). **XML values are not translated** and are usually generated in the language used during form development.
You can also view or export your data using [question and choice names](https://support.kobotoolbox.org/glossary.html#question-name). **Question and choice names are not translated** and are usually generated in the language used during form development.

Using XML values is recommended for analysis, as these provide short, consistent variable names and coded values that **remain consistent across translations**, regardless of the language used by respondents.
Using question and choice names is recommended for analysis, as these provide short, consistent variable names and coded values that **remain consistent across translations**, regardless of the language used by respondents.
4 changes: 2 additions & 2 deletions source/data_analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ You can export your data from KoboToolbox in several formats, depending on how y
To learn more about exporting KoboToolbox data, see <a href="https://support.kobotoolbox.org/export_download.html">Exporting and downloading your data.</a>
</p>

When exporting data for analysis in external software, it is recommended to export your data as **XML values and headers**, and to **separate multiple choice responses** into separate columns. These settings make exported data easier to process and analyze.
When exporting data for analysis in external software, it is recommended to export your data as **Question & choice names**, and to **separate multiple choice responses** into separate columns. These settings make exported data easier to process and analyze.

If you are sharing raw data with non-technical audiences, **exporting labels** instead of **XML values and headers** may be more user-friendly. Labels can also be exported in multiple languages.
If you are sharing raw data with non-technical audiences, **exporting Question & choice labels** instead of **Question & choice names** may be more user-friendly. Labels can also be exported in multiple languages.

Other export settings, such as storing date and number responses as text or including data from all form versions, depend on your analysis needs and preferences.

Expand Down
8 changes: 4 additions & 4 deletions source/data_through_webforms.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,15 +161,15 @@ For example, you could share different links in different places, and each link

To share a link that prefills a field in your form:

1. Add the question you want to prefill to your form, then set its [data column name](https://support.kobotoolbox.org/glossary.html#data-column-name).
1. Add the question you want to prefill to your form, then set its [question name](https://support.kobotoolbox.org/question_options.html#question-name).
- This can be a [Hidden](https://support.kobotoolbox.org/form_logic.html#storing-constants-in-your-form) question if you want to store the value in the background, or any standard question type if you want respondents to see it in the form.
2. Copy your form link in **FORM > Collect data.**
3. Add `?d[data_column_name]=value` at the end of the URL, where `data_column_name` is the data column name of the Hidden question and `value` is the prefilled value.
3. Add `?d[question_name]=value` at the end of the URL, where `question_name` is the question name of the Hidden question and `value` is the prefilled value.
- For example: `https://ee.kobotoolbox.org/x/[form_id]?d[prefilled_field]=12345`.

<p class="note">
<strong>Note:</strong>
Use the full data column name in the URL parameter. If the question is inside one or more groups, the name must include the <strong>group name or names</strong> as well (e.g., <code>group1/question1</code>). You can find the exact name in the question’s <a href="https://support.kobotoolbox.org/question_options.html#data-column-name">Data column name</a> field in the Formbuilder, or in the <code>name</code> column of an XLSForm.
Use the full question name in the URL parameter. If the question is inside one or more groups, the name must include the <strong>group name or names</strong> as well (e.g., <code>group1/question1</code>). You can find the exact name in the <a href="https://support.kobotoolbox.org/question_options.html#question-name">question name</a> field in the Formbuilder, or in the <code>name</code> column of an XLSForm.
</p>

### Redirecting users to another webpage after submission
Expand Down Expand Up @@ -245,7 +245,7 @@ Use the latest version of a modern browser. Chrome is generally recommended for

<details>
<summary><strong>Web form submission fails </strong></summary>
If a web form submission fails, check whether your form uses a <strong>reserved XLSForm term</strong> as the <a href="https://support.kobotoolbox.org/glossary.html#data-column-name">data column name</a>. Reserved words are terms that cannot be used as variable names because they are used by the underlying XForms engine for structure, logic, or data analysis (e.g., type, label, start, today). Using these words can cause form validation errors, publishing failures, or data export issues.<br><br>
If a web form submission fails, check whether your form uses a <strong>reserved XLSForm term</strong> as a <a href="https://support.kobotoolbox.org/glossary.html#question-name">question name</a>. Reserved words are terms that cannot be used as variable names because they are used by the underlying XForms engine for structure, logic, or data analysis (e.g., type, label, start, today). Using these words can cause form validation errors, publishing failures, or data export issues.<br><br>

To fix the issue, rename the affected question to a different value, then redeploy the form. This issue usually affects web forms even when the form opens normally, while KoboCollect may continue to work as expected. Note that any submissions already saved against the old version of the form may remain unsubmittable, so it is important to update the form as soon as possible if you are collecting data through web forms. Always <strong>test form submission before launching data collection</strong> so you can catch naming issues early.
</details>
Expand Down
12 changes: 6 additions & 6 deletions source/deploy_form_new_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ If you make changes to a form after data collection has already started, those c

Changes that can affect your data structure include:

- **Changing a question’s [data column name](https://support.kobotoolbox.org/glossary.html#data-column-name)**: KoboToolbox will treat it as a new variable and create a new column in the data table.
- **Changing a question type while keeping the same data column name**: This can create inconsistent data in the same column and lead to errors (e.g., in the **DATA > Reports** view).
- **Changing a [question name](https://support.kobotoolbox.org/glossary.html#question-name)**: KoboToolbox will treat it as a new variable and create a new column in the data table.
- **Changing a question type while keeping the same question name**: This can create inconsistent data in the same column and lead to errors (e.g., in the **DATA > Reports** view).
- **Moving questions into or out of groups**: KoboToolbox will treat these questions as new variables and create new columns in the data table.
- **Removing choices from a choice list**: Previous submissions may still contain those choice values, but they may no longer have an associated label in the form.
- **Adding new choices to a Select one or Select many question**: Make sure each new choice has a unique [XML value](https://support.kobotoolbox.org/glossary.html#xml-value) within a given choice list.
- **Adding new choices to a Select one or Select many question**: Make sure each new choice has a unique [choice name](https://support.kobotoolbox.org/glossary.html#choice-name) within a given choice list.
- **Deleting a question that is used elsewhere in the form**: If the question is referenced in a calculation, relevance condition, constraint, or another expression, you will also need to update those references.
- **Changing question or choice labels**: Does not affect the data structure if the data column name or XML value stays the same, but previously collected data will use the updated label.
- **Changing question or choice labels**: Does not affect the data structure if the question or choice name stays the same, but previously collected data will use the updated label.
- **Changing the meaning of existing choice values**: Changing choice names or labels can make data inconsistent across form versions and lead to misinterpretation. For example, this can happen if you reverse the meaning of values such as `1 = Yes` and `0 = No`, or change the direction of a Likert scale.

<p class="note">
Expand All @@ -90,9 +90,9 @@ Changes to a form can also affect how older submissions behave when you edit the

<details>
<summary><strong>Error when deploying: Choice names must be unique for each choice list</strong></summary>
This error means that two or more choices in the same choice list have the same <a href="https://support.kobotoolbox.org/glossary.html#xml-value">XML value (or choice name)</a>.
This error means that two or more choices in the same choice list have the same <a href="https://support.kobotoolbox.org/glossary.html#choice-name">choice name</a>.
<br><br>
If you are using the <strong>Formbuilder</strong>, check the <a href="https://support.kobotoolbox.org/question_types.html#setting-xml-values-for-option-choices">XML values</a> that you have set manually for each option choice to ensure that each XML value is unique within a given choice list.
If you are using the <strong>Formbuilder</strong>, check the <a href="https://support.kobotoolbox.org/question_types.html#setting-choice-names-for-option-choices">choice names</a> that you have set manually for each option choice to ensure that each choice name is unique within a given choice list.
<br><br>
If you cannot identify which choice is causing the problem, <a href="https://support.kobotoolbox.org/xlsform_with_kobotoolbox.html#downloading-an-xlsform-from-kobotoolbox">download the form</a> as an <strong>XLSForm</strong> and check the <code>choices</code> sheet to find the duplicate value more easily. The error message will usually provide the row number in the <code>choices</code> sheet that is causing the error.
</details>
Expand Down
8 changes: 4 additions & 4 deletions source/dynamic_data_attachment_formbuilder.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ In the **question label** field of the Calculate question where linked data will
For each expression in the table below:

- `parent` is the unique name assigned to the **parent form** (in the External XML question of the **child form**).
- `parent_question` refers to the data column name of a question from the **parent form.**
- `child_question` refers to the data column name of a question from the **child form.**
- `parent_question` refers to the question name of a question from the **parent form.**
- `child_question` refers to the question name of a question from the **child form.**
- `parent_index_question` is the identifying question from the **parent form** that links it to the **child form** (e.g., unique ID, organization name).
- `child_index_question` is the identifying question from the **child form** that links it to the **parent form** (e.g., unique ID, organization name).
- `parent_group` refers to the data column name of the group in the **parent form** in which the `parent_question` is located.
- `parent_index_group` refers to the data column name of the group in the **parent form** in which the `parent_index_question` is located.
- `parent_group` refers to the question name of the group in the **parent form** in which the `parent_question` is located.
- `parent_index_group` refers to the question name of the group in the **parent form** in which the `parent_index_question` is located.

| **XPath** | **Description** |
| :----------------- | :--------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion source/editing_deleting_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ To edit raw data in KoboToolbox:
1. Select the submission using the checkbox.
2. Click <i class="k-icon-edit"></i> **Edit** above the data table.
3. In the edit window, click **Edit** next to the field you want to change and enter the new value.
- For select type questions, enter one or more valid [XML values](https://support.kobotoolbox.org/glossary.html#xml-value), separated by spaces.
- For select type questions, enter one or more valid [choice names](https://support.kobotoolbox.org/glossary.html#choice-name), separated by spaces.
4. Click **Save**, then **Confirm & close.**


Expand Down
Loading
Loading