From a7045c328789edbd645d2aae70d2159f16039c20 Mon Sep 17 00:00:00 2001 From: joostverburg Date: Wed, 19 Nov 2003 22:19:45 +0000 Subject: [PATCH] corrections git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@3182 212acab6-be3b-0410-9dea-997c60f758d6 --- Contrib/Modern UI/Readme.html | 103 +++++++++++++++++----------------- 1 file changed, 53 insertions(+), 50 deletions(-) diff --git a/Contrib/Modern UI/Readme.html b/Contrib/Modern UI/Readme.html index 3b56a013..45fad49a 100644 --- a/Contrib/Modern UI/Readme.html +++ b/Contrib/Modern UI/Readme.html @@ -149,8 +149,8 @@ settings. Others (e.g. MUI_UI) can be used to define a specific value.

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: $\" because the Modern -UI macros use " separate parameters.

+

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

1. Header file

 !include "MUI.nsh"
@@ -162,13 +162,13 @@ all pages of a certain type.

 
General Interface Settings

 

 
MUI_ICON icon_file

-The icon of the installer.

+The icon for the installer.

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

 
MUI_UNICON icon_file

-The icon of the uninstaller.

+The icon for the uninstaller.

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

 
MUI_HEADERIMAGE

-Display an image on the header of a page.

+Image to display on the header of a page.

 

 
MUI_HEADERIMAGE_BITMAP bmp_file

 Bitmap image to display on the header of installers pages (recommended size: 150x57 pixels).

@@ -180,15 +180,15 @@ you have an image that does not use the whole space. If you have a full size bit
 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).

+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

@@ -201,14 +201,15 @@ you have an image that does not use the whole space. If you have a full size bit
 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).

+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

@@ -216,7 +217,7 @@ Display the header image on the right side instead of the left side (when using
 will be displayed on the left side instead of the right side).

 
 
MUI_BGCOLOR (color: RRGGBBR hexadecimal)

-Background color for the header, Welcome- and Finish page.

+Background color for the header, the Welcome page and the Finish page.

 Default: FFFFFF

 
 
Interface Resource Settings

@@ -244,10 +245,10 @@ The interface files with a customized dialog resource IDD_SELCOM without a descr
 
Welcome/Finish Page Interface Settings

 

 
MUI_WELCOMEFINISHPAGE_3LINES

-Create a bigger area for the title on the Welcome- and Finish page, to allow displaying 3 lines of
-text (with the default font).

+Create a bigger area for the title on the Welcome page and the Finish page, to allow displaying 3
+lines of text (with the default font).

 
MUI_WELCOMEFINISHPAGE_BITMAP bmp_file

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

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

 Default: ${NSISDIR}\Contrib\Graphics\Wizard\win.bmp

 

 
MUI_WELCOMEFINISHPAGE_BITMAP_NOSTRETCH

@@ -260,20 +261,20 @@ 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- and Finish page.

+InstallOptions INI file for the Welcome page and the Finish page.

 Default: ${NSISDIR}\Contrib\Modern UI\ioSpecial.ini

 
MUI_WELCOMEFINISHPAGE_INI_3LINES ini_file

-InstallOptions INI file for the Welcome- and Finish page with space for 3 lines of title text (with
-the default font).

+InstallOptions INI file for the Welcome page and the Finish page with space for 3 lines of title
+text (with the default font).

 Default: ${NSISDIR}\Contrib\Modern UI\ioSpecial3.ini

 

 
Uninstaller Welcome/Finish Page Settings

 

 
MUI_UNWELCOMEFINISHPAGE_3LINES

-Create a bigger area for the title on the uninstaller Welcome- and Finish page, to allow displaying
-3 lines of text (with the default font).

+Create a bigger area for the title on the uninstaller Welcome page and the Finish page, to allow
+displaying 3 lines of text (with the default font).

 
MUI_UNWELCOMEFINISHPAGE_BITMAP bmp_file

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

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

 Default: ${NSISDIR}\Contrib\Graphics\Wizard\win.bmp

 

 
MUI_UNWELCOMEFINISHPAGE_BITMAP_NOSTRETCH

