Previous | Next | Up | Table of Contents

7. Active Help API

The Help button on installers created with IPF provides web-based context sensitive help. By default the URL associcated to the Help button is 'http://help.ioncube.com/ipf/index.php', but any web page can be used by setting the active-help-url option.

Several GET paramaters are used to control the content displayed to the user. The possible parameters are listed below.

page

The page parameter is set according to the page on which the user clicks the Help button. Possible values for this parameter are:

  • intro
  • license
  • introfile
  • localremote
  • loc
  • ftp
  • http
  • review
  • actions
  • done
  • configure

version

This parameter is set to the version of IPF used to create the installer, for example 3.0.0.

type

This parameter can take values 'local' or 'remote', according to whether the user is performing a local or remote install.

locale

This parameter is the language and country code of the system locale on the user's machine, for example en_GB.

introfile

This parameter is 1 or 0 according to whether the installer has an intro file or not.

license

This parameter is 1 or 0 according to whether the installer has a license file or not.

ftp_host

If the user clicked Help on the HTTP settings page then this parameter will be set to the FTP host name which the user entered on the FTP settings page.

ftp_dir

If the user clicked Help on the HTTP settings page then this parameter will be set to the FTP install directory which the user entered on the FTP settings page.