3ea2188d7c
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@1907 212acab6-be3b-0410-9dea-997c60f758d6
429 lines
No EOL
18 KiB
HTML
429 lines
No EOL
18 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
|
|
<title>NSIS Modern User Interface</title>
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
|
|
<style type="text/css">
|
|
|
|
body
|
|
{
|
|
padding: 10px;
|
|
background-color: #F0F0F0;
|
|
font-family: Verdana, Arial, Helvetica, sans-serif;
|
|
font-size: 10pt;
|
|
font-weight: normal;
|
|
}
|
|
|
|
center
|
|
{
|
|
text-align: center;
|
|
}
|
|
|
|
table
|
|
{
|
|
margin: auto;
|
|
text-align: left;
|
|
background-color: #FFFFFF;
|
|
}
|
|
|
|
.maintable
|
|
{
|
|
border: 2px solid #376EAB;
|
|
}
|
|
|
|
.margin
|
|
{
|
|
margin: 20px;
|
|
}
|
|
|
|
.text
|
|
{
|
|
margin: 20px;
|
|
}
|
|
|
|
.bold
|
|
{
|
|
font-weight: bold;
|
|
color: #303030;
|
|
}
|
|
|
|
.changelog
|
|
{
|
|
}
|
|
|
|
.header
|
|
{
|
|
font-size: 14pt;
|
|
color: #7A7272;
|
|
}
|
|
|
|
.subheader
|
|
{
|
|
margin: 20px;
|
|
font-size: 11pt;
|
|
font-weight: bold;
|
|
color: #303030;
|
|
}
|
|
|
|
.footer
|
|
{
|
|
margin: 5px 5px 5px 5px;
|
|
text-align: right;
|
|
font-size: 8pt;
|
|
color: #909090;
|
|
}
|
|
|
|
a:link, a:visited, a:active
|
|
{
|
|
color: #294F75;
|
|
text-decoration: none;
|
|
}
|
|
|
|
a:hover
|
|
{
|
|
color: #182634;
|
|
text-decoration: none;
|
|
}
|
|
|
|
</style>
|
|
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="center">
|
|
<table width="750" cellpadding="0" cellspacing="0" class="maintable">
|
|
<tr><td>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr class="header">
|
|
<td><img src="Readme.jpg" width="750" height="80" alt=""></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><div class="margin">
|
|
<p class="header">Introduction</p>
|
|
<p class="text">NSIS 2 makes it is possible to create installers
|
|
with a custom user interface.</p>
|
|
<p class="text"> 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.</p>
|
|
<p class="text">To use this new interface for for installer, you need
|
|
to add some code to your NSIS script. Read this document for more info!</p>
|
|
<p class="header">Requirements</p>
|
|
<p class="text"><a href="http://nsis.sourceforge.net">NSIS 2 beta 0 (or later)</a></p>
|
|
<p class="header">Screenshots</p>
|
|
<p class="text"><img src="Screenshot.png" width="503" height="393" alt=""></p>
|
|
<p class="text"><img src="Screenshot2.png" width="503" height="393" alt=""></p>
|
|
<p class="header">How to use</p>
|
|
<p class="text">The Modern UI has a macro system, so most of the code
|
|
has already been written for you!</p>
|
|
<p class="text">The easiest way to use the Modern UI is to customize one of the <a href="#examples">example</a>
|
|
scripts, but you can also modify an existing script.</p>
|
|
<p class="text"><span class="bold">Note:</span> 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.</p>
|
|
<p class="text">How to use the Modern UI in an existing scrip (in order, from the beginning of the script):</p>
|
|
<p class="subheader">1. Include the header file</p>
|
|
<pre class="margin">!include "${NSISDIR}\Contrib\Modern UI\System.nsh"</pre>
|
|
<p class="subheader">2. Define the name and version of your software</p>
|
|
<pre class="margin">
|
|
!define MUI_PRODUCT "Test Software" ;Define your own software name here
|
|
!define MUI_VERSION "1.0" ;Define your own software version here
|
|
</pre>
|
|
<p class="subheader">3. Define settings</p>
|
|
<p class="text">Use defines to let the Modern UI know what it
|
|
should insert. Most defines (i.e. MUI_WELCOMEPAGE) don't need
|
|
a value, but others should be used to define a value for the
|
|
Modern UI (i.e. MUI_FINISHPAGE_RUN):</p>
|
|
<pre class="margin">
|
|
!define MUI_WELCOMEPAGE
|
|
!define MUI_FINISHPAGE_RUN "$INSTDIR\Application.exe"
|
|
</pre>
|
|
<p class="text">All defines are optional, if you don't define
|
|
a page, the page won't be shown. If you don't define a value,
|
|
the Modern UI won't use that option.</p>
|
|
<p class="text"><span class="bold">MUI_WELCOMEPAGE</span><br>
|
|
Show the welcome page.</p>
|
|
<p class="text"><span class="bold">MUI_LICENSEPAGE</span><br>
|
|
Show the license page.</p>
|
|
<p class="text"><span class="bold">MUI_COMPONENTSPAGE</span><br>
|
|
Show the component selection page.</p>
|
|
<p class="text"><span class="bold">MUI_DIRECTORYPAGE</span><br>
|
|
Show the directory selection page.</p>
|
|
<p class="text"><span class="bold">MUI_STARTMENUPAGE</span><br>
|
|
Show the Start Menu Folder selection page page.</p>
|
|
<p class="text"><span class="bold">MUI_STARTMENU_VARIABLE</span><br>
|
|
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.</p>
|
|
<p class="text"><span class="bold">MUI_STARTMENU_DEFAULTFOLDER</span><br>
|
|
The default start menu Folder. Use $(LANGSTRINGNAME) as value is you want
|
|
to use a language string.</p>
|
|
<p class="text"><span class="bold">MUI_FINISHPAGE</span><br>
|
|
Show the Finish page.</p>
|
|
<p class="text"><span class="bold">MUI_FINISHPAGE_RUN</span><br>
|
|
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.</p>
|
|
<p class="text"><span class="bold">MUI_FINISHPAGE_RUN_PARAMETERS</span><br>
|
|
Parameters for the application to run. Don't forget to escape double
|
|
quotes ($\") in the value.</p>
|
|
<p class="text"><span class="bold">MUI_FINISHPAGE_SHOWREADME</span><br>
|
|
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.
|
|
Use $(LANGSTRINGNAME) as value is you want to use a language string.</p>
|
|
<p class="text"><span class="bold">MUI_FINISHPAGE_NOAUTOCLOSE</span><br>
|
|
Do not automatically jump to the finish page, to allow the user to
|
|
check the log.</p>
|
|
<p class="text"><span class="bold">MUI_FINISHPAGE_NOREBOOTSUPPORT</span><br>
|
|
Disables support for a reboot option. Use this to save some space if
|
|
you are not using /REBOOTOK or SetRebootFlag.</p>
|
|
<p class="text"><span class="bold">MUI_ABORTWARNING</span><br>
|
|
Show a message box with a warning (are you sure?) when the user closes
|
|
the installation.</p>
|
|
<p class="text"><span class="bold">MUI_CUSTOMPAGECOMMANDS</span><br>
|
|
Don't insert Page commands. Use this if you are using custom Page
|
|
commands to add your own pages.</p>
|
|
<p class="text"><span class="bold">MUI_CUSTOMGUIINIT</span><br>
|
|
Don't insert the .onGUIInit function. Use this if you want to add
|
|
custom code to the function. <a href="#customGUIInit">More info...</a></p>
|
|
<p class="text"><span class="bold">MUI_UNINSTALLER</span><br>
|
|
Define if you are using an uninstaller.</p>
|
|
<p class="text"><span class="bold">MUI_UNCUSTOMPAGECOMMANDS</span><br>
|
|
Don't insert UninstPage commands. Use this if you are using custom
|
|
UninstPage commands to add your own pages.</p>
|
|
<p class="text"><span class="bold">MUI_UNCUSTOMGUIINIT</span><br>
|
|
Don't insert the un.onGUIInit function. Use this if you want to add
|
|
custom code to the function. <a href="#customGUIInit">More info...</a></p>
|
|
<p class="subheader">4. Insert language files</p>
|
|
<p class="text">Insert the Modern UI language files for the languages you are using:</p>
|
|
<pre class="margin">!insertmacro MUI_LANGUAGE "English"</pre>
|
|
<p class="text">The Modern UI language files load the NLF language files,
|
|
so you should not use LoadLanguageFile.</p>
|
|
<p class="text">You don't need to edit the language files if you want to customize
|
|
some strings. Use defines before you insert the language file:</p>
|
|
<pre class="margin">
|
|
!define MUI_INNERTEXT_LICENSE_TOP "Text on the top of the license dialog"
|
|
!insertmacro MUI_LANGUAGE "English"
|
|
</pre>
|
|
<p class="text">Have a look at the language files for a complete list of all the
|
|
names.
|
|
<p class="text"><span class="bold">Note:</span> 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.<br>
|
|
Please help to translate the new strings and post them at the
|
|
<a href="http://forums.winamp.com/forumdisplay.php?forumid=65">NSIS Forum</a>.</p>
|
|
<p class="subheader">5. Define interface settings (optional)</p>
|
|
<p class="text">You can also change the settings of the interface by usings defines:</p>
|
|
<pre class="margin">!define MUI_UI "${NSISDIR}\Contrib\UIs\modern2.exe"</pre>
|
|
<p class="text">If you don't define a setting, the default will be used.</p>
|
|
<p class="text">The following settings are available: <i>(default values)</i></p>
|
|
<p class="text"><span class="bold">MUI_UI</span> <i>(${NSISDIR}\Contrib\UIs\modern.exe)</i><br>
|
|
The interface file with the dialog resources.</p>
|
|
<p class="text"><span class="bold">MUI_ICON</span> <i>(${NSISDIR}\Contrib\Icons\modern-install.ico)</i><br>
|
|
The icon of the instaleller.</p>
|
|
<p class="text"><span class="bold">MUI_UNICON</span> <i>(${NSISDIR}\Contrib\Icons\modern-uninstall.ico)</i><br>
|
|
The icon of the uninstaleller.</p>
|
|
<p class="text"><span class="bold">MUI_CHECKBITMAP</span> <i>(${NSISDIR}\Contrib\Icons\modern.bmp)</i><br>
|
|
The bitmap with images for the checks of the component select treeview.</p>
|
|
<p class="text"><span class="bold">MUI_BRANDINGTEXT</span> <i>(Nullsoft Install System ?.??)</i><br>
|
|
The text at the bottom left corner of the window.</p>
|
|
<p class="text"><span class="bold">MUI_FONT, MUI_FONTSIZE</span> <i>(MS Shell Dlg, 8)</i><br>
|
|
The font for the normal texts.</p>
|
|
<p class="text"><span class="bold">MUI_FONT_HEADER, MUI_FONTSIZE_HEADER, MUI_FONTSTYLE_HEADER</span>
|
|
<i>(MS Sans Serif, 8, 700)</i><br>
|
|
The font for the title in the header. Fontstyle: [weight] [/ITALIC] [/UNDERLINE] [/STRIKE]</p>
|
|
<p class="text"><span class="bold">MUI_FONT_TITLE, MUI_FONTSIZE_TITLE, MUI_FONTSTYLE_TITLE</span>
|
|
<i>(Verdana, 12, 700)</i><br>
|
|
The font for the title on the Welcome and Finish pages. Fontstyle: [weight] [/ITALIC] [/UNDERLINE] [/STRIKE]</p>
|
|
<p class="text"><span class="bold">MUI_INSTALLCOLORS</span> <i>(/windows)</i><br>
|
|
The hexadecimal colors of the details screen ("foreground" "background").
|
|
<p class="text"><span class="bold">MUI_PROGRESSBAR</span> <i>(smooth)</i><br>
|
|
The style of the progress bar ("colored" to use the MUI_INSTALLCOLORS or "" for a old-school windows look).</p>
|
|
<p class="text"><span class="bold">MUI_SPECIALINI</span> <i>(${NSISDIR}\Contrib\Modern UI\ioSpecial.ini)</i><br>
|
|
Install Options INI File for the Welcome and Finish pages.</p>
|
|
<p class="text"><span class="bold">MUI_SPECIALBITMAP</span> <i>(${NSISDIR}\Contrib\Icons\modern-wizard.bmp)</i><br>
|
|
Bitmap for the Welcome and Finish pages.</p>
|
|
<p class="subheader">6. Insert the MUI_SYSTEM macro</p>
|
|
<pre class="margin">!insertmacro MUI_SYSTEM</pre>
|
|
<p class="subheader">7. Insert the MUI_SECTIONS_FINISHHEADER macro
|
|
<p class="text">If you are not using a Finish page, you should insert the
|
|
MUI_SECTIONS_FINISHHEADER after all the sections to display the finish-header.</p>
|
|
<pre class="margin">!insertmacro MUI_SECTIONS_FINISHHEADER</pre>
|
|
<p class="text">For the uninstaller, insert MUI_UNFINISHHEADER at the end of the
|
|
Unintaller section.</p>
|
|
<pre class="margin">
|
|
!insertmacro MUI_UNFINISHHEADER
|
|
</pre>
|
|
<p class="subheader">8. Set the descriptions for the sections</p>
|
|
<p class="text">Insert the description macro's to set the descriptions
|
|
for the sections. These descriptions will be displayed on the component
|
|
selection page, when the users hovers the mouse over a section.
|
|
If you don't want to use descriptions, use the modern3.exe UI.</p>
|
|
<pre class="margin">
|
|
LangString DESC_Section1 ${LANG_ENGLISH} "Description of section 1."
|
|
LangString DESC_Section2 ${LANG_ENGLISH} "Description of section 2."
|
|
|
|
!insertmacro MUI_FUNCTIONS_DESCRIPTION_BEGIN
|
|
!insertmacro MUI_DESCRIPTION_TEXT ${Section1} $(DESC_Section1)
|
|
!insertmacro MUI_DESCRIPTION_TEXT ${Section2} $(DESC_Section2)
|
|
!insertmacro MUI_FUNCTIONS_DESCRIPTION_END
|
|
</pre>
|
|
<p class="text">Add an extra parameter to the Section command to
|
|
set a define with the section number:</p>
|
|
<pre class="margin">
|
|
Section "Section Name 1" Section1
|
|
...
|
|
SectionEnd
|
|
</pre>
|
|
<p class="header">Custom pages</p>
|
|
<p class="text">
|
|
<p class="subheader">Custom page commands</p>
|
|
<p class="text">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.</p>
|
|
<pre class="margin">
|
|
LangString TEXT_IO_WINDOWTITLE ": Install Options Page Title"
|
|
|
|
!insertmacro MUI_PAGECOMMAND_WELCOME
|
|
!insertmacro MUI_PAGECOMMAND_LICENSE
|
|
!insertmacro MUI_PAGECOMMAND_COMPONENTS
|
|
!insertmacro MUI_PAGECOMMAND_DIRECTORY
|
|
Page custom FunctionName $(TEXT_IO_WINDOWTITLE) ;A custom page
|
|
!insertmacro MUI_PAGECOMMAND_INSTFILES
|
|
!insertmacro MUI_PAGECOMMAND_FINISH
|
|
</pre>
|
|
<p class="text">This is also possible in the uninstaller:</p>
|
|
<pre class="margin">
|
|
LangString un.UNTEXT_IO_WINDOWTITLE ": Install Options Page Title"
|
|
|
|
!insertmacro MUI_UNPAGECOMMAND_CONFIRM
|
|
UninstPage custom un.FunctionName $(UNTEXT_IO_WINDOWTITLE) ;A custom page
|
|
!insertmacro MUI_UNPAGECOMMAND_INSTFILES
|
|
</pre>
|
|
<p class="text">Don't forget to define MUI_CUSTOMPAGECOMMANDS or
|
|
MUI_UNCUSTOMPAGECOMMANDS before inserting the MUI_SYSTEM macro.</p>
|
|
<p class="subheader">Call Install Options</p>
|
|
<p class="text">Have a look at the <a href="..\InstallOptions\Install Options.html">
|
|
Install Options documentation</a> for info about creating Install Options INI Files.</p>
|
|
<p class="text">First, you need to extract your InstallOptions INI
|
|
File in the .onInit function (un.onInit for the uninstaller):</p>
|
|
<pre class="margin">
|
|
Function .onInit
|
|
!insertmacro MUI_INSTALLOPTIONS_EXTRACT "ioFile.ini"
|
|
FunctionEnd
|
|
</pre>
|
|
<p class="text">You can call Install Options in the function defined with the Page
|
|
or UninstPage command:</p>
|
|
<pre class="margin">
|
|
LangString TEXT_IO_TITLE ${LANG_ENGLISH} "Install Options Page Title"
|
|
LangString TEXT_IO_SUBTITLE ${LANG_ENGLISH} "A subtitle"
|
|
|
|
Function FunctionName
|
|
!insertmacro MUI_HEADER_TEXT "$(TEXT_IO_TITLE)" "$(TEXT_IO_SUBTITLE)"
|
|
!insertmacro MUI_INSTALLOPTIONS_SHOW "ioFile.ini"
|
|
FunctionEnd
|
|
</pre>
|
|
<p class="header"><a name="examples">Examples</a></p>
|
|
<p class="text">Basic: <a href="../../Examples/Modern UI/Basic.nsi">Basic.nsi</a><br>
|
|
Multilanguage: <a href="../../Examples/Modern UI/MultiLanguage.nsi">MultiLanguage.nsi</a><br>
|
|
Custom pages: <a href="../../Examples/Modern UI/InstallOptions.nsi">InstallOptions.nsi</a><br>
|
|
Start Menu Folder selection: <a href="../../Examples/Modern UI/StartMenu.nsi">StartMenu.nsi</a><br>
|
|
Welcome/Finish page: <a href="../../Examples/Modern UI/WelcomeFinish.nsi">WelcomeFinish.nsi</a><br>
|
|
</p>
|
|
<p class="header">The interface</p>
|
|
<p class="subheader">Different versions</p>
|
|
<p class="text">There are three different versions of the Modern UI.
|
|
Modern.exe contains the dialogs of the standard interface.
|
|
If you have an installer with a lot of subsections or long section
|
|
names, use modern2.exe, which has a different component-selection page.
|
|
Use modern3.exe if you are not using descriptions.</p>
|
|
<p class="subheader">Customize the dialogs</p>
|
|
<p class="text">To change elements on the dialogs, modify modern?.exe
|
|
in the Contrib\UIs directory using a resource editor such as
|
|
<a href="http://www.users.on.net/johnson/resourcehacker/">Resource Hacker</a>.</p>
|
|
<p class="text">The 'Please wait while Setup is loading...' text
|
|
on the splash screen which is being displayed when the installer
|
|
is starting (Verifying 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?.exe.<br>
|
|
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.</p>
|
|
<p class="text">To modify the Welcome and Finish dialog, edit the Install
|
|
Options INI File ioWizard.ini in the 'Contrib\Modern UI' directory.
|
|
<p class="subheader"><a name="customGUIInit">Customize the GUIInit function</a></p>
|
|
<p class="text">If you want to insert your own code in the .onGUIInit function,
|
|
define MUI_CUSTOMGUIINIT (MUI_UNCUSTOMGUIINIT for the uninstaller) before inserting
|
|
MUI_SYSTEM and insert the MUI_GUIINIT (MUI_UNGUIINIT for the uninstaller) macro
|
|
in your .onGUIInit or un.onGUInit function:</p>
|
|
<pre class="text">
|
|
!define MUI_CUSTOMGUIINIT
|
|
|
|
Function .onGUIInit
|
|
!insertmacro MUI_GUIINIT
|
|
...your own code...
|
|
FunctionEnd
|
|
</pre>
|
|
<p class="header">Version history</p>
|
|
<ul>
|
|
<li class="changelog">1.61 - December 5, 2002
|
|
<ul>
|
|
<li>Final version for NSIS 2 beta 0
|
|
<li>modern3.exe UI without description area
|
|
<li>Different translation for finish page title
|
|
<li>Define for parameters for the application to run on the finishpage
|
|
<li>Bugfixes
|
|
</ul>
|
|
<p class="text"></p>
|
|
<li class="changelog">1.6 - November 18, 2002
|
|
<ul>
|
|
<li>Welcome / Finish pages
|
|
<li>Automatic ask for reboot on finish page
|
|
<li>Create no shortcut option on Start Menu Folder selection page
|
|
<li>Customizing GUIInit functions easier
|
|
<li>Minor font / UI changes
|
|
</ul>
|
|
</ul>
|
|
<p class="text"><a href="Changelog.txt">Complete version history</a></p>
|
|
<p class="header">Credits</p>
|
|
<p class="text">Made by Joost Verburg.<br>
|
|
Icons designed by Nikos Adamamas, aka adni18.<br>
|
|
Thanks to Amir Szekely, aka KiCHiK, for his work on NSIS
|
|
to make this possible.</p>
|
|
<p class="header">Help</p>
|
|
<p class="text">Please post questions at the <a href="http://forums.winamp.com/forumdisplay.php?forumid=65">NSIS
|
|
Forum</a>.</p>
|
|
<p class="header">License</p>
|
|
<pre class="margin">Copyright © 2002 Joost Verburg
|
|
|
|
This software is provided 'as-is', without any express or implied
|
|
warranty. In no event will the authors be held liable for any damages
|
|
arising from the use of this software.
|
|
|
|
Permission is granted to anyone to use this software for any purpose,
|
|
including commercial applications, and to alter it and redistribute
|
|
it freely, subject to the following restrictions:
|
|
|
|
1. The origin of this software must not be misrepresented;
|
|
you must not claim that you wrote the original software.
|
|
If you use this software in a product, an acknowledgment in the
|
|
product documentation would be appreciated but is not required.
|
|
2. Altered versions must be plainly marked as such,
|
|
and must not be misrepresented as being the original software.
|
|
3. This notice may not be removed or altered from any distribution.
|
|
</pre>
|
|
</div></td>
|
|
</tr>
|
|
<tr>
|
|
<td><div class="footer">©2002 Joost Verburg</div></td>
|
|
</tr>
|
|
</table>
|
|
</td></tr>
|
|
</table>
|
|
</div>
|
|
|
|
</body>
|
|
</html> |