diff --git a/docs/8.0/ayanova/docs/adm-translation.md b/docs/8.0/ayanova/docs/adm-translation.md index 1738b731..e57c3fa6 100644 --- a/docs/8.0/ayanova/docs/adm-translation.md +++ b/docs/8.0/ayanova/docs/adm-translation.md @@ -1,3 +1,4 @@ # ADM-TRANSLATION Placeholder TODO: How to use the Translation form to edit and create new translations. +todo: cross reference link to Localization page \ No newline at end of file diff --git a/docs/8.0/ayanova/docs/adm-users.md b/docs/8.0/ayanova/docs/adm-users.md index 7d6b4ad6..139b0ad7 100644 --- a/docs/8.0/ayanova/docs/adm-users.md +++ b/docs/8.0/ayanova/docs/adm-users.md @@ -1,5 +1,9 @@ # ADM-USERS Placeholder -This is a placeholder page for sections that are not written yet -Note: strongly suggest login name be user's email address \ No newline at end of file +## LOGIN NAME +We recommend using the users Email address as their login name + +## User Settings +This section is a duplicate of the [User settings](home-user-settings.md) form. + diff --git a/docs/8.0/ayanova/docs/ay-start-common-controls.md b/docs/8.0/ayanova/docs/ay-start-common-controls.md index 53b56271..87d5e4f5 100644 --- a/docs/8.0/ayanova/docs/ay-start-common-controls.md +++ b/docs/8.0/ayanova/docs/ay-start-common-controls.md @@ -1,5 +1,13 @@ # FORM CONTROLS + +### UTC +All dates and times are stored at the server in UTC (GMT) values. The server has no knowledge of time zones so this value is used to display the time and date in your local Browser time zone. +While you can ovveride this setting it's generally best to allow it to be the default setting obtained from the browser itself. + +### Filtering dates +When viewing data in AyaNova that is filtered with one of the relative date filters (for example a filter of "TODAY"), this time zone setting is taken into account in order to ensure that the user sees data appropriate to *their time zone*. This means that two people with browsers in different time zones using a filter of TODAY for a date field may see different list of results from each other. + todo: document that emojis can be used in any text field and key combo on windows is winkey-period -other os's too? diff --git a/docs/8.0/ayanova/docs/ay-start-data-types.md b/docs/8.0/ayanova/docs/ay-start-data-types.md new file mode 100644 index 00000000..2197ccc5 --- /dev/null +++ b/docs/8.0/ayanova/docs/ay-start-data-types.md @@ -0,0 +1,38 @@ +# DATA TYPES + +## DATES / TIMES + +### UTC +All dates and times are stored at the server in UTC (GMT) values. The server has no knowledge of time zones. The browser time zone and language settings control the display format of the time and date and which time zone is used to convert them. Input and display is considered to be in the time zone as set in the browser or overridden in User settings. + +### Filtering dates +When viewing data in AyaNova that is filtered with one of the relative date filters (for example a filter of "TODAY"), this time zone setting is taken into account in order to ensure that the user sees data appropriate to *their time zone*. This means that two people with browsers in different time zones using a filter of TODAY for a date field may see different list of results from each other. + +## Currency / Decimal numbers +Currency and decimal numbers are stored with 38 digit precision and 18 digit scale. (DECIMAL(38,18)) This level of precision and scale is necessary to accomodate potential usage of crypto currencies such as Etherium or Bitcoin. + +### Currency +AyaNova is a single-currency program, it assumes all currency values entered are for the same currency and values entered are stored at the server as Decimal numbers. Currency as entered is interpreted and displayed with a combination of settings specified in the user's Currency setting and the locale / language setting of the browser (or the override if overriden). + +### Decimal numbers +Decimal numbers are exactly the same as currency but without a currency symbol + +At the back end in the database the actual values stored are + +## Text + + +todo: document that emojis can be used in any text field and key combo on windows is winkey-period + -other os's too? + +todo: WIKI controls + +todo: DATA TABLES + Need help page specific to DataTable usage, link to it from the top of all manual pages that are for DataList UI pages (e.g. Customers page) + Note: arbitrary 1024 max char text field length, truncates after that. + Note: Special note to indicate that filtering by a column then hiding that column is supported as a feature + User won't see the filtered column if they hid it but the filter still applies + User can tell it's still filtered by the prescence of the filter reset button (circle with X inside) to the right of the filter selection list + note: filtering system, column view system, saving filter, case sensitivity, tokens etc + hidden query-affecting columns: Data Table column selector button will change to larger and accented when this is the case and the column selector form will highlight these hidden columns that affect the view with raised elevation, accent color and filter+sort icon (both show, there is no distinction which type of way it's affecting) + diff --git a/docs/8.0/ayanova/docs/ay-start-localization.md b/docs/8.0/ayanova/docs/ay-start-localization.md new file mode 100644 index 00000000..64004bc1 --- /dev/null +++ b/docs/8.0/ayanova/docs/ay-start-localization.md @@ -0,0 +1,49 @@ +# LOCALIZATION OVERRIDE + +Localization here means the way in which times, dates and numbers are displayed and interpreted by AyaNova. +It does *not* have any connection to the [Translation](ay-translation.md) features of AyaNova which determine what text is displayed in the user interface. + +AyaNova relies on the web browser to provide the language and time zone to be used automatically. These settings in turn determine how time, date, currency and numbers are displayed and interpreted when typed in. + +Rarely if ever should there be a need to override the browser's defaults as they generally come from the operating system itself and should be most appropriate for the user and device already. + +If necessary, these override settings will replace the browser provided defaults for use in AyaNova. + + +## Language code override + +The Language Code controls how the browser displays and accepts Numbers, Date and time values. + +The *default* value for this setting is obtained from the browser's language setting. If more than one language is set for the browser the *first* language is used. + +When no override setting has been made by the user this form displays the currently in-use default value in light gray text below this field. + +This setting is provided for the purpose of forcing a browser to use a different one of it's installed languages than the default. Unless you have a specific reason, it's best to leave this field empty and accept the browsers default language or make adjustments in the browser's language settings rather than here. + +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 [Translation](ay-translation.md) setting which controls the set of customizable text used by AyaNova to display to the user. + +### Choosing a Language code +To get started choosing a language code (a.k.a "Language Tag") here is a helpful guide from the standards body: [W3.org](https://www.w3.org/International/questions/qa-choosing-language-tags) + + +## 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. +Wikipedia has a helpful list of time zone database codes [https://wikipedia.org/wiki/List_of_tz_database_time_zones](https://wikipedia.org/wiki/List_of_tz_database_time_zones) + +This value must be the "database name" value, for example: `America/Denver` or `Australia/Sydney`. + +If no value can be determined from the browser, and no override has been set, the default Time Zone used is `America/New_York`. + + + + + + +todo: list of common language codes here to save lookup +todo: alternative to forcing overrides by setting browser defaults instead in browser + + + + diff --git a/docs/8.0/ayanova/docs/ay-translation.md b/docs/8.0/ayanova/docs/ay-translation.md index a8c98484..02cff0c5 100644 --- a/docs/8.0/ayanova/docs/ay-translation.md +++ b/docs/8.0/ayanova/docs/ay-translation.md @@ -19,4 +19,4 @@ There are two places with settings related to Translations used: *User default* In the AyaNova [User settings form](home-user-settings.md) you can select a default Translation for the logged in user. - +todo: link to localization docs diff --git a/docs/8.0/ayanova/docs/cust-contacts.md b/docs/8.0/ayanova/docs/cust-contacts.md index 1aad823e..d8bf3070 100644 --- a/docs/8.0/ayanova/docs/cust-contacts.md +++ b/docs/8.0/ayanova/docs/cust-contacts.md @@ -2,4 +2,10 @@ This is a placeholder page for sections that are not written yet -Note: strongly suggest login name be user's email address +## LOGIN NAME +We recommend using the users Email address as their login name + + +## User Settings +This section is a duplicate of the [User settings](home-user-settings.md) form. + diff --git a/docs/8.0/ayanova/docs/home-user-settings.md b/docs/8.0/ayanova/docs/home-user-settings.md index b9241c46..40f81fbd 100644 --- a/docs/8.0/ayanova/docs/home-user-settings.md +++ b/docs/8.0/ayanova/docs/home-user-settings.md @@ -43,15 +43,14 @@ Use the preset examples as a reference if making your own custom url. ## Currency code -The Currency Code controls how currency values are displayed and accepted for input in AyaNova. +AyaNova is a single-currency program, it assumes all currency values entered are for the same currency and values entered are stored at the server as Decimal numbers so this setting will affect how values are displayed and accepted for entry only, it has no relation to actual currency values or exchange etc. + +The Currency Code controls how currency values are displayed and accepted for input in AyaNova. The code must be one of the 3 character alphabetic [ISO 4217 active currency codes](https://wikipedia.org/wiki/ISO_4217#Active_codes) This value is *required* and cannot be determined from the Browser itself. If no setting is made the *default* value is "USD" for dollar symbol $. -This value is *required* and cannot be determined from the Browser itself. If no setting is made the *default* value is "USD" for U.S. dollars. Some other common currency codes are: "EUR" - Euro, "GBP" - Great British Pound, "CAD" - Canadian dollar, "AUD" - Australian dollar. -AyaNova is not a multi-currency program, it assumes all currency values entered are for the same currency and values entered are stored at the server as Decimal numbers so this setting will affect how values are displayed and accepted for entry only, it has no relation to actual currency values or exchange etc. - ## 12 hour clock -This *optional* setting controls whether times are displayed and selected in 12 hour (AM/PM) format or 24 hour format. +This *optional* setting controls whether times are displayed and selected in 12 hour (AM/PM) format or 24 hour format. If not set it will be determined from the browser default language setting. ## User color This *optional* setting controls some aspects of AyaNova where multiple user's data is being displayed at once to make it easier to visually distinguish between users at a glance. @@ -59,31 +58,7 @@ One example is the Schedule form when it is displaying schedules for more than o The *default* value is black / transparent. -## Language code override -The Language Code controls how the browser displays and accepts Numbers, Date and time values. - -It must be a value that is understood by the browser and matches one of the languages chosen in the browsers languages settings. - -The *default* value for this setting is obtained from the browser's language setting. If more than one language is set for the browser the *first* language is used. - -When no override setting has been made by the user this form displays the currently in-use default value in light gray text in this field. - -This setting is provided for the purpose of forcing a browser to use a different one of it's installed languages than the default. Unless you have a specific reason, it's best to leave this field empty and accept the browsers default language or make adjustments in the browser's language settings rather than here. - -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 [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. - -### UTC -All dates and times are stored at the server in UTC (GMT) values. The server has no knowledge of time zones so this value is used to display the time and date in your local Browser time zone. -While you can ovveride this setting it's generally best to allow it to be the default setting obtained from the browser itself. - -If no value can be determined the default Time Zone used is `America/New_York`. - -### Filtering dates -When viewing data in AyaNova that is filtered with one of the relative date filters (for example a filter of "TODAY"), this time zone setting is taken into account in order to ensure that the user sees data appropriate to *their time zone*. This means that two people with browsers in different time zones using a filter of TODAY for a date field may see different list of results from each other. - +## Language code override / Time Zone override +Optional settings to override the values used by the web browser by default. These should not need to be set in most cases. +See [Localization override](ay-start-localization.md) for details.