Localizing the Splash Screen
InstallAnywhere 2021
The startup splash screen shows a splash screen title, image, and confirmation button. All of these elements are customizable by locale.
When you localize these splash screen elements, they respond to the locale of the target machine and to the command-line option that sets the locale:
-l <language code>
Note:To learn more, see Using Command-Line Arguments with Installers and Uninstallers.
Tip:You can use a variable for these elements, but be aware that the only variables that are automatically resolved in the splash screen are $INSTALLER_TITLE$ and $PRODUCT_NAME$. The value of any other variable used here must either be passed to the installer at the command line or be included in the installer.properties file for the installer. (It is not possible to localize the splash screen with references to keys in an external resource bundle.)
Localizing the Splash Screen Title
To localize the splash screen title:
| 1. | Locate your project’s locales directory. This directory is in the same location as your project file, and the directory is named to match your project name: |
Project_namelocales_Build_configuration_name
For example:
My_Productlocales_OSConfiguration
| 2. | Open each non-English locale file in a text editor, and find the splashScreenGUITitle element. This element typically uses an Installer.#.splashScreenGUITitle key, where the number sign (#) represents the reference ID for the element. |
| 3. | Provide the translated title text as the value for the Installer.#.splashScreenGUITitle key. |
Localizing the Splash Screen Image
To localize the splash screen image:
| 1. | In the Advanced Designer, on the Sequence page, click Install. The Install view opens. |
| 2. | Add all localized splash screen image files to the DO NOT INSTALL magic folder. This ensures that the image resources for the localized splash screens are available to your installer but not installed to the target system. |
| 3. | Locate your project’s locales directory. This directory is in the same location as your project file, and the directory is named to match your project name: |
Project_namelocales_Build_configuration_name
For example:
My_Productlocales_OSConfiguration
| 4. | Open each non-English locale file in a text editor, and find the splashScreenGUIImageName and splashScreenImagePath elements. These elements appear in the locale files as Installer.#.splashScreenGUIImageName and Installer.#.splashScreenImagePath, where the number sign (#) represents the reference ID for the element. |
| 5. | Enter the correct locale-specific file name and path (if necessary) values for the Installer.#.splashScreenGUIImageName and Installer.#.splashScreenImagePath keys, respectively. |
Localizing the Splash Screen Confirmation Button
To localize the splash screen confirmation button:
| 1. | Locate your project’s locales directory. This directory is in the same location as your project file, and the directory is named to match your project name: |
Project_namelocales_Build_configuration_name
For example:
My_Productlocales_OSConfiguration
| 2. | Open each non-English locale file in a text editor, and find the splashScreenGUIConfirm element. This element typically uses an Installer.#.splashScreenGUIConfirm key, where the number sign (#) represents the reference ID for the element. |
| 3. | Provide the translated confirmation button text as the value for the Installer.#.splashScreenGUIConfirm key. |
Tip:You can also localize related console-installer elements on the Choose Locale console using the locale elements splashScreenConsoleTitle and splashScreenConsolePrompt.
See Also