Virtual Text Definitions
Previous Topic  Next Topic 

The following virtual text definitions are currently available in InstallJammer.  Anytime you see ?something? inside of a virtual text field, it means that that virtual text can or must have an argument passed to it.



<%AllowLanguageSelection%>

If true, the user will be prompted to select a language at the beginning of the install.


<%AppName%>

The name of the application as set during build time in the Application Information tab.


<%ApplicationID%>

A unique identifier for this application.  This ID is set when the install project is first created and never changes through the life of the project.  It can be used to identify previous installs of the same application on a target system, and InstallJammer uses it during uninstallation.


<%BuildVersion%>

The build version is the fourth value of the <%InstallVersion%>.


<%CancelledInstallAction%>

Contains the text describing the action InstallJammer will take if the install is cancelled mid-process.  This virtual text is defined under the Install Features in the Application Information tab.


<%CleanupCancelledInstall%>

Tells InstallJammer whether it needs to cleanup a cancelled install or not.


<%Company%>

The company name set during build time in the Application Information tab.


<%ConsoleMode%>

True if the install is currently being run in console mode.


<%CurrentAction%>

The ID of the current action being executed.


<%CurrentCondition%>

The ID of the current condition being executed.


<%CurrentObject%>

The ID of the current object being used in the system.  This can be a pane, action or condition.


<%CurrentPane%>

The Pane ID of the current pane displayed to the user.


<%Date ?dateFormat?%>

A formatted string of today's date based on <%DateFormat%>.  The Date virtual text can receive an optional argument of the format to use for the date.

Defaults to <%Date <%DateFormat%>%>


<%DateFormat%>

The default format to use for <%Date%> when no format argument is specified.

Defaults to %Y%m%d, which looks like 20051201.


<%Debugging%>

If true, InstallJammer will run in debugging mode.  Debug mode outputs debug messages to a log file and saves the temporary directory used during installation for later debugging.


<%DefaultLanguage%>

The default language if none is specified or if the user is not allowed to choose a language.


<%DefaultMode%>

True if the user selected to run in the install in Default mode.


<%Dir ?directory or filename? ?platform?%>

Take the given directory and normalize it so that it matches the format of the current platform.  On Windows this will use a \ as the path separator.  On UNIX, the path separator will be / and any drive lettering (C:, D:, etc...) will be stripped off.


If a second argument is specified, it can be one of the following: backslash, forwardslash, platform, unix or windows.  Backslash and forwardslash specifies which path separator to use but no other modifications are done to the directory.  Unix or Windows will behave as described above for the given platform.


<%Dirname ?directory or filename?%>

Given a directory or filename, return the parent directory.  Example: <%Dirname C:/foo/bar%> would return C:/foo.


<%DiskSpace ?disk space?%>

Returns a pretty text string describing the space in disk space.  Depending on the size, this will be N KB, N MB, or N GB where N is the size.


<%DOSName ?directory or filename?%>

Given a directory or filename, return the 8.3 short DOS name on Windows.  This will return something like C:/Progra~1/file by using the Windows native short name.


<%Env ?variable?%>

This will return the value of an environment variable if it exists.  <%Env PATH%> would return the user's current PATH variable.


<%ErrorDirs%> (set by Uninstall Selected Files)

If <%ErrorsOccurred%> is true, this virtual text may contain a list of directories that the uninstaller failed to remove.


<%ErrorFiles%> (set by Uninstall Selected Files)

If <%ErrorsOccurred%> is true, this virtual text may contain a list of files that the uninstaller failed to remove.


<%Errors%> (set by Uninstall Selected Files)

If <%ErrorsOccurred%> is true, this virtual text will contain a string representation of the errors that occurred during an uninstall.  This is usually displayed to the user in the uninstall details.


<%ErrorsOccurred%> (set by Uninstall Selected Files)

This is set during the Uninstall Selected Files action.  It will be false if no errors occurred during the uninstall, or it will be true if some error happened while doing the uninstall.


<%Ext%>

Return the executable extension for the current platform.  This is .exe on Windows and empty on UNIX.


<%ExtractSolidArchivesOnStartup%>

True if the developer has opted to extract any solid archives when the installer first starts.


<%FileBeingInstalled%>

The file currently being installed.  This is only valid during file installation.


<%FileBeingInstalledText%>

A pretty text describing the current file being installed.

Defaults to "Copying <%FileBeingInstalled%>"


<%FileGroup ?file group?%>

Given the name of a file group, return the full directory path for that file group.


<%GroupBeingInstalled%>

The name of the current file group being installed.  This is only valid during file installation.


<%GroupBeingInstalledText%>

