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: Removed reference to $INSTALL_PATH in <variables> example for IZPACK-696 to avoid confusion

...

This element allows you to define variables for the variables substitution system. Some variables are built-in, such as $INSTALL_PATH (which is the installation path chosen by the user). When you define a set of variables, you just have to place as many <variable> tags in the file as needed. If you define a variable named VERSION you need to type $VERSION in the files to parse. The variable substitutor will then replace it with the correct value. One<variable> tag take the following attributes :

  • name : the variable name
  • value : the variable value

Here's a sample <variables> section :

 

Code Block
languagehtml/xml
<variables>
  <variable name="app-version" value="1.4"/>
  <variable name="released-on" value="08/03/2002"/>
</variables>

Here's a precise sample on how to use desktopshortcutcheckboxenabled and InstallerFrame.logfilePath variables:

 

Code Block
languagehtml/xml
<variables>
  <variable name="InstallerFrame.logfilePath" value="$INSTALL_PATH/My-install.log"/>
  <!-- This means that the log name will be My-install and that it will be stored at the root of the installation. -->
  <!-- Any path is fine. If value is set to "Default" then "$INSTALL_PATH/uninstall/install.log" is used. -->
  <!-- And if variable isn't defined then no log is written. -->
  <variable name="desktopshortcutcheckboxenabled" value="true"/>
  <!-- This automatically checks the "Create Desktop Shortcuts" button. Default value is "False". -->
</variables>

Types of Variables

Static variables

...