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.

...

Name

Required

Description

Allowed Values

order

yes

Determine at what point of installation the antcalls defined by element target should be performed. Be aware that with beforepack(s) there are no installed files and also no installed build file. With this order only preexistent build files are useable.

beforepack, afterpack, beforepacks or afterpacks.

uninstall_order

no

Determine at what point of uninstallation the antcalls defined by element uninstall_target should be performed. As opposed to the behaviour of order the referenced files are also accessible in the order afterdeletion. The uninstaller action copies the files into tempfiles before deletion which are marked as deleteOnExit.

beforedeletion,afterdeletion

quiet

no

To quit or notWhether to log just warnings and errors, be quiet otherwise.
Maps to Ant log level "infowarning". 

yes or no, default: no

verbose

no

To output Whether to log verbose information or not.
Maps to Ant log level "verbose". 

yes or no, default: no

loglevelno

Straight Ant log priority level mapping to the according log levels in Ant projects.
The attributes verbose and quiet have higher priority, if they are used, and "win" over loglevel.
If none of the attributes, quiet, verbose nor loglevel is used, the Ant action log level default to "info".

error, warning, info, verbose, debug

logfile

no

Path to the file where logging should be performed. Note: The logfile should be not marked for uninstallation otherwise it will be deleted too.

Any valid file path (TODO: should verify format)

buildfile

yes, if buildresource not specified

Path to the file which contains the antcall. This is the file you normally use as -buildfile during an ant call via the command line. Variables are not substituted in this file. Variables should be set using ANT properties. Note: Never write an IzPack variable in an ant buildfile.

Any valid file path (TODO: should verify format)

buildresource

yes, if buildfile not specified

The value is the id of the resource which contains the antcall. This resource will be extracted out into a temporary file and the path to this file will be passed as if -buildfile were specified during the ant call via the command line. The temporary file is removed after the ant call. In this file variables are not substituted. For substitution there are properties in ant which can be used. Note: Never write an IzPack variable in an ant buildfile.

A resource id.

dirnoThe working directory for executing the Ant build in buildfile or buildresource. If set, it explicitly overrides the basedir set there and serves as base directory for relative path names accessed during the Ant build.Any valid directory path

messageid

no

If it is defined, the message will be displayed in the InstallPanel whilst performing the ant call.

A string ID which refers to bin/langpacks/installer/<lang>.xml.

conditionnoExecute this action only if the condition is fulfilled.A valid condition string.

...