Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Attribute

Usage

idunique id for the pack to be used for internationalization via packsLang.xml file

name

the user-friendly name that will be displayed during the installation

required

specifies whether the pack must be installed (yes) or is optional (no)

os

optional. Lets you make the pack targeted to a specific operating system, see OS Restrictions.

preselected

optional. Lets you choose whether the pack is selected for installation by default or not. Possible values are yes and no. A pack which is not preselected needs to be explicitly selected by the user during installation to get installed

loose

optional. Indicates that the files are not located in the installer Jar. The possible values are true or false, the default being false. For example, your application could be distributed on a CD so that the users could run it directly from the CD. In order to install the software locally without duplicating the files in a jar, you can set loose to "true" to make IzPack take the files on the CD rather than from the installer jar. Please make sure that your relative file paths are correct!

When using <packs loose="true"> in combination with <file unpack=true"> please be aware the relative path of the loosely coupled files is considered to be its path relative to the root entry of the archive it is extracted from. Thus you must extract the file to the desired location (for instance the CD root) before accessing it from the installer.

packImgId

optional. reference to a resource that defines the pack's image for the ImgPacksPanel. The resource should be defined in the <resources> element of the installation XML using the same value for the id attribute of the <res> element.

condition

optional. ID of a condition which has to be fulfilled to enable this package to be selected by the user. If the condition evaluates to false the package will be "greyed out" in the PacksPanel user view.

The condition interacts with required in the following way:


required: false
(default if not defined) 
required: true
condition: false

Pack is ...
preselected
: no
user interaction: no
disabled: yes
("not enabled")

Pack is ...
preselected
: no
user interaction: no
disabled: yes
("not enabled") 
condition: true
(default if not defined) 
Pack is ...
preselected
: yes
user interaction: yes
disabled: no
("optional")
Pack is ...
preselected: yes
user interaction: no
disabled: yes
("required")

Notice: if a package condition evaluates to false but it is marked required the pack remains unselected. Vice versa, a pack's required attribute forces the package to be selected just in case an optional pack condition isn't used or evaluates true.

hidden

optional. takes true or false and specifies whether the pack shall be shown in the packs panel. The size of a hidden pack will be used to calculate the required space, but the pack itself won't be shown. A hidden pack can be preselected or selected conditionally. For the latter, you have to specify a condition. The default for this attribute is false.

size

optional. Specifies the size of the pack, in bytes. If not specified, the size will default to the sum of all file lengths in the pack. Since 5.0

installGroupsoptional. A comma separated list of groups, see InstallationGroupPanel for using them.
uninstalloptional. If set "true", the according pack gets into the uninstaller's list of files to be uninstalled. This attribute has effect just in case of <uninstaller write="true"/>. Default: true

...