diff --git a/Contrib/Modern UI/Changelog.txt b/Contrib/Modern UI/Changelog.txt index 4eeae408..f642d03c 100644 --- a/Contrib/Modern UI/Changelog.txt +++ b/Contrib/Modern UI/Changelog.txt @@ -1,11 +1,15 @@ NSIS Modern User Interface - VERSION HISTORY +1.70 - February 6, 2004 +* Improved documentation +* New Init custom function for Welcome and Finish page + 1.69 - January 7, 2004 * All uninstaller pages work without installer pages * Fixed top text on uninstaller license page 1.68 - November 24, 2003 -* New settings for extra space for title and text on Welcome page and Finish page. +* New settings for extra space for title and text on Welcome and Finish page. * Improved handling of verbose settings. Define MUI_VERBOSE the set the Modern UI verbose level (1-4). * Language file string for uninstaller reboot information * Setting for folder validation in leave function @@ -18,7 +22,8 @@ NSIS Modern User Interface - VERSION HISTORY * Renamed a few settings * Default header image * Support for uninstaller abort warning -* Setting for 3 line text on Welcome page and Finish page +* Setting for 3 line text on Welcome and Finish page + (NOTE: New settings have been introduces in version 1.68) * Langauge file backwards compatibility: English for missing strings * Support for different uninstaller header image * Language selection dialog not displayed if installer is silent @@ -29,7 +34,7 @@ NSIS Modern User Interface - VERSION HISTORY * New system for page settings and custom pages * Support for uninstaller components page * Support for multiple pages of the same type -* New possition for interface settings +* New position for interface settings * Changed macro, setting names * Updated langauge system, new language files and settings * Removed MUI_BRANDINGTEXT. Use BrandingText command now. @@ -41,10 +46,9 @@ NSIS Modern User Interface - VERSION HISTORY * Example script updates (new format, user variables) * Improved registry storage for Start Menu folder * ReserveFile macro for StartMenu plug-in -* Option to always show the language selection dialog (even if a language has been stored in the registry) +* Option to always show the language selection dialog (even if a language has been stored in the registry) * Checkboxes on Finish page can be used to call a function -* Support for custom leave functions for Start Menu Folder, - Welcome and Finish pages +* Support for custom leave functions for Start Menu Folder, Welcome and Finish pages * Support for a link on the Finish page * New macro to get Start Menu folder in uninstaller * Options to disable bitmap stretching @@ -52,7 +56,7 @@ NSIS Modern User Interface - VERSION HISTORY when mouse is outside box, disabled style 1.64 - April 27, 2003 -* Support for license page with checkbox or radiobuttons to let the user accept the agreement or not +* Support for license page with checkbox or radiobuttons to let the user accept the agreement or not * Macros for finish headers don't have to be inserted anymore * Language preference stored when installation has completed, no problems anymore when the users selects the wrong language * Header text for aborted installation @@ -63,14 +67,14 @@ NSIS Modern User Interface - VERSION HISTORY 1.63 - March 9, 2003 * Support for a bitmap in the wizard header -* New defines to change the description area +* New defines to change the components page interface * MUI_SYSTEM inserted automatically * Single macro for language selection dialog * Removed page description in window title * Easier to customize resource files * New system for custom functions * Start Menu folder registry key automatically written -* New InstallOptions macros that do not remove the return value from the stack +* New InstallOptions macros that do not remove the return value from the stack * Support for custom pages before the finish page * Renamed Start Menu page defines * 'Do not create shortcuts' checkbox can be removed @@ -80,21 +84,25 @@ NSIS Modern User Interface - VERSION HISTORY * Minor fixes 1.62 - February 2, 2003 -* New language strings for finish page +* New language strings for Finish page * Possibility to let a Modern UI Function call your own function -* No problems anymore when using both 'Run program' and 'Show Readme' on the finish page +* No problems anymore when using both 'Run program' and 'Show Readme' on the Finish page * Default state of checkboxes on the finish page can be changed * Welcome / Finish page compatible with custom DPI settings * Converted Install Options INI files to use dialog units * More ReserveFile macros + (NOTE: Some of these macros have been removed in later versions) * Background color can be changed with a define * Support for multilingual branding texts * Start Menu / Finish page window titles also work when using custom page commands * Language files should be inserted after inserting the MUI_SYSTEM macro + (NOTE: The MUI_SYSTEM macro has been removed in version 1.63) * Define MUI_MANUALVERBOSE if you don't want the Modern UI to change the verbose settings during compilation + (NOTE: This setting has been changed in version 1.68) 1.61 - December 5, 2002 * modern3.exe UI without description area + (NOTE: This setting has been changed in version 1.63) * Added define to show uninstall confirm page * Added language string for finish page title and continue to uninstall * Define for parameters for the application to run on the finish page @@ -112,7 +120,8 @@ NSIS Modern User Interface - VERSION HISTORY * Language strings can be changed in the script without editing languagefiles * Start Menu Folder selection page * 'Click Next to continue' and 'Click Install to start the installation' texts automatically change to the page order -* Install Options macros updated. MUI_INSTALLOPTIONS_DISPLAY is the standard macro now. Use MUI_INSTALLOPTIONS_INITDIALOG and MUI_INSTALLOPTIONS_SHOW if you want to customize dialog controls. +* Install Options macros updated. MUI_INSTALLOPTIONS_DISPLAY is the standard macro now. + Use MUI_INSTALLOPTIONS_INITDIALOG and MUI_INSTALLOPTIONS_SHOW if you want to customize dialog controls. * No more writing window titles & abort warnings to Install Options INI Files * Compatible with updated paging system * Renamed macros and defines @@ -132,6 +141,7 @@ NSIS Modern User Interface - VERSION HISTORY * Small bugfixes & typo corrections * SetPage function should be set using defines * Different NextPage/PrevPage/FinishHeader macros for install/uninstall + (NOTE: These macros have been removed in version 1.4) * Interface settings can be definend (for example, MUI_ICON), no parameters for MUI_INTERFACE anymore * New Install Options macros to read/write IO INI file value @@ -139,21 +149,25 @@ NSIS Modern User Interface - VERSION HISTORY * Temp vars set in Modern UI header * Currentpage & Install Options vars should be set using parameters of the MUI_INTERFACE and * MUI_INSTALLOPTIONS macros + (NOTE: The MUI_INTERFACE macro has been removed in version 1.3) * MultiLanguage.nsi uses the new language strings 1.2 - September 22, 2002 + (NOTE: All macors mentioned here have been removed in version 1.4) + * Lots of macro system updates & fixes * InstallOptions support in macro system * Added Modern UI + InstallOptions example (InstallOptions.nsi) * MUI_NEXTPAGE_OUTER integrated in MUI_NEXTPAGE * No hard-coded function names anymore (you should give MUI_PREVPAGE a parameter with the set page function name - (for example, MUI_PREVPAGE SetPage) + (for example, MUI_PREVPAGE SetPage) * Examples use ReserveFile for faster startup 1.19 - Semtember 19, 2002 * Renamed some macros * Custom code can be used between page start/stop macros + (NOTE: These macros have been removed in version 1.4) 1.18 - Semtember 13, 2002 * Uses the new Sendmessage string option @@ -167,6 +181,7 @@ NSIS Modern User Interface - VERSION HISTORY 1.15 - Semtember 4, 2002 * Multilanguage example: changed LangDialog to LangDLL::LangDialog (using the DLL name is now required) + (NOTE: A new macro for the language selection dialog has been introduced in version 1.63) 1.14 - Semtember 3, 2002 * Small grammar fix (thanks eccles) @@ -180,8 +195,11 @@ NSIS Modern User Interface - VERSION HISTORY 1.11 - August 29, 2002 * Finish header for uninstaller can also be set using MUI_FINISHHEADER + (NOTE: The MUI_FINISHHEADER macro has been removed in version 1.64) 1.1 - August 29, 2002 + (NOTE: All settings mentioned here do not exist anymore) + * Header file with macros, it's now very easy to use the UI in your scripts * Added the modern2.exe UI, with an other location of the Description frame, for installers with a lot of subsections (thanks rainwater) * Updated example scripts diff --git a/Contrib/Modern UI/Readme.html b/Contrib/Modern UI/Readme.html index 0f9a2d33..6ab13ebd 100644 --- a/Contrib/Modern UI/Readme.html +++ b/Contrib/Modern UI/Readme.html @@ -2,7 +2,9 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - +NSIS Modern User Interface - Documentation + - + + -
- +
- + @@ -863,6 +1248,5 @@ it freely, subject to the following restrictions:
+""

Introduction

-

NSIS 2 makes it is possible to create installers with a custom user interface. The Modern UI is -an interface with a style like the wizards of recent Windows versions.

-

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 +

+

NSIS 2 makes it is possible to create installers with a custom +user interface. The Modern UI is an interface with a style like the +wizards of recent Windows versions.

+

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.

-

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 +

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 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.

-

Screenshots

-

-

+

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.

+

Open/Close section Screenshots

+
+

+""

+

+""

+
+

How to use

-

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 will also help you to learn more -about the Modern UI.

+
+

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 +will also help you to learn more about the Modern UI.

Syntax

-

Some defines (e.g. MUI_COMPONENTSPAGE_SMALLDESC) don't need a value, they are true/false -settings. Others (e.g. MUI_UI) can be used to define a specific value.

-

Parameters are specified in this format: required (option1 | option2) -[optional]

-

You should put all parameters in one string.

+
+

Some defines (e.g. MUI_COMPONENTSPAGE_SMALLDESC) don't need a +value, they are true/false settings. Others (e.g. MUI_UI) can be +used to define a specific value.

+

Parameters are specified in this format: required (option1 | option2) [optional]

+

Parameters for defined settings should be in one string:

 !define MUI_COMPONENTSPAGE_SMALLDESC ;No value
 !define MUI_UI "myUI.exe" ;Value
 !define MUI_INSTFILESPAGE_COLORS "FFFFFF 000000" ;Multiple settings
-

If you want a certain value (e.g. a text) to be language-specific, set a language string (using -LangString) and define $(STRINGNAME) as value. Use a license language string (LicenseLangString) -for the license text.

-

If you want to add " to a Modern UI string, you should always escape it using $\" because the -Modern UI macros use " separate parameters.

+

If you want a certain value (e.g. a text) to be +language-specific, set a language string (using LangString) and +define $(STRINGNAME) as value. Use a license language string +(LicenseLangString) for the license text.

+

If you want to add " to a Modern UI string, you should always +escape it using $\" because the Modern UI macros use " to separate +parameters.

+

1. Header file

+
 !include "MUI.nsh"
-

MUI.nsh is in the Include directory, so you don't have to specify a path.

-

2. Interface Settings

-

Interface settings should be set before inserting page macros. Page interface settings apply to -all pages of a certain type.

-

General Interface Settings

+

MUI.nsh is in the Include directory, so you don't have to +specify a path.

+
+

2. Interface +Configuration

-

MUI_ICON icon_file
+

Interface settings should be set before inserting page macros. +Page interface settings apply to all pages of a certain type.

+

Open/Close section Interface Settings

+
+

Open/Close section General Interface +Settings

+
+

MUI_ICON icon_file
The icon for the installer.
-Default: ${NSISDIR}\Contrib\Graphics\Icons\modern-install.ico

-

MUI_UNICON icon_file
+Default: +${NSISDIR}\Contrib\Graphics\Icons\modern-install.ico

+

MUI_UNICON icon_file
The icon for the uninstaller.
-Default: ${NSISDIR}\Contrib\Graphics\Icons\modern-uninstall.ico

+Default: +${NSISDIR}\Contrib\Graphics\Icons\modern-uninstall.ico

MUI_HEADERIMAGE
-Image to display on the header of a page.

+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).
+

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 the whole space. If you have a full size bitmap that fits -exactly, you should not use this option because the size of the field will be different if the user -has a custom DPI setting.

