Locale -> Translation
This commit is contained in:
@@ -21,11 +21,11 @@ The [API explorer console](api-console.md) on your server is always the best sou
|
||||
|
||||
All dates and times sent or retrieved from the REST interface **must** be in UTC / GMT time zone. It is the Client software's responsibility to display and accept input of dates in local format but all dates transmitted to or received from the server must be in is0-8601 UTC time zone format only. For example: `2018-12-19T17:54:13.616028`. Note there is no time zone offset, the time is understood to be UTC already.
|
||||
|
||||
## Localization
|
||||
## Translation
|
||||
|
||||
Every User account in AyaNova has their own UserOptions object which contains their personal localization settings such as time zone offset, currency symbol and numeric formatting options you can use this value to correctly display and interpret values at a client level.
|
||||
Every User account in AyaNova has their own UserOptions object which contains their personal Translation settings such as time zone offset, currency symbol and numeric formatting options you can use this value to correctly display and interpret values at a client level.
|
||||
|
||||
In addition every user has their own LocaleId setting stored in their User record (not UserOptions) which can be used to fetch and display text in the correct locale by using the methods in the Locale routes.
|
||||
In addition every user has their own TranslationId setting stored in their User record (not UserOptions) which can be used to fetch and display text in the correct translation by using the methods in the Translation routes.
|
||||
|
||||
## Paging, sorting and filtering lists
|
||||
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
# LOCALE
|
||||
|
||||
The Locale feature controls the text displayed in the AyaNova user interface.
|
||||
The primary purpose is to provide the AyaNova user interface in various languages however it is also used to customize text displayed to conform to specific terminology used by a business.
|
||||
For example a property management company may prefer the term "Apartment" rather than the generic term "Unit" provided by AyaNova.
|
||||
|
||||
## Stock locales
|
||||
AyaNova comes with predefined locale translations for `English`, `French`, `Spanish` and `German`
|
||||
|
||||
## Setting the locale
|
||||
There are two places to set locales:
|
||||
A default server [AYANOVA_DEFAULT_LANGUAGE](ops-config-default-language.md) setting used to control the default Locale used.
|
||||
|
||||
|
||||
TODO: USER SETTING FOR LOCALE
|
||||
|
||||
16
docs/8.0/ayanova/docs/ay-translation.md
Normal file
16
docs/8.0/ayanova/docs/ay-translation.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# TRANSLATION
|
||||
|
||||
The Translation feature controls the text displayed in the AyaNova user interface.
|
||||
The primary purpose is to provide the AyaNova user interface in various languages however it is also used to customize text displayed to conform to specific terminology used by a business.
|
||||
For example a property management company may prefer the term "Apartment" rather than the generic term "Unit" provided by AyaNova.
|
||||
|
||||
## Stock translations
|
||||
AyaNova comes with predefined translations for `English`, `French`, `Spanish` and `German`
|
||||
|
||||
## Setting the translation
|
||||
There are two places to set translations:
|
||||
A default server [AYANOVA_DEFAULT_TRANSLATION](ops-config-default-language.md) setting used to control the default Translation used.
|
||||
|
||||
|
||||
TODO: USER SETTING FOR TRANSLATION
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
# HOME-LOCALE Placeholder
|
||||
# HOME-TRANSLATION Placeholder
|
||||
|
||||
This is a placeholder page for sections that are not written yet
|
||||
@@ -38,7 +38,7 @@ This setting is provided for the purpose of forcing a browser to use a different
|
||||
|
||||
If no language can be determined from the browser and no override has been set AyaNova will default to English USA - "en-US".
|
||||
|
||||
NOTE: This is a separate and unrelated setting to the users [Locale](ay-locale.md) setting which controls the set of customizable text used by AyaNova to display to the user.
|
||||
NOTE: This is a separate and unrelated setting to the users [Translation](ay-translation.md) setting which controls the set of customizable text used by AyaNova to display to the user.
|
||||
|
||||
## Time Zone override
|
||||
The *required* Time Zone setting controls how date and time values are displayed, accepted for input and very importantly **converted** to local time from UTC time.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# DEFAULT LANGUAGE / LOCALE SETTING
|
||||
# DEFAULT TRANSLATION SETTING
|
||||
|
||||
This setting controls the default language for text displayed to users in the AyaNova user interface.
|
||||
|
||||
@@ -8,7 +8,7 @@ It will also be used for some messages that originate at the server and are not
|
||||
|
||||
## Default
|
||||
|
||||
If no language is specified or AyaNova can't find the language specified in the database then AyaNova defaults to English locale "en".
|
||||
If no language is specified or AyaNova can't find the language specified in the database then AyaNova defaults to English translation "en".
|
||||
|
||||
## Built in language values
|
||||
|
||||
@@ -17,7 +17,7 @@ You can use the ISO two letter country code or the English name of the language
|
||||
|
||||
Valid settings:
|
||||
|
||||
| LANGUAGE | VALID SETTINGS |
|
||||
| TRANSLATION | VALID SETTINGS |
|
||||
| ----- | ------------------------------ |
|
||||
| English | "en", "English" |
|
||||
| French | "fr", "French", "Français" |
|
||||
@@ -26,31 +26,31 @@ Valid settings:
|
||||
|
||||
## Custom language values
|
||||
|
||||
AyaNova allows for customized languages and this setting should be the exact name of a custom locale that exists within AyaNova if not using a built in language.
|
||||
AyaNova allows for customized languages and this setting should be the exact name of a custom translation that exists within AyaNova if not using a built in language.
|
||||
|
||||
## Setting
|
||||
|
||||
AyaNova expects the language setting to be provided by an environment variable or command line parameter named
|
||||
|
||||
`AYANOVA_DEFAULT_LANGUAGE`
|
||||
`AYANOVA_DEFAULT_TRANSLATION`
|
||||
|
||||
The value specified should be a string containing one of the stock valid settings in the table above or the name of a custom locale, for example:
|
||||
The value specified should be a string containing one of the stock valid settings in the table above or the name of a custom translation, for example:
|
||||
`French`
|
||||
or
|
||||
`AcmeWidgetsCustomLocale`
|
||||
`AcmeWidgetsCustomTranslation`
|
||||
|
||||
Example command line parameter
|
||||
|
||||
`dotnet run --AYANOVA_DEFAULT_LANGUAGE="ES"`
|
||||
`dotnet run --AYANOVA_DEFAULT_TRANSLATION="ES"`
|
||||
|
||||
Example environment variable
|
||||
|
||||
Windows
|
||||
|
||||
`set "AYANOVA_DEFAULT_LANGUAGE=DE"`
|
||||
`set "AYANOVA_DEFAULT_TRANSLATION=DE"`
|
||||
|
||||
Linux / MAC
|
||||
|
||||
`export AYANOVA_DEFAULT_LANGUAGE="MyCustomLocale"`
|
||||
`export AYANOVA_DEFAULT_TRANSLATION="MyCustomTranslation"`
|
||||
|
||||
If both a command line parameter and an environment variable are set the command line parameter takes precedence.
|
||||
@@ -19,9 +19,9 @@ These values can all be specified as an environment variable or as a command lin
|
||||
- [AYANOVA_LOG_LEVEL](common-log.md#log-level)
|
||||
- [AYANOVA_LOG_PATH](common-log.md#log-path)
|
||||
|
||||
## LANGUAGE / LOCALE
|
||||
## TRANSLATION
|
||||
|
||||
- [AYANOVA_DEFAULT_LANGUAGE](ops-config-default-language.md)
|
||||
- [AYANOVA_DEFAULT_TRANSLATION](ops-config-default-translation.md)
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ Here are all the error codes that can be returned by the AyaNova server:
|
||||
| E1010 | Could not find wwwRoot folder. AyaNova must be started from the folder immediately above wwwRoot. Generally the start folder should be the same folder as AyaNova.dll file. |
|
||||
| E1012 | Missing resource folder. AyaNova was started from the wrong location or the resource folder was not installed properly. This is required to intialize a new AyaNova database |
|
||||
| E1013 | Missing language resource file was deleted, renamed or not installed correctly. Resource language files are required to load into a new AyaNova database to display text in several languages for the user interface |
|
||||
| E1015 | Missing language. One or more of the stock languages were not found in the database or a custom language specified in the config setting [AYANOVA_DEFAULT_LANGUAGE](ops-config-default-language.md) is missing from the database. Log will have details. |
|
||||
| E1015 | Missing language. One or more of the stock languages were not found in the database or a custom language specified in the config setting [AYANOVA_DEFAULT_TRANSLATION](ops-config-default-language.md) is missing from the database. Log will have details. |
|
||||
| E1020 | Licensing related error. The message will contain the explanation |
|
||||
| E1030 | AyaNova database failed an integrity check. Contact support immediately. |
|
||||
| E1040 | File location [environment variables](ops-config-environment-variables.md) for backup files and user files were found to be the same location and must not be |
|
||||
|
||||
@@ -26,7 +26,7 @@ nav:
|
||||
- 'Memos': 'form-home-memos.md'
|
||||
- 'Reminders': 'form-home-reminders.md'
|
||||
- 'User settings': 'form-home-user-settings.md'
|
||||
- 'Locale': 'form-home-locale.md'
|
||||
- 'Translation': 'form-home-translation.md'
|
||||
- 'Set password': 'form-home-password.md'
|
||||
- 'Notification subscriptions': 'form-home-notify-subscriptions.md'
|
||||
- Customers:
|
||||
@@ -58,7 +58,7 @@ nav:
|
||||
- 'Global settings': 'form-adm-global-settings.md'
|
||||
- 'License': 'form-adm-license.md'
|
||||
- 'Users': 'form-adm-users.md'
|
||||
- 'Localized text design': 'form-adm-localized-text.md'
|
||||
- 'Translation': 'form-adm-translation.md'
|
||||
- 'Report templates': 'form-adm-report-templates.md'
|
||||
- 'Attached files': 'form-adm-attachments.md'
|
||||
- 'History': 'form-adm-history.md'
|
||||
@@ -78,7 +78,7 @@ nav:
|
||||
- 'Customer service requests': 'form-customer-csr-list.md'
|
||||
- 'Widget (testing)': 'form-widget.md'
|
||||
- Features:
|
||||
- 'Locale': 'ay-locale.md'
|
||||
- 'Translation': 'ay-translation.md'
|
||||
- 'Notification': 'ay-notification.md'
|
||||
- Server operations guide:
|
||||
- Forms:
|
||||
@@ -92,7 +92,7 @@ nav:
|
||||
- Technical:
|
||||
- 'Installation': '_placeholder.md'
|
||||
- 'Logging': 'common-log.md'
|
||||
- 'Language / locale': 'ops-config-default-language.md'
|
||||
- 'Language / translation': 'ops-config-default-language.md'
|
||||
- 'Backup files folder': 'ops-config-folder-backup-files.md'
|
||||
- 'User files folder': 'ops-config-folder-user-files.md'
|
||||
- 'Database configuration': 'ops-config-db.md'
|
||||
|
||||
Reference in New Issue
Block a user