Content localisation allows content to be provided in multiple languages, Oomph then renders the appropriate content based on the user's preference. This is identical to the way iOS apps are localised.
Localisation can not only be used to provide content in native language for your readers, but can also be used to tailor content for a local audience, for example to show American model on the cover of a car magazine for American readers, and a European one for German readers.
A single content bundle contains all available languages, this allows languages to be changed dynamically based on system settings or user override. You can provide a single content bundle for all languages you wish to support. The server does not (at present) optimise delivery of content bundles to the current language choice.
Publishing an app to the iTunes App Store opens your work to the world and markets beyond your region. Currently the world has over 6,000 spoken languages catering for one or more of these languages may encourage the download/purchase of your app. Multiple language support within your app should be on your radar for implementation.
Oomph is the leading multiple language app publishing platform. Oomph provides in-built support for multiple languages and regional dialects. A good example of language implementation in an Oomph app can be seen in the Cathay Pacific “CX Discovery” magazine currently available for free in the iTunes App Store.
The illustrations below show different versions of the first page of “The Showman” section from the May 2013 Issue. The first version is in English, the second in Chinese (Simplified)
By selecting a different language from the app interface the screen is refreshed and that language version displayed.
Not only do the pages reflect the language change but other features such as social sharing can also reflect the alternate language choices. The illustrations below show alternate email versions in both English and Chinese (Mandarin).
A language designator is specified as a combination of the main language, plus optionally any regional dialect. For example the English language has several regional dialects including Australian & American English. A language designator is made up of a language code (e.g.
en) and an optional region code (e.g.
US) OR a dialect (aka scripting) code (e.g.
A user chooses their language preference in the Settings app on device, this is available in the following location:
Oomph also provides an in-app override, that overrides the system language. This allows for example an app that contains French localised content to be read by a French reader even if the system language is English.
These regional settings are often referred to as a “locale”, or more correctly for the purpose here, a language designator . For information on the supported languages & their codes, please read the Apple documentation on Language and Locale Designations.
Languages use the ISO 639-1 or ISO 639-2 standard, a complete list is available http://www.loc.gov/standards/iso639-2/php/English_list.php.
Region codes use the ISO 3166-1 standard, a complete list is available at http://www.iso.org/iso/iso-3166-1_decoding_table/.
Oomph will render localised content as follows:
When only one language is available, Oomph will use this content for all languages (this is the behaviour for pre-Oomph 17 apps).
When multiple languages are available, Oomph will render content based on the closest user's language and region preferences. For example if English, French & US English localisations are available, and the system language is British English, English will be used.
Oomph also provides a way to locally override the system setting from within the app. This setting is available from the toolbar at the top of the screen (accessible with a single-tap) which presents the user with a menu available translations.
Every Oomph application also has a nominated default "base language". This is deemed to be the language of all non-localised content. Only the languages available within the content are shown, for example if French & US English localisations are available, and the base language of the application is English, the menu will contain:
English (United States)
Before you produce your localised content, you should first produce the “base” or default content (as you would for pre-Oomph 17 content). This is the content that is shown if you do not provide a localisation for a particular language. For example if you provide French & German localisations, a Japanese reader will see the base content.
After you've authored your base content, you can produce the localised versions. You place your localised content either under the section or widget you're localising. At each of these levels, localised content is placed within a folder, this folder has a name which matches the language code, and may optionally include a regional code. You do not need to include a region code, you should only add it if you wish to provide additional specificity for regional readers.
Consider the following folder names:
en- English (includes all regional variations)
en-US- US English
en-GB- British English
Full details of the language & region codes can be found in understanding_languages above. Note that a hyphen must be used to separate the language from the region code. Do not include the hyphen if you do not specify a region, for example
en- is invalid, use just
For example French content for the
Cover section will live in the folder
10-Cover/fr/, the first page will be
10-Cover/fr/P1-1.pdf. Similarly, American English content for a Vertical In Page Slideshow will be in
Let’s take a look at the Cathay Pacific example to see how it’s done. The following illustration shows the folder assets for “The Showman” section of the Issue.
This looks like a standard Oomph section folder with the P1-1.pdf in English. The important thing to note is the inclusion of the “zh” folder. The zh folder contains the alternate language versions of the main pages.
As you can see by the Cathay Pacific example the localised content is placed within a folder named “zh” which matches the language designator for Chinese defined by the International Organization for Standardization (ISO).
When Oomph looks for content for a reader, if their language & region is not found, the closest matching language will be used. So if you've provided US English (
en-US) & British English (
en-GB) content, an Australian English (
en-AU) reader will see the base content. However, if you were to also include an English (
en) localisation, an Australian reader will see that content.
Localised content for Shared Widgets
As you can see there are three folders in the section folder of the Cathay example called ShareEmail, ShareFacebook and ShareTwitter. Each of these widget folders contains base and localised content. The example below shows the base content in the ShareEmail folder including a “zh” folder. The zh folder contains a similar collection of assets in the Chinese language.
The comparison illustration below shows the English body.html file and the Chinese body.html file (the Chinese version located within the zh folder)
iPad Preview Files
To view these files on your iPad click here to download Oomph Viewer onto your iPad. Once Oomph Viewer is installed download the Handy Book of Oomph in the Library section and preview all the Oomph features in one issue.
Got a question?