Allows localization of IOS App Name ('Bundle Display Name' or CFBundleDisplayName) when compiling PhoneGap/Cordova apps using build.phonegap.com (PhoneGap Build)
npm install cordova-plugin-pgb-ios-localize-app-nameThis plugin is for localizing the App Name ("Bundle Display Name" or CFBundleDisplayName) of IOS PhoneGap/Cordova applications. It does not work on other Cordova platforms (Android, Windows, etc).
It is only needed for users of build.phonegap.com (PhoneGap Build), because Cordova CLI users can make these changes directly in XCode.
This plugin ONLY localizes the name which displays under the icon when installed on the physical device. It does not localize any other content of the app.
For Example (App title translated from en "Messages" to es "Mensajes"):
!Alt text
!Alt text
You will want to use this plugin if you get the following iTunes Connect rejection notice:
> 3.4 - App names in iTunes Connect and as displayed on a device should be similar, so as not to cause confusion
This essentially means that you've used iTunes Connect to localize the App Name/Description that appears on the iTunes app store, but you haven't changed your compiled .ipa file to reflect the same names. This might be confusing to your users because the name which displays under the icon when used on their device will be different than the name they saw on the app store.
You can test if the localization of your app's name is working correctly by switching the language on your iOS device under "Settings / General / Language & Region / iPad Language". After switching the iPad language the device will soft-reboot. Afterwards, the text under your app's icon on the home screen should display the localized (translated) version.
Modify your config.xml to include the following tags:
``
`
For anyone who is curious how this works behind the scenes (or if you're a Cordova CLI user wanting to do this directly in XCode)
The app's main Info.plist (binary XML file) needs the "Application has localized display name" LSHasLocalizedDisplayName setting set to "Yes" ( in XML )
If you want to view your Info.plist file in a normal text editor you can use the plutil executable (in C:\Program Files (x86)\Common Files\Apple\Apple Application Support if iTunes is installed) to decode from binary xml to xml.
Your .ipa file also needs a set of files titled [languagecode].lproj/InfoPlist.strings next to the www folder (not inside it). These files need to specify values for the CFBundleDisplayName & CFBundleName variables.
For example, if you unzip your .ipa file, you should see the following (assuming english & spanish localized app name):
`
[MyAppName].ipa\
Payload\
[MyAppName].app\
en.lproj\
InfoPlist.strings
es.lproj\
InfoPlist.strings
...
config.xml
Info.plist
www\
index.html
cordova.js
...
`
The contents of the [MyAppName].ipa\Payload\[MyAppName].app\en.lproj\InfoPlist.strings should be:
`
CFBundleDisplayName = "My English Translated Long App Name";
CFBundleName = "My English Translated Short App Name";
Note: It is not document if/where the CFBundleName is actually used, but it is still considered best practice to give it a localized value.
Note: The iTunes App Store description lists which localizations are available for the actual UI inside your app.
!Alt text
If you desire to modify the languages listed on the above iTunes App Store screenshot, you may use the following code in your config.xml
`
Note: These config.xml tags don't require the use this or any other plugin. However, ALL they do is specify to the user which languages are available inside the app's UI. The tags don't magically translate anything. It is up to the programmer to write the code which actually detects the user's region & dynamically modifies the text in the html/css/js of his application. There may be some other Cordova plugins or javascript libraries that can help with this.
These tags are not required if you only want to translate your app's icon title to match your iTunes Connect App Store listing.
Pull requests are welcome! :)
`
The MIT License (MIT)
Copyright (c) 2015 Devin Garner
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.
``