Keywords: iOS | Localization | Info.plist | InfoPlist.strings | NSLocationWhenInUseUsageDescription
Abstract: This article provides a detailed guide on localizing key values in the iOS Info.plist file, specifically for usage descriptions like NSLocationWhenInUseUsageDescription, using the InfoPlist.strings file. It covers file creation, adding localized content, testing, and common issues, with step-by-step instructions and code examples.
Introduction
In iOS app development, the Info.plist file contains essential configuration details, including usage descriptions for permissions. As apps support multiple languages, these descriptions require localization. Starting with iOS 8, keys such as NSLocationWhenInUseUsageDescription mandate that developers provide user-facing explanations. Hardcoding strings directly into multiple Info.plist files is inefficient and error-prone. This article explores how to leverage the InfoPlist.strings file for effective localization.
Purpose and Creation of the InfoPlist.strings File
The InfoPlist.strings file is specifically designed for localizing Info.plist key values in iOS. Its name must be InfoPlist (with capital letters) to ensure proper system recognition. To create it, in Xcode, select File->New->File, choose Strings File under the Resource tab for iOS, name it InfoPlist, and create it. After creation, enable localization by clicking the Localize... button in the file inspector and selecting the base language and additional supported languages.
Adding Localized Content
In the InfoPlist.strings file, define localized strings using key-value pairs. For example, for NSLocationWhenInUseUsageDescription, add the following code:
"NSLocationWhenInUseUsageDescription" = "This app requires your location to provide relevant services.";Each language version of the InfoPlist.strings file should include the same keys but with values translated into the respective language. For instance, in a Spanish version:
"NSLocationWhenInUseUsageDescription" = "Esta aplicación requiere su ubicación para proporcionar servicios relevantes.";As referenced in auxiliary materials, developers might attempt localization for keys like CFBundleDisplayName, but accuracy in key names is crucial. Incorrect keys or malformed formats can lead to App Store rejection errors, such as ITMS-90038.
Testing and Verification
Testing is a critical step after localization. When running on a simulator or device, change the system language of the device itself, not just the language in the Xcode target. For example, in the simulator, navigate to Settings->General->Language & Region to switch languages. If localization does not take effect, verify that the InfoPlist.strings file is correctly localized and the key-value pairs are properly formatted.
Common Issues and Solutions
A frequent issue involves file format errors. The InfoPlist.strings file must use UTF-16 encoding and end each line with a semicolon. If garbled text or failure to load occurs, check the file encoding settings in Xcode. Additionally, key names must exactly match those in Info.plist, including case sensitivity. For example, NSLocationWhenInUseUsageDescription should not be misspelled as NSLocationWhenInUseUsageDescription.
Conclusion
Using the InfoPlist.strings file allows developers to efficiently manage localized strings for Info.plist, avoiding the complexity of maintaining multiple Info.plist files. This approach is applicable not only to permission descriptions but also to other keys like CFBundleDisplayName. Proper implementation enhances the international user experience and minimizes review issues.