We need you!

Icon

The IzPack documentation needs work, and you are invited to edit it!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: minor simplification

...

Properties cannot be re-defined and once a property is created, it will not be overwritten, once there exists a property with the same key.

Using Properties

Properties can be explicitely set in the installer descriptor. Additionally, IzPack sets different kinds of built-in properties depending on how the compilation is launched

...

Explicit properties can be defined by the user using the <properties> tag in the installation description element as a child of the <installation> element.

Example:

Code Block
titleinstall.xml
languagehtml/xml
<properties>
  <property name="info.appName" value="My Application"/>
  <property name="info.appsubpath" value="my-company/my-app"/>
  <property name="info.url" value="http://www.my-company.com"/>
  <property name="info.company.name" value="My Company Name"/>
  <property name="info.company.email" value="info@my-company.com"/>
</properties>

...

When launching the compilation using the IzPack Maven plugin, there are automatically added all Maven project properties are available as available properties in IzPack.

Maven properties have priority over explicit properties, since they are set during instantiation of the IzPack compiler, before the IzPack compilation starts so they can not be replaced by later specifications from the <properties> element.

This behavior of defining implicit properties is similar than to setting implicit Ant project properties in IzPack 4.X.

...

Reading/Substituting Properties

IzPack properties can be accessed for reading referenced in the installation descriptor specification by a leading 'at' placeholder followed by the property name (for example @my.prop.name).

Optionally, when embedding property substitution into text which continues without a whitespace character, the key can be embedded in braces opening after the 'at' (for example @{my.prop.name}).

IzPack properties are substituted when there their definition can be is found in the installation descriptor XML inside of

...