Localization (l10n)
Often we want to make a localization of our system or part of system and here we show you how you can easily do it with your Ziggeo embeddings.
As always just send us an email if you have any additional questions.
To help make it easy find exact part that you need, we made several segments:
- How to translate everything to supported language
- How to find the exact (specific) strings you can translate
- How to make the custom translation
How to translate everything (to one of supported languages)
We have an interactive version that can help you set the default language of your embeddings on our Header section and we suggest checking it out, while we will show you here just the basic principle behind it.
All of our supported languages are shown on our Supported languages page.
While you might need to set up the language to a specific preference, it is good to mention that we are actually auto detecting the browser "locale" setting so if it is set up so that your preferred language is German, our system will load the German language automatically for you or your customers allowing the best experience.
Once you find the shortcode of the language you prefer you would do the following:
ZiggeoApi.V2.Locale.setLocale('shortcode');
- for example:
ZiggeoApi.V2.Locale.setLocale('de');
Example setting up embeddings to use German language
How to find specific strings for translations
Since our system is built on top of BetaJS framework it means that some of the translations are made for the BetaJS part and some for Ziggeo part. We will of course cover both as both are needed to completely translate your apps and their embeddings. At the end of this page we will list all of the strings, while before that we will show you how to use them and make your translations.
// ZiggeoApi.V2.Locale.setLocale('de');
ZiggeoApi.V2.Locale.mainLocale.all();
// ZiggeoApi.V2.Locale.mediaLocale.setLocale('de');
ZiggeoApi.V2.Locale.mediaLocale.all();
This will give you all of the Ziggeo and BetaJS strings (in a particular language).
Our stable revision usually has most of the languages, while latest revision available has them all. Once you find the language that you need (if you did not see it already), you know which revision is the minimal one for you.
if you use ZiggeoApi.V2.Locale.mediaLocale.all() you can see the value such as this one ba-videorecorder-chooser.record-video which is the key for "Record Video". The text that is shown on the button at the start (first screen).
Now we can do the following: ZiggeoApi.V2.Locale.mediaLocale.register({"ba-videorecorder-chooser.record-video": "Record your video"}, 10); and what happens is that it will no longer show us "Record Video", rather it will now be shown us our new string "Record your video" instead.
Following the same approach you can change all your strings. First get the key that represents the value you want to change using functions above, and then changing them using one of the following:
ZiggeoApi.V2.Locale.mediaLocale.register({"ba-videorecorder-chooser.record-video": "Rec"}, 10);
or:
ZiggeoApi.V2.Locale.mainLocale.register({"ziggeoplayer.video-not-found": "Video is no where to be seen"}, 10);
That would be all that is needed for you to make the translations that you want. There are only few things to point out so that it is easier for you.
We recommend that you set the language strings before you set the application.
It is also good to note that while you could change them later on, it is more than likely that the same changes would not be available for your embedding and that embeddings would not automatically update.
If you make a translation of a language that we do not yet support and want it to be part of our plan instead of you adding code for the same on your own, just let us know and we will include it into our system.
Code examples
Here you can see couple of code examples that should help you set things up.
How to set the main language to use?
ZiggeoApi.V2.Locale.setLocale('de');
Example setting up embeddings to use German language
What if I just want to set strings for French regardless what language is used?
ZiggeoApi.V2.Locale.mediaLocale.register({ "ba-videorecorder-chooser.record-video": "Enregistrer une vidéo" }, ["language:fr"], 10);
Example setting up string for French language
Language keys and their values
Here is the list of the keys followed by their values in all languages, making it easier to get the context of what each means if you are bi or multi lingual.