Previous | Next | Up | Table of Contents

5.2. Install Files

Files such as a readme and end-user license agreement can be displayed to the user during the installation process within the wizard interface. We refer to these files as install files. Settings related to these files can be entered on the Install Files tab:

Files referred to on this page are not usually located in the source package, as they are usually displayed during installation rather than being

Basic Install File Usage

Install files are displayed to the user at certain points during the installation process. All files are optional - if the files are not specified, then the corresponding installer wizard page will be omitted.

The License file is displayed immediately after the start page.

The Intro File is shown immediately after the license agreement. It is typically used to display a welcome message, installation instructions, or other text. If the intro file is a text file it can be displayed internally in the installer wizard. Any file with a Windows file association (for example an html file) can be used if the Launch intro file using Windows option is checked. A URL may be specified instead of the path to a file.

The Readme File is displayed at the end of the installation process.

Localised Install Files

Localised install files are supported from IPF version 2.0. The path to a folder containing localised documents should be entered in the Localised Documents Root Folder in order to use this feature. This folder will be searched during the installation for an appropriately localised version of the document, and if a suitable version isn't found, then the unlocalised version will be used.

Put simply, the localised documents folder should contain localised versions of install files, and the common documents folder should contain default, unlocalised versions of these documents (used in case an appropriately localised version is not found).

For example, suppose we enter C:\local as the localised documents folder. We create a subfolder de, and save a German readme.txt into the de folder. We also save an unlocalised version, English in this case, to C:\docs\readme.txt, and enter C:\docs as the Common Documents Folder. We should enter readme.txt into the Readme File edit box.

In this example, when the installer is run by an end-user whose system is set to the German locale, the readme.txt will be selected from the de folder and displayed to the user. If the user's system was set to Spanish, and no readme.txt was found localised to Spanish, then the file copied from C:\docs\readme.txt would be displayed.

It is not necessary to enter a localised documents folder - in that case the files will always be taken from the common documents folder.

If a common documents folder is not used, then relative paths will be resolved with respect to the location of the .pfs script.