PATH Contents > Customizing components
Customizing components

This document describes the customization you can add to a component and which will be visible during the installation with Installer.

You need to remember that only the customizations of the root component will be visible during the installation.

Notes:
  • By default, files are referenced by absolute path names. You can switch to relative path names using the pop-up menu of the text fields.

  • This document shows how to change a file reference with the standard open dialog. You can also directly type the path or drag and drop a file in the text field (as long as it's not being edited).

  • If a reference points to a file which does not exist (any more), the path name will be displayed red.

Customizing the background image

By default, when you install a package or a metapackage, Installer displays the X of the Mac OS X logo in the background (on Mac OS X 10.4, it is now a big application icon). You can change this image and use a custom one.

Background Picture

To use the default background image:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Select the button labeled Default.

To use a custom background image:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Select the button labeled Path:.
4Choose Choose… from the Action pop-up menu.
5

Select the image to use as the background image.

Note: The following image formats are supported: TIFF, GIF, PDF, EPS and JPEG.
6Click Choose.

To change the background image scale:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
2Select the button labeled:
  • Proportionally: If the image is larger than 620 pixels x 418 pixels, it shrinks to fit inside the Installer main window content frame. If the image is too small, it expands. The proportions of the image are preserved.

  • To Fit: The image shrinks or expands, and its proportions distort, until it exactly fits Installer main window content frame.

  • None: No scaling will be performed.

To change the background image alignment:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3

Choose the alignment from the Alignment pop-up menu.

Note: The alignment values are the same as the NSImageView object in Interface Builder.

Customizing the Welcome message

By default, when you install a package or a metapackage, Installer displays the following welcome message: "Welcome to the Mac OS X Installation Program. You will be guided through the steps necessary to install this software.". You can change this message to use a more appropriate one for your component. You can use the same message for all languages or you can localize it.

Important: The welcome message is displayed in a non scrollable view.

Welcome

To use the default welcome:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3

Select the button labeled Default.

Note: This assumes that there is no other welcome localizations defined.

Note: The welcome will be displayed in the language of the user.

To use a custom welcome:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Select the button labeled Path:.
4Choose Choose… from the Action pop-up menu.
6

Select the text document to use for the welcome message.

Note: The text document format can be text, RTF, RTFd or HTML.
7Click Choose.

Note: By default, the welcome message will be the same for every language. To display a localized message, you need to add localized welcome message.

To add a custom welcome localization:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Choose Add Localization… from the localization pop-up menu.
4Type the name of the localization and click Add.
5Select the button labeled Path:.
6Choose Choose… from the Action pop-up menu.
7Select the text document to use for the welcome message.
8Click Choose.

To edit a custom welcome localization:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Choose the localization to remove from the localization pop-up menu.
3Make your changes.

To remove a custom welcome localization:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Choose the localization to remove from the localization pop-up menu.
4Choose Remove… from the localization pop-up menu.
5

Click Remove.

Note: The referenced document is not deleted from the disk, only the reference to this document is removed.

Customizing the ReadMe message

Installer can display a readme message after the welcome message. This message can be printed or saved by the user. By default, no readme messages is displayed. You can use the same message message for all languages or localize it.

Read-me

To display no readme messages:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3

Select the button labeled None.

Note: This assumes that there is no other readme localizations defined.

To display a custom readme message:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Select the button labeled Path:.
4Choose Choose… from the Action pop-up menu.
6

Select the text document to use for the readme message.

Note: The text document format can be text, RTF, RTFd or HTML.
7Click Choose.

To add a custom readme localization:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Choose Add Localization… from the localization pop-up menu.
4Type the name of the localization and click Add.
5Select the button labeled Path:.
6Choose Choose… from the Action pop-up menu.
7Select the text document to use for the readme message.
8Click Choose.

To edit a custom readme localization:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Choose the localization to edit from the localization pop-up menu.
3Make your changes.

To remove a custom readme localization:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Choose the localization to remove from the localization pop-up menu.
4Choose Remove… from the localization pop-up menu.
5

Click Remove.

Note: The referenced document is not deleted from the disk, only the reference to this document is removed.

Customizing the user license agreement

When a package or a metapackage is being installed, Installer can ask the user to agree to an End User License Agreement (EULA) so that he/she can perform the installation. The user license can be printed or saved by the user. If multiple localizations of the license are available, they are all accessibles to the user. By default, no license is displayed.

User License

To display no licenses:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3

Select the button labeled None.

Note: This assumes that there is no other license localizations defined.

To display a user license defined in a text document:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Select the button labeled Path:.
4Choose Choose… from the Action pop-up menu.
6

Select the text document to use for the user license.

Note: The text document format can be text, RTF, RTFd or HTML.
7Click Choose.

To display a user license based on a license template:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Select the button labeled Template:.
4

Choose the license template from the Template pop-up menu.

Notes:
  • There is no International license templates. You need to add an English or French localization to get access to license templates.

  • It is possible to customize some templates using the template table of keys and values.

  • You can create your own license templates. The License templates document describes how to do it.

To add a license localization:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Choose Add Localization… from the localization pop-up menu.
4Type the name of the localization and click Add.
5Configure the license settings as needed.

To edit a license localization:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Choose the localization to remove from the localization pop-up menu.
3Make your changes.

To remove a license localization:

1Select the component in the Packages & Metapackages list.
2Choose View > Documents.
3Choose the localization to remove from the localization pop-up menu.
4Choose Remove… from the localization pop-up menu.
5

Click Remove.

Note: The referenced document is not deleted from the disk, only the reference to this document is removed.

Running an installation simulation

You can preview the customizations you added to the component with the installation simulator. It will show you the three first steps of an installation as if you were running Installer. Moreover, you will be able to select the language and to change the alignment or scale of the background image.

Installation Simulator

To run a simulation:

1Select the component in the Packages & Metapackages list.
2Choose Build > Preview.

To change the alignment or scale of the background image:

1Cliquez sur le menu local de configuration de l'image de fond dans la fenêtre du simulateur.
2Choose the alignment or scale from the contextual menu.

To quit the simulator:

1Click Close.
2If you changed a setting of the background image, a dialog will pop-up and ask you to confirm the modifications.


Author: Stéphane Sudre