dragonleo/NSIS
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

corrections

Browse source 
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@3182 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
joostverburg 2003-11-19 22:19:45 +00:00
parent b2cc8876b9
commit a7045c3287
1 changed files with 53 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

103
Contrib/Modern UI/Readme.html
View file

@ -149,8 +149,8 @@ settings. Others (e.g. MUI_UI) can be used to define a specific value.</p>
<p>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.</p>
<p>If you want to add " to a Modern UI string, you should always escape it: $\" because the Modern
UI macros use " separate parameters.</p>
<p>If you want to add " to a Modern UI string, you should always escape it using $\" because the
Modern UI macros use " separate parameters.</p>
<h2>1. Header file</h2>
<pre>
!include "MUI.nsh"
@ -162,13 +162,13 @@ all pages of a certain type.</p>
<h3>General Interface Settings</h3>
<div>
<p><strong>MUI_ICON</strong> <span class="parameter">icon_file</span><br />
The icon of the installer.<br />
The icon for the installer.<br />
<em>Default: ${NSISDIR}\Contrib\Graphics\Icons\modern-install.ico</em></p>
<p><strong>MUI_UNICON</strong> <span class="parameter">icon_file</span><br />
The icon of the uninstaller.<br />
The icon for the uninstaller.<br />
<em>Default: ${NSISDIR}\Contrib\Graphics\Icons\modern-uninstall.ico</em></p>
<p><strong>MUI_HEADERIMAGE</strong><br />
Display an image on the header of a page.</p>
Image to display on the header of a page.</p>
<div>
<p><strong>MUI_HEADERIMAGE_BITMAP</strong> <span class="parameter">bmp_file</span><br />
Bitmap image to display on the header of installers pages (recommended size: 150x57 pixels).<br />
@ -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.</p>
<p><strong>MUI_HEADERIMAGE_BITMAP_RTL</strong> <span class="parameter">bmp_file</span><br />
Bitmap image to display on the header of installers pages when using a RTL language
(recommended size: 150x57 pixels).<br />
Bitmap image to display on the header of installers pages when using a RTL language (recommended
size: 150x57 pixels).<br />
<em>Default: Non-RTL bitmap</em></p>
<div>
<p><strong>MUI_HEADERIMAGE_BITMAP_RTL_NOSTRETCH</strong><br />
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.</p>
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.</p>
</div>
</div>
<p><strong>MUI_HEADERIMAGE_UNBITMAP</strong> <span class="parameter">bmp_file</span><br />
@ -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.</p>
<p><strong>MUI_HEADERIMAGE_UNBITMAP_RTL</strong> <span class="parameter">bmp_file</span><br />
Bitmap image to display on the header of uninstallers pages when using a RTL language (recommended size: 150x57 pixels).<br />
Bitmap image to display on the header of uninstallers pages when using a RTL language (recommended
size: 150x57 pixels).<br />
<em>Default: Installer RTL header bitmap</em></p>
<div>
<p><strong>MUI_HEADERIMAGE_UNBITMAP_RTL_NOSTRETCH</strong><br />
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.</p>
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.</p>
</div>
</div>
<p><strong>MUI_HEADERIMAGE_RIGHT</strong><br />
@ -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).</p>
</div>
<p><strong>MUI_BGCOLOR</strong> <span class="parameter">(color: RRGGBBR hexadecimal)</span><br />
Background color for the header, Welcome- and Finish page.<br />
Background color for the header, the Welcome page and the Finish page.<br />
<em>Default: FFFFFF</em></p>
</div>
<h3>Interface Resource Settings</h3>
@ -244,10 +245,10 @@ The interface files with a customized dialog resource IDD_SELCOM without a descr
<h3>Welcome/Finish Page Interface Settings</h3>
<div>
<p><strong>MUI_WELCOMEFINISHPAGE_3LINES</strong><br />
Create a bigger area for the title on the Welcome- and Finish page, to allow displaying 3 lines of
text (with the default font).</p>
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).</p>
<p><strong>MUI_WELCOMEFINISHPAGE_BITMAP</strong> <span class="parameter">bmp_file</span><br />
Bitmap for the Welcome- and Finish page (recommended size: 164x314 pixels).<br />
Bitmap for the Welcome page and the Finish page (recommended size: 164x314 pixels).<br />
<em>Default: ${NSISDIR}\Contrib\Graphics\Wizard\win.bmp</em></p>
<div>
<p><strong>MUI_WELCOMEFINISHPAGE_BITMAP_NOSTRETCH</strong><br />
@ -260,20 +261,20 @@ if the user has a custom DPI setting.</p>
<h3>Welcome/Finish Page InstallOptions INI Settings</h3>
<div>
<p><strong>MUI_WELCOMEFINISHPAGE_INI</strong> <span class="parameter">ini_file</span><br />
InstallOptions INI file for the Welcome- and Finish page.<br />
InstallOptions INI file for the Welcome page and the Finish page.<br />
<em>Default: ${NSISDIR}\Contrib\Modern UI\ioSpecial.ini</em></p>
<p><strong>MUI_WELCOMEFINISHPAGE_INI_3LINES</strong> <span class="parameter">ini_file</span><br />
InstallOptions INI file for the Welcome- and Finish page with space for 3 lines of title text (with
the default font).<br />
InstallOptions INI file for the Welcome page and the Finish page with space for 3 lines of title
text (with the default font).<br />
<em>Default: ${NSISDIR}\Contrib\Modern UI\ioSpecial3.ini</em></p>
</div>
<h3>Uninstaller Welcome/Finish Page Settings</h3>
<div>
<p><strong>MUI_UNWELCOMEFINISHPAGE_3LINES</strong><br />
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).</p>
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).</p>
<p><strong>MUI_UNWELCOMEFINISHPAGE_BITMAP</strong> <span class="parameter">bmp_file</span><br />
Bitmap for the Welcome- and Finish page (recommended size: 164x314 pixels).<br />
Bitmap for the Welcome page and the Finish page (recommended size: 164x314 pixels).<br />
<em>Default: ${NSISDIR}\Contrib\Graphics\Wizard\win.bmp</em></p>
<div>
<p><strong>MUI_UNWELCOMEFINISHPAGE_BITMAP_NOSTRETCH</strong><br />
@ -286,11 +287,11 @@ if the user has a custom DPI setting.</p>
<h3>Uninstaller Welcome/Finish Page Interface INI Settings</h3>
<div>
<p><strong>MUI_UNWELCOMEFINISHPAGE_INI</strong> <span class="parameter">ini_file</span><br />
InstallOptions INI file for the uninstaller Welcome- and Finish page.<br />
InstallOptions INI file for the uninstaller Welcome page and the Finish page.<br />
<em>Default: ${NSISDIR}\Contrib\Modern UI\ioSpecial.ini</em></p>
<p><strong>MUI_WELCOMEFINISHPAGE_INI_3LINES</strong> <span class="parameter">ini_file</span><br />
InstallOptions INI file for the Welcome- and Finish page with space for 3 lines of title text (with
the default font).<br />
InstallOptions INI file for the Welcome page and the Finish page with space for 3 lines of title
text (with the default font).<br />
<em>Default: ${NSISDIR}\Contrib\Modern UI\ioSpecial3.ini</em></p>
</div>
<h3>License Page Interface Settings</h3>
@ -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.</p>
<div>
<p><strong>MUI_ABORTWARNING_TEXT</strong> <span class="parameter">text</span><br />
Texts to display on the abort warning messagebox.</p>
Text to display on the abort warning messagebox.</p>
</div>
</div>
<h3>Uninstaller Abort Warning Settings</h3>
@ -348,7 +349,7 @@ Texts to display on the abort warning messagebox.</p>
Show a message box with a warning when the user wants to close the uninstaller.</p>
<div>
<p><strong>MUI_UNABORTWARNING_TEXT</strong> <span class="parameter">text</span><br />
Texts to display on the abort warning messagebox.</p>
Text to display on the abort warning messagebox.</p>
</div>
</div>
<h2>3. Pages</h2>
@ -365,8 +366,8 @@ multiple folders).</p>
Var STARTMENU_FOLDER
!insertmacro MUI_PAGE_STARTMENU "Application" $STARTMENU_FOLDER
</pre>
<p>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.</p>
<p>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.</p>
<p><strong>Installer Pages</strong><br />
MUI_PAGE_WELCOME<br />
MUI_PAGE_LICENSE <span class="parameter">text/rtf_file</span><br />
@ -383,7 +384,8 @@ MUI_UNPAGE_COMPONENTS<br />
MUI_UNPAGE_DIRECTORY<br />
MUI_UNPAGE_INSTFILES<br />
MUI_UNPAGE_FINISH</p>
<p>Page Settings apply to a single page and should be set before inserting a page macro. Example:</p>
<p>Page Settings apply to a single page and should be set before inserting a page macro.
Example:</p>
<pre>
;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.</p>
Text to display next to the checkbox to agree with the license terms.</p>
</div>
<p><strong>MUI_LICENSEPAGE_RADIOBUTTONS</strong><br />
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.</p>
<div>
<p><strong>MUI_LICENSEPAGE_RADIOBUTTONS_TEXT_ACCEPT</strong> <span class=
@ -431,7 +433,7 @@ not.</p>
Text to display next to the checkbox to accept the license terms.</p>
<p><strong>MUI_LICENSEPAGE_RADIOBUTTONS_TEXT_DECLINE</strong> <span class=
"parameter">text</span><br />
Text to display next to the checkbox to dicline the license terms.</p>
Text to display next to the checkbox to decline the license terms.</p>
</div>
</div>
<h3>Components Page Settings</h3>
@ -483,8 +485,8 @@ Do not display the checkbox to disable the creation of Start Menu shortcuts.</p>
<strong>MUI_STARTMENUPAGE_REGISTRY_VALUENAME</strong> <span class=
"parameter">value_name</span><br />
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.</p>
preference. You should also use for the uninstaller to remove the Start Menu folders. Don't forget
to remove this key during uninstallation.</p>
<p>For the uninstaller, use the MUI_STARTMENU_GETFOLDER macro to get the Start Menu folder:</p>
<pre>
!insertmacro MUI_STARTMENU_GETFOLDER page_id $R0
@ -514,7 +516,7 @@ Text to display on the page. Use \r\n for a newline.</p>
<p><strong>MUI_FINISHPAGE_BUTTON</strong> <span class="parameter">text</span><br />
Text to display on the Finish button.</p>
<p><strong>MUI_FINISHPAGE_TEXT_REBOOT</strong> <span class="parameter">text</span><br />
Text to display on the finish page when asking for a sytem reboot. Use \r\n for a newline.</p>
Text to display on the finish page when asking for a system reboot. Use \r\n for a newline.</p>
<p><strong>MUI_FINISHPAGE_TEXT_REBOOTNOW</strong> <span class="parameter">text</span><br />
Text to display next to the 'Reboot now' option button.</p>
<p><strong>MUI_FINISHPAGE_TEXT_REBOOTLATER</strong> <span class="parameter">text</span><br />
@ -647,7 +649,7 @@ ReserveFile "ioFile.ini" ;Your own InstallOptions INI files
</pre>
<h2>7. Your own sections and functions</h2>
<p>Add your installer sections and functions. See the NSIS Users Manual for details.</p>
<p>Information about section- and function code for Start Menu shortcut creation and language
<p>Information about section code and function code for Start Menu shortcut creation and language
selection can be found above.</p>
<h2>8. Descriptions for the sections</h2>
<p>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
</pre>
<p>For the uninstaller, use the MUI_UNFUNCTION_DESCRIPTION_BEGIN and
MUI_UNFUNCTIONS_DESCRIPTION_END macros</p>
MUI_UNFUNCTIONS_DESCRIPTION_END macros:</p>
<pre>
ReserveFile "ioFile.ini" ;Your own InstallOptions INI files
ReserveFile "${NSISDIR}\Contrib\Graphics\Header\nsis.bmp" ;Your header bitmap
@ -771,7 +773,8 @@ input:</p>
<p>Basic: <a href="../../Examples/Modern%20UI/Basic.nsi">Basic.nsi</a><br />
Welcome/Finish page: <a href=
"../../Examples/Modern%20UI/WelcomeFinish.nsi">WelcomeFinish.nsi</a><br />
Multiple languages: <a href="../../Examples/Modern%20UI/MultiLanguage.nsi">MultiLanguage.nsi</a><br />
Multiple languages: <a href=
"../../Examples/Modern%20UI/MultiLanguage.nsi">MultiLanguage.nsi</a><br />
Header image: <a href="../../Examples/Modern%20UI/HeaderBitmap.nsi">HeaderBitmap.nsi</a><br />
Custom pages: <a href="../../Examples/Modern%20UI/InstallOptions.nsi">InstallOptions.nsi</a><br />
Start Menu Folder page: <a href="../../Examples/Modern%20UI/StartMenu.nsi">StartMenu.nsi</a></p>
@ -786,8 +789,8 @@ customized UI resource file (MUI_UI setting) with a modified dialog 111.<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 have to edit this file and recompile
NSIS.</p>
<p>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.</p>
<p>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.</p>
<h1><a name="customFunctions" id="customFunctions">Customize Modern UI Functions</a></h1>
<p>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
<p><strong>Notes:</strong></p>
<ul>
<li>The StartMenu page does not have a Show function</li>
<li>In the Pre function of the Welcome- and Finish page, you can write to the InstallOptions INI
file of the page (ioSpecial.ini)</li>
<li>In the Show function of Welcome- and Finish page, $MUI_HWND contains the HWND of the inner
dialog</li>
<li>In the Pre function of the Welcome page and the Finish page, you can write to the
InstallOptions INI file of the page (ioSpecial.ini)</li>
<li>In the Show function of Welcome page and the Finish page, $MUI_HWND contains the HWND of the
inner dialog</li>
</ul>
</div>
<h1>Version history</h1>
<ul>
<li>1.67 - November 9, 2003
<ul>
<li>Support for uninstaller Welcome- and Finish pages</li>
<li>Support for uninstaller Welcome/Finish pages</li>
<li>Improved and changed text settings</li>
<li>ID for Start Menu Folder pages, easier to use multiple pages</li>
<li>Renamed a few settings</li>
<li>Default header image</li>
<li>Support for uninstaller abort warning</li>
<li>Setting for 3 line text on Welcome- and Finish page</li>
<li>Setting for 3 line text on Welcome/Finish page</li>
<li>Langauge file backwards compatibility: English for missing strings</li>
<li>Support for different uninstaller header image</li>
<li>Language selection dialog not displayed if installer is silent</li>