A pretty text describing the current group being installed.

Defaults to "Installing <%GroupBeingInstalled%>"


<%GUID%>

Generates a new globally unique identifier (GUID).


<%GuiMode%>

True if the install is currently running in a mode that requires a GUI.


<%IncludeDebugging%>

Whether or not debugging options were included in this installer.


<%InstallDirSuffix%>

If this virtual text variable exists in your project, its value will automatically be appended to the <%InstallDir%> anytime it is changed if the <%InstallDir%>'s tail directory does not already match the value.  So, if InstallDirSuffix were set to <%AppName%>, for example, the installer would always append the name of your application to the installation directory path no matter where the user chooses to install, unless the InstallDir already has <%AppName%> at the end.


<%InstallDrive%>

This Windows-only virtual text holds the drive letter that the installation is targeted for.  So, if <%InstallDir%> is C:/install, <%InstallDrive%> would be C:.  This virtual text is automatically updated anytime the <%InstallDir%> value is changed.


<%InstallFinished%>

Whether or not InstallJammer completed the file installation.  This is only true if file installation was begun and completed without the user cancelling.


<%InstallHasSolidArchives%>

True if the installer has any solid archives.


<%InstallID%>

A unique identifier for this instance of the running installer.  This ID is set when the installer first starts up, and a new one is generated every time the installer is run.


<%InstallMode%>

The current mode of installation chosen by the user.  Can be: Console, Default, Silent or Standard.


<%InstallPassword%>

This virtual text is used, by default, in the Install Password pane of most themes.  It is empty by default, and will contain a password if the user enters one.  This is usually matched against the <%InstallPasswordEncrypted%> virtual text to see if the password is correct.


<%InstallPasswordEncrypted%>

If the project was defined with an install password for the installer, this virtual text will contain the encrypted form of that password.  The plain-text form of the install password is never stored in the installer itself.  This virtual text is usually compared against a password the user enters using the Password Test Condition to see if they match.


<%InstallPercentComplete%>

The current percentage complete of the file installation.  This is only valid during file installation.


<%InstallRegistryInfo%>

If this virtual text is set to false in your project, InstallJammer will not attempt to create a registry directory separate from your installation to hold its install information.  Instead, all of the install information will be stored inside the uninstaller so that it can properly uninstall.


<%InstallSource%>

The full path to the source directory the installation executable was started from.


<%InstallStarted%>

True if the file installation portion of the install was started, whether it completed or not.


<%InstallStopped%>

True if the user cancelled the file installation before it had a chance to complete.


<%InstallType%>

The setup type of installation the user has chosen to install. If the user is not given the option to select a setup type, or that pane has not been shown yet, this variable will default to the Default Setup Type set during build time.


<%InstallVersion%>

The install version of your application.  This version is represented as X.X.X.X and is also used by InstallJammer when determining whether to install files based on version numbers.


<%Installer%>

The full path to the installation executable when it was started.


<%InstallerID%>

A unique identifier for this installer.  This ID is set when the installer is built and remains the same no matter how many times the install is run.  This ID changes with each build of an installer.


<%Installing%>

True if the file installation is currently in progress.


<%Language%>

The current language of the installer as expressed as a language code, an optional country code, and an optional system-specific code, each separated by _.  The country and language code are specified in standards ISO-639 and ISO-3166.  For example, the locale "en" specified English, and "en_US" specifies U.S. english.


<%LastGUID%>

Contains the value of the last GUID generated by using the <%GUID%> virtual text.


<%LastUUID%>

Contains the value of the last UUID generated by using the <%UUID%> virtual text.


<%LicenseAccepted%>

True if the user has seen and accepted the license agreement for the application.


<%MajorVersion%>

The major version is the first value of the <%InstallVersion%>.


<%MinorVersion%>

The minor version is the second value of the <%InstallVersion%>.


<%PackageDescription%>

The package description defined in the project.


<%PackageLicense%>

The package license defined in the project.


<%PackageMaintainer%>

The package maintainer defined in the project.


<%PackageName%>

The package name defined in the project.


<%PackagePackager%>

The package packager defined in the project.


<%PackageRelease%>

The package release version defined in the project.


<%PackageSummary%>

The package summary defined in the project.


<%PackageVersion%>

The package version defined in the project.


<%PatchVersion%>

The patch version is the third value of the <%InstallVersion%>.


<%PathSeparator%>

The character used to separate paths in variables on the target system.  This is ; for Windows and : for UNIX.


<%Platform%>

The name of the current platform being installed. This variable only exists during installation time.


<%ProgramExecutable%>

