From 6f6bb7810af82c22cfa968dc25141ed53efcdbae Mon Sep 17 00:00:00 2001
From: joostverburg
This new interface also features new pages (Welcome, Finish, -Start Menu) and a description area on the components page. The -interface and the graphics can be customized using the provided -settings.
+Start Menu) and a description area on the components page.Using the Modern UI macros and language files, writing scripts -with a modern interface is easy. This document contains information -about writing Modern UI scripts and a reference of all +with a modern interface is easy. This document contains all +information about writing Modern UI scripts and a reference of all settings.
-Important: Because the Modern UI has its own -macro system, its own default settings and a lot of new features, -the interface configuration works differently. So you should not -use commands like LicenseText, Icon, CheckBitmap, InstallColors -etc.
+Please be aware that the Modern UI interface settings are +different compared to the classic interface. This means that you +should not use settings like LicenseText, Icon, CheckBitmap, +InstallColors etc. but the ones that are documented here.
The Modern UI has a macro system, so all the code to control the interface has already been written for you.
If you want to start a new Modern UI script or upgrade an older script with the Classic UI, follow the steps below.
-Taking a look at the example scripts +
Taking a look at the example scripts will also help you to learn more about the Modern UI.
MUI_HEADERIMAGE
Display an image on the header of the page.
MUI_HEADERIMAGE_BITMAP bmp_file
Bitmap image to display on the header of installers pages
(recommended size: 150x57 pixels).
Default: ${NSISDIR}\Contrib\Graphics\Header\nsis.bmp
MUI_HEADERIMAGE_BITMAP_NOSTRETCH
Do not stretch the installer header bitmap to fit the size of the
field. Use this option only if you have an image that does not use
@@ -291,7 +293,7 @@ be different if the user has a custom DPI setting.
MUI_HEADERIMAGE_BITMAP_RTL_NOSTRETCH
Do not stretch the installer header bitmap when using a RTL
language to fit the size of the field. Use this option only if you
@@ -306,7 +308,7 @@ custom DPI setting.
MUI_HEADERIMAGE_UNBITMAP_NOSTRETCH
Do not stretch the uninstaller header bitmap to fit the size of the
field. Use this option only if you have an image that does not use
@@ -318,7 +320,7 @@ be different if the user has a custom DPI setting.
MUI_HEADERIMAGE_UNBITMAP_RTL_NOSTRETCH
Do not stretch the uninstaller header bitmap when using a RTL
language to fit the size of the field. Use this option only if you
@@ -384,7 +386,7 @@ Interface Settings
Bitmap for the Welcome page and the Finish page (recommended size:
164x314 pixels).
Default: ${NSISDIR}\Contrib\Graphics\Wizard\win.bmp
MUI_WELCOMEFINISHPAGE_BITMAP_NOSTRETCH
Do not stretch the bitmap for the Welcome and Finish page to fit
the size of the field. Use this option only if you have an image
@@ -415,7 +417,7 @@ Welcome/Finish Page Settings
Bitmap for the Welcome page and the Finish page (recommended size:
164x314 pixels).
Default: ${NSISDIR}\Contrib\Graphics\Wizard\win.bmp
MUI_UNWELCOMEFINISHPAGE_BITMAP_NOSTRETCH
Do not stretch the bitmap for the Welcome and Finish page to fit
the size of the field. Use this option only if you have an image
@@ -509,7 +511,7 @@ Settings
MUI_ABORTWARNING
Show a message box with a warning when the user wants to close the
installer.
MUI_ABORTWARNING_TEXT text
Text to display on the abort warning messagebox.
MUI_UNABORTWARNING
Show a message box with a warning when the user wants to close the
uninstaller.
MUI_UNABORTWARNING_TEXT text
Text to display on the abort warning messagebox.
Page Settings apply to a single page and should be set before -inserting a page macro. If you have multiple pages of one type and -you want to set a setting for all them, put the setting before each -page macro. Example:
+Page settings apply to a single page and should be set before +inserting a page macro. You have to repeat the setting if you +want it to apply to multiple pages. Example:
;Add a directory page to let the user specify a plug-ins folder ;Store the folder in $PLUGINS_FOLDER @@ -630,7 +631,7 @@ Text to display on the 'I Agree' button.MUI_LICENSEPAGE_CHECKBOX
-
Display a checkbox the user has to check to agree with the license terms.+MUI_LICENSEPAGE_CHECKBOX_TEXT text
Text to display next to the checkbox to agree with the license @@ -639,7 +640,7 @@ terms.MUI_LICENSEPAGE_RADIOBUTTONS
-
Display two radio buttons to allow the user to choose between accepting the license terms or not.+MUI_LICENSEPAGE_RADIOBUTTONS_TEXT_ACCEPT text
Application which the user can select to run using a checkbox. You don't need to put quotes around the filename when it contains spaces. -
Text to display next to the checkbox to accept the license @@ -792,7 +793,7 @@ Text to display next to the 'Reboot later' option button.+MUI_FINISHPAGE_RUN_TEXT text
@@ -814,7 +815,7 @@ and use it for other things. File or website which the user can select to view using a checkbox. You don't need to put quotes around the filename when it contains spaces. -
Texts to display next to the 'Run program' checkbox.+MUI_FINISHPAGE_SHOWREADME_TEXT text
@@ -831,7 +832,7 @@ and use it for other things. "parameter">link_text
Texts to display next to the 'Show Readme' checkbox.
Text for a link on the which the user can click to view a website or file. -+-MUI_FINISHPAGE_LINK_LOCATION file/url
Website or file which the user can select to view using the link. @@ -1193,7 +1194,7 @@ for the page is written, so you can use it to initialize any variables used in the page settings.Examples
+Example Scripts
-Basic: Basic.nsi
@@ -1212,7 +1213,7 @@ Custom pages: StartMenu.nsiVersion history
+Version History
- 1.75 - April 1, 2006