Skip to main content

Navigation

Key name: Navigation
Element type: Dictionnary
Status: Optional

Lets you customize some properties relative to the navigation view. This view is at the bottom of the window and displays the navigation buttons. The last slide will display a Quit button instead of the Next button. This Quit button will terminate the app. It will quit the app only if all the mandatory monitors specified in the monitors are installed and if the current slide is valid.

Keys

NameTypeRequired
IsHiddenBoolean
PreviousButtonTextString
NextButtonTextString
PreviousButtonTextColorString
NextButtonTextColorString
QuitButtonTextString
InstallationIncompleteQuitTextString
UserCanQuitIfInstallationIsIncompleteBoolean
MandatoryFilesMissingQuitTextString

Detail

IsHidden

Type: Boolean
Explanation: If set to true, the navigation view will be hidden (useful when displaying one slide in full screen for example). Default is false.

PreviousButtonText

Type: String
Explanation: Text displayed for the "Previous" button (left).

NextButtonText

Type: String
Explanation: Text displayed for the "Next" button (right).

PreviousButtonTextColor

Type: String
Explanation: The text color of the "Previous" button (left).

NextButtonTextColor

Type: String
Explanation: The text color of the "Next" button (right).

QuitButtonText

Type: String
Explanation: Let you customize the text of the "Quit" button which appears on the last slide.

InstallationIncompleteQuitText

Type: String
Explanation: Displayed text in an alert when the user clicks the "Quit" button while all mandatory applications/packages are not installed.

UserCanQuitIfInstallationIsIncomplete

Type: Boolean
Explanation: If set to true, this key allows the user to quit the app with the "Quit" Button or the Quit shortcut even if all mandatory applications/packages are not installed. Default is false.

info

If the user closes the Octory window (using the title bar close button), the behavior you specified is ignored and the app is terminated with no conditions. To avoid that, checkout IsClosable key in Window.

MandatoryFilesMissingQuitText

Type: String
Explanation: Displayed text in an alert when the user clicks the "Quit" button while all mandatory files are not present on the device.

Example

The following hide the navigation view while enabling user to quit even if not all mandatory monitors are installed.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<!-- ... -->
<key>Navigation</key>
<dict>
<key>IsHidden</key>
<true/>
<key>UserCanQuitIfInstallationIsIncomplete</key>
<true/>
</dict>
<!-- ... -->
</dict>
</plist>