Versions Compared

Key

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

...

$INSTALL_PATH is treated as the base path for include/exclude patterns with relative paths.

<parsable> -

...

Mark Text Files For Parsing / Substituting Variables

Pack files marked <parsable> are parsed after installation and may have variables substituted.copying them to the target system and substitute IzPack variables. Those variables can be defined in a syntax according to their file format, the default for plain files is ${<variable_name>} or $variable_name.

Files must be first added to the pack using <singlefile>, <file> or <fileset> before they can be marked parsable.

...

Attributes

...

Attribute

Description

Required

Values
(Default)

targetfile

the file to parse, could be something like $INSTALL_PATH/bin/launch-script.sh A slash will be changed to the system dependant path separator (e.g. to a backslash on Windows) only if no backslash masks the slash.

yes

 

type specifies

Specifies the text file type (same as for the resources) - the default is plain

encoding

specifies the file encoding

os

specifies the operating system.

no

"plain" | "javaprop" (Properties) | "xml" | "java" | "shell" | "at" | "ant" (Ant buildfile)
("plain")

encoding

The file encoding

no

A valid Java encoding string
("ISO-8859-1" for type="javaprop",
"UTF-8" for type="xml", otherwise the Java default charset is assumed as encoding)

os

Limits this action on a particular OS, works like for <file>

no

 

condition an

id of a condition Limits this action on a particular condition with the specified ID which has to be fullfilled to parse this file fulfilled

no

 

...

Nested Elements

...

The nested <os> element is supported.

<executable> - mark file as executable and optionally execute it

The <executable> tag is a very useful thing if you need to execute something during the installation process. It can also be used to set the executable flag on Unix-like systems. Here are the attributes:

...

Attributes

...

Attribute

Description

Required

Values
(Default)

targetfile

the file to run, could be something like $INSTALL_PATH/bin/launch-script.sh Slashes are handled special (see attribute targetfile of tag <parsable>).

yes

A previously added pack file path

type

bin or jar (the default is bin)

no

"bin" | "jar"
("bin")

class

If the executable is a jar file, this is the class to run for a Java program

type

bin or jar (the default is bin) no

A valid Java class within the jar file

stage

specifies Specifies at which stage when to launch the executable:

  • never (default)
    will never launch it (useful to set the +x flag on Unix)
  • postinstall is
    just after the installation is done
  • uninstall will launch the executable
    when the application is uninstalled. The executable is executed before any files are deleted.

no

"never" | "postinstall" | "uninstall"
("never")

failure

specifies what to do when an error occurs:

  • ask (default) will ask the user what to do
  • abort will abort the installation process
  • warn will just tell the user that something is wrong
  • ignore don't tell the user, just continue

no

"ask" | "abort" | "warn" | "ignore"
("ask")

os

specifies the operating system, works like for <file>

no


keep

takes true or false (default for backward compatibility). specifies whether Whether the file will be kept after execution .

no

"true" | "false"
("false")

condition

an id ID of a condition which has to be fullfilled fulfilled to execute this file

no

A valid condition ID

...

Nested Elements

...

Takes an <args> tag to pass one or more arguments (one <arg> tag per argument) to the executable.
<arg> passes the argument specified in the value attribute. Slashes are handled special (see attribute targetfile of tag <parsable>.

The nested <os> element is supported.

Anchor
os-element
os-element

...

This enables a model in which a single developer is responsible for maintaining the packs and resources (e.g. separate packsLang.xml_xyz files providing internationalization; see Internationalization of the PacksPanel) related to the development-package assigned to him. The main install XML references these xml-files to avoid synchronization efforts between the central installation XML and the developer-maintained installer XMLs.

Attributes

Attribute

Description

file

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

...

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 the id and src attributes set at the name of the file. The format of these files is identical with the distribution langpack files located at `` $IZPACK_HOME/bin/langpacks/installer``. For the name of the panel you just use the pack id as the txt id. For the description you use the pack id suffixed with .description.

An exampleExample:

Code Block
xml
xml
<resources>
    <res id="packsLang.xml_eng" src="i18n/myPacksLang.xml_eng"/>
</resources>

The packsLang.xml_eng file:

Code Block
xml
xml
<langpack>

...


    <str id="myApplication" txt="Main Application"/>

...


    <str id="myApplication.description" txt="A description of my main application"/>

...


</langpack>