From 43a8e2b2b0e5f56c13c0d13600f45d1aee3d42f8 Mon Sep 17 00:00:00 2001 From: joostverburg Date: Mon, 11 Nov 2002 18:37:31 +0000 Subject: [PATCH] updated documentation git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@1676 212acab6-be3b-0410-9dea-997c60f758d6 --- Contrib/Modern UI/Changelog.txt | 7 ++-- Contrib/Modern UI/Readme.html | 60 ++++++++++++++------------------- 2 files changed, 30 insertions(+), 37 deletions(-) diff --git a/Contrib/Modern UI/Changelog.txt b/Contrib/Modern UI/Changelog.txt index e7a2784e..42ed1a25 100644 --- a/Contrib/Modern UI/Changelog.txt +++ b/Contrib/Modern UI/Changelog.txt @@ -1,11 +1,14 @@ NSIS Modern User Interface - VERSION HISTORY -1.5 - Novermber 9, 2002 +1.5 - Novermber 11, 2002 * New language file format * Language strings can be changed in the script without editing language files +* 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 macro's updated. MUI_INSTALLOPTIONS_DISPLAY is the standard macro now. Use MUI_INSTALLOPTIONS_INITDIALOG and MUI_INSTALLOPTIONS_SHOW if you want to customize dialog controls. -* Start Menu Folder selection page +* No more writing window titles & abort warnings to Install Options INI Files * Compatible with new paging system * Renamed macro's and defines * Some small fixes diff --git a/Contrib/Modern UI/Readme.html b/Contrib/Modern UI/Readme.html index d2e44093..37e2e0e9 100644 --- a/Contrib/Modern UI/Readme.html +++ b/Contrib/Modern UI/Readme.html @@ -137,17 +137,13 @@ with a custom user interface.

!define MUI_COMPONENTSPAGE ;Component-selection page !define MUI_DIRECTORYPAGE ;Directory-selection page !define MUI_LICENSEPAGE ;License page -!define MUI_STARTMENUPAGE ;Start Menu-selection page - +!define MUI_STARTMENUPAGE ;Start Menu Folder selection page !define MUI_ABORTWARNING ;Abort warning messagebox - !define MUI_CUSTOMPAGECOMMANDS ;Use customized pages -!define MUI_WINDOWTITLE ;Insert string for the window title !define MUI_UNINSTALLER ;Uninstaller !define MUI_UNCUSTOMPAGECOMMANDS ;Use customized uninstaller pages -

MUI_WINDOWTITLE is required by MUI_(UN)INSTALLOPTIONS_WRITETITLE.

4. Insert language files

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

!insertmacro MUI_LANGUAGE "English"
@@ -162,10 +158,9 @@ with a custom user interface.

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

NOTE: Not all language files contain strings for the - new Start Menu-selection page yet. If you are using a language file which does not contain + new Start Menu Folder selection page yet. If you are using a language file which does not contain these strings, you should always define them.
Please help to translate the new strings and - post them at the NSIS - Forum.

+ post them at the NSIS Forum.

5. Define interface settings (optional)

You can change the settings of the interface by usings defines:

!define MUI_UI "${NSISDIR}\Contrib\UIs\modern2.exe"
@@ -228,49 +223,40 @@ Install Options documentation for info about creating Install Options INI Fi

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

+LangString TEXT_IO_WINDOWTITLE ": Install Options Page"
+
 !insertmacro MUI_PAGECOMMAND_LICENSE
 !insertmacro MUI_PAGECOMMAND_COMPONENTS
 !insertmacro MUI_PAGECOMMAND_DIRECTORY
-Page custom [function name] ;A custom page
+Page custom FunctionName $(TEXT_IO_WINDOWTITLE) ;A custom page
 !insertmacro MUI_PAGECOMMAND_INSTFILES
-

This is also possible the uninstaller:

+

This is also possible in the uninstaller:

+LangString UNTEXT_IO_WINDOWTITLE ": Install Options Page"
+
 !insertmacro MUI_UNPAGECOMMAND_CONFIRM
-UninstPage custom [function name] ;A custom page
+UninstPage custom FunctionName $(TEXT_IO_WINDOWTITLE) ;A custom page
 !insertmacro MUI_UNPAGECOMMAND_INSTFILES

Don't forget to define MUI_CUSTOMPAGECOMMANDS or MUI_UNCUSTOMPAGECOMMANDS before inserting the MUI_SYSTEM macro.

Call Install Options

-

You can call Install Options in [function name]:

+

You can call Install Options in FunctionName:

 LangString TEXT_IO_TITLE ${LANG_ENGLISH} "Install Options Page"
 LangString TEXT_IO_SUBTITLE ${LANG_ENGLISH} "Create your own dialog!"
 
-Function [function name]
+Function FunctionName
   !insertmacro MUI_HEADER_TEXT "$(TEXT_IO_TITLE)" "$(TEXT_IO_SUBTITLE)"
   !insertmacro MUI_INSTALLOPTIONS_SHOW "ioFile.ini"
 FunctionEnd
-

Write title to Install Options INI Files

-

Use these macro's in .onInit to write the page -title to an Install Options INI File.

-
-LangString TEXT_IO_PAGETITLE ${LANG_ENGLISH} "Page Title"
-
-!insertmacro MUI_INSTALLOPTIONS_WRITETITLE "ioFile.ini" "$(TEXT_IO_PAGETITLE)"
-
-

For the uninstaller, use:

-
-LangString UNTEXT_IO_PAGETITLE ${LANG_ENGLISH} "Uninstaller Page Title"
-
-!insertmacro MUI_UNINSTALLOPTIONS_WRITETITLE "ioFile.ini" "$(UNTEXT_IO_PAGETITLE)"
-

Examples

Basic: Basic.nsi
Multilanguage: MultiLanguage.nsi
- Cutom pages: InstallOptions.nsi
+ Custom pages: InstallOptions.nsi
+ Start Menu Folder selection: StartMenu.nsi

The interface

Modern.exe and modern2.exe

@@ -285,24 +271,28 @@ LangString UNTEXT_IO_PAGETITLE ${LANG_ENGLISH} "Uninstaller Page Title" Resource Hacker.

The 'Loading Setup' text on the splash screen which is being displayed when the installer is starting (Verifying - installer, Unpacking data when using COMPRESS_WHOLE) cannot - be changed by the script, because the installer is not started - yet when this dialog is being displayed. If you want to change - this text, modify dialog 111 of modern(2).exe.
-The 'verifying installer' and 'unpacking data' texts are defined in + installer, Unpacking data) cannot be changed by the script, + because the installer is not started yet when this dialog is being + displayed. If you want to change this text, modify dialog 111 of + modern(2).exe.
+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 need to edit this file and recompile NSIS.

Version history