|
| 1 | +# Form settings in XLSForm |
| 2 | + |
| 3 | +XLSForm allows you to configure settings for your forms using the `settings` worksheet. For example, you can specify a form title, set a default language, or track version numbers. |
| 4 | + |
| 5 | +This article covers how to add and utilize the available form settings in XLSForm. |
| 6 | + |
| 7 | +<p class="note"> |
| 8 | +<strong>Note:</strong> This article focuses on form settings forms in <a href="https://support.kobotoolbox.org/getting_started_xlsform.html">XLSForm</a>. To learn about configuring form settings in the KoboToolbox Formbuilder, see <a href="https://support.kobotoolbox.org/form_meta.html">Form settings and metadata</a>. |
| 9 | +</p> |
| 10 | + |
| 11 | +## Adding form settings in XLSForm |
| 12 | + |
| 13 | +To add form settings in XLSForm: |
| 14 | +1. Add a `settings` worksheet to your XLSForm. |
| 15 | +2. Create a new column for each setting, using the exact column name shown [in the table below](https://support.kobotoolbox.org/form_settings_xls.html#available-form-settings-in-xlsform). |
| 16 | +3. Under each setting, specify the relevant value. |
| 17 | + |
| 18 | +**settings worksheet** |
| 19 | + |
| 20 | +| form_title | version | default_language | style | |
| 21 | +|:----------------------|:--------|:----------------|:------| |
| 22 | +| Form settings in XLSForm | v3 | English (en) | pages | |
| 23 | +| settings | |
| 24 | + |
| 25 | +## Available form settings in XLSForm |
| 26 | + |
| 27 | +Available form settings in XLSForm include: |
| 28 | + |
| 29 | +| Form setting | Description | |
| 30 | +|:----------------------------|:------------| |
| 31 | +| <code>form_title</code> | Specifies the title of the form that is shown to users. This can also be set and managed in KoboToolbox when the form is uploaded. | |
| 32 | +| <code>version</code> | Includes a string that represents the current version of the XLSForm (e.g., v1 or YYYYMMDD). Useful for tracking form versions for collaboration. | |
| 33 | +| <code>instance_name</code> | Specifies a unique name for each form submission using fields filled in by the user during the survey. Appears in the data table for each submission. Can be used to create custom participant or submission IDs.<br><br>For example, <code>concat(${lname}, '-', ${fname}, '-', today())</code> returns <code>lastname-firstname-date</code>. | |
| 34 | +| <code>default_language</code> | Sets the default language in <a href="https://support.kobotoolbox.org/language_xls.html">translated forms</a>. The format <strong>language (code)</strong> should be used, as defined in the <a href="https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry">IANA language registry website</a>. | |
| 35 | +| <code>style</code> | Specifies an <a href="https://support.kobotoolbox.org/form_style_xls.html">alternative theme for Enketo web forms</a>. | |
| 36 | +| <code>allow_choice_duplicates</code> | Allows an XLSForm to reuse duplicated option names <strong>within</strong> a choice list (e.g., when using choice filters where choice names are duplicated). | |
| 37 | +| <code>public_key</code> | Specifies the public key for <a href="https://support.kobotoolbox.org/encrypting_forms.html?highlight=encryption">encryption-enabled forms</a>. | |
| 38 | + |
0 commit comments