From ec520f22cf40c46457fe17744698711d4d7b0202 Mon Sep 17 00:00:00 2001 From: Nick Reid Date: Tue, 9 Aug 2016 21:27:39 -0700 Subject: [PATCH] i18n message documentation --- docs/i18n.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/i18n.md diff --git a/docs/i18n.md b/docs/i18n.md new file mode 100644 index 0000000..e229732 --- /dev/null +++ b/docs/i18n.md @@ -0,0 +1,20 @@ +# i18n and Localized Content +The MOTECH-UI framework supports i18n and localized content that can be delivered from either the MOTECH Server or locally built into the UI. All content displayed in the UI should be rendered from message strings. + +This functionality is mostly supported by the [angular-translate]() framework, and the message-fromat parsing library. + +## Message Sources +There are two ways that translated messages can be loaded into the UI, either from the MOTECH Server, or locally at build time. The content for these strings are refreshed on the 'motech.reload' event. + +All messages are written in JAVA's message property format, and then changed into JSON before being loaded into the UI. + +### Local MOTECH Message Strings +Message strings can be loaded locally into the MOTECH-UI by creating a .properties file in any source directory. All files must meet the following file naming pattern: + +``` +[name].[language abbreviation].properties +``` + +'Name' should reference the UI component that the strings belong to. 'Language abbreviation' must be the two letter abbreviation for the language — this will be used to build separate .json files that are loaded into the MOTECH-UI on demand. + +All local message strings overwrite MOTECH Server message strings. \ No newline at end of file