Shortcut Specification
The specification for application shortcuts is provided to the Shortcut Panel in the XML file format. The root element is <shortcuts>.
Nested Elements
defaultCurrentUser
The <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
The <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
The <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.
programGroup
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 location
parameter.
Attribute | Description | Required |
---|---|---|
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. |
location | Specifies where the group menu should be displayed in the desktop menu. There are two choices:
On Unix-based systems, the | No; default is applications . |
installGroup | When using the Installation Group Panel, multiple programGroup elements can be specified, each defining this attribute with the name of the applicable installation group. A custom programGroup can be defined for each installation group, but Shortcut Panel will still only create one progam group folder. If no programGroup spec has an installGroup attribute matching the selected installation group name, the first defined programGroup will be used. If multiple programGroup tags with the same installGroup attribute are defined, the first will be used and all others ignored. | 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.
shortcut
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 on Unix. Additional, Unix-specific attributes, are listed separately.
Attribute | Description | Required |
---|---|---|
Unix-specific attributes
These attributes apply only to Unix-based systems (including Linux).
Attribute | Description | Required |
---|---|---|
createForPack
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 <shortcut>
.
<createForPack name="Pack 1" /> <createForPack name="Pack 2"/>