Using the Modern UI macro's and language files, +
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.
@@ -139,7 +139,7 @@ should not use commands like Icon, BrandingText etc.
How to use
-The Modern UI has a macro system, so all the code the +
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.
@@ -147,7 +147,7 @@ an older script with the Classic UI, follow the steps below. will also help you to learn more about the Modern UI.Note: If you want to add a double quote (") to a Modern UI string, you should always escape -it ($\"), because the Modern UI macro's use " to separate +it ($\"), because the Modern UI macros use " to separate parameters.
1. Include the header file
!include "MUI.nsh"@@ -161,9 +161,9 @@ parameters.
This information will be used inside the texts for the installer interface.
3. Pages
-Insert the following macro's to set the pages you want to use. +
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 commmands between the macro's to add custom pages.
+ You can also insert custom Page commands between the macros to add custom pages.
More info about custom pages...
Example:
!insertmacro MUI_PAGE_COMPONENTS@@ -218,7 +218,7 @@ parameters.
Start Menu Folder Page Settings
If you did not disable the 'Do not create shortcuts' checkbox, - put the script code to write the shortcuts between these macro's, + put the script code to write the shortcuts between these macros, because the creation can be disabled by the user:
!insertmacro MUI_STARTMENU_WRITE_BEGIN @@ -436,7 +436,7 @@ FunctionEnd
7. Set the descriptions for the sections
The descriptions of sections will be displayed on the - componens page, when the users hovers the mouse over a section. + components page, when the user hovers the mouse over a section. If you don't want to use descriptions, use the MUI_COMPONENTSPAGE_NODESC setting.
To set a description for a section, you have to add an @@ -447,7 +447,7 @@ Section "Section Name 1" Section1 ... SectionEnd -
Use these macro's to set the descriptions:
+Use these macros to set the descriptions:
LangString DESC_Section1 ${LANG_ENGLISH} "Description of section 1."
LangString DESC_Section2 ${LANG_ENGLISH} "Description of section 2."
@@ -463,7 +463,7 @@ insert ReserveFile commands. More info...
Custom page commands
If you want add custom pages to your installer, you should insert your
-own page commands between the page macro's:
+own page commands between the page macros:
!insertmacro MUI_PAGE_WELCOME
Page custom FunctionName ;Custom page
@@ -491,7 +491,7 @@ FunctionEnd
If your INI File is located in another directory, use
MUI_INSTALLOPTIONS_EXTRACT_AS. The second parameter is the filename for
the Plugins directory. Use this name when inserting the other InstallOptions
-macro's:
+macros:
Function .onInit
!insertmacro MUI_INSTALLOPTIONS_EXTRACT_AS "..\ioFile.ini" "ioFile.ini"
@@ -509,7 +509,7 @@ Function FunctionName ;FunctionName defined with Page command
!insertmacro MUI_INSTALLOPTIONS_DISPLAY "ioFile.ini"
FunctionEnd
-For custom fonts and colors, macro's for the initDialog and show
+
For custom fonts and colors, macros for the initDialog and show
functions of InstallOptions are also available:
Var HWND
@@ -539,7 +539,7 @@ 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 added to the stack, so you can use the Pop command to get it.
-To read or write INI file values use these macro's:
+To read or write INI file values use these macros:
!insertmacro MUI_INSTALLOPTIONS_READ $VAR "ioFile.ini" "Field #" "Value Name"
!insertmacro MUI_INSTALLOPTIONS_WRITE "ioFile.ini" "Field #" "Value Name" "Value"
@@ -556,7 +556,7 @@ files which are being extracted in the .onInit function or in Page
functions are first in the data block, because this will make your installer
start faster.
If these functions are not above any other File command,
-insert the ReserveFile commands or macro's above other File commands:
+insert the ReserveFile commands or macros above other File commands:
ReserveFile "ioFile.ini" ;Your own InstallOptions INI files
ReserveFile "${NSISDIR}\Contrib\Icons\modern-header.bmp" ;Your header bitmap
@@ -594,7 +594,7 @@ ReserveFile "${NSISDIR}\Contrib\Icons\modern-header.bmp" ;Your header bitmap
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. Add the defines before the MUI_LANGUAGE macro's.
+to define the name of your functions. Add the defines before the MUI_LANGUAGE macros.
Example:
!define MUI_CUSTOMFUNCTION_GUIINIT myGuiInit
@@ -693,11 +693,11 @@ MUI_UNCUSTOMFUNCTION_INSTFILES_LEAVE