Versions Compared

Key

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

...

<pack>

Attributes

Attribute

Usage

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

namedefines

the pack nameuser-friendly name that will be displayed during the installation

required

takes yes or no and 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

can be used so optional. indicates that the files are not located in the installer Jar. The possible values are true or false, the default being false. The author of this feature needed to put his application For example, your application could be distributed on a CD so that the users could run it directly from this media. However, he also wanted to offer them the possibility the CD. In order to install the software localy. Enabling this feature will locally without duplicating the files in a jar, you can set loose to "true" to make IzPack take the files on disk instead of the CD rather than from the installer jar. Please make sure that your relative files file paths are correct!

id

this attribute is used to give a unique id to the pack to be used for internationalization via packsLang.xml file

packImgId

this attribute is used to reference a unique resource that represents 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 fullfilled 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")

Especially notice, that 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

...

Attribute

Description

file

Relative path during at compile-time to an externally defined packs-definition

...

Attribute

Description

dir

Relative base directory during at compile-time for the refpackset

includes

Pattern of files in <refpack> format that have to will be included

Example:

Code Block
<refpackset dir="" includes="**/refpack.xml" />

...

In order to provide internationalization for the PacksPanel, so that your users can be presented with a different name and description for each language you support, you have to create a file named packsLang.xml_xyz where xyz is the ISO3 code of the language in lowercase. Please be aware that case is significant. This file has to be inserted in the resources section of ``  install.xml`` with xml with the id and src attributes set at to the name of the file. The format of these files is identical with to the distribution langpack files located at ``  $IZPACK_HOME/bin/langpacks/installer``installer. For the name of the panel you just use the pack id as the txt part of text id. For the description you use the pack id suffixed with .description.

...