Skip to content

i18n message documentation #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nickdotreid wants to merge 1 commit into
base: master
Choose a base branch
from
Open

i18n message documentation #67

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/i18n.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.