From cdb1967c698e6192f1de7a13d42e6fe0b7e587f1 Mon Sep 17 00:00:00 2001 From: joostverburg Date: Fri, 6 Dec 2002 19:22:42 +0000 Subject: [PATCH] more improvements git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@1913 212acab6-be3b-0410-9dea-997c60f758d6 --- Contrib/Modern UI/Readme.html | 43 +++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 17 deletions(-) diff --git a/Contrib/Modern UI/Readme.html b/Contrib/Modern UI/Readme.html index 17d394ea..140d2fbf 100644 --- a/Contrib/Modern UI/Readme.html +++ b/Contrib/Modern UI/Readme.html @@ -110,7 +110,7 @@ with a custom user interface.

I made this interface with a modern wizard style, like the wizards of recent Windows versions. This new interface also features new graphics and a description area on the - component-selection page.

+ component selection page.

To use this new interface for for installer, you need to add some code to your NSIS script. Read this document for more info!

Requirements

@@ -121,11 +121,15 @@ with a custom user interface.

How to use

The Modern UI has a macro system, so most of the code has already been written for you!

-

The easiest way to use the Modern UI is to customize one of the example - scripts, but you can also modify an existing script.

-

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

-

How to use the Modern UI in an existing scrip (in order, from the beginning of the script):

+

The easiest way to use the Modern UI is to customize +one of the example scripts, but you can also +modify an existing script.

+

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

+

To use the Modern UI in an existing script, you should +add the following things (in order, from the beginning of the script):

1. Include the header file

!include "${NSISDIR}\Contrib\Modern UI\System.nsh"

2. Define the name and version of your software

@@ -155,24 +159,26 @@ you should always escape it ($\"), because the Modern UI macro's use " Show the directory selection page.

MUI_STARTMENUPAGE
Show the Start Menu Folder selection page page.

+

MUI_STARTMENU_VARIABLE
Variable to store the current Start Menu Folder. Default is $9. - You cannot use this variable in your script (or you should Push/Pop it) - if you are using the Start Menu Folder selection page.

+ You cannot use this variable in your script (or you should Push/Pop it).e.

MUI_STARTMENU_DEFAULTFOLDER
- The default start menu Folder. Use $(LANGSTRINGNAME) as value is you want + The default Start Menu Folder. Use $(LANGSTRINGNAME) as value is you want to use a language string.

+

MUI_FINISHPAGE
Show the Finish page.

+

MUI_FINISHPAGE_RUN
Applcation which the user can select to run (using a checkbox). - You don't need to put quotes around the value when it contains spaces.

+ You don't need to put quotes around the filename when it contains spaces.

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

MUI_FINISHPAGE_SHOWREADME
File which the user can select to view (using a checkbox). - You don't need to put quotes around the value when it contains spaces. + You don't need to put quotes around the filename when it contains spaces. Use $(LANGSTRINGNAME) as value is you want to use a language string.

MUI_FINISHPAGE_NOAUTOCLOSE
Do not automatically jump to the finish page, to allow the user to @@ -180,6 +186,7 @@ you should always escape it ($\"), because the Modern UI macro's use "

MUI_FINISHPAGE_NOREBOOTSUPPORT
Disables support for a reboot option. Use this to save some space if you are not using /REBOOTOK or SetRebootFlag.

+

MUI_ABORTWARNING
Show a message box with a warning (are you sure?) when the user closes the installation.

@@ -191,12 +198,14 @@ you should always escape it ($\"), because the Modern UI macro's use " custom code to the function. More info...

MUI_UNINSTALLER
Define if you are using an uninstaller.

+

MUI_UNCUSTOMPAGECOMMANDS
Don't insert UninstPage commands. Use this if you are using custom UninstPage commands to add your own pages.

MUI_UNCUSTOMGUIINIT
Don't insert the un.onGUIInit function. Use this if you want to add custom code to the function. More info...

+

4. Insert language files

Insert the Modern UI language files for the languages you are using:

!insertmacro MUI_LANGUAGE "English"
@@ -209,7 +218,7 @@ you should always escape it ($\"), because the Modern UI macro's use " !insertmacro MUI_LANGUAGE "English"

Have a look at the language files for a complete list of all the - names. + string names.

Note: Not all language files contain strings for the new Start Menu Folder selection, Welcome and Finish pages yet. If you are using one of these pages and the language file does not contain these strings, you should always define them.
@@ -239,7 +248,7 @@ you should always escape it ($\"), because the Modern UI macro's use " (Verdana, 12, 700)
The font for the title on the Welcome and Finish pages. Fontstyle: [weight] [/ITALIC] [/UNDERLINE] [/STRIKE]

MUI_INSTALLCOLORS (/windows)
- The hexadecimal colors of the details screen ("foreground" "background"). + The colors of the details screen, hexadecimal ("foreground" "background").

MUI_PROGRESSBAR (smooth)
The style of the progress bar ("colored" to use the MUI_INSTALLCOLORS or "" for a old-school windows look).

MUI_SPECIALINI (${NSISDIR}\Contrib\Modern UI\ioSpecial.ini)
@@ -272,7 +281,7 @@ LangString DESC_Section2 ${LANG_ENGLISH} "Description of section 2." !insertmacro MUI_FUNCTIONS_DESCRIPTION_END

Add an extra parameter to the Section command to -set a define with the section number:

+set the define with the section number:

 Section "Section Name 1" Section1
   ...
@@ -282,7 +291,7 @@ SectionEnd
 

 
Custom page commands

 
If you want add custom pages to your installer, you should insert your
-own page commands to set the order of the pages and the names of the page functions.

+own page commands to set the order of the pages and the names of the page functions:

 
 LangString TEXT_IO_WINDOWTITLE ": Install Options Page Title"
 
@@ -394,8 +403,8 @@ FunctionEnd
   Thanks to Amir Szekely, aka KiCHiK, for his work on NSIS 
   to make this possible.

 
Help

-
Please post questions at the NSIS 
-  Forum.

+
Please post questions at the
+NSIS Forum.

 
License

 
Copyright © 2002 Joost Verburg