NSIS/Contrib/Modern UI/Readme.html

329 lines
15 KiB
HTML
Raw Normal View History

<!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;
color: #000000;
}
center
{
text-align: center;
}
table
{
margin: auto;
text-align: left;
background-color: #FFFFFF;
color: #000000;
}
.maintable
{
border: 2px solid #376EAB;
}
.margin
{
margin: 20px;
}
.text
{
margin: 20px;
font-size: 10pt;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-weight: normal;
color: #000000;
background-color: #FFFFFF;
}
.bold
{
font-size: 10pt;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-weight: bold;
color: #303030;
background-color: #FFFFFF;
}
.header
{
font-size: 14pt;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-weight: normal;
color: #7A7272;
background-color: #FFFFFF;
}
.subheader
{
font-size: 11pt;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-weight: bold;
color: #303030;
background-color: #FFFFFF;
}
.footer
{
margin: 5px 5px 5px 5px;
text-align: right;
font-size: 8pt;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-weight: normal;
color: #909090;
background-color: #FFFFFF;
}
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">Using NSIS 2, it is possible
to create new user interfaces for the Nullsoft Installer System.</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 icons (designed by adni18) and a description
area on the component select dialog.</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">Screenshot</p>
<p class="text"><img src="Screenshot.png" width="504" height="391" 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"><span class="subheader">Basic Macro System</span><br>
For most scripts, you can use the basic macro system. The basic
macro system inserts all code and functions for you. For an example,
have a look at <a href="..\..\Examples\Modern UI\Basic.nsi">Basic.nsi</a>.<br><br>
To remove certain default NSIS pages (such as the License page),
remove a define before the language files (for example, remove
!define MUI_LICENSEPAGE), and remove the other instruction for
the page (for example, LicenseData).</p>
<p class="text"><span class="subheader">Advanced Macro System, Install Options</span><br>
If you want put your code in certain NSIS functions or want to
use custom installer pages, use the Advanced Macro System.
The code will still be inserted using the macro's, but
you can customize a lot of things, add your own code or
add new pages.<br>
Using the Install Options macro's, it's also very easy to use
custom pages in your installer.<br>
Have a look at <a href="..\..\Examples\Modern UI\InstallOptions.nsi">
InstallOptions.nsi</a> for an example of the Install Options
and the Advanced Macro System.</p>
<p class="text"><span class="subheader">Multilanguage installers</span><br>
The Modern UI has full multilanguage support and also uses
language files which can be translated easily. You can find the
language files in the Contrib\Modern UI\Language files directory.
There are already a lot of translations available, but you can
also make your own translation.<br>
See <a href="..\..\Examples\Modern UI\MultiLanguage.nsi">MultiLanguage.nsi</a>
for a multilanguage example using the Basic Macro System.
<p class="header">The interface</p>
<p class="text"><span class="subheader">Modern.exe and modern2.exe</span><br>
There are two different version of the interface.
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.</p>
<p class="text"><span class="subheader">Change interface settings</span><br>
You can change the settings of the interface
by usings defines before you insert the MUI_INTERFACE macro.<br>
Example: !define MUI_UI "${NSISDIR}\Contrib\UIs\modern2.exe"<br>
If you don't define a setting, the default will be used.<br><br>
The following settings are available: <i>(default)</i><br>
<span class="bold">MUI_ICON</span> <i>(${NSISDIR}\Contrib\Icons\modern-install.ico)</i>
- The icon of the instaleller<br>
<span class="bold">MUI_UNICON</span> <i>(${NSISDIR}\Contrib\Icons\modern-uninstall.ico)</i>
- The icon of the uninstaleller<br>
<span class="bold">MUI_CHECKBITMAP</span> <i>(${NSISDIR}\Contrib\Icons\modern.bmp)</i>
- The bitmap with images for the checks of the
component select treeview.<br>
<span class="bold">MUI_UI</span> <i>(${NSISDIR}\Contrib\UIs\modern.exe)</i>
- The interface file with the dialog resources<br>
<span class="bold">MUI_FONT</span> <i>(Tahoma)</i>
- The font of the installer and uninstaller<br>
<span class="bold">MUI_INSTALLCOLORS</span> <i>(/windows)</i>
- The hexadecimal colors of the details screen ("foreground" "background")<br>
<span class="bold">MUI_PROGRESSBAR</span> <i>(smooth)</i>
- 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="subheader">Customize the dialogs</span><br>
To change elements on the dialogs, modify modern.exe or modern2.exe in the
Contrib\UIs directory using a resource editor such as
<a href="http://www.users.on.net/johnson/resourcehacker/">Resource Hacker</a>.<br><br>
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.<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="header">Version history</p>
<ul>
<li class="text">1.3 - October 26, 2002
<ul>
<li>Easier macro system for basic scripts
<li>New MultiLanguage system using Modern UI Language Files
<li>New directory structure (header/language files in Contrib\Modern UI)
<li>Small bugfixes & typo corrections
<li>SetPage function should be set using defines
<li>Different NextPage/PrevPage/FinishHeader macro's for install/uninstall
<li>Interface settings can be definend (for example, MUI_ICON), no parameters
for MUI_INTERFACE anymore
<li>New Install Options macro's to read/write IO INI file values
</ul>
<li class="text">1.21 - September 30, 2002
<ul>
<li>Temp vars set in Modern UI header
<li>Currentpage & Install Options vars should be set using parameters of the
MUI_INTERFACE and MUI_INSTALLOPTIONS macro's
<li>MultiLanguage.nsi uses the new language strings
</ul>
<li class="text">1.2 - September 22, 2002
<ul>
<li>Lots of macro system updates & fixes
<li>InstallOptions support in macro system
<li>Added Modern UI + InstallOptions example (InstallOptions.nsi)
<li>MUI_NEXTPAGE_OUTER integrated in MUI_NEXTPAGE
<li>No hard-coded function names anymore (you should give MUI_PREVPAGE a parameter
with the set page function name (for example, MUI_PREVPAGE SetPage)
<li>Examples use ReserveFile for faster startup
</ul>
<li class="text">1.19 - Semtember 19, 2002
<ul>
<li>Renamed some macro's
<li>Custom code can be used between page start/stop macro's
</ul>
<li class="text">1.18 - Semtember 13, 2002
<ul>
<li>Uses the new Sendmessage string option
</ul>
<li class="text">1.17 - Semtember 10, 2002
<ul>
<li>Win9x font weight bug fixed (font of title in white rect)
</ul>
<li class="text">1.16 - Semtember 6, 2002
<ul>
<li>Change text 'Scroll down' on license page to 'Press Page Down',
because the RichEdit control has focus by default now
</ul>
<li class="text">1.15 - Semtember 4, 2002
<ul>
<li>Multilanguage example: changed LangDialog to LangDLL::LangDialog
(using the DLL name is now required)
</ul>
<li class="text">1.14 - Semtember 3, 2002
<ul>
<li>Small grammar fix (thanks eccles)
<li>UI files updated by Justin for better RichEdit usage
</ul>
<li class="text">1.13 - Semtember 2, 2002
<ul>
<li>Added 16 color icons
</ul>
<li class="text">1.12 - August 30, 2002
<ul>
<li>Verifying installer & Unpacking data dialog has no titlebar anymore
</ul>
<li class="text">1.11 - August 29, 2002
<ul>
<li>Finish header for uninstaller can also be set using MUI_FINISHHEADER
</ul>
<li class="text">1.1 - August 29, 2002
<ul>
<li>Header file with macros, it's now very easy to use the UI in your scripts :)
<li>Added the modern2.exe UI, with an other location of the Description frame,
for installers with a lot of subsections (thanks rainwater)
<li>Updated example scripts
<li>Added Multilanguage.nsi example (Multilanguage & LangDLL)
<li>Fixed background color issue with some custom XP themes
<li>Removed WS_VISIBLE from black rect for inner dialog (fixes display issues)
<li>Changed size of description area
<li>Example script: Added instructions for the user on the Description frame
<li>Auto sizing branding text
<li>Used modern.bmp for the checks (thanks rainwater)
<li>Using the new NSIS version, descriptions work using the keyboard and you can give
descriptions to subsections
<li>Correct font size using High-DPI fonts
</ul>
<li class="text">1.0 - August 26, 2002
<ul>
<li>Initial release
</ul>
</ul>
<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>
<p class="text">Copyright &copy; 2002 Joost Verburg</p>
<p class="text"> 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.</p>
<p class="text"> 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:</p>
<p class="text"> 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.<br>
2. Altered versions must be plainly marked as such, and
must not be misrepresented as being the original software.<br>
3. This notice may not be removed or altered from any distribution.</p>
</div></td>
</tr>
<tr>
<td><div class="footer">&copy;2002 Joost Verburg</div></td>
</tr>
</table>
</td></tr>
</table>
</div>
</body>
</html>