Information About Reunion's localization.plist File and Localization Installation...
The Reunion 12 app will look for and optionally install downloaded localizations contained in a .reunion_localization package.
A localization.plist file must be present inside your .lproj folder and optionally a custom 128 x 128 localization.png image file may also be present.
The completed localization of your .lproj folder is placed inside the .reunion_localization package.
Modify the localization.plist file using Apple’s Property List Editor or equivalent. You should localize everything in the “Value” column on the right but do not change the key words in the left column. Here is a description of the items found in the localization.plist file...
Reunion Information
- Version - Main version of Reunion for which this localization is intended. Example: 12 or 13
- Build - Build of Reunion for which this localization is originally intended. Note that this build number does NOT have to match the current build of Reunion. It is simply a point of reference for the creation of the localization files.
- Date - Date this localization was released.
- Author - Name of the localizer.
- Locale - Language name for the localization. This should not be changed after your first localization version is released.
- Version - Numeric version for the localization. Must be purely numeric (1 2 3 not 1.1 or V12) and newer versions must have a higher number. This version number can be multiple digits for example: 20200513 - but any newer versions must have a higher number.
- URL - Optional web address for information specific to the localizer or the localization.
- Title - Bold text at the top of the install localization confirmation sheet.
- Content - Plain text that appears in the install localization confirmation sheet.
- Bold text that appears while the localization is being installed.
- Title - Bold text at the top of the installation success sheet.
- Content - Plain text that appears in the installation success sheet.
- Title - Bold text at the top of the installation error sheet.
- Content - Plain text that appears in the installation error sheet.
- Cancel - Cancel button that will appear in confirmation and warning sheets.
- Close - Close button that will appear in confirmation and warning sheets.
- Install - Install buttons that will appear in the confirmation sheet.
- Install Localization - Button that appears in the About Reunion window.
- Localization Information - Button that appears in the About Reunion window.
- URL - if you are providing your web address, this button will appear in the Localization Information sheet.
Optionally, you may include a 128 x 128 .png image to appear in the localization installation and information windows. This file should be named localization.png and be placed inside the .lproj folder.
Create a .zip of the .reunion_localization folder and make it available for download to your customers.
When your customer downloads the .reunion_localization file to their browser they can leave the file in the Downloads folder or drag the file out to the Desktop.
If you emailed the package to the customer, they can drag the unzipped package either to the Desktop or the Downloads folder.
The customer will then launch Reunion and choose Reunion > About Reunion. If Reunion finds the .reunion_localization package in their Downloads folder or on their Desktop an “Install Localization” button will appear allowing the customer to install your localization into the Reunion application.
After the localization has been installed, Reunion should be restarted. You can then choose Reunion > About Reunion and a “Localization Information” button will appear. Clicking this button will display information about the localization installed in the Reunion application.
If you need to update your localization, simply increase the Localization Version number in your localization.plist file, upload a new .reunion_localization file and have your customers download the updated localization. The customer must again choose Reunion > About Reunion to install the newer localization. Note that there is no need to delete the old localization from Reunion and older downloads of .reunion_localization packages will be ignored in favor of the localization with the highest version number.
If a newer build of Reunion is installed the localization will need to be installed again by choosing Reunion > About Reunion. If the customer has left the .reunion_localization package on the Desktop or in the Downloads folder, there is no need for them to download the installer again. Reunion will find the package as long as it was not deleted and is still in one of these two locations.
This localization installer is different from other localization installers since it’s built into the Reunion app itself. 3rd party installers may have to ask the user where to install the localization or which application is the target of the install. This is not the case here because the Reunion app that is currently running will be the application that gets the localization installation. Therefore, any step about choosing a destination for the install is not necessary.