Difference between revisions of "Custom Field Language Settings"
| Line 1: | Line 1: | ||
| − | The '''Language Setting'' on [[Custom Fields]] enables display of content in different languages, based on the [[Personal Settings#Additional Personal Settings|language preference]] of the logged in user. | + | The '''Language Setting''' on [[Custom Fields]] enables display of Custom Field content in different languages, based on the [[Personal Settings#Additional Personal Settings|language preference]] of the logged in user. |
| Line 5: | Line 5: | ||
| − | The settings that can be translated using the '''Language Settings''' vary depending on the type of Custom Field | + | The settings that can be translated using the '''Language Settings''' vary depending on the type of Custom Field being translated. |
| + | These can include: | ||
* '''Caption''': The leading question or prologue before the field | * '''Caption''': The leading question or prologue before the field | ||
| − | * '''Tab Name''': ([[Custom Field Type: Text – Single Line|Single Line]] or [[Custom Field Type: Text – Multiple Lines|Multiple Lines]] text box field types) | + | * '''Tab Name''': For fields to be displayed on a different "Navigation" tab. (See [[Tabs (Disambiguation)]]) |
| − | + | * '''Default Text''': ([[Custom Field Type: Text – Single Line|Single Line]] or [[Custom Field Type: Text – Multiple Lines|Multiple Lines]] text box field types) The default text that will be displayed in the text box | |
* '''Values''': ([[Combo Box]] and [[Check Boxes]] field types) The values to be used within the combo box or check boxes, delimited by a semi-colon with no spaces. | * '''Values''': ([[Combo Box]] and [[Check Boxes]] field types) The values to be used within the combo box or check boxes, delimited by a semi-colon with no spaces. | ||
::'''Note:''' It is normally vital that the ''StoreValue=DisplayValue'' syntax is used for these values. See below. | ::'''Note:''' It is normally vital that the ''StoreValue=DisplayValue'' syntax is used for these values. See below. | ||
* '''[[Validation Message]]''': The message that the user will see if the data in the field fails a validation check | * '''[[Validation Message]]''': The message that the user will see if the data in the field fails a validation check | ||
| + | * '''Maximum Message''': ([[Custom Field Type: Text – Single Line|Single Line]] or [[Custom Field Type: Text – Multiple Lines|Multiple Lines]] text box field types) Message the user will see when they reach the maximum length | ||
* '''[[Number Format]]''': The format in which numbers will be displayed. | * '''[[Number Format]]''': The format in which numbers will be displayed. | ||
* '''[[Tool Tip]]''': Help text to be shown on mouse-over | * '''[[Tool Tip]]''': Help text to be shown on mouse-over | ||
| + | |||
| + | |||
| + | ==Values== | ||
| + | When translating [[Combo Box]] or [[Check Boxes]] custom fields it is important to use the ''StoreValue=DisplayValue'' technique to ensure that the value stored to the database is the same, regardless of what language is being displayed to the user entering the values. If this technique is not used the values stored in one language will not be correlated to other language leading to loss of data or inconsistent data. | ||
| + | |||
| + | If you want the value stored in the field to be different from what is displayed in the combo box you can use the following syntax in the Values section: | ||
| + | StoreValue1=DisplayValue1;StoreValue2=DisplayValue2;StoreValue3=DisplayValue3; | ||
| + | The value before the equal sign will be stored. The value after the equal sign is what will be displayed in the combo box (or check boxes), but does not get saved. | ||
| + | |||
| + | |||
| + | When using this technique for translating custom field values there are 2 possible approaches: | ||
| + | |||
| + | '''Approach 1: Use the English value as the stored value''' | ||
| + | Values on main custom field (English): | ||
| + | --Please Select--;Yes;No | ||
| + | Values in French Translation: | ||
| + | --Please Select--=--Sélectionner--;Yes=Oui;No=Non | ||
| + | |||
Revision as of 20:17, 3 March 2013
The Language Setting on Custom Fields enables display of Custom Field content in different languages, based on the language preference of the logged in user.
Note: If a custom field does not have an entry for the selected language of the current user the English language custom field settings will be applied.
The settings that can be translated using the Language Settings vary depending on the type of Custom Field being translated.
These can include:
- Caption: The leading question or prologue before the field
- Tab Name: For fields to be displayed on a different "Navigation" tab. (See Tabs (Disambiguation))
- Default Text: (Single Line or Multiple Lines text box field types) The default text that will be displayed in the text box
- Values: (Combo Box and Check Boxes field types) The values to be used within the combo box or check boxes, delimited by a semi-colon with no spaces.
- Note: It is normally vital that the StoreValue=DisplayValue syntax is used for these values. See below.
- Validation Message: The message that the user will see if the data in the field fails a validation check
- Maximum Message: (Single Line or Multiple Lines text box field types) Message the user will see when they reach the maximum length
- Number Format: The format in which numbers will be displayed.
- Tool Tip: Help text to be shown on mouse-over
Values
When translating Combo Box or Check Boxes custom fields it is important to use the StoreValue=DisplayValue technique to ensure that the value stored to the database is the same, regardless of what language is being displayed to the user entering the values. If this technique is not used the values stored in one language will not be correlated to other language leading to loss of data or inconsistent data.
If you want the value stored in the field to be different from what is displayed in the combo box you can use the following syntax in the Values section:
StoreValue1=DisplayValue1;StoreValue2=DisplayValue2;StoreValue3=DisplayValue3;
The value before the equal sign will be stored. The value after the equal sign is what will be displayed in the combo box (or check boxes), but does not get saved.
When using this technique for translating custom field values there are 2 possible approaches:
Approach 1: Use the English value as the stored value Values on main custom field (English):
--Please Select--;Yes;No
Values in French Translation:
--Please Select--=--Sélectionner--;Yes=Oui;No=Non