@@ -286,11 +287,11 @@ 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- and Finish page.

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

 Default: ${NSISDIR}\Contrib\Modern UI\ioSpecial.ini

 
MUI_WELCOMEFINISHPAGE_INI_3LINES ini_file

-InstallOptions INI file for the Welcome- and Finish page with space for 3 lines of title text (with
-the default font).

+InstallOptions INI file for the Welcome page and the Finish page with space for 3 lines of title
+text (with the default font).

 Default: ${NSISDIR}\Contrib\Modern UI\ioSpecial3.ini

 

 
License Page Interface Settings

@@ -339,7 +340,7 @@ Do not automatically jump to the finish page, to allow the user to check the uni
 Show a message box with a warning when the user wants to close the installer.

 

 
MUI_ABORTWARNING_TEXT text

-Texts to display on the abort warning messagebox.

+Text to display on the abort warning messagebox.

 

 

 
Uninstaller Abort Warning Settings

@@ -348,7 +349,7 @@ Texts to display on the abort warning messagebox.

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

 

 
MUI_UNABORTWARNING_TEXT text

-Texts to display on the abort warning messagebox.

+Text to display on the abort warning messagebox.

 

 

 
3. Pages

@@ -365,8 +366,8 @@ multiple folders).

 Var STARTMENU_FOLDER
 !insertmacro MUI_PAGE_STARTMENU "Application" $STARTMENU_FOLDER
-

You need the page ID for the Start Menu Folder page when using the Start Menu Folder macros. The -Start Menu Forder 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
@@ -383,7 +384,8 @@ MUI_UNPAGE_COMPONENTS
MUI_UNPAGE_DIRECTORY
MUI_UNPAGE_INSTFILES
MUI_UNPAGE_FINISH

-

Page Settings apply to a single page and should be set before inserting a page macro. Example:

+

Page Settings apply to a single page and should be set before inserting a page macro. +Example:

 ;Add a directory page to let the user specify a plug-ins folder
 ;Store the folder in $PLUGINS_FOLDER
@@ -423,7 +425,7 @@ Display a checkbox the user has to check to agree with the license terms.

 Text to display next to the checkbox to agree with the license terms.

 
 
MUI_LICENSEPAGE_RADIOBUTTONS

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

 

 
MUI_LICENSEPAGE_RADIOBUTTONS_TEXT_ACCEPT 
 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 dicline the license terms.

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

 

 
 
Components Page Settings

@@ -483,8 +485,8 @@ Do not display the checkbox to disable the creation of Start Menu shortcuts.

 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.

+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
@@ -514,7 +516,7 @@ Text to display on the page. Use \r\n for a newline.

 
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 sytem reboot. Use \r\n for a newline.

+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

@@ -647,7 +649,7 @@ ReserveFile "ioFile.ini" ;Your own InstallOptions INI files
 

 
7. Your own sections and functions

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

-
Information about section- and function code for Start Menu shortcut creation and language
+
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
@@ -671,7 +673,7 @@ LangString DESC_Section2 ${LANG_ENGLISH} "Description of section 2."
 !insertmacro MUI_FUNCTION_DESCRIPTION_END

For the uninstaller, use the MUI_UNFUNCTION_DESCRIPTION_BEGIN and -MUI_UNFUNCTIONS_DESCRIPTION_END macros

+MUI_UNFUNCTIONS_DESCRIPTION_END macros:

 ReserveFile "ioFile.ini" ;Your own InstallOptions INI files
 ReserveFile "${NSISDIR}\Contrib\Graphics\Header\nsis.bmp" ;Your header bitmap
@@ -771,7 +773,8 @@ input:

 
Basic: Basic.nsi

 Welcome/Finish page: WelcomeFinish.nsi

-Multiple languages: MultiLanguage.nsi

+Multiple languages: MultiLanguage.nsi

 Header image: HeaderBitmap.nsi

 Custom pages: InstallOptions.nsi

 Start Menu Folder page: StartMenu.nsi

@@ -786,8 +789,8 @@ 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- and Finish dialog, use a custom INI file (MUI_SPECIALINI setting) or
-write to the INI file in the custom page functions.

+
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
@@ -817,23 +820,23 @@ FunctionEnd
 
Notes:

 
 
 
Version history