The specification for application shortcuts is provided to the Shortcut Panel in the XML file format. The root element is
<shortcuts>. It should be added to the
<resources> section with the ID
<res id="shortcutSpec.xml" src="my-installer-files/shortcutSpec.xml/>
<defaultCurrentUser/> tags has no attributes or content. Makes create shortcut for: current user the default selection on the Shortcut Panel. If not specified, then all users will be the default selection (if available).
<skipIfNotSupported/> tag has no attributes or content. It suppresses the default behavior on systems not supported by Shortcut Panel, forcing the installer to completely skip the display of Shortcut Panel. (The default behavior is to show an alternative UI, which displays the shortcut information that would have been created on a supported system.)
<notSupported/> tag has no attributes or content. Allows you to review what an end user would see if the target operating system is not supported by forcing the Shortcut Panel to behave as though running on an unsupported system.
This tag is for testing purposes only. Be sure to remove this tag before preparing your installer for production.
<lateShortcutInstall/> tag has no attributes or content. Delays the creation of shortcuts until after all packs have been installed (instead of creating shortcuts as soon as 'Next' is clicked). Specify this if you want to show ShortcutPanel before InstallPanel.
Allows you to specify the name of the menu, or more precisely the folder, in which the shortcuts will be grouped. The exact location and appearance of the program group depends on the specific target system on which the application will be installed. This can be partially controlled by the
|defaultName||Specifies the name that the group menu should have on the target system. You should be aware that the Shortcut Panel will present this name to the user as a choice. The user can then edit this name, or select a group that already exists.||No, but recommended; default is blank.|
Specifies where the group menu should be displayed in the desktop menu. There are two choices:
On Unix-based systems, the
|No; default is |
|installGroup||When using the Installation Group Panel, multiple ||No.|
If more than one instance of
<programGroup> is specified without the use of the Installation Group Panel and the
installGroup parameter, only the first one will be used - all other
<programGroup> tags will be ignored.
For each shortcut you want to create, you have to add one
<shortcut> tag. The attributes can be divided into two groups:
- attributes that describe properties of the shortcut
- attributes that define the location(s) at which a copy of the shortcut should be placed.
The attributes listed in this table are mostly common to all platforms, but some are not valid or sensible on all operating systems. These cases are noted. Additional, OS-specific attributes, are listed below.
|name||The 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|
The application that should be launched when the shortcut is clicked. The value is translated through the variable substitutor, so variables such as
|commandLine||Specifies command line arguments to pass to the ||No|
|workingDirectory||Defines 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 ||No|
|description||The 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|
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
See Shortcut Tips on shortcut icons.
|iconIndex||If 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|
If the target operating system supports this feature, then this value will set the initial window state of the application. Valid options are:
No; default is
|programGroup||If the value is ||At least one location attribute is required, as all default to |
|desktop||If the value is |
|applications||If the value is |
|startMenu||If the value is |
|startup||If the value is |
|subgroup||Specifies 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 |
|condition||Specifies 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|
These attributes apply only to Unix-based systems (including Linux).
Specifies the type of shortcut. Valid values are:
|url||Specifies a locally installed HTML file, other file with a known MIME type (e.g. plain text), or a WWW URL (e.g. ||Yes, if |
Specifies the MIME type for links pointing to local files when using
|No; recommended if |
|encoding||This should always set to ||Yes|
|terminal||Set to ||No; defaults to |
Specifies attributes for terminal windows when
|KdeSubstUID||This is the sudo option for a shortcut. If set to |
No; defaults to
|KdeUsername||The username with correct sudo permissions where ||No; defaults to |
|createForAll||If a user with administrative rights, such as root, performs the installation, set to ||No; defaults to |
The category in the Desktop Application Menu where the shortcut will be placed. Here are some sample categories and their apps. For more examples, examine the desktop files in
|No; no default.|
|tryexec||Specifies a command to pass through 'raw' to the operating system.||No; default is to use |
These attributes apply only to Windows-based systems.
Determines if the target of the shortcut should be run with administrator privileges
|No; defaults to |
This is an optional nested element, with one required attribute,
name, specifying the name of a pack that must be selected for this shortcut to be created. Multiple
<createForPack> elements can be nested in the same
<createForPack name="Pack 1" /> <createForPack name="Pack 2"/>