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.

...

AttributeDescriptionRequired
nameThe name that the shortcut will have. This is the text that makes up the menu name if the shortcut is placed in a menu or the caption that is displayed with the shortcut if it is placed on the desktop.Yes
target

The application that should be launched when the shortcut is clicked. The value is translated through the variable substitutor, so variables such as $INSTALL_PATH can be used in the path.

Note

 Use of this attribute may change once other operating systems are supported.

Yes
commandLineSpecifies command line arguments to pass to the target through the shortcut. Command line arguments are not supported by all operating systems. As a result, your applications will not be portable if they depend on command line arguments. Instead, consider using system properties or configuration files. See Shortcut Tips on command line arguments.No
workingDirectoryDefines the working directory for the application at the time it is launched. Exercise caution in relying on this too heavily if your application should be portable, since this might not be supported by all operating systems. The value is translated through the variable substitutor, so variables such as $INSTALL_PATH can be used to describe the directory.No
descriptionThe value of this attribute will be visible to the user when a brief description about associated application is requested. The form of the request and the way in which this description is displayed varies between operating systems. On Windows, the description is shown as a tool tip when the mouse cursor hovers over the icon for a few seconds. On some operating systems this feature might not be supported.No
iconFile

A file that holds the icon that should be displayed as a symbol for this shortcut. This value is translated through the variable substitutor, so variables such as $INSTALL_PATH can be used. If this attribute is omitted, no icon will be specified for the shortcut. Usually this causes the OS to display an OS-supplied default icon.

Note

 Use of this attribute may change once other operating systems are supported. 

See Shortcut Tips on shortcut icons.

No
iconIndexIf the file type for the icon supports multiple icons in one file, then this attribute may be used to specify the correct index for the icon. In file formats that do not support multiple icons, this value is ignored. This is only likely to be useful for Windows shortcuts, if the icon is in a multiple-icon ICO, or embedded in a DLL or EXE file. See Shortcut Tips on shortcut icons.No
initialState

If the target operating system supports this feature, then this value will set the initial window state of the application. Valid options are:

  • normal
  • minimized (not valid on Unix
  • maximized (not valid on Unix)
  • noShow(not valid on Unix)

The noShow option is particularly useful when launching batch scripts on Windows, as no command window will be visible with this option. For instance, a shortcut to a batch file that launches a Java application has the less-than-pretty side effect that two windows show: the DOS command prompt and the Java application window. Even if the shortcut is configured to show minimized, there will be buttons for both windows in the task bar. Using noShow will completely eliminate this effect, only the Java application window will be visible.

No; default is normal

programGroupIf the value is true, then a copy of this shortcut will be placed in the group menu (see programGroup). On Unix (KDE) this will always be placed on the top level.At least one location attribute is required, as all default to false. If no location attribute is true, the shortcut will not be displayed anywhere. If multiple locations attributes are true, a copy of the shortcut will be displayed in all of those locations.




desktopIf the value is true, then a copy of the shortcut is placed on the desktop. On Unix the shortcuts will only be placed on the KDE desktop of the user currently running the installer. For Gnome the user can simply copy the .desktop files from */Desktop to /gnome-desktop.
applicationsIf the value is true, then a copy of the shortcut is placed in the applications menu (if the target operating system supports this). This is the same location as the applications choice for the programGroup element. Setting applications="true" is equivalent to setting programGroup="true" on Unix.
startMenuIf the value is true, then a copy of the shortcut is placed directly in the top most menu that is available for placing application shortcuts. This is not supported on Unix.  
startupIf the value is true, then a copy of the shortcut is placed in a location where all applications get automatically started at OS launch time, if this is available on the target OS. This is not supported on Unix.
subgroupSpecifies a sub-path (i.e. a sub-folder) of the main program group in which this shortcut will be placed. This is not supported on Unix.No; has no effect unless programGroup is true.
conditionSpecifies the name of an installer condition that must evaluate to true for this shortcut to be created. If the condition does not exist, the shortcut is created.No

...

The runAsAdministrator flag will be available in

(since 5.0.0-rc1)

 

 

AttributeDescriptionRequired
runAsAdministrator

Determines if the target of the shortcut should be run with administrator privileges

Warning
No; defaults to false.

 

createForPack

...