If specified by the user during build time, this variable contains the path to the executable that will start the installed program upon completion of installation.


<%ProgramFolderName%>

The name of the Program Folder the user has chosen. If the user is not given the option to select the program folder, or that pane has not been shown yet, this variable will default to the Default Program Folder set during build time.


<%ProgramLicense%>

The location of the application's LICENSE file as specified in the project.


<%ProgramReadme%>

The location of the application's README file as specified in the project.


<%PromptForRoot%>

True if the developer has opted to prompt for the root password when a root password is required to run the (un)install.


<%Property ?object? ?property?%>

This will return the value of a property on a given object.  If object is specified, the property value for that object will be returned.  If no object is specified, the property will be returned for the currently-active object.  This can be whatever action or condition is currently being executed.


<%RealUsername%>

The name of the real user running the install.  If the user is running as root (through su or sudo), the <%Username%> will show root instead of the real user name.  This value always reflects the real user.


<%RegValue ?registry key? ?value?%>

The current value of a registry key on Windows.  If only a key is passed, the default value for that key will be returned.  If value is passed, that value within the specified key will be returned.


<%RequireRoot%>

True if the (un)installer requires root to run.


<%RunningInstaller%>

True if the currently-running program is the installer.


<%RunningUninstaller%>

True if the currently-running program is the uninstaller.


<%ScriptExt%>

This is the file extension for common script on each platform.  This is set to .bat on Windows and .sh on UNIX platforms.


<%SelectedComponents%>

A list of components that are currently selected for installation.  This should be treated as a Tcl list.


<%SelectedFileGroups%>

A list of file groups that are currently selected for installation.  This should be treated as a Tcl list.


<%ShortAppName%>

A shortened version of your application name.  This is usually used on UNIX systems as a directory for your application, so it should usually be all lowercase and contain no spaces.


<%ShowConsole%>

If true, InstallJammer will show a debugging console on startup.


<%SilentMode%>

True if the user selected to run the install in Silent mode.


<%SolidArchivesExtracted%>

True if the installer has any solid archives that have been extracted already.


<%SpaceAvailable ?directory?%>

Returns the disk space available on the current drive.  If directory is specified, returns the disk space available for that drive.


<%SpaceAvailableText%>

Returns a pretty text description of the disk space available on the current drive.

Equivalent to <%DiskSpace <%SpaceAvailable%>%>.


<%SpaceRequired%>

The current amount of space required on the target system to install the selected components.


<%SpaceRequiredText%>

A pretty text describing the amount of space required to install.

Equivalent to <%DiskSpace <%SpaceRequired%>%>.


<%Status%>

This variable is used as the current status of what InstallJammer is doing.  During file installation, this is usually set to <%FileBeingInstalledText%>, but it can reflect many other actions InstallJammer is taking.


<%Tail ?directory or filename?%>

Given a directory or filename, return the tail end of the path.  Example:  <%Tail C:/foo/bar%> would return bar.


<%Testing%>

If true, InstallJammer will run in test mode which means no files will be installed or uninstalled.  This does not stop other actions that create shortcuts, etc...


<%UninstallMode%>

The current uninstall mode: Console, Silent or Standard.


<%UninstallPercentComplete%>

The current percentage complete of the file uninstallation.  This is only valid during uninstall.


<%UpgradeApplicationID%>

The Upgrade Application ID specified by the developer.


<%UpgradeInstall%>

If Upgrade Application ID is not null, this value will be true, telling InstallJammer that this is an upgrade install and certain actions should not be performed.


<%UserIsRoot%>

True if the user currently installing is root.


<%UserMovedBack%>

True if the user has reached the current pane by clicking the Back button.


<%UserMovedNext%>

True if the user has reached the current pane by clicking the Next button.


<%Username%>

The username of the current system user executing the install.  If the user is currently root, this value will show 'root'.  If you want to know the user who is currently running as root, you can use <%RealUsername%>


<%Version%>

The version set during build time in the Application Information tab.


<%WindowsPlatform%>

A string specifying the exact version of Windows currently being installed on.  Possible versions are: Win95, Win98, WinNT, WinME, Win2k, WinXP, Win2003, Vista, and Windows7.


<%WizardCancelled%>

True if the wizard started and the user cancelled the wizard before it completed.


<%WizardFinished%>

True if the wizard was started and actually completed successfully without the user cancelling.


<%WizardFirstStep%>

True if the pane currently displayed is the first step of the wizard.


<%WizardLastStep%>

True if the pane currently displayed is the last step of the wizard.


<%WizardStarted%>

True if the wizard started up successfully.  This virtual text will always be false for silent and console installs since no wizard is ever started.