Going International
Localizing & Internationalizing your in-app Support.
Internationalization
Helpshift macOS SDK comes with support for 46 languages out of the box with English as the default.
All localizations are available automatically to your app when you use the SDK. By default, all languages in the Resources folder inside the framework will be supported. You need to remove the lproj folders corresponding to the localizations that your app doesn't support from HelpshiftOSX.framework/Resources folder.
The Helpshift SDK will be localized based on the user’s device language. If the user’s device language is not available, English will be used as default.
If the end-user has a language already set for their device the correct language translations will be used. If the said language is not available English will be used as default.
List of supported languages
| Language | Locale | |
|---|---|---|
| English | en | |
| Arabic | ar | |
| Bulgarian | bg | |
| Bengali | bn | |
| Catalan | ca | |
| Czech | cs | |
| Danish | da | |
| German | de | |
| Greek | el | |
| Spanish | es | |
| Persian | fa | |
| Finnish | fi | |
| French | fr | |
| Gujarati | gu | |
| Hebrew | iw | |
| Hindi | hi | |
| Croatian | hr | |
| Hungarian | hu | |
| Indonesian | id | |
| Italian | it | |
| Japanese | ja | |
| Kannada | kn | |
| Korean | ko | |
| Latvian | lv | |
| Malayalam | ml | |
| Marathi | mr | |
| Malay | ms | |
| Norway | nb-NO | |
| Norwegian | nb | |
| Dutch | nl | |
| Punjabi | pa | |
| Polish | pl | |
| Portuguese | pt | |
| Romanian | ro | |
| Russian | ru | |
| Slovak | sk | |
| Slovenian | sl | |
| Swedish | sv | |
| Tamil | ta | |
| Telugu | te | |
| Thai | th | |
| Turkish | tr | |
| Ukrainian | uk | |
| Vietnamese | vi | |
| Simplified-Chinese | zh-Hans | |
| Traditional-Chinese | zh-Hant |
Adding your own translations
Steps to add your own language translation to Helpshift macOS SDK:
- Add a new strings file in your application and name it to HelpshiftLocalizable.strings.
-
Select your Project from XCode, you can see the Localizations section as shown below, click on the + symbol to add your Localization. Select the localization you want to add for e.g., Dutch.
-
Once you have selected Dutch, XCode will prompt you to choose reference language to create Dutch localization, select HelpshiftLocalizable.strings and select
Englishas reference language, uncheck all other resource files in your project to createDutchlocalization for Helpshift macOS SDK. See below for reference.
-
After you have pressed the Finish button, Xcode will create the file
HSLocalization/nl.lproj/HelpshiftLocalizable.strings. Click "HelpshiftLocalizable.strings (Dutch)" from XCode to add Dutch Localization. See below for reference:
-
Once you add the translations for the keys required by the Helpshift SDK, copy the lproj folder corresponding to the newly added localization and paste it to
HelpshiftOSX.framework/Resourcesfolder in the framework.
Set SDK language
You can set the SDK language using the method + (BOOL) setSDKLanguage:(NSString *)languageCode;
By default, the device's prefered language is used by the SDK.
For Example :
// Language Code is like "en" for English or "fr" for French [HelpshiftCore setSDKLanguage:@"fr"];
Now, head over to String Customization for the list of strings that you can customize as per your needs.