ember-tml
v1.0.13
The default blueprint for ember-cli addons.
0/weekUpdated 3 years agoMIT
Published by translationexchange
npm install ember-tml
Ember TML
===
This addon adds helpers for doing advanced localization of your ember apps with Translation Markup Language (TML) by Translation Exchange.
Translation Markup Language (TML) is a simple markup language that provides syntax for identifying dynamic data and decorations within strings. TML aims at abstracting out the decoration mechanisms of the string and instead provides its own simple, but powerful syntax. This allows for translation sharing across multiple applications and platforms.
Installation
```javascript``
ember install ember-tml
Configuration
The first thing you need to do to get started with Ember TML is sign up for a free Translation Exchange account and create your first project.
Once you have created a project and have your project key and token you must configure the service:
``javascript``
// config/environment.js
module.exports = function(environment) {
var ENV = {
tml: {
key: "YOUR_PROJECT_KEY"
}
}
}
Usage
$3
To start using tml in your templates you will need to initialize the SDK. We suggest doing it in the beforeModel hook of your application route.
This will retrieve any translations from either your cache or the CDN before rendering any templates.
``javascript``
// app/routes/application.js
export default Ember.Route.extend({
beforeModel(){
return this.get('tml').initialize();
}
});
$3
The Ember TML Addon provides a few helpers and a service:
#### {{tr}} Helper
tr is the basic translate function. It takes 3 parameters:
* label is the only required parameter.description
* is an optional parameter, but should always be used if the label by itself is not sufficient enough to provide the meaning of the phrase.tokens
* is an optional parameter that contains a hash of token values to be substituted in the label.
This is what it should look like in your templates:
``handlebars``{{tr "Hello World" }}{{tr "Invite" "Link to invite your friends"}}{{tr "Welcome {user}!" user=userName}}{{tr "You have {count || message, messages}" count=1}}{{tr "You have {count || message, messages}" count=5}}
yields:
``handlebars``Hello WorldInviteWelcome Jane!You have 1 messageYou have 5 messages
#### {{trl}} Helper
trl works the same as tr but should be used for attribute values.
``handlebars``
{{input placeholder=(trl "Enter email address")}}
yields:
``handlebars``
You can find more on how to use TML in the docs at Translation Exchange
$3
#### TML Service Api
The TML service will be injected into Controllers, Routes, Views and Components.
``javascript``
Ember.get(this, 'tml').trl("Hello World");
and includes some handy methods for working with TML:
currentTranslator
an object representing the current logged in translator
``javascript``
Ember.get(this, 'tml.currentTranslator');
// {
// name: "translator_username",
// inline: true
// }
currentSource
a string of the current source
``javascript``
Ember.get(this, 'tml.currentSource');
// "index"
currentApplication
return an object representing your Translation Exchange application
``javascript``
Ember.get(this, 'tml.currentApplication');
// {
// id: 123,
// key: "APP_KEY",
// name: "Dom Examples",
// current_locale: "zh",
// default_locale: "en-US",
// features: {...},
// languages: [...]
// }
currentLanguage
returns the currently selected language
``javascript``
Ember.get(this, 'tml.currentLanguage');
// {
// id: 233,
// english_name: "Russian",
// native_name: "Русский",
// locale: "ru",
// right_to_left: false,
// flag_url: "https://s3-us-west-1.amazonaws.com/trex-snapshots/flags/default/languages/16/ru.png"
// }
returns a list of all available languages for your project
translationModeEnabled
returns whether or not the application is currently in translation mode
translate(label [,description, tokens])
tr(label [,description, tokens])
works the same as the tr helper
translateLabel(label [,description, tokens])
trl(label [,description, tokens])
works the same as the trl helper
changeLanguage(locale)
sets the current language
$3
``
handlebars
{{#each tml.availableLanguages as |language|}}
{{tr language.english_name}}
{{/each}}
```Links
==================
* Register on TranslationExchange.com: http://translationexchange.com
* Follow TranslationExchange on Twitter: https://twitter.com/translationx
* Connect with TranslationExchange on Facebook: https://www.facebook.com/translationexchange
* If you have any questions or suggestions, contact us: support@translationexchange.com
Copyright and license
==================
Copyright (c) 2017 Translation Exchange, Inc.
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.