-

MUI_HEADERIMAGE_BITMAP_RTL bmp_file
-Bitmap image to display on the header of installers pages when using a RTL language (recommended -size: 150x57 pixels).
+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 +the whole space. If you have a full size bitmap that fits exactly, +you should not use this option because the size of the field will +be different if the user has a custom DPI setting.

+

MUI_HEADERIMAGE_BITMAP_RTL bmp_file
+Bitmap image to display on the header of installers pages when +using a RTL language (recommended size: 150x57 pixels).
Default: Non-RTL bitmap

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 have an image that does not use the whole space. If you have a full -size bitmap that fits exactly, you should not use this option because the size of the field will be -different if the user has a custom DPI setting.

+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 +have an image that does not use the whole space. If you have a full +size bitmap that fits exactly, you should not use this option +because the size of the field will be different if the user has a +custom DPI setting.

-

MUI_HEADERIMAGE_UNBITMAP bmp_file
-Bitmap image to display on the header of uninstaller pages (recommended size: 150x57 pixels).
+

MUI_HEADERIMAGE_UNBITMAP bmp_file
+Bitmap image to display on the header of uninstaller pages +(recommended size: 150x57 pixels).
Default: Installer header bitmap

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 the whole space. If you have a full size bitmap that fits -exactly, you should not use this option because the size of the field will be different if the user -has a custom DPI setting.

-

MUI_HEADERIMAGE_UNBITMAP_RTL bmp_file
-Bitmap image to display on the header of uninstallers pages when using a RTL language (recommended -size: 150x57 pixels).
+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 +the whole space. If you have a full size bitmap that fits exactly, +you should not use this option because the size of the field will +be different if the user has a custom DPI setting.

+

MUI_HEADERIMAGE_UNBITMAP_RTL bmp_file
+Bitmap image to display on the header of uninstallers pages when +using a RTL language (recommended size: 150x57 pixels).
Default: Installer RTL header bitmap

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 have an image that does not use the whole space. If you have a -full size bitmap that fits exactly, you should not use this option because the size of the field -will be different if the user has a custom DPI setting.

+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 +have an image that does not use the whole space. If you have a full +size bitmap that fits exactly, you should not use this option +because the size of the field will be different if the user has a +custom DPI setting.

MUI_HEADERIMAGE_RIGHT
-Display the header image on the right side instead of the left side (when using a RTL language it -will be displayed on the left side instead of the right side).

+Display the header image on the right side instead of the left side +(when using a RTL language it will be displayed on the left side +instead of the right side).

-

MUI_BGCOLOR (color: RRGGBBR hexadecimal)
-Background color for the header, the Welcome page and the Finish page.
+

MUI_BGCOLOR (color: +RRGGBBR hexadecimal)
+Background color for the header, the Welcome page and the Finish +page.
Default: FFFFFF

-

Interface Resource Settings

-
-

MUI_UI ui_file
-The interface file with the dialog resources. Change this if you have made your own customized -UI.
+

Open/Close section Interface Resource +Settings

+
+

MUI_UI ui_file
+The interface file with the dialog resources. Change this if you +have made your own customized UI.
Default: ${NSISDIR}\Contrib\UIs\modern.exe

-

MUI_UI_HEADERIMAGE ui_file
-The interface files with the dialog resource IDD_INST that contains a bitmap control and space for -the header bitmap.
+

MUI_UI_HEADERIMAGE ui_file
+The interface files with the dialog resource IDD_INST that contains +a bitmap control and space for the header bitmap.
Default: ${NSISDIR}\Contrib\UIs\modern-headerbmp.exe

-

MUI_UI_HEADERIMAGE_RIGHT ui_file
-The interface files with the dialog resource IDD_INST that contains a bitmap control and space for -the header bitmap on the right side.
+

MUI_UI_HEADERIMAGE_RIGHT ui_file
+The interface files with the dialog resource IDD_INST that contains +a bitmap control and space for the header bitmap on the right +side.
Default: ${NSISDIR}\Contrib\UIs\modern-headerbmpr.exe

-

MUI_UI_COMPONENTSPAGE_SMALLDESC ui_file
-The interface files with a customized dialog resource IDD_SELCOM with a small description -area.
+

MUI_UI_COMPONENTSPAGE_SMALLDESC ui_file
+The interface files with a customized dialog resource IDD_SELCOM +with a small description area.
Default: {NSISDIR}\Contrib\UIs\modern-smalldesc.exe

-

MUI_UI_COMPONENTSPAGE_NODESC ui_file
-The interface files with a customized dialog resource IDD_SELCOM without a description area.
+

MUI_UI_COMPONENTSPAGE_NODESC ui_file
+The interface files with a customized dialog resource IDD_SELCOM +without a description area.
Default: {NSISDIR}\Contrib\UIs\modern-nodesc.exe

-

Welcome/Finish Page Interface Settings

-
-

MUI_WELCOMEFINISHPAGE_BITMAP bmp_file
-Bitmap for the Welcome page and the Finish page (recommended size: 164x314 pixels).
+

Open/Close section Welcome/Finish Page +Interface Settings

