X-Setup Wizards (*.xwz)

For general information about Wizards, please see the original X-Setup documentation. We assume that you have read this information.

A Wizard is basically a collection of plug-ins that are displayed and executed one after another. Therefore, the Wizard file does not contain any code, just a list of plug-ins X-Setup should execute. Because creating this file is so easy, a text editor like Notepad.EXE is enough to create.

 

Here's an example (a template is provided in the \templates directory of the SDK):

"FILE"="Xteq Systems X-Setup Wizard 4.0"
"UIPATH"="Login/Logoff"
"NAME"="Windows NT Wizard"
"AUTHOR"="Xteq Systems"
"COPYRIGHT"="Copyright © Xteq Systems - All Rights Reserved"
"COMMENT 1"="For more information, go to http://www.xteq.com or write to TeXHeX@xteq.com."
"COMMENT 2"="Version 1.1"
"WELCOME 1"="This wizard allows you to change settings that are related to the startup- (aka Booting) or ending-process."
"WELCOME 2"="Please note that these settings only apply if you are using Windows NT!"
"WELCOME 3"="It you have any other OS, you should close this wizard now."
"PLUGIN 1"="XQ Startup Ex 1.xpl" 
"PLUGIN 2"="XQ WinNT Popup Options 1.xpl"

 

 

FILE

FILE= is the indicator for X-Setup and has to look exactly as shown.

UIPATH, NAME

UIPATH is the path that will be shown in the X-Setup UI, sub-entries can be created by using "\". For example, setting UIPATH to "Test\My Wizard\System" will result in a menu titled "Test" to be created, with a sub-menu "My Wizard" and this will have yet another sub-menu titled "System". NAME is the name of the Wizard (also shown in the UI).

AUTHOR, COPYRIGHT, COMMENT, WELCOME

AUTHOR, COPYRIGHT, COMMENT x, WELCOME x are additional information about the Wizard to help the user understanding what your Wizard does.

PLUGIN x

The plug-ins that should be included in the Wizard are set using the  command. X-Setup will first execute PLUGIN 1, then PLUGIN 2 and so on. To avoid confusion, you should take care in which order the plug-ins are executed. Group similar plug-ins if possible, so they are displayed one after another.

 

Deploy

To deploy your Wizard, simply copy the file (*.XWZ) to the \Wizards directory of the existing X-Setup installation. If you are using non-standard plug-ins note that you need to deploy them also!

 

Test it

To test your wizard, simply copy it to your \Wizard directory, select "File" -> "Refresh all" in X-Setup and start it. X-Setup will display a nice error-box if something is wrong.