PATH Contents > Defining Installer Plugins
Defining Installer Plugins

This document describes how you can add steps or panes during the installation process of your project using Installer plugins.

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

About Installer Plugins

Installer plugins are Cocoa bundles located in the Contents/Plugins folder of the package or metapackage. They are loaded by Installer when your package or metapackage is being installed. An Installer plugin will be inserted as a new step of the installation process. This new step can be completed in one or more panes.

Installer plugins are only supported by Installer on Mac OS X 10.4 and later. The plugins won't be used on earlier versions of the OS or when installing a package with Apple Remote Desktop or the command line tool. So if for instance, you'd like to add a serialization step in your package, you still need to have code in your software to let the user serialize your product.

Important: Installer plugins need to be build as Universal Binaries to be properly loaded on both PowerPC and Intel based Macs.

Creating an Installer plugin

You can create an Installer Plugin with XCode and Interface Builder. You need to know how to code Objective-C and the Cocoa APIs.

Requirement: XCode 2.0 or later needs to be installed to create an Installer plugin project

1Open XCode.
2Choose File > New Project…
3Select the Apple Standard Plug-ins > Installer Plugin project template
4Click Next.
5Type the name of the project in the Project Name text field.
6Code your plugin.
7Build it.

Managing Installer Plugins

Iceberg lets you quickly add, remove or change the display order of an Installer plugin to your project.

To add an Installer plugin:

1Select the component in the Packages & Metapackages list.
2Choose View > Plugins.
3Click the + button.
4Select the plugins you want to add and click on Add.

Note: By default, the references are absolute path names. You can switch to relative path names using the local menu in the Reference column.

To remove an Installer plugin:

1Select the component in the Packages & Metapackages list.
2Choose View > Plugins.
3Select the pugins to be removed.
4Click the - button.
5Click Remove.

To enable or disable an Installer plugin:

1Select the component in the Packages & Metapackages list.
2Choose View > Plugins.
3Select the plugin.
4Select or unselect the checkbox in the MemberShip (•) column.

To change the display order of an Installer plugin:

1Select the component in the Packages & Metapackages list.
2Choose View > Plugins.
3Select the plugin.
4Drag and drop it to the new position.


Author: Stéphane Sudre