+
+

MUI_WELCOMEFINISHPAGE_BITMAP bmp_file
+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 that does not use the whole space. If you have a full size bitmap -that fits exactly, you should not use this option because the size of the field will be different -if the user has a custom DPI setting.

+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 +that does not use the whole space. If you have a full size bitmap +that fits exactly, you should not use this option because the size +of the field will be different if the user has a custom DPI +setting.

-

Welcome/Finish Page InstallOptions INI Settings

-
-

MUI_WELCOMEFINISHPAGE_INI ini_file
-InstallOptions INI file for the Welcome page and the Finish page.
+

Open/Close section Welcome/Finish Page +InstallOptions INI Settings

+
+

MUI_WELCOMEFINISHPAGE_INI ini_file
+InstallOptions INI file for the Welcome page and the Finish +page.
Default: ${NSISDIR}\Contrib\Modern UI\ioSpecial.ini

-

Uninstaller Welcome/Finish Page Settings

-
-

MUI_UNWELCOMEFINISHPAGE_BITMAP bmp_file
-Bitmap for the Welcome page and the Finish page (recommended size: 164x314 pixels).
+

Open/Close section Uninstaller +Welcome/Finish Page Settings

+
+

MUI_UNWELCOMEFINISHPAGE_BITMAP bmp_file
+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 that does not use the whole space. If you have a full size bitmap -that fits exactly, you should not use this option because the size of the field will be different -if the user has a custom DPI setting.

+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 +that does not use the whole space. If you have a full size bitmap +that fits exactly, you should not use this option because the size +of the field will be different if the user has a custom DPI +setting.

-

Uninstaller Welcome/Finish Page Interface INI Settings

-
-

MUI_UNWELCOMEFINISHPAGE_INI ini_file
-InstallOptions INI file for the uninstaller Welcome page and the Finish page.
+

Open/Close section Uninstaller +Welcome/Finish Page Interface INI Settings

+
+

MUI_UNWELCOMEFINISHPAGE_INI ini_file
+InstallOptions INI file for the uninstaller Welcome page and the +Finish page.
Default: ${NSISDIR}\Contrib\Modern UI\ioSpecial.ini

-

License Page Interface Settings

-
-

MUI_LICENSEPAGE_BGCOLOR (/windows | /grey | (color: -RRGGBB hexadecimal))
-The background color for the license textbox. Use /windows for the Windows text background color -(usually white). Use the /grey for the window background color (usually grey).
+

Open/Close section License Page Interface +Settings

+
+

MUI_LICENSEPAGE_BGCOLOR (/windows | /grey | (color: RRGGBB +hexadecimal))
+The background color for the license textbox. Use /windows for the +Windows text background color (usually white). Use the /grey for +the window background color (usually grey).
Default: /windows

-

Components Page Interface Settings

-
-

MUI_COMPONENTSPAGE_CHECKBITMAP bitmap_file
-The bitmap with images for the checks of the component select treeview.
+

Open/Close section Components Page Interface +Settings

+
+

MUI_COMPONENTSPAGE_CHECKBITMAP bitmap_file
+The bitmap with images for the checks of the component select +treeview.
Default: ${NSISDIR}\Contrib\Graphics\Checks\modern.bmp

MUI_COMPONENTSPAGE_SMALLDESC
-A small description area on the bottom of the page. Use this layout if you have a lot of sections -and don't need large descriptions.

+A small description area on the bottom of the page. Use this layout +if you have a lot of sections and don't need large +descriptions.

MUI_COMPONENTSPAGE_NODESC
No description area.

-

Installation Page Interface Settings

-
-

MUI_INSTFILESPAGE_COLORS (/windows | (foreground color: -RRGGBB hexadecimal) (background color: RRGGBB hexadecimal))
-The colors of the details screen. Use /windows for the default Windows colors.
+

Open/Close section Installation Page +Interface Settings

+
+

MUI_INSTFILESPAGE_COLORS (/windows | (foreground color: RRGGBB hexadecimal) +(background color: RRGGBB hexadecimal))
+The colors of the details screen. Use /windows for the default +Windows colors.
Default: /windows

-

MUI_INSTFILESPAGE_PROGRESSBAR ("" | colored | -smooth)
-The style of the progress bar. Colored makes it use the MUI_INSTALLCOLORS.
+

MUI_INSTFILESPAGE_PROGRESSBAR ("" | colored | smooth)
+The style of the progress bar. Colored makes it use the +MUI_INSTALLCOLORS.
Default: smooth

-

Installer Finish Page Interface Settings

-
+

Open/Close section Installer Finish Page +Interface Settings

+

MUI_FINISHPAGE_NOAUTOCLOSE
-Do not automatically jump to the finish page, to allow the user to check the install log.

+Do not automatically jump to the finish page, to allow the user to +check the install log.

-

Uninstaller Finish Page Interface Settings

-
+

Open/Close section Uninstaller Finish Page +Interface Settings

+

MUI_UNFINISHPAGE_NOAUTOCLOSE
-Do not automatically jump to the finish page, to allow the user to check the uninstall log.

+Do not automatically jump to the finish page, to allow the user to +check the uninstall log.

-

Abort Warning Settings

-
+

Open/Close section Abort Warning +Settings

+

MUI_ABORTWARNING
-Show a message box with a warning when the user wants to close the installer.

+Show a message box with a warning when the user wants to close the +installer.

-

MUI_ABORTWARNING_TEXT text
+

MUI_ABORTWARNING_TEXT text
Text to display on the abort warning messagebox.

-

Uninstaller Abort Warning Settings

-
+

Open/Close section Uninstaller Abort +Warning Settings

+

MUI_UNABORTWARNING
-Show a message box with a warning when the user wants to close the uninstaller.

+Show a message box with a warning when the user wants to close the +uninstaller.

-

MUI_UNABORTWARNING_TEXT text
+

MUI_UNABORTWARNING_TEXT text
Text to display on the abort warning messagebox.

+
+

3. Pages

-

Insert the following macros to set the pages you want to use. The pages will appear in the order -you insert them in your script. You can also insert custom Page commands between the macros to add -custom pages. More info about custom pages...

-

You can add multiple pages of certain types (for example, if you want the user to specify -multiple folders).

+
+

Insert the following macros to set the pages you want to use. +The pages will appear in the order you insert them in your script. +You can also insert custom Page commands between the macros to add +custom pages. More info about custom +pages...

+

You can add multiple pages of certain types (for example, if you +want the user to specify multiple folders).

Examples:

 !insertmacro MUI_PAGE_LICENSE "License.rtf"
@@ -352,29 +518,35 @@ multiple folders).

 Var STARTMENU_FOLDER
 !insertmacro MUI_PAGE_STARTMENU "Application" $STARTMENU_FOLDER
-

You will need the page ID for the Start Menu Folder page when using the Start Menu Folder -macros. The Start Menu Folder will be stored in the specified variable.

+

You will need the page ID for the Start Menu Folder page when +using the Start Menu Folder macros. The Start Menu Folder will be +stored in the specified variable.

Installer Pages
MUI_PAGE_WELCOME
MUI_PAGE_LICENSE text/rtf_file
MUI_PAGE_COMPONENTS
MUI_PAGE_DIRECTORY
-MUI_PAGE_STARTMENU page_id variable
+MUI_PAGE_STARTMENU page_id +variable
MUI_PAGE_INSTFILES
MUI_PAGE_FINISH

Uninstaller Pages
MUI_UNPAGE_WELCOME
MUI_UNPAGE_CONFIRM
-MUI_UNPAGE_LICENSE text/rtf_file
+MUI_UNPAGE_LICENSE text/rtf_file
MUI_UNPAGE_COMPONENTS
MUI_UNPAGE_DIRECTORY
MUI_UNPAGE_INSTFILES
MUI_UNPAGE_FINISH

-

Page Settings

-
-

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:

+

Open/Close section Page Settings

+
+

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:

 ;Add a directory page to let the user specify a plug-ins folder
 ;Store the folder in $PLUGINS_FOLDER
@@ -383,216 +555,317 @@ Var PLUGINS_FOLDER
 !define MUI_DIRECTORYPAGE_VARIABLE $PLUGINS_FOLDER
 !insertmacro MUI_PAGE_DIRECTORY
-

Note: There is no diference between installer and uninstaller page settings.

-

General Page Settings

-
-

MUI_PAGE_HEADER_TEXT text
+

Note: There is no diference between installer and +uninstaller page settings.

+

Open/Close section General Page +Settings

+
+

MUI_PAGE_HEADER_TEXT text
Text to display on the header of the page.

-

MUI_PAGE_HEADER_SUBTEXT text
+

MUI_PAGE_HEADER_SUBTEXT text
Subtext to display on the header of the page.

-

Welcome Page Settings

-
-

MUI_WELCOMEPAGE_TITLE title
+

Open/Close section Welcome Page +Settings

+
+

MUI_WELCOMEPAGE_TITLE title
Title to display on the top of the page.

MUI_WELCOMEPAGE_TITLE_3LINES
Extra space for the title area.

-

MUI_WELCOMEPAGE_TEXT text
+

MUI_WELCOMEPAGE_TEXT text
Text to display on the page. Use \r\n for a newline.

-

License Page Settings

-
-

MUI_LICENSEPAGE_TEXT_TOP text
+

Open/Close section License Page +Settings

+
+

MUI_LICENSEPAGE_TEXT_TOP text
Text to display on the top of the page.

-

MUI_LICENSEPAGE_TEXT_BOTTOM text
+

MUI_LICENSEPAGE_TEXT_BOTTOM text
Text to display on the bottom of the page.

-

MUI_LICENSEPAGE_BUTTON button_text
+

MUI_LICENSEPAGE_BUTTON button_text
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.

+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 terms.

+

MUI_LICENSEPAGE_CHECKBOX_TEXT text
+Text to display next to the checkbox to agree with the license +terms.

MUI_LICENSEPAGE_RADIOBUTTONS
-Display two radio buttons to allow the user to choose between accepting the license terms or -not.

+Display two radio buttons to allow the user to choose between +accepting the license terms or not.

-

MUI_LICENSEPAGE_RADIOBUTTONS_TEXT_ACCEPT text
-Text to display next to the checkbox to accept the license terms.

-

MUI_LICENSEPAGE_RADIOBUTTONS_TEXT_DECLINE text
-Text to display next to the checkbox to decline the license terms.

+

MUI_LICENSEPAGE_RADIOBUTTONS_TEXT_ACCEPT +text
+Text to display next to the checkbox to accept the license +terms.

+

MUI_LICENSEPAGE_RADIOBUTTONS_TEXT_DECLINE +text
+Text to display next to the checkbox to decline the license +terms.

-

Components Page Settings

-
-

MUI_COMPONENTSPAGE_TEXT_TOP text
+

Open/Close section Components Page +Settings

+
+

MUI_COMPONENTSPAGE_TEXT_TOP text
Text to display on the top of the page.

-

MUI_COMPONENTSPAGE_TEXT_COMPLIST text
+

MUI_COMPONENTSPAGE_TEXT_COMPLIST text
Text to display on next to the components list.

-

MUI_COMPONENTSPAGE_TEXT_INSTTYPE text
+

MUI_COMPONENTSPAGE_TEXT_INSTTYPE text
Text to display on next to the installation type combo box.

-

MUI_COMPONENTSPAGE_TEXT_DESCRIPTION_TITLE text
+

MUI_COMPONENTSPAGE_TEXT_DESCRIPTION_TITLE +text
Text to display on the of the top of the description box.

-

MUI_COMPONENTSPAGE_TEXT_DESCRIPTION_INFO text
-Text to display inside the description box when no section is selected.

+

MUI_COMPONENTSPAGE_TEXT_DESCRIPTION_INFO +text
+Text to display inside the description box when no section is +selected.

-

Directory Page Settings

-
-

MUI_DIRECTORYPAGE_TEXT_TOP text
+

Open/Close section Directory Page +Settings

+
+

MUI_DIRECTORYPAGE_TEXT_TOP text
Text to display on top of the page.

-

MUI_DIRECTORYPAGE_TEXT_DESTINATION text
+

MUI_DIRECTORYPAGE_TEXT_DESTINATION text
Text to display on the destination folder frame.

-

MUI_DIRECTORYPAGE_VARIABLE variable
+

MUI_DIRECTORYPAGE_VARIABLE variable
Variable in which to store the selected folder.
Default: $INSTDIR

MUI_DIRECTORYPAGE_VERIFYONLEAVE
-Does not disable the Next button when a folder is invalid but allows you to use GetInstDirError in -the leave function to handle an invalid folder.

+Does not disable the Next button when a folder is invalid but +allows you to use GetInstDirError in the leave function to handle +an invalid folder.

-

Start Menu Folder Page Settings

-
-

Put the code to write the shortcuts (using CreateShortcut) between the MUI_STARTMENU_WRITE_BEGIN -and MUI_STARTMENU_WRITE_END macros:

+

Open/Close section Start Menu Folder Page +Settings

+
+

Put the code to write the shortcuts (using CreateShortcut) +between the MUI_STARTMENU_WRITE_BEGIN and MUI_STARTMENU_WRITE_END +macros:

 !insertmacro MUI_STARTMENU_WRITE_BEGIN page_id
   ...create shortcuts...
 !insertmacro MUI_STARTMENU_WRITE_END
-

The page ID should be the ID of the page on which the user has selected the folder for the -shortcuts you want to write.

-

MUI_STARTMENUPAGE_TEXT_TOP text
+

The page ID should be the ID of the page on which the user has +selected the folder for the shortcuts you want to write.

+

MUI_STARTMENUPAGE_TEXT_TOP text
Text to display on the top of the page.

-

MUI_STARTMENUPAGE_TEXT_CHECKBOX text
-Text to display next to the checkbox to disable the Start Menu folder creation.

-

MUI_STARTMENUPAGE_DEFAULTFOLDER folder
+

MUI_STARTMENUPAGE_TEXT_CHECKBOX text
+Text to display next to the checkbox to disable the Start Menu +folder creation.

+

MUI_STARTMENUPAGE_DEFAULTFOLDER folder
The default Start Menu Folder.

MUI_STARTMENUPAGE_NODISABLE
-Do not display the checkbox to disable the creation of Start Menu shortcuts.

-

MUI_STARTMENUPAGE_REGISTRY_ROOT root
-MUI_STARTMENUPAGE_REGISTRY_KEY key
+Do not display the checkbox to disable the creation of Start Menu +shortcuts.

+

MUI_STARTMENUPAGE_REGISTRY_ROOT root
+MUI_STARTMENUPAGE_REGISTRY_KEY key
MUI_STARTMENUPAGE_REGISTRY_VALUENAME value_name
-The registry key to store the Start Menu folder. The page will use it to remember the users -preference. You should also use for the uninstaller to remove the Start Menu folders. Don't forget -to remove this key during uninstallation.

-

For the uninstaller, use the MUI_STARTMENU_GETFOLDER macro to get the Start Menu folder:

+The registry key to store the Start Menu folder. The page will use +it to remember the users preference. You should also use for the +uninstaller to remove the Start Menu folders. Don't forget to +remove this key during uninstallation.

+

For the uninstaller, use the MUI_STARTMENU_GETFOLDER macro to +get the Start Menu folder:

 !insertmacro MUI_STARTMENU_GETFOLDER page_id $R0
   Delete "$SMPROGRAMS\$R0\Your Shortcut.lnk"
-

Installation Page Settings

-
-

MUI_INSTFILESPAGE_FINISHHEADER_TEXT text
-Text to display on the header of the installation page when the installation has been completed -(won't be displayed when using a Finish page without MUI_(UN)FINISHPAGE_NOAUTOCLOSE).

-

MUI_INSTFILESPAGE_FINISHHEADER_SUBTEXT Open/Close section Installation Page +Settings +

+

MUI_INSTFILESPAGE_FINISHHEADER_TEXT +text
+Text to display on the header of the installation page when the +installation has been completed (won't be displayed when using a +Finish page without MUI_(UN)FINISHPAGE_NOAUTOCLOSE).

+

MUI_INSTFILESPAGE_FINISHHEADER_SUBTEXT +text
+Subext to display on the header of the installation page when the +installation has been completed (won't be displayed when using a +Finish page without MUI_(UN)FINISHPAGE_NOAUTOCLOSE).

+

MUI_INSTFILESPAGE_ABORTHEADER_TEXT text
-Subext to display on the header of the installation page when the installation has been completed -(won't be displayed when using a Finish page without MUI_(UN)FINISHPAGE_NOAUTOCLOSE).

-

MUI_INSTFILESPAGE_ABORTHEADER_TEXT text
-Text to display on the header of the installation page when the installation has been aborted.

-

MUI_INSTFILESPAGE_ABORTHEADER_SUBTEXT text
-Subext to display on the header of the installation page when the installation has been -aborted.

+Text to display on the header of the installation page when the +installation has been aborted.

+

MUI_INSTFILESPAGE_ABORTHEADER_SUBTEXT +text
+Subext to display on the header of the installation page when the +installation has been aborted.

-

Finish Page Settings

-
-

MUI_FINISHPAGE_TITLE title
+

Open/Close section Finish Page Settings

+
+

MUI_FINISHPAGE_TITLE title
Title to display on the top of the page.

MUI_FINISHPAGE_TITLE_3LINES
Extra space for the title area.

-

MUI_FINISHPAGE_TEXT text
+

MUI_FINISHPAGE_TEXT text
Text to display on the page. Use \r\n for a newline.

MUI_FINISHPAGE_TEXT_LARGE
Extra space for the text area (if using checkboxes).

-

MUI_FINISHPAGE_BUTTON text
+

MUI_FINISHPAGE_BUTTON text
Text to display on the Finish button.

-

MUI_FINISHPAGE_TEXT_REBOOT text
-Text to display on the finish page when asking for a system reboot. Use \r\n for a newline.

-

MUI_FINISHPAGE_TEXT_REBOOTNOW text
+

MUI_FINISHPAGE_TEXT_REBOOT text
+Text to display on the finish page when asking for a system reboot. +Use \r\n for a newline.

+

MUI_FINISHPAGE_TEXT_REBOOTNOW text
Text to display next to the 'Reboot now' option button.

-

MUI_FINISHPAGE_TEXT_REBOOTLATER text
+

MUI_FINISHPAGE_TEXT_REBOOTLATER text
Text to display next to the 'Reboot later' option button.

-

MUI_FINISHPAGE_RUN exe_file
-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.

+

MUI_FINISHPAGE_RUN exe_file
+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.

-

MUI_FINISHPAGE_RUN_TEXT text
+

MUI_FINISHPAGE_RUN_TEXT text
Texts to display next to the 'Run program' checkbox.

-

MUI_FINISHPAGE_RUN_PARAMETERS parameters
-Parameters for the application to run. Don't forget to escape double quotes in the value (use -$\").

+

MUI_FINISHPAGE_RUN_PARAMETERS parameters
+Parameters for the application to run. Don't forget to escape +double quotes in the value (use $\").

MUI_FINISHPAGE_RUN_NOTCHECKED
Do not check the 'Run program' checkbox by default

-

MUI_FINISHPAGE_RUN_FUNCTION function_name
-Call a function instead of executing an application (define MUI_FINISHPAGE_RUN without parameters). -You can use the function to exectute multiple applications or you can change the checkbox name and -use it for other things.

+

MUI_FINISHPAGE_RUN_FUNCTION function_name
+Call a function instead of executing an application (define +MUI_FINISHPAGE_RUN without parameters). You can use the function to +exectute multiple applications or you can change the checkbox name +and use it for other things.

-

MUI_FINISHPAGE_SHOWREADME file/url
-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.

+

MUI_FINISHPAGE_SHOWREADME file/url
+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.

-

MUI_FINISHPAGE_SHOWREADME_TEXT text
+

MUI_FINISHPAGE_SHOWREADME_TEXT text
Texts to display next to the 'Show Readme' checkbox.

MUI_FINISHPAGE_SHOWREADME_NOTCHECKED
Do not check the 'Show Readme' checkbox by default

MUI_FINISHPAGE_SHOWREADME_FUNCTION function_name
-Call a function instead of showing a file (define MUI_FINISHPAGE_SHOWREADME without parameters). -You can use the function to show multiple files or you can change the checkbox name and use it for -other things.

+Call a function instead of showing a file (define +MUI_FINISHPAGE_SHOWREADME without parameters). You can use the +function to show multiple files or you can change the checkbox name +and use it for other things.

-

MUI_FINISHPAGE_LINK link_text
-Text for a link on the which the user can click to view a website or file.

+

MUI_FINISHPAGE_LINK link_text
+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. You don't need to put quotes -around the filename when it contains spaces.

-

MUI_FINISHPAGE_LINK_COLOR (color: RRGGBB -hexadecimal)
+

MUI_FINISHPAGE_LINK_LOCATION file/url
+Website or file which the user can select to view using the link. +You don't need to put quotes around the filename when it contains +spaces.

+

MUI_FINISHPAGE_LINK_COLOR (color: RRGGBB hexadecimal)
Text color for the link on the Finish page.
Default: 000080

MUI_FINISHPAGE_NOREBOOTSUPPORT
-Disables support for the page that allows the user to reboot the system. Define this option to save -some space if you are not using the /REBOOTOK flag or SetRebootFlag.

+Disables support for the page that allows the user to reboot the +system. Define this option to save some space if you are not using +the /REBOOTOK flag or SetRebootFlag.

-

Uninstall Confirm Page Settings

-
-

MUI_UNCONFIRMPAGE_TEXT_TOP text
+

Open/Close section Uninstall Confirm Page +Settings

+
+

MUI_UNCONFIRMPAGE_TEXT_TOP text
Text to display on the top of the page.

-

MUI_UNCONFIRMPAGE_TEXT_LOCATION text
+

MUI_UNCONFIRMPAGE_TEXT_LOCATION text
Text to display next to the uninstall location text box.

-

Advanced Page Settings

-
-

You can add custom code to the page functions of your Modern UI pages. More info...

+

Open/Close section Advanced Page +Settings

+
+

You can add custom code to the page functions of your Modern UI +pages. More info...

+

4. Custom functions

-

If you want add your own code to functions inserted by the Modern UI (e.g. the .onGUIInit -function and the page functions), create your own function and let the Modern UI functions call +

+

If you want add your own code to functions inserted by the +Modern UI (e.g. the .onGUIInit function and the page functions), +create your own function and let the Modern UI functions call them.

More info...

+

5. Language files

-

Insert the Modern UI language files for the languages to want to include.

+
+

Insert the Modern UI language files for the languages to want to +include.

 !insertmacro MUI_LANGUAGE "English"
-

The Modern UI language files load the NLF language files, so you should not use -LoadLanguageFile.

-

Language Selection Dialog

-
-

If you want the installer to display a language selection dialog (have a look at the MultiLanguage.nsi example), insert the -MUI_LANGDLL_DISPLAY macro in the .onInit function:

+

The Modern UI language files load the NLF language files, so you +should not use LoadLanguageFile.

+

Open/Close section Language Selection +Dialog

+
+

If you want the installer to display a language selection dialog +(have a look at the MultiLanguage.nsi +example), insert the MUI_LANGDLL_DISPLAY macro in the .onInit +function:

 Function .onInit
 
@@ -600,19 +873,29 @@ Function .onInit
 
 FunctionEnd
-

You can also use this macro for the uninstaller, in the un.onInit function.

-

Language Selection Dialog Settings

-
-

To remember to users preference, you can define a registry key.
-Note: These defines should be set before inserting the instfiles page macro.

-

MUI_LANGDLL_REGISTRY_ROOT root
-MUI_LANGDLL_REGISTRY_KEY key
-MUI_LANGDLL_REGISTRY_VALUENAME value_name
-The registry key to store the language. The users preference will be remembered. You can also use -it for the uninstaller to display the right language. Don't forget to remove this key in the +

You can also use this macro for the uninstaller, in the +un.onInit function.

+

Open/Close section Language Selection Dialog +Settings

+
+

To remember to users preference, you can define a registry +key.
+Note: These defines should be set before inserting +the installation page macro.

+

MUI_LANGDLL_REGISTRY_ROOT root
+MUI_LANGDLL_REGISTRY_KEY key
+MUI_LANGDLL_REGISTRY_VALUENAME value_name
+The registry key to store the language. The users preference will +be remembered. You can also use it for the uninstaller to display +the right language. Don't forget to remove this key in the uninstaller.

-

For the uninstaller, insert the MUI_UNGETLANGUAGE macro in un.onInit to get the stored language -preference:

+

For the uninstaller, insert the MUI_UNGETLANGUAGE macro in +un.onInit to get the stored language preference:

 Function un.onInit
 
@@ -620,40 +903,57 @@ Function un.onInit
 
 FunctionEnd
-

Language Selection Dialog Interface Settings

-
-

To customize the language selection dialog interface, use these defines before inserting the -MUI_LANGDLL_DISPLAY macro.

-

MUI_LANGDLL_WINDOWTITLE text
+

Open/Close section Language Selection +Dialog Interface Settings

+
+

To customize the language selection dialog interface, use these +defines before inserting the MUI_LANGDLL_DISPLAY macro.

+

MUI_LANGDLL_WINDOWTITLE text
The window title of the language selection dialog.

-

MUI_LANGDLL_INFO text
+

MUI_LANGDLL_INFO text
The text to display on the language selection dialog.

MUI_LANGDLL_ALWAYSSHOW
-Always show the language selection dialog, even if a language has been stored in the registry. The -language stored in the registry will be selected by default.

+Always show the language selection dialog, even if a language has +been stored in the registry. The language stored in the registry +will be selected by default.

+

6. Reserve files

-

If you are using solid compression (by default, solid compression is enabled for BZIP2 and -LZMA), it's important that files which are being extracted in init- or page functions function are -located before other files in the data block, because this will make your installer faster.

-

If there are File commands in your sections or functions above the init- or page functions, add -the reserve file macros above your sections and functions.

+
+

If you are using solid compression (by default, solid +compression is enabled for BZIP2 and LZMA), it's important that +files which are being extracted in init- or page functions function +are located before other files in the data block, because this will +make your installer faster.

+

If there are File commands in your sections or functions above +the init- or page functions, add the reserve file macros above your +sections and functions.

 ReserveFile "ioFile.ini" ;Your own InstallOptions INI files
 !insertmacro MUI_RESERVEFILE_INSTALLOPTIONS ;InstallOptions plug-in
 !insertmacro MUI_RESERVEFILE_LANGDLL ;Language selection dialog
-
+

7. Your own sections and functions

-

Add your installer sections and functions. See the NSIS Users Manual for details.

-

Information about section code and function code for Start Menu shortcut creation and language -selection can be found above.

-

8. Descriptions for the sections

-

The descriptions of sections will be displayed on the components page, when the user hovers the -mouse over a section. If you don't want to use descriptions, use the MUI_COMPONENTSPAGE_NODESC +

+

Add your installer sections and functions. See the NSIS Users +Manual for details.

+

Information about section code and function code for Start Menu +shortcut creation and language selection can be found above.

+
+

8. Section descriptions

+
+

The descriptions of sections will be displayed on the components +page, when the user hovers the mouse over a section. If you don't +want to use descriptions, use the MUI_COMPONENTSPAGE_NODESC interface setting.

-

To set a description for a section, you have to add an additional parameter to the Section -commmand with a name for the define that should contain the section number.

+

To set a description for a section, you have to add an +additional parameter to the Section commmand with a name for the +define that should contain the section number.

 Section "Section Name 1" Section1
    ...
@@ -669,12 +969,14 @@ LangString DESC_Section2 ${LANG_ENGLISH} "Description of section 2."
   !insertmacro MUI_DESCRIPTION_TEXT ${Section2} $(DESC_Section2)
 !insertmacro MUI_FUNCTION_DESCRIPTION_END
-

For the uninstaller, use the MUI_UNFUNCTION_DESCRIPTION_BEGIN and -MUI_UNFUNCTIONS_DESCRIPTION_END macros.

+

For the uninstaller, use the MUI_UNFUNCTION_DESCRIPTION_BEGIN +and MUI_UNFUNCTIONS_DESCRIPTION_END macros.

+
+

Custom pages

-

Custom page commands

-

If you want add custom pages to your installer, you should insert your own page commands between -the page macros.

+
+

If you want add your custom pages to your installer, you should +insert your own page commands between the page macros.

 !insertmacro MUI_PAGE_WELCOME
 Page custom FunctionName ;Custom page
@@ -685,28 +987,37 @@ Page custom FunctionName ;Custom page
 UninstPage custom un.FunctionName ;Custom page
 !insertmacro MUI_UNPAGE_INSTFILES
-

Call InstallOptions

-

InstallOptions is a plug-in that displays custom pages that you can create using INI files.

-

Have a look at the InstallOptions documentation for -info about creating InstallOptions INI files.

-

First, you have to extract your InstallOptions INI File in the .onInit function (un.onInit for -the uninstaller) using the MUI_INSTALLOPTIONS_EXTRACT macro.

+

Open/Close section Using InstallOptions for +custom pages

+
+

InstallOptions is a plug-in that displays custom pages that you +can create using INI files.

+

Have a look at the InstallOptions documentation +for info about creating InstallOptions INI files.

+

First, you have to extract your InstallOptions INI File in the +.onInit function (un.onInit for the uninstaller) using the +MUI_INSTALLOPTIONS_EXTRACT macro:

 Function .onInit
   !insertmacro MUI_INSTALLOPTIONS_EXTRACT "ioFile.ini"
 FunctionEnd
-

If your INI File is located in another directory, use MUI_INSTALLOPTIONS_EXTRACT_AS. The second -parameter is the filename for the temporary plug-ins directory, use this filename as parameter for -the other InstallOptions macros.

+

If your INI File is located in another directory, use +MUI_INSTALLOPTIONS_EXTRACT_AS. The second parameter is the filename +for the temporary plug-ins directory, use this filename as +parameter for the other InstallOptions macros.

 Function .onInit
   !insertmacro MUI_INSTALLOPTIONS_EXTRACT_AS "..\ioFile.ini" "ioFile.ini"
 FunctionEnd
-

You can call Instal Options in the function defined with the Page or UninstPage command using -the MUI_INSTALLOPTIONS_DISPLAY macro. Use the MUI_HEADER_TEXT macro to set the text in the white -box.

+

You can call Instal Options in the function defined with the +Page or UninstPage command using the MUI_INSTALLOPTIONS_DISPLAY +macro. Use the MUI_HEADER_TEXT macro to set the text on the page +header:

 LangString TEXT_IO_TITLE ${LANG_ENGLISH} "Install Options Page Title"
 LangString TEXT_IO_SUBTITLE ${LANG_ENGLISH} "A subtitle"
@@ -716,8 +1027,8 @@ Function FunctionName ;FunctionName defined with Page command
   !insertmacro MUI_INSTALLOPTIONS_DISPLAY "ioFile.ini"
 FunctionEnd
-

For custom fonts and colors, macros for the initDialog and show functions of InstallOptions are -also available.

+

For custom fonts and colors, macros for the initDialog and show +functions of InstallOptions are also available:

 Var HWND
 Var DLGITEM
@@ -743,47 +1054,57 @@ Function FunctionName ;FunctionName defined with Page command
 
 FunctionEnd
-

If you need the InstallOptions return value (success, back, cancel, error), use the -MUI_INSTALLOPTIONS_DISPLAY_RETURN or MUI_INSTALLOPTIONS_SHOW_RETURN macro. The return value will be +

If you need the InstallOptions return value (success, back, +cancel, error), use the MUI_INSTALLOPTIONS_DISPLAY_RETURN or +MUI_INSTALLOPTIONS_SHOW_RETURN macro. The return value will be added to the stack, so you can use the Pop command to get it.

Use these macros to read or write INI file values:

-!insertmacro MUI_INSTALLOPTIONS_READ $VAR "ioFile.ini" "Field #" "Value Name"
-!insertmacro MUI_INSTALLOPTIONS_WRITE "ioFile.ini" "Field #" "Value Name" "Value"
+!insertmacro MUI_INSTALLOPTIONS_READ $VAR "ioFile.ini" "Field #" "Name"
+!insertmacro MUI_INSTALLOPTIONS_WRITE "ioFile.ini" "Field #" "Name" "Value"
-

For example, you can use the MUI_INSTALLOPTIONS_READ macro in a section to get the user -input:

+

For example, you can use the MUI_INSTALLOPTIONS_READ macro in a +section to get the user input:

 !insertmacro MUI_INSTALLOPTIONS_READ $R0 "ioFile.ini" "Field 1" "State"
-

For more details about InstallOptions, validation of user input etc., check the InstallOptions documentation.

-

Examples

-

Basic: Basic.nsi
-Welcome/Finish page: WelcomeFinish.nsi
-Multiple languages: MultiLanguage.nsi
-Header image: HeaderBitmap.nsi
-Custom pages: InstallOptions.nsi
-Start Menu Folder page: StartMenu.nsi

-

Customize the dialogs

-

To change elements on the dialogs, use customized UI resource files (see Interface settings). -You can change your copies of the original files (in the Contrib\UIs folder) by using an -application such as Resource +

For more details about InstallOptions, validation of user input +etc., check the InstallOptions +documentation.

+
+

Open/Close section Customize standard +dialogs

+
+

To change elements on the dialogs, use customized UI resource +files (see Interface Configuration). +You can change your copies of the original files (in the +Contrib\UIs folder) by using an application such as Resource Hacker.

-

The 'Please wait while Setup is loading...' text on the splash screen that is being displayed -while the installer is starting (Verifying installer, Unpacking data) can be changed by using a -customized UI resource file (MUI_UI setting) with a modified dialog 111.
-The 'Verifying installer' and 'Unpacking data' texts are defined in the language header file of the -NSIS exehead (Source\exehead\lang.h). To change them, you have to edit this file and recompile -NSIS.

-

To modify the Welcome dialog and Finish dialog, use a custom INI file (MUI_SPECIALINI setting) -or write to the INI file in the custom page functions.

-

Customize Modern UI Functions

-

If you want add your own code to functions inserted by the Modern UI, such as the .onGUIInit -function and the Page functions, create your own function and let the Modern UI functions call -them. Use the defines to define the name of your functions.

+

The 'Please wait while Setup is loading...' text on the splash +screen that is being displayed while the installer is starting +(Verifying installer, Unpacking data) can be changed by using a +customized UI resource file (MUI_UI setting) with a modified dialog +111.
+The 'Verifying installer' and 'Unpacking data' texts are defined in +the language header file of the NSIS exehead +(Source\exehead\lang.h). To change them, you have to edit this file +and recompile NSIS.

+

To modify the Welcome dialog and Finish dialog, use a custom INI +file (MUI_SPECIALINI setting) or write to the INI file in the +custom page functions.

+
+
+

Customize Modern +UI Functions

+
+

If you want add your own code to functions inserted by the +Modern UI, such as the .onGUIInit function and the Page functions, +create your own function and let the Modern UI functions call them. +Use the defines to define the name of your functions.

Example:

 !define MUI_CUSTOMFUNCTION_GUIINIT myGuiInit
@@ -792,47 +1113,109 @@ Function myGUIInit
   ...your own code...
 FunctionEnd
-

General Custom Functions

-
-

These defines should be set before inserting the language macros.

-

MUI_CUSTOMFUNCTION_GUIINIT function
-MUI_CUSTOMFUNCTION_UNGUIINIT function
-MUI_CUSTOMFUNCTION_ABORT function
-MUI_CUSTOMFUNCTION_UNABORT function

+

Open/Close section General Custom +Functions

+
+

These defines should be set before inserting the language +macros.

+

MUI_CUSTOMFUNCTION_GUIINIT function
+MUI_CUSTOMFUNCTION_UNGUIINIT function
+MUI_CUSTOMFUNCTION_ABORT function
+MUI_CUSTOMFUNCTION_UNABORT function

-

Page Custom Functions

-
+

Open/Close section Page Custom +Functions

+

These defines should be set before inserting a page macro.

-

MUI_PAGE_CUSTOMFUNCTION_PRE function
-MUI_PAGE_CUSTOMFUNCTION_SHOW function
-MUI_PAGE_CUSTOMFUNCTION_LEAVE function

+

MUI_PAGE_CUSTOMFUNCTION_PRE function
+MUI_PAGE_CUSTOMFUNCTION_SHOW function
+MUI_PAGE_CUSTOMFUNCTION_LEAVE function

Notes:

  • The StartMenu page does not have a Show function
    • -
  • In the Pre function of the Welcome page and the Finish page, you can write to the -InstallOptions INI file of the page (ioSpecial.ini)
    • -
  • In the Show function of Welcome page and the Finish page, $MUI_HWND contains the HWND of the -inner dialog
    • +
  • In the Pre function of the Welcome page and the Finish page, +you can write to the InstallOptions INI file of the page +(ioSpecial.ini)
    • +
  • In the Show function of Welcome page and the Finish page, +$MUI_HWND contains the HWND of the inner dialog
+

Open/Close section Welcome/Finish Page +Custom Functions

+
+

This define should be inserted before a single Welcome or Finish +page.

+

MUI_WELCOMEFINISHPAGE_CUSTOMFUNCTION_INIT +function

+

This Init function is called before the InstallOptions INI file +for the page is written, so you can use it to initialize any +variables used in the page settings.

+
+
+

Examples

+
+

Basic: Basic.nsi
+Welcome/Finish page: WelcomeFinish.nsi
+ +Multiple languages: MultiLanguage.nsi
+ +Header image: HeaderBitmap.nsi
+ +Custom pages: InstallOptions.nsi
+ +Start Menu Folder page: StartMenu.nsi

+

Version history

+
    -
  • 1.69 - January 7, 2004 +
  • 1.70 - February 6, 2004
      -
    • Fixed top text on uninstaller license page
      • -
    • All uninstaller pages work without installer pages
      • +
    • Improved documentation
      • +
    • New Init custom function for Welcome and Finish page

Complete version history

+

Credits

+

Made by Joost Verburg.
Icons designed by Nikos Adamamas, aka adni18.
-Thanks to Amir Szekely, aka KiCHiK, for his work on NSIS to make this possible.

+Thanks to Amir Szekely, aka KiCHiK, for his work on NSIS to make +this possible.

+

Help

-

Please post questions at the NSIS +

License

+
+

The zlib/libpng license applies to the Modern UI.

+

Open/Close section License Terms

+
 Copyright © 2002-2004 Joost Verburg
 
@@ -852,6 +1235,8 @@ it freely, subject to the following restrictions:
    and must not be misrepresented as being the original software.
 3. This notice may not be removed or altered from any distribution.
+
+
- diff --git a/Contrib/Modern UI/Screenshot.png b/Contrib/Modern UI/Screenshot.png deleted file mode 100644 index 94f53865..00000000 Binary files a/Contrib/Modern UI/Screenshot.png and /dev/null differ diff --git a/Contrib/Modern UI/Screenshot2.png b/Contrib/Modern UI/Screenshot2.png deleted file mode 100644 index 5741c034..00000000 Binary files a/Contrib/Modern UI/Screenshot2.png and /dev/null differ diff --git a/Contrib/Modern UI/System.nsh b/Contrib/Modern UI/System.nsh index 2d3246d0..22e18837 100644 --- a/Contrib/Modern UI/System.nsh +++ b/Contrib/Modern UI/System.nsh @@ -1110,10 +1110,21 @@ Var MUI_TEMP2 !macroend +!macro MUI_WELCOMEFINISHPAGE_FUNCTION_CUSTOM + + !ifdef MUI_WELCOMEFINISHPAGE_CUSTOMFUNCTION_INIT + Call "${MUI_WELCOMEFINISHPAGE_CUSTOMFUNCTION_INIT}" + !undef MUI_WELCOMEFINISHPAGE_CUSTOMFUNCTION_INIT + !endif + +!macroend + !macro MUI_FUNCTION_WELCOMEPAGE PRE LEAVE Function "${PRE}" + !insertmacro MUI_WELCOMEFINISHPAGE_FUNCTION_CUSTOM + !insertmacro MUI_INSTALLOPTIONS_WRITE "ioSpecial.ini" "Settings" "NumFields" "3" !insertmacro MUI_INSTALLOPTIONS_WRITE "ioSpecial.ini" "Settings" "NextButtonText" "" !insertmacro MUI_INSTALLOPTIONS_WRITE "ioSpecial.ini" "Settings" "CancelEnabled" "" @@ -1353,6 +1364,8 @@ Var MUI_TEMP2 Function "${PRE}" + !insertmacro MUI_WELCOMEFINISHPAGE_FUNCTION_CUSTOM + !insertmacro MUI_INSTALLOPTIONS_WRITE "ioSpecial.ini" "Settings" "NextButtonText" "${MUI_FINISHPAGE_BUTTON}" !ifdef MUI_FINISHPAGE_ABORTWARNINGCHECK diff --git a/Contrib/Modern UI/images/closed.gif b/Contrib/Modern UI/images/closed.gif new file mode 100644 index 00000000..b45054ee Binary files /dev/null and b/Contrib/Modern UI/images/closed.gif differ diff --git a/Contrib/Modern UI/Readme.gif b/Contrib/Modern UI/images/header.gif similarity index 100% rename from Contrib/Modern UI/Readme.gif rename to Contrib/Modern UI/images/header.gif diff --git a/Contrib/Modern UI/images/open.gif b/Contrib/Modern UI/images/open.gif new file mode 100644 index 00000000..9fff60ed Binary files /dev/null and b/Contrib/Modern UI/images/open.gif differ diff --git a/Contrib/Modern UI/images/screen1.png b/Contrib/Modern UI/images/screen1.png new file mode 100644 index 00000000..0e25c0d3 Binary files /dev/null and b/Contrib/Modern UI/images/screen1.png differ diff --git a/Contrib/Modern UI/images/screen2.png b/Contrib/Modern UI/images/screen2.png new file mode 100644 index 00000000..4fccd41c Binary files /dev/null and b/Contrib/Modern UI/images/screen2.png differ diff --git a/Examples/Modern UI/Basic.nsi b/Examples/Modern UI/Basic.nsi index 381e9acd..949ede0f 100644 --- a/Examples/Modern UI/Basic.nsi +++ b/Examples/Modern UI/Basic.nsi @@ -1,4 +1,4 @@ -;NSIS Modern User Interface version 1.69 +;NSIS Modern User Interface version 1.70 ;Basic Example Script ;Written by Joost Verburg @@ -8,10 +8,10 @@ !include "MUI.nsh" ;-------------------------------- -;Configuration +;General - ;General - Name "Modern UI Test 1.69" + ;Name and file + Name "Modern UI Test 1.70" OutFile "Basic.exe" ;Default installation folder @@ -48,7 +48,7 @@ Section "Dummy Section" SecDummy SetOutPath "$INSTDIR" - ;ADD YOUR OWN STUFF HERE! + ;ADD YOUR OWN FILES HERE... ;Store installation folder WriteRegStr HKCU "Software\Modern UI Test" "" $INSTDIR @@ -74,7 +74,7 @@ SectionEnd Section "Uninstall" - ;ADD YOUR OWN STUFF HERE! + ;ADD YOUR OWN FILES HERE... Delete "$INSTDIR\Uninstall.exe" diff --git a/Examples/Modern UI/HeaderBitmap.nsi b/Examples/Modern UI/HeaderBitmap.nsi index 8c404daf..6fa51020 100644 --- a/Examples/Modern UI/HeaderBitmap.nsi +++ b/Examples/Modern UI/HeaderBitmap.nsi @@ -1,4 +1,4 @@ -;NSIS Modern User Interface version 1.69 +;NSIS Modern User Interface version 1.70 ;Header Bitmap Example Script ;Written by Joost Verburg @@ -8,10 +8,10 @@ !include "MUI.nsh" ;-------------------------------- -;Configuration +;General - ;General - Name "Modern UI Test 1.69" + ;Name and file + Name "Modern UI Test 1.70" OutFile "HeaderBitmap.exe" ;Default installation folder @@ -21,7 +21,7 @@ InstallDirRegKey HKCU "Software\Modern UI Test" "" ;-------------------------------- -;Modern UI Configuration +;Interface Configuration !define MUI_HEADERIMAGE !define MUI_ABORTWARNING @@ -49,7 +49,7 @@ Section "Dummy Section" SecDummy SetOutPath "$INSTDIR" - ;ADD YOUR OWN STUFF HERE! + ;ADD YOUR OWN FILES HERE... ;Store installation folder WriteRegStr HKCU "Software\Modern UI Test" "" $INSTDIR @@ -75,7 +75,7 @@ SectionEnd Section "Uninstall" - ;ADD YOUR OWN STUFF HERE! + ;ADD YOUR OWN FILES HERE... Delete "$INSTDIR\Uninstall.exe" diff --git a/Examples/Modern UI/InstallOptions.nsi b/Examples/Modern UI/InstallOptions.nsi index 759127ab..cf2eefdf 100644 --- a/Examples/Modern UI/InstallOptions.nsi +++ b/Examples/Modern UI/InstallOptions.nsi @@ -1,4 +1,4 @@ -;NSIS Modern User Interface version 1.69 +;NSIS Modern User Interface version 1.70 ;InstallOptions Example Script ;Written by Joost Verburg @@ -8,10 +8,10 @@ !include "MUI.nsh" ;-------------------------------- -;Configuration +;General - ;General - Name "Modern UI Test 1.69" + ;Name and file + Name "Modern UI Test 1.70" OutFile "InstallOptions.exe" ;Default installation folder @@ -68,7 +68,7 @@ Section "Dummy Section" SecDummy SetOutPath "$INSTDIR" - ;ADD YOUR OWN STUFF HERE! + ;ADD YOUR OWN FILES HERE... ;Store installation folder WriteRegStr HKCU "Software\Modern UI Test" "" $INSTDIR @@ -137,7 +137,7 @@ FunctionEnd Section "Uninstall" - ;ADD YOUR OWN STUFF HERE! + ;ADD YOUR OWN FILES HERE... Delete "$INSTDIR\Uninstall.exe" diff --git a/Examples/Modern UI/MultiLanguage.nsi b/Examples/Modern UI/MultiLanguage.nsi index 87ead347..ee6bcb0a 100644 --- a/Examples/Modern UI/MultiLanguage.nsi +++ b/Examples/Modern UI/MultiLanguage.nsi @@ -1,4 +1,4 @@ -;NSIS Modern User Interface version 1.69 +;NSIS Modern User Interface version 1.70 ;Multilingual Example Script ;Written by Joost Verburg @@ -8,10 +8,10 @@ !include "MUI.nsh" ;-------------------------------- -;Configuration +;General - ;General - Name "Modern UI Test 1.69" + ;Name and file + Name "Modern UI Test 1.70" OutFile "MultiLanguage.exe" ;Default installation folder @@ -103,7 +103,7 @@ Section "Dummy Section" SecDummy SetOutPath "$INSTDIR" - ;ADD YOUR OWN STUFF HERE! + ;ADD YOUR OWN FILES HERE... ;Store installation folder WriteRegStr HKCU "Software\Modern UI Test" "" $INSTDIR @@ -138,7 +138,7 @@ FunctionEnd Section "Uninstall" - ;ADD YOUR OWN STUFF HERE! + ;ADD YOUR OWN FILES HERE... Delete "$INSTDIR\Uninstall.exe" diff --git a/Examples/Modern UI/StartMenu.nsi b/Examples/Modern UI/StartMenu.nsi index c3801718..582577e0 100644 --- a/Examples/Modern UI/StartMenu.nsi +++ b/Examples/Modern UI/StartMenu.nsi @@ -1,4 +1,4 @@ -;NSIS Modern User Interface version 1.69 +;NSIS Modern User Interface version 1.70 ;Start Menu Folder Selection Example Script ;Written by Joost Verburg @@ -8,10 +8,10 @@ !include "MUI.nsh" ;-------------------------------- -;Configuration +;General - ;General - Name "Modern UI Test 1.69" + ;Name and file + Name "Modern UI Test 1.70" OutFile "StartMenu.exe" ;Default installation folder @@ -62,7 +62,7 @@ Section "Dummy Section" SecDummy SetOutPath "$INSTDIR" - ;ADD YOUR OWN STUFF HERE! + ;ADD YOUR OWN FILES HERE... ;Store installation folder WriteRegStr HKCU "Software\Modern UI Test" "" $INSTDIR @@ -96,7 +96,7 @@ SectionEnd Section "Uninstall" - ;ADD YOUR OWN STUFF HERE! + ;ADD YOUR OWN FILES HERE... Delete "$INSTDIR\Uninstall.exe" diff --git a/Examples/Modern UI/WelcomeFinish.nsi b/Examples/Modern UI/WelcomeFinish.nsi index 508f5546..5c22ae3a 100644 --- a/Examples/Modern UI/WelcomeFinish.nsi +++ b/Examples/Modern UI/WelcomeFinish.nsi @@ -1,4 +1,4 @@ -;NSIS Modern User Interface version 1.69 +;NSIS Modern User Interface version 1.70 ;Welcome/Finish Page Example Script ;Written by Joost Verburg @@ -8,10 +8,10 @@ !include "MUI.nsh" ;-------------------------------- -;Configuration +;General - ;General - Name "Modern UI Test 1.69" + ;Name and file + Name "Modern UI Test 1.70" OutFile "WelcomeFinish.exe" ;Default installation folder @@ -52,7 +52,7 @@ Section "Dummy Section" SecDummy SetOutPath "$INSTDIR" - ;ADD YOUR OWN STUFF HERE! + ;ADD YOUR OWN FILES HERE... ;Store installation folder WriteRegStr HKCU "Software\Modern UI Test" "" $INSTDIR @@ -78,7 +78,7 @@ SectionEnd Section "Uninstall" - ;ADD YOUR OWN STUFF HERE! + ;ADD YOUR OWN FILES HERE... Delete "$INSTDIR\Uninstall.exe"