PATH Contents > Customizing a distribution interface
Customizing a distribution interface

A distribution, contrary to a raw package, lets you customize what is visible to the user. You can customize the contents of some steps of the installation, the background image of the Installer window or localize the title of the distribution.

To see how to customize the Installation Type step, check the Customizing a distribution Installation Type and requirements chapter.

Project Presentation

To access the Presentation tab for a distribution project:

1Choose Project > Project…
2Click the Presentation project tab.


Customizing the distribution title

The distribution title is the name that will be used to create the title of the Installer window and the title of the Introduction step. By default, there are no localizations for the distribution title and the name of the project will be used.

Distribution Title

To add a localization for the distribution title:

1Choose Title from the Presentation inspector popup button.
2Click the + button.
3Type the title of the distribution and validate with Return.
4Choose the language from the language popup button.

To remove one or multiple localizations of the distribution title:

1Choose Title from the Presentation inspector popup button.
2Select the localizations you want to remove.
3Click the - button.
4Click Remove.


Customizing the background image

The background image is the image that is displayed in the Installer window behind the list of steps and the main pane. Packages lets you define which background imae you want to display for a distribution.

Distribution Background Image

Notes and recommendations:
  • The following formats are supported for the custom background image: TIFF, JPEG, PNG, PDF, GIF and PICT.

  • The minimum size of the view that displays the background image is x .

  • Do not use a background image that is too opaque. Otherwise, it may make the list of steps in Installer difficult to read.

  • On some macOS versions, the Installer window is resizable. Take this into account when you decide the size, scaling and alignment of the background image. You can resize the distribution project window to check how your background image behaves in such cases.

  • It's best not to use a background image that contains text. Packages does not support localized background images.

  • If the custom image you specified can not be found, Packages will display a broken file in the left corner instead of the background image. Obviously, the build will fail too.

  • On macOS 10.10 and later, the background of the right view is opaque. On macOS 10.9 and earlier, it is translucent.

By default, the background image is the generic application icon on macOS version 10.9 and earlier, empty on 10.10 and later.

To set a custom background image:

1Choose Background from the Presentation inspector popup button.
2Choose Custom Background from the Show popup button.
3Choose Choose… from the Image popup button.
4Select the image you want to use.
5Click Choose.
6Choose the type of alignment for the image from the Alignment matrix.
7Choose the scaling mode for the image from the Scaling radion buttons.

To revert to the default background image:

1Choose Background from the Presentation inspector popup button.
2Choose Default Background from the Show popup button.


Customizing the Introduction message

The Introduction step is the first step visible to users when they install a distribution with Installer. This step displays a message that welcomes the user or provides information. The message can be localized. Packages lets you define which message you want to present to the user by providing a text file for each localization you need to support.

Distribution Introduction Message

Notes and recommendations:
  • The following formats are supported for the Introduction message: TEXT, RTF, RTFd and HTML.

  • The document format for all the localizations should be the same.

By default, there are no localizations for the Introduction message and the generic message will be used.

To use a custom localized message:

1Choose Introduction from the Presentation inspector popup button.
2Click the + button.
3Choose Choose… from the popup button in the third column of the new row.
4Select the text document you want to use.
5Click Choose.
6Choose the language from the language popup button.

To remove one or multiple localizations:

1Choose Introduction from the Presentation inspector popup button.
2Select the localizations you want to remove.
3Click the - button.
4Click Remove.


Customizing the Read Me message

The Read Me step is the second step visible to users when they install a distribution, if a Read Me message has been defined. Otherwise this step is not displayed. The message can be localized. Packages lets you define which message you want to present to the user by providing a text file for each localization you need to support.

Distribution Read Me Message

Notes and recommendations:
  • The following formats are supported for the Read Me message: TEXT, RTF, RTFd and HTML.

  • The document format for all the localizations should be the same.

  • The Read Me message can be printed or saved by users.

By default, there are no localizations for the Read Me message and so the step will not be shown to users.

To present a localized Read Me message:

1Choose Read Me from the Presentation inspector popup button.
2Click the + button.
3Choose Choose… from the popup button in the third column of the new row.
4Select the text document you want to use.
5Click Choose.
6Choose the language from the language popup button.

To remove one or multiple localizations:

1Choose Read Me from the Presentation inspector popup button.
2Select the localizations you want to remove.
3Click the - button.
4Click Remove.


Customizing the License agreement

The License step is the third step visible to users when they install a distribution, if a License agreement document has been defined. Otherwise this step is not displayed. The license agreement can be localized. Packages lets you define which License you want to present to the user by providing a text file for each localization you need to support. It also offers you a list of Open Source End User License Agreements to choose from.

Distribution License Document

Notes and recommendations:
  • The following formats are supported for the Read Me message: TEXT, RTF, RTFd and HTML.

  • The document format for all the localizations should be the same.

  • The License document can be printed or saved by users.

  • Do not use the Introduction, Read Me or Summary steps to display a End User License Agreement. The License step lets the user choose the language for the agreement (if multiple localizations are provided) and requires the user to accept the license before going to the next step. The other steps don't do that.

  • If you need to display multiple license agreements, consider using the EULA_Plugin Installer plugin.

By default, there are no localizations for the License document and so the step will not be shown to users.

To present a localized License document:

1Choose License from the Presentation inspector popup button.
2Choose Custom License from the popup button.
3Click the + button.
4Choose Choose… from the popup button in the third column of the new row.
5Select the text document you want to use.
6Click Choose.
7Choose the language from the language popup button.

To remove one or multiple localizations:

1Choose License from the Presentation inspector popup button.
2Select the localizations you want to remove.
3Click the - button.
4Click Remove.

To use a Open Source End User License Agreement provided by Packages:

1Choose License from the Presentation inspector popup button.
2Choose the License Template from the popup button.
3If needed, fill in the required values for the keywords.

You can create your own License Templates. To learn more about this, check the License Templates documentation in the Packages SDK.


Customizing the Summary message

The Summary message is the message that is displayed by Installer after the installation process ends successfully (or not). This step displays a message that informs the user about the result of the installation. The message can be localized. Packages lets you define which message you want to present to the user by providing a text file for each localization you need to support.

Distribution Summary Message

Notes and recommendations:
  • The following formats are supported for the Read Me message: TEXT, RTF, RTFd and HTML.

  • The document format for all the localizations should be the same.

  • This message is only displayed if the installation is successful. You can not provide a custom message for a failed installation.

By default, there are no localizations for the Summary message and the generic message will be used.

To use a custom localized message:

1Choose Summary from the Presentation inspector popup button.
2Click the + button.
3Choose Choose… from the popup button in the third column of the new row.
4Select the text document you want to use.
5Click Choose.
6Choose the language from the language popup button.

To remove one or multiple localizations:

1Choose Summary from the Presentation inspector popup button.
2Select the localizations you want to remove.
3Click the - button.
4Click Remove.


Adding Installer Plugins

Installer supports plugins that allows you to add steps. An additional step can for instance be used to request the user to enter the license key of the product to continue the installation process. Packages lets you add Installer plugins to a distribution.

Distribution Installer Plugins

Notes and recommendations:
  • Installer plugins are not supported in flat distributions on Mac OS X 10.5.x.

  • Installer plugins will not be run when the installation is made with the installer tool or Apple Remote Desktop application.

  • Creating an Installer plugin requires to use Xcode and have some Cocoa development knowledge.

  • An Installer plugin should include support for the ppc, i386 and x86_64 architectures.

  • You can find more information about Installer plugins development on the Installer plugins resources page.

To add an Installer plugin:

1Click the Plugins + button.
2Select the plugin you want to add.
3Click Add.

or:

Drag and drop the Installer plugin to the list of steps.

To change the position of an Installer plugin:

1Click the appropriate step in the list of Installation steps.
2Drag and drop the step to the appropriate location.

To remove an Installer plugin:

1Click the appropriate step in the list of Installation steps.
2Click the Plugins - button.
3Click Remove.




Revision History
05/16/10 First version

Copyright 2010-2017 Stéphane Sudre. All rights reserved.