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

design

Browse source 
git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@3474 212acab6-be3b-0410-9dea-997c60f758d6
This commit is contained in:
joostverburg 2004-02-06 23:03:59 +00:00
parent 956710c71d
commit 0b4e16ef1e
2 changed files with 397 additions and 257 deletions
Download patch file Download diff file Expand all files Collapse all files

598
Contrib/InstallOptions/Readme.html
View file

@ -3,7 +3,8 @@
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title>InstallOptions 2</title> <title>InstallOptions 2</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" /> <meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
<style type="text/css"> <style type="text/css">
/*<![CDATA[*/ /*<![CDATA[*/
@ -14,12 +15,12 @@ body
font-family: Verdana, Arial, Helvetica, sans-serif; font-family: Verdana, Arial, Helvetica, sans-serif;
font-size: 13px; font-size: 13px;
font-weight: normal; font-weight: normal;
text-align: left;
} }
p p, li
{ {
font-size: 100%; font-size: 13px;
margin: 20px;
} }
.center .center
@ -30,7 +31,7 @@ p
table table
{ {
margin: auto; margin: auto;
text-align: left; font-size: 13px;
background-color: #FFFFFF; background-color: #FFFFFF;
} }
@ -48,31 +49,29 @@ table
h1 h1
{ {
font-size: 220%; font-size: 30px;
color: #333333; color: #333333;
font-weight: normal; font-weight: normal;
text-align: center; text-align: center;
margin: 20px; margin-top: 20px;
} }
h2 h2
{ {
font-size: 165%; font-size: 20px;
color: #7A7272; color: #7A7272;
font-weight: normal; font-weight: normal;
} }
h3 h3
{ {
font-size: 140%; font-size: 17px;
font-weight: bold; font-weight: bold;
color: #303030; color: #303030;
margin: 20px;
} }
pre { pre {
font-size: 100%; font-size: 13px;
margin: 20px;
} }
div div
@ -115,197 +114,242 @@ a:hover
</style> </style>
</head> </head>
<body> <body>
<div class="center"> <table width="750" class="maintable" cellspacing="0" cellpadding=
<table width="750" class="maintable" cellspacing="0" cellpadding="0"> "0" align="center">
<tr> <tr>
<td> <td>
<h1>InstallOptions 2</h1> <h1>InstallOptions 2</h1>
<div> <div>
<h2>Introduction</h2> <h2>Introduction</h2>
<p>InstallOptions is a NSIS plugin which allows you to create custom pages for NSIS installers, to <div>
prompt the user for extra information.</p> <p>InstallOptions is a NSIS plugin which allows you to create
<p>InstallOptions will create a dialog which will be displayed inside the NSIS window. The controls custom pages for NSIS installers, to prompt the user for extra
on the dialog can be defined in an INI file.</p> information.</p>
<p>NSIS 2 has a new page system, which allows you to add custom pages to your installer without <p>InstallOptions will create a dialog which will be displayed
messing with Prev/Next functions. With the new plugin system, you also don't have to worry anymore inside the NSIS window. The controls on the dialog can be defined
about extracting and deleting the DLL file. When you store the INI files in the plugins directory, in an INI file.</p>
NSIS will also delete them automatically.</p> <p>NSIS 2 has a new page system, which allows you to add custom
<p>This new version of InstallOptions has been designed for NSIS 2. It supports customized user pages to your installer without messing with Prev/Next functions.
interfaces and custom font and DPI settings.</p> With the new plugin system, you also don't have to worry anymore
about extracting and deleting the DLL file. When you store the INI
files in the plugins directory, NSIS will also delete them
automatically.</p>
<p>This new version of InstallOptions has been designed for NSIS 2.
It supports customized user interfaces and custom font and DPI
settings.</p>
</div>
<h2>INI File</h2> <h2>INI File</h2>
<p>The INI file has one required section. This section includes the number of controls to be <div>
created as well as general window attributes. The INI file also includes a variable number of Field <p>The INI file has one required section. This section includes the
number of controls to be created as well as general window
attributes. The INI file also includes a variable number of Field
sections which are used to create the controls to be displayed.</p> sections which are used to create the controls to be displayed.</p>
<p>The required section is named "<em>Settings</em>". It can contain the following values:</p> <p>The required section is named "<em>Settings</em>". It can
contain the following values:</p>
<table class="subtable"> <table class="subtable">
<tr> <tr>
<td class="lefttable"><strong>NumFields</strong></td> <td class="lefttable"><strong>NumFields</strong></td>
<td class="lefttable"><em>(required)</em></td> <td class="lefttable"><em>(required)</em></td>
<td class="righttable">The number of control elements to be displayed on the dialog window.</td> <td class="righttable">The number of control elements to be
displayed on the dialog window.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>Title</strong></td> <td class="lefttable"><strong>Title</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">If specified, gives the text to set the titlebar to. Otherwise, the titlebar <td class="righttable">If specified, gives the text to set the
text is not changed.</td> titlebar to. Otherwise, the titlebar text is not changed.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>CancelEnabled</strong></td> <td class="lefttable"><strong>CancelEnabled</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">If specified, overrides NSIS settings and enables or disables the cancel <td class="righttable">If specified, overrides NSIS settings and
button. If set to 1, the cancel button will be enabled. If set to 0, the cancel button will be enables or disables the cancel button. If set to 1, the cancel
button will be enabled. If set to 0, the cancel button will be
disabled.</td> disabled.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>CancelShow</strong></td> <td class="lefttable"><strong>CancelShow</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">If specified, overrides NSIS settings and shows or hides the cancel button <td class="righttable">If specified, overrides NSIS settings and
If set to 1, the cancel button will be shown. If set to 0, the cancel button will be hidden.</td> shows or hides the cancel button If set to 1, the cancel button
will be shown. If set to 0, the cancel button will be hidden.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>BackEnabled</strong></td> <td class="lefttable"><strong>BackEnabled</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">If specified, overrides NSIS settings and enables or disables the back <td class="righttable">If specified, overrides NSIS settings and
button. If set to 1, the back button will be enabled. If set to 0, the back button will be enables or disables the back button. If set to 1, the back button
will be enabled. If set to 0, the back button will be
disabled.</td> disabled.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>CancelButtonText</strong></td> <td class="lefttable"><strong>CancelButtonText</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">Overrides the text for the cancel button. If not specified, the cancel <td class="righttable">Overrides the text for the cancel button. If
button text will not be changed.</td> not specified, the cancel button text will not be changed.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>NextButtonText</strong></td> <td class="lefttable"><strong>NextButtonText</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">Overrides the text for the next button. If not specified, the next button <td class="righttable">Overrides the text for the next button. If
text will not be changed.</td> not specified, the next button text will not be changed.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>BackButtonText</strong></td> <td class="lefttable"><strong>BackButtonText</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">Overrides the text for the back button. If not specified, the back button <td class="righttable">Overrides the text for the back button. If
text will not be changed.</td> not specified, the back button text will not be changed.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>Rect</strong></td> <td class="lefttable"><strong>Rect</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">Overrides the default rect ID to run over. This will make IO resize itself <td class="righttable">Overrides the default rect ID to run over.
according to a different rect than NSIS's dialogs rect.</td> This will make IO resize itself according to a different rect than
NSIS's dialogs rect.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>RTL</strong></td> <td class="lefttable"><strong>RTL</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">If 1 is specified the dialog will be mirrored and all texts will be aligned <td class="righttable">If 1 is specified the dialog will be
to the right. Use NSIS's $(^RTL) to fill this field, it's the easiest way.</td> mirrored and all texts will be aligned to the right. Use NSIS's
$(^RTL) to fill this field, it's the easiest way.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>State</strong></td> <td class="lefttable"><strong>State</strong></td>
<td class="lefttable"><em>(output)</em></td> <td class="lefttable"><em>(output)</em></td>
<td class="righttable">This is not something you have to supply yourself but is set by <td class="righttable">This is not something you have to supply
InstallOptions, before calling your custom page validation function, to the field number of the yourself but is set by InstallOptions, before calling your custom
custom Button control (or other control having the Notify flag) the user pressed, if any.</td> page validation function, to the field number of the custom Button
control (or other control having the Notify flag) the user pressed,
if any.</td>
</tr> </tr>
</table> </table>
<p>Each field section has the heading "Field #" where # must be sequential numbers from 1 to <p>Each field section has the heading "Field #" where # must be
NumFields. Each Field section can contain the following values:</p> sequential numbers from 1 to NumFields. Each Field section can
contain the following values:</p>
<table class="subtable"> <table class="subtable">
<tr> <tr>
<td class="lefttable"><strong>Type</strong></td> <td class="lefttable"><strong>Type</strong></td>
<td class="lefttable"><em>(required)</em></td> <td class="lefttable"><em>(required)</em></td>
<td class="righttable">Type of control to be created. Valid values are "<em>Label</em>", <td class="righttable">Type of control to be created. Valid values
"<em>Text</em>", "<em>Password</em>", "<em>Combobox</em>", "<em>DropList</em>", "<em>Listbox</em>", are "<em>Label</em>", "<em>Text</em>", "<em>Password</em>",
"<em>CheckBox</em>", "<em>RadioButton</em>", "<em>FileRequest</em>", "<em>DirRequest</em>" "<em>Combobox</em>", "<em>DropList</em>", "<em>Listbox</em>",
"<em>Icon</em>", "<em>Bitmap</em>", "<em>GroupBox</em>", "<em>Link</em>" or "<em>CheckBox</em>", "<em>RadioButton</em>",
"<em>FileRequest</em>", "<em>DirRequest</em>" "<em>Icon</em>",
"<em>Bitmap</em>", "<em>GroupBox</em>", "<em>Link</em>" or
"<em>Button</em>".<br /> "<em>Button</em>".<br />
<br /> <br />
A "<em>Label</em>" is used to display static text. (i.e. a caption for a textbox)<br /> A "<em>Label</em>" is used to display static text. (i.e. a caption
A "<em>Text</em>" and "<em>Password</em>" accept text input from the user. "<em>Password</em>" for a textbox)<br />
masks the input with * characters.<br /> A "<em>Text</em>" and "<em>Password</em>" accept text input from
A "<em>Combobox</em>" allows the user to type text not in the popup list, a "<em>Droplist</em>" the user. "<em>Password</em>" masks the input with *
only allows selection of items in the list.<br /> characters.<br />
A "<em>Listbox</em>" shows multiple items and can optionally allow the user to select more than one A "<em>Combobox</em>" allows the user to type text not in the popup
item.<br /> list, a "<em>Droplist</em>" only allows selection of items in the
A "<em>CheckBox</em>" control displays a check box with label.<br /> list.<br />
A "<em>RadioButton</em>" control displays a radio button with label.<br /> A "<em>Listbox</em>" shows multiple items and can optionally allow
A "<em>FileRequest</em>" control displays a textbox and a browse button. Clicking the browse button the user to select more than one item.<br />
will display a file requester where the user can browse for a file.<br /> A "<em>CheckBox</em>" control displays a check box with
A "<em>DirRequest</em>" control displays a textbox and a browse button. Clicking the browse button label.<br />
will display a directory requester where the user can browse for a directory.<br /> A "<em>RadioButton</em>" control displays a radio button with
An "<em>Icon</em>" control displays an icon. Use no Text to use the installer icon.<br /> label.<br />
A "<em>FileRequest</em>" control displays a textbox and a browse
button. Clicking the browse button will display a file requester
where the user can browse for a file.<br />
A "<em>DirRequest</em>" control displays a textbox and a browse
button. Clicking the browse button will display a directory
requester where the user can browse for a directory.<br />
An "<em>Icon</em>" control displays an icon. Use no Text to use the
installer icon.<br />
A "<em>Bitmap</em>" control displays a bitmap.<br /> A "<em>Bitmap</em>" control displays a bitmap.<br />
A "<em>GroupBox</em>" control displays a frame to group controls.<br /> A "<em>GroupBox</em>" control displays a frame to group
A "<em>Link</em>" control displays a static hot text. When the user clicks the control the contents controls.<br />
of <strong>State</strong> (e.g. http://...) will be executed using ShellExecute. Alternatively A "<em>Link</em>" control displays a static hot text. When the user
<strong>State</strong> can be omitted and the <em>NOTIFY</em> flag used to have your NSIS script clicks the control the contents of <strong>State</strong> (e.g.
called. See the "<em>NOTIFY</em>" flag below for more information.<br /> http://...) will be executed using ShellExecute. Alternatively
A "<em>Button</em>" control displays a push button that can be used in the same way as the <strong>State</strong> can be omitted and the <em>NOTIFY</em> flag
"<em>Link</em>" control above.</td> used to have your NSIS script called. See the "<em>NOTIFY</em>"
flag below for more information.<br />
A "<em>Button</em>" control displays a push button that can be used
in the same way as the "<em>Link</em>" control above.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>Text</strong></td> <td class="lefttable"><strong>Text</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">Specifies the caption of a label, checkbox, or radio button control. For <td class="righttable">Specifies the caption of a label, checkbox,
icon and bitmaps control this specifies the path to the image.<br /> or radio button control. For icon and bitmaps control this
specifies the path to the image.<br />
<br /> <br />
<strong>Note:</strong> For labels, \r\n will be converted to a newline. To use a back-slash in your <strong>Note:</strong> For labels, \r\n will be converted to a
text you have to escape it using another back-slash - \\. Described <a href="#escaping">below</a> newline. To use a back-slash in your text you have to escape it
are NSIS functions for converting text to/from this format.</td> using another back-slash - \\. Described <a href=
"#escaping">below</a> are NSIS functions for converting text
to/from this format.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>State</strong></td> <td class="lefttable"><strong>State</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">Specifies the state of the control. This is updated when the user closes the <td class="righttable">Specifies the state of the control. This is
window, so you can read from it from NSIS. For edit texts and dir and file request boxes, this is updated when the user closes the window, so you can read from it
the string that is specified. For radio button and check boxes, this can be '0' or '1' (for from NSIS. For edit texts and dir and file request boxes, this is
unchecked or checked). For list boxes, combo boxes and drop lists this is the selected items the string that is specified. For radio button and check boxes,
separated by pipes ('|'). For Links and Buttons this can specify something to be executed or opened this can be '0' or '1' (for unchecked or checked). For list boxes,
(using ShellExecute).<br /> combo boxes and drop lists this is the selected items separated by
pipes ('|'). For Links and Buttons this can specify something to be
executed or opened (using ShellExecute).<br />
<br /> <br />
<strong>Note:</strong> For Text fields with the MULTILINE flag, \r\n will be converted to a <strong>Note:</strong> For Text fields with the MULTILINE flag,
newline. To use a back-slash in your text you have to escape it using another back-slash - \\. \r\n will be converted to a newline. To use a back-slash in your
Described <a href="#escaping">below</a> are NSIS functions for converting text to/from this text you have to escape it using another back-slash - \\. Described
format.</td> <a href="#escaping">below</a> are NSIS functions for converting
text to/from this format.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>ListItems</strong></td> <td class="lefttable"><strong>ListItems</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">A list of items to display in a combobox, droplist, or listbox.<br /> <td class="righttable">A list of items to display in a combobox,
This is a single line of text with each item separated by a pipe character '|'</td> droplist, or listbox.<br />
This is a single line of text with each item separated by a pipe
character '|'</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>MaxLen</strong></td> <td class="lefttable"><strong>MaxLen</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">Causes validation on the selected control to limit the maximum length of <td class="righttable">Causes validation on the selected control to
text.<br /> limit the maximum length of text.<br />
If the user specifies more text than this, a message box will appear when they click "OK" and the If the user specifies more text than this, a message box will
dialog will not be dismissed.<br /> appear when they click "OK" and the dialog will not be
You should not use this on a "<em>combobox</em>" since the user can not control what is dismissed.<br />
selected.<br /> You should not use this on a "<em>combobox</em>" since the user can
This should be set to a maximum of 260 for "<em>FileRequest</em>" and "<em>DirRequest</em>" not control what is selected.<br />
controls.<br /> This should be set to a maximum of 260 for "<em>FileRequest</em>"
and "<em>DirRequest</em>" controls.<br />
Ignored on "<em>Label</em>" controls.</td> Ignored on "<em>Label</em>" controls.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>MinLen</strong></td> <td class="lefttable"><strong>MinLen</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">Causes validation on the selected control to force the user to enter a <td class="righttable">Causes validation on the selected control to
minimum amount of text.<br /> force the user to enter a minimum amount of text.<br />
If the user specifies less text than this, a message box will appear when they click "OK" and the If the user specifies less text than this, a message box will
dialog will not be dismissed.<br /> appear when they click "OK" and the dialog will not be
Unlike MaxLen, this is useful for "<em>Combobox</em>" controls. By setting this to a value of "1" dismissed.<br />
the program will force the user to select an item.<br /> Unlike MaxLen, this is useful for "<em>Combobox</em>" controls. By
setting this to a value of "1" the program will force the user to
select an item.<br />
Ignored on "<em>Label</em>" controls.</td> Ignored on "<em>Label</em>" controls.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>ValidateText</strong></td> <td class="lefttable"><strong>ValidateText</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">If the field fails the test for "<em>MinLen</em>" or "<em>MaxLen</em>", a <td class="righttable">If the field fails the test for
messagebox will be displayed with this text.<br /> "<em>MinLen</em>" or "<em>MaxLen</em>", a messagebox will be
displayed with this text.<br />
<br /> <br />
<strong>Note:</strong> \r\n will be converted to a newline, two back-slashes will be converted to <strong>Note:</strong> \r\n will be converted to a newline, two
one - \\. Described <a href="#escaping">below</a> are NSIS functions for converting text to/from back-slashes will be converted to one - \\. Described <a href=
this format.</td> "#escaping">below</a> are NSIS functions for converting text
to/from this format.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>Left<br /> <td class="lefttable"><strong>Left<br />
@ -313,50 +357,59 @@ Right<br />
Top<br /> Top<br />
Bottom</strong></td> Bottom</strong></td>
<td class="lefttable"><em>(required)</em></td> <td class="lefttable"><em>(required)</em></td>
<td class="righttable">The position on the dialog where this control appears. All sizes should be <td class="righttable">The position on the dialog where this
set in dialog units. To get the right dimensions for your controls, design your dialog using a control appears. All sizes should be set in dialog units. To get
the right dimensions for your controls, design your dialog using a
resource editor and copy the dimensions to the INI file.<br /> resource editor and copy the dimensions to the INI file.<br />
<br /> <br />
<strong>Note:</strong> You can specify negative coordinates to specify the distance from the right <strong>Note:</strong> You can specify negative coordinates to
or bottom edge.<br /> specify the distance from the right or bottom edge.<br />
<br /> <br />
<strong>Note (2):</strong> For combobox or droplist, the "<em>bottom</em>" value is not used in the <strong>Note (2):</strong> For combobox or droplist, the
same way.<br /> "<em>bottom</em>" value is not used in the same way.<br />
In this case, the bottom value is the maximum size of the window when the pop-up list is being In this case, the bottom value is the maximum size of the window
displayed. All other times, the combobox is automatically sized to be one element tall. If you have when the pop-up list is being displayed. All other times, the
trouble where you can not see the combobox drop-down, then check the bottom value and ensure it is combobox is automatically sized to be one element tall. If you have
large enough. A rough guide for the height required is the number of items in the list multiplied trouble where you can not see the combobox drop-down, then check
the bottom value and ensure it is large enough. A rough guide for
the height required is the number of items in the list multiplied
by 8, plus 20.<br /> by 8, plus 20.<br />
<br /> <br />
<strong>Note (3):</strong> FileRequest and DirRequest controls will allocate 15 dialog units to the <strong>Note (3):</strong> FileRequest and DirRequest controls will
browse button. Make this control wide enough the contents of the textbox can be seen.</td> allocate 15 dialog units to the browse button. Make this control
wide enough the contents of the textbox can be seen.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>Filter</strong></td> <td class="lefttable"><strong>Filter</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">Specifies the filter to be used in the "<em>FileRequest</em>" control.<br /> <td class="righttable">Specifies the filter to be used in the
This is constructed by putting pairs of entries together, each item separated by a | "<em>FileRequest</em>" control.<br />
character.<br /> This is constructed by putting pairs of entries together, each item
The first value in each pair is the text to display for the filter.<br /> separated by a | character.<br />
The first value in each pair is the text to display for the
filter.<br />
The second value is the pattern to use to match files.<br /> The second value is the pattern to use to match files.<br />
For example, you might specify:<br /> For example, you might specify:<br />
Filter=Text Files|*.txt|Programs|*.exe;*.com|All Files|*.*<br /> Filter=Text Files|*.txt|Programs|*.exe;*.com|All Files|*.*<br />
If not specified, then the filter defaults to All Files|*.*<br /> If not specified, then the filter defaults to All Files|*.*<br />
<br /> <br />
<strong>Note:</strong> you should not put any extra spaces around the | characters.</td> <strong>Note:</strong> you should not put any extra spaces around
the | characters.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>Root</strong></td> <td class="lefttable"><strong>Root</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">Used by <strong>DirRequest</strong> controls to specify the root directory <td class="righttable">Used by <strong>DirRequest</strong> controls
of the search. By default, this allows the user to browse any directory on the computer. This will to specify the root directory of the search. By default, this
allows the user to browse any directory on the computer. This will
limit the search to a particular directory on the system.</td> limit the search to a particular directory on the system.</td>
</tr> </tr>
<tr> <tr>
<td class="lefttable"><strong>Flags</strong></td> <td class="lefttable"><strong>Flags</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">This specifies additional flags for the display of different controls. Each <td class="righttable">This specifies additional flags for the
value should be separated by a | character, and you should be careful not to put any spaces around display of different controls. Each value should be separated by a
| character, and you should be careful not to put any spaces around
the | character.<br /> the | character.<br />
<table class="righttable"> <table class="righttable">
<tr> <tr>
@ -365,79 +418,91 @@ the | character.<br />
</tr> </tr>
<tr> <tr>
<td class="righttable">REQ_SAVE</td> <td class="righttable">REQ_SAVE</td>
<td class="righttable">This causes "<em>FileRequest</em>" controls to display a Save As dialog. If <td class="righttable">This causes "<em>FileRequest</em>" controls
not specified, an Open dialog is used.</td> to display a Save As dialog. If not specified, an Open dialog is
used.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">FILE_MUST_EXIST</td> <td class="righttable">FILE_MUST_EXIST</td>
<td class="righttable">Used by "<em>FileRequest</em>" to determine if the selected file must <td class="righttable">Used by "<em>FileRequest</em>" to determine
exist.<br /> if the selected file must exist.<br />
This only applies if an "Open" dialog is being displayed.<br /> This only applies if an "Open" dialog is being displayed.<br />
This currently does not force the file to exist other than through the browse button.</td> This currently does not force the file to exist other than through
the browse button.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">FILE_EXPLORER</td> <td class="righttable">FILE_EXPLORER</td>
<td class="righttable">Used by "<em>FileRequest</em>", enables new file request look <td class="righttable">Used by "<em>FileRequest</em>", enables new
(recommended)</td> file request look (recommended)</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">FILE_HIDEREADONLY</td> <td class="righttable">FILE_HIDEREADONLY</td>
<td class="righttable">Used by "<em>FileRequest</em>", hides "open read only" checkbox in open <td class="righttable">Used by "<em>FileRequest</em>", hides "open
dialog.</td> read only" checkbox in open dialog.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">WARN_IF_EXIST</td> <td class="righttable">WARN_IF_EXIST</td>
<td class="righttable">Used by "<em>FileRequest</em>" to display a warning message if the selected <td class="righttable">Used by "<em>FileRequest</em>" to display a
file already exists.<br /> warning message if the selected file already exists.<br />
The warning message is only displayed for files selected with the browse button.</td> The warning message is only displayed for files selected with the
browse button.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">PATH_MUST_EXIST</td> <td class="righttable">PATH_MUST_EXIST</td>
<td class="righttable">Used by "<em>FileRequest</em>" to force the path to exist. Prevents the user <td class="righttable">Used by "<em>FileRequest</em>" to force the
from typing a non-existent path into the browse dialog window.<br /> path to exist. Prevents the user from typing a non-existent path
into the browse dialog window.<br />
This only validates path's selected with the browse button.</td> This only validates path's selected with the browse button.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">PROMPT_CREATE</td> <td class="righttable">PROMPT_CREATE</td>
<td class="righttable">Used by "<em>FileRequest</em>" to display a warning if the selected file <td class="righttable">Used by "<em>FileRequest</em>" to display a
does not exist. However, it still allows the user to select the file.<br /> warning if the selected file does not exist. However, it still
This only displays the warning for files selected with the browse button.<br /> allows the user to select the file.<br />
This only displays the warning for files selected with the browse
button.<br />
Doesn't work along with REQ_SAVE.</td> Doesn't work along with REQ_SAVE.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">RIGHT</td> <td class="righttable">RIGHT</td>
<td class="righttable">Used by "<em>Checkbox</em>" and "<em>Radiobutton</em>" controls to specify <td class="righttable">Used by "<em>Checkbox</em>" and
you want the checkbox to the right of the text instead of the left as is the default.</td> "<em>Radiobutton</em>" controls to specify you want the checkbox to
the right of the text instead of the left as is the default.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">MULTISELECT</td> <td class="righttable">MULTISELECT</td>
<td class="righttable">Used by "<em>Listbox</em>" controls. Turns string selection on or off each <td class="righttable">Used by "<em>Listbox</em>" controls. Turns
time the user clicks or double-clicks a string in the list box. The user can select any number of string selection on or off each time the user clicks or
strings. If this flag and EXTENDEDSELCT are not specified, only one item can be selected from the double-clicks a string in the list box. The user can select any
list.</td> number of strings. If this flag and EXTENDEDSELCT are not
specified, only one item can be selected from the list.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">EXTENDEDSELCT</td> <td class="righttable">EXTENDEDSELCT</td>
<td class="righttable">Used by "<em>Listbox</em>" controls. Allows multiple items to be selected by <td class="righttable">Used by "<em>Listbox</em>" controls. Allows
using the SHIFT key and the mouse or special key combinations. If this flag and MULTISELECT are not multiple items to be selected by using the SHIFT key and the mouse
or special key combinations. If this flag and MULTISELECT are not
specified, only one item can be selected from the list.</td> specified, only one item can be selected from the list.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">RESIZETOFIT</td> <td class="righttable">RESIZETOFIT</td>
<td class="righttable">This causes "<em>Bitmap</em>" controls to resize the image to the size of <td class="righttable">This causes "<em>Bitmap</em>" controls to
the control. Also useful to support custom DPI settings.</td> resize the image to the size of the control. Also useful to support
custom DPI settings.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">GROUP</td> <td class="righttable">GROUP</td>
<td class="righttable">Add this flag to the first control of a group of controls to group them. <td class="righttable">Add this flag to the first control of a
Grouping controls allows you to create multiple groups of radio button and makes keyboard group of controls to group them. Grouping controls allows you to
create multiple groups of radio button and makes keyboard
navigation using arrow keys easier.</td> navigation using arrow keys easier.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">NOTABSTOP</td> <td class="righttable">NOTABSTOP</td>
<td class="righttable">Do not stop on the control when the user pressed the Tab key. Add NOTABSTOP <td class="righttable">Do not stop on the control when the user
to all controls of a group except the first one to allow navigation between groups with the Tab pressed the Tab key. Add NOTABSTOP to all controls of a group
key.</td> except the first one to allow navigation between groups with the
Tab key.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">DISABLED</td> <td class="righttable">DISABLED</td>
@ -445,30 +510,33 @@ key.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">ONLY_NUMBERS</td> <td class="righttable">ONLY_NUMBERS</td>
<td class="righttable">Used by "<em>Text</em>" controls. Forces the user to enter only numbers into <td class="righttable">Used by "<em>Text</em>" controls. Forces the
the edit box.</td> user to enter only numbers into the edit box.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">MULTILINE</td> <td class="righttable">MULTILINE</td>
<td class="righttable">Used by "<em>Text</em>" controls. Causes the control to accept <td class="righttable">Used by "<em>Text</em>" controls. Causes the
multiple-lines.</td> control to accept multiple-lines.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">WANTRETURN</td> <td class="righttable">WANTRETURN</td>
<td class="righttable">Used by "<em>Text</em>" controls with multiple-line. Specifies that a <td class="righttable">Used by "<em>Text</em>" controls with
carriage return be inserted when the user presses the ENTER key while entering text into the text multiple-line. Specifies that a carriage return be inserted when
the user presses the ENTER key while entering text into the text
box.</td> box.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">NOWORDWRAP</td> <td class="righttable">NOWORDWRAP</td>
<td class="righttable">Used by "<em>Text</em>" controls with multiple-line. Disables the word-wrap <td class="righttable">Used by "<em>Text</em>" controls with
that occurs when long lines are entered. Long lines instead scroll off to the side. Specifying the multiple-line. Disables the word-wrap that occurs when long lines
HSCROLL flag also has this effect.</td> are entered. Long lines instead scroll off to the side. Specifying
the HSCROLL flag also has this effect.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">HSCROLL</td> <td class="righttable">HSCROLL</td>
<td class="righttable">Show a horizontal scrollbar. When used by "<em>Text</em>" controls with <td class="righttable">Show a horizontal scrollbar. When used by
multiple-lines this also disables word-wrap.</td> "<em>Text</em>" controls with multiple-lines this also disables
word-wrap.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">VSCROLL</td> <td class="righttable">VSCROLL</td>
@ -476,18 +544,23 @@ multiple-lines this also disables word-wrap.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">READONLY</td> <td class="righttable">READONLY</td>
<td class="righttable">Used by "<em>Text</em>" controls. Prevents the user from entering or editing <td class="righttable">Used by "<em>Text</em>" controls. Prevents
text in the edit control, but allow the user to select and copy the text.</td> the user from entering or editing text in the edit control, but
allow the user to select and copy the text.</td>
</tr> </tr>
<tr> <tr>
<td class="righttable">NOTIFY</td> <td class="righttable">NOTIFY</td>
<td class="righttable">Used by "<em>Button</em>", "<em>Link</em>", "<em>CheckBox</em>", <td class="righttable">Used by "<em>Button</em>", "<em>Link</em>",
"<em>RadioButton</em>", "<em>ListBox</em>" and "<em>DropList</em>" controls. Causes InstallOptions "<em>CheckBox</em>", "<em>RadioButton</em>", "<em>ListBox</em>" and
to call your NSIS custom page validation/leave function whenever the control's selection changes. "<em>DropList</em>" controls. Causes InstallOptions to call your
Your validation/leave function can read the "<em>State</em>" value from the "<em>Settings</em>" NSIS custom page validation/leave function whenever the control's
section to determine which control caused the notification, if any, and perform some appropriate selection changes. Your validation/leave function can read the
action followed by an Abort instruction (to tell NSIS to return to the page). The "<em>State</em>" value from the "<em>Settings</em>" section to
Contrib\InstallOptions folder contains an example script showing how this might be used.</td> determine which control caused the notification, if any, and
perform some appropriate action followed by an Abort instruction
(to tell NSIS to return to the page). The Contrib\InstallOptions
folder contains an example script showing how this might be
used.</td>
</tr> </tr>
</table> </table>
</td> </td>
@ -495,16 +568,25 @@ Contrib\InstallOptions folder contains an example script showing how this might
<tr> <tr>
<td class="lefttable"><strong>TxtColor</strong></td> <td class="lefttable"><strong>TxtColor</strong></td>
<td class="lefttable"><em>(optional)</em></td> <td class="lefttable"><em>(optional)</em></td>
<td class="righttable">Used by <strong>Link</strong> controls to specify the foreground color of <td class="righttable">Used by <strong>Link</strong> controls to
the text. Format: 0xBBRRGG (hexadecimal).</td> specify the foreground color of the text. Format: 0xBBRRGG
(hexadecimal).</td>
</tr> </tr>
</table> </table>
</div>
<h2>How to use</h2> <h2>How to use</h2>
<div>
<h3>Modern UI</h3> <h3>Modern UI</h3>
<p>For information about using InstallOptions with the Modern UI, have a look at the <a href= <div>
"../Modern%20UI/Readme.html#customPages">Modern UI documentation</a>.</p> <p>For information about using InstallOptions with the Modern UI,
have a look at the <a href=
"../Modern%20UI/Readme.html#customPages">Modern UI
documentation</a>.</p>
</div>
<h3>Extract the INI File</h3> <h3>Extract the INI File</h3>
<p>First, you have to extract the INI files for the dialogs in the .onInit function:</p> <div>
<p>First, you have to extract the INI files for the dialogs in the
.onInit function:</p>
<pre> <pre>
Function .onInit Function .onInit
@ -512,18 +594,20 @@ Function .onInit
File /oname=$PLUGINSDIR\test.ini test.ini File /oname=$PLUGINSDIR\test.ini test.ini
FunctionEnd FunctionEnd
</pre> </pre></div>
<h3>Call the DLL</h3> <h3>Call the DLL</h3>
<p>You can call InstallOptions in a page function, check the <a href= <div>
"../../Docs/Chapter4.html#4.5">NSIS documentation</a> for information about the page system. <p>You can call InstallOptions in a page function, check the
Example:</p> <a href="../../Docs/Chapter4.html#4.5">NSIS documentation</a> for
information about the page system. Example:</p>
<pre> <pre>
Page custom SetCustom ValidateCustom Page custom SetCustom ValidateCustom
</pre> </pre>
<p>The InstallOptions DLL has three functions:</p> <p>The InstallOptions DLL has three functions:</p>
<ul> <ul>
<li>dialog - Creates the dialog immediately</li> <li>dialog - Creates the dialog immediately</li>
<li>initDialog - Creates the dialog in memory, does not show it</li> <li>initDialog - Creates the dialog in memory, does not show
it</li>
<li>show - Shows a dialog created in memory</li> <li>show - Shows a dialog created in memory</li>
</ul> </ul>
<p>Usually, you only need to use the dialog function:</p> <p>Usually, you only need to use the dialog function:</p>
@ -538,22 +622,26 @@ Function SetCustom ;FunctionName defined with Page command
Pop $R0 Pop $R0
FunctionEnd FunctionEnd
</pre> </pre></div>
<h3>Get the input</h3> <h3>Get the input</h3>
<p>To get the input of the user, read the State value of a Field using ReadINIStr:</p> <div>
<p>To get the input of the user, read the State value of a Field
using ReadINIStr:</p>
<pre> <pre>
ReadINIStr $R0 "$PLUGINSDIR\test.ini" "Field 1" "State" ReadINIStr $R0 "$PLUGINSDIR\test.ini" "Field 1" "State"
</pre> </pre>
<p><a name="escaping" id="escaping"></a><strong>Note:</strong></p> <p><a name="escaping" id="escaping"></a><strong>Note:</strong></p>
<p>Some InstallOptions values are escaped (in a similar manner to "C" strings) to allow characters <p>Some InstallOptions values are escaped (in a similar manner to
to be used that are not normally valid in INI file values. The affected values are:</p> "C" strings) to allow characters to be used that are not normally
valid in INI file values. The affected values are:</p>
<ul> <ul>
<li>The ValidateText field</li> <li>The ValidateText field</li>
<li>The Text value of Label fields</li> <li>The Text value of Label fields</li>
<li>The State value of Text fields that have the MULTILINE flag</li> <li>The State value of Text fields that have the MULTILINE
flag</li>
</ul> </ul>
<p>The escape character is the back-slash character ("\") and the available escape sequences <p>The escape character is the back-slash character ("\") and the
are:</p> available escape sequences are:</p>
<table class="subtable"> <table class="subtable">
<tr> <tr>
<td class="lefttable">"\\"</td> <td class="lefttable">"\\"</td>
@ -572,7 +660,8 @@ are:</p>
<td class="righttable">Tab (ASCII 9)</td> <td class="righttable">Tab (ASCII 9)</td>
</tr> </tr>
</table> </table>
<p>The following functions can be used to convert a string to and from this format:</p> <p>The following functions can be used to convert a string to and
from this format:</p>
<pre> <pre>
; Convert an NSIS string to a form suitable for use by InstallOptions ; Convert an NSIS string to a form suitable for use by InstallOptions
; Usage: ; Usage:
@ -648,10 +737,12 @@ done:
Pop $1 Pop $1
Exch $0 Exch $0
FunctionEnd FunctionEnd
</pre> </pre></div>
<h3>Validate the input</h3> <h3>Validate the input</h3>
<p>If you want to validate the input on the page, for example, you want to check whether the user <div>
has filled in a textbox, use the leave function of the Page command and Abort when the validation <p>If you want to validate the input on the page, for example, you
want to check whether the user has filled in a textbox, use the
leave function of the Page command and Abort when the validation
has failed:</p> has failed:</p>
<pre> <pre>
Function ValidateCustom Function ValidateCustom
@ -662,35 +753,47 @@ Function ValidateCustom
Abort Abort
FunctionEnd FunctionEnd
</pre> </pre></div>
<h3>Return value</h3> <h3>Return value</h3>
<p>After you have called the DLL, InstallOptions adds one value to the stack, with one of the <div>
following values:</p> <p>After you have called the DLL, InstallOptions adds one value to
the stack, with one of the following values:</p>
<ul> <ul>
<li>success - The user has pressed the Next button</li> <li>success - The user has pressed the Next button</li>
<li>back - The user has pressed the Back button</li> <li>back - The user has pressed the Back button</li>
<li>cancel - The user has pressed the Cancel button</li> <li>cancel - The user has pressed the Cancel button</li>
<li>error - An error has occurred, the dialog cannot be displayed.</li> <li>error - An error has occurred, the dialog cannot be
displayed.</li>
</ul> </ul>
<p>Usually, you don't need to check this value, but you still have to remove it from the stack <p>Usually, you don't need to check this value, but you still have
(have a look at the example above).</p> to remove it from the stack (have a look at the example above).</p>
<p>If you want to check the user input immediately, for example, to display a warning when the <p>If you want to check the user input immediately, for example, to
input is invalid, you should check whether the user has pressed the Back or Next button.</p> display a warning when the input is invalid, you should check
whether the user has pressed the Back or Next button.</p>
</div>
</div>
<h2>Reserve files</h2> <h2>Reserve files</h2>
<p>If you are using BZIP2 (solid) compression, it's important that files which are being extracted <div>
in init- or page functions function are located before other files in the data block, because this <p>If you are using BZIP2 (solid) compression, it's important that
will make your installer faster.</p> files which are being extracted in init- or page functions function
<p>If there are File commands in your sections or functions above the init- or page functions, add are located before other files in the data block, because this will
ReserveFile commands above your sections and functions:</p> make your installer faster.</p>
<p>If there are File commands in your sections or functions above
the init- or page functions, add ReserveFile commands above your
sections and functions:</p>
<pre> <pre>
ReserveFile "test.ini" ReserveFile "test.ini"
ReserveFile "${NSISDIR}\Plugins\InstallOptions.dll" ReserveFile "${NSISDIR}\Plugins\InstallOptions.dll"
</pre> </pre></div>
<h2>Fonts and colors</h2> <h2>Fonts and colors</h2>
<p>If you want to use custom fonts or colors on your InstallOptions dialogs, you should use the <div>
initDialog and show functions. initDialog creates the dialog in memory, but does not show it. After <p>If you want to use custom fonts or colors on your InstallOptions
calling initDialog, you can set the fonts and colors, and call show to show the dialog. initDialog dialogs, you should use the initDialog and show functions.
pushes the HWND of the custom dialog to the stack. To get the HWND of the controls use:</p> initDialog creates the dialog in memory, but does not show it.
After calling initDialog, you can set the fonts and colors, and
call show to show the dialog. initDialog pushes the HWND of the
custom dialog to the stack. To get the HWND of the controls
use:</p>
<pre> <pre>
GetDlgItem (output var) (hwnd of the custom dialog) (1200 + Field number - 1) GetDlgItem (output var) (hwnd of the custom dialog) (1200 + Field number - 1)
</pre> </pre>
@ -721,23 +824,28 @@ Function FunctionName ;FunctionName defined with Page command
Pop $R0 Pop $R0
FunctionEnd FunctionEnd
</pre> </pre></div>
<h2>Version history</h2> <h2>Version history</h2>
<div>
<ul> <ul>
<li>DLL version 2.4 (1/4/2004) <li>DLL version 2.4 (1/4/2004)
<ul> <ul>
<li>Initial focus is set in "initDialog" making it possible to override it from NSIS prior to <li>Initial focus is set in "initDialog" making it possible to
calling "show"</li> override it from NSIS prior to calling "show"</li>
<li>When initial focus is to a Text field InstallOptions now follows standard Windows behaviour by <li>When initial focus is to a Text field InstallOptions now
having the text selected</li> follows standard Windows behaviour by having the text selected</li>
<li>Label and other static fields no longer have State= written to the INI file when leaving the <li>Label and other static fields no longer have State= written to
dialog</li> the INI file when leaving the dialog</li>
<li>NOTIFY flag can now be used with Link fields (State should be omitted in this case)</li> <li>NOTIFY flag can now be used with Link fields (State should be
<li>Likewise, State can now be used with Button fields (behaves the same as with Link fields)</li> omitted in this case)</li>
<li>NOTIFY flag can also now be used with ListBox and DropList fields to have NSIS notified when <li>Likewise, State can now be used with Button fields (behaves the
the selection changes</li> same as with Link fields)</li>
<li>Meaning of RIGHT flag is now reversed in right-to-left language mode</li> <li>NOTIFY flag can also now be used with ListBox and DropList
<li>HSCROLL and VSCROLL flags are no longer restricted to Text fields</li> fields to have NSIS notified when the selection changes</li>
<li>Meaning of RIGHT flag is now reversed in right-to-left language
mode</li>
<li>HSCROLL and VSCROLL flags are no longer restricted to Text
fields</li>
<li>Various Link field fixes</li> <li>Various Link field fixes</li>
</ul> </ul>
</li> </li>
@ -768,13 +876,15 @@ the selection changes</li>
<ul> <ul>
<li>DLL version 2.1 (3/15/2003) <li>DLL version 2.1 (3/15/2003)
<ul> <ul>
<li>\r\n converts to newline in both label Text and ValidateText</li> <li>\r\n converts to newline in both label Text and
ValidateText</li>
<li>New browse dialog style (modern)</li> <li>New browse dialog style (modern)</li>
<li>Word wrapping for check boxes and radio buttons</li> <li>Word wrapping for check boxes and radio buttons</li>
<li>No ugly border for edit fields under XP</li> <li>No ugly border for edit fields under XP</li>
<li>Scroll bar for list boxes</li> <li>Scroll bar for list boxes</li>
<li>Works with SetStaticBkColor</li> <li>Works with SetStaticBkColor</li>
<li>DISABLED dir and file request fields now disable the browse button too</li> <li>DISABLED dir and file request fields now disable the browse
button too</li>
<li>No more STATE value for labels</li> <li>No more STATE value for labels</li>
<li>Minor fixes</li> <li>Minor fixes</li>
</ul> </ul>
@ -784,7 +894,8 @@ the selection changes</li>
<li>DLL version 2.0 (1/4/2003) <li>DLL version 2.0 (1/4/2003)
<ul> <ul>
<li>Supports custom font and DPI settings (by Joost Verburg)</li> <li>Supports custom font and DPI settings (by Joost Verburg)</li>
<li>INI files should contain dialog units now, no pixels (by Joost Verburg)</li> <li>INI files should contain dialog units now, no pixels (by Joost
Verburg)</li>
<li>RESIZETOFIT flag for Bitmap control (by Amir Szekely)</li> <li>RESIZETOFIT flag for Bitmap control (by Amir Szekely)</li>
<li>New documentation (by Joost Verburg)</li> <li>New documentation (by Joost Verburg)</li>
<li>New GROUP/NOTABSTOP/DISABLED flags</li> <li>New GROUP/NOTABSTOP/DISABLED flags</li>
@ -792,12 +903,16 @@ the selection changes</li>
</li> </li>
</ul> </ul>
<p><a href="Changelog.txt">Complete version history</a></p> <p><a href="Changelog.txt">Complete version history</a></p>
</div>
<h2>Credits</h2> <h2>Credits</h2>
<div>
<p>Original version by Michael Bishop<br /> <p>Original version by Michael Bishop<br />
DLL version by Nullsoft, Inc.<br /> DLL version by Nullsoft, Inc.<br />
DLL version 2 by Amir Szekely, ORTIM, Joost Verburg<br /> DLL version 2 by Amir Szekely, ORTIM, Joost Verburg<br />
New documentation by Joost Verburg</p> New documentation by Joost Verburg</p>
</div>
<h2>License</h2> <h2>License</h2>
<div>
<pre> <pre>
Original version Copyright &copy; 2001 Michael Bishop Original version Copyright &copy; 2001 Michael Bishop
DLL version 1 Copyright &copy; 2001-2002 Nullsoft, Inc., ORTIM DLL version 1 Copyright &copy; 2001-2002 Nullsoft, Inc., ORTIM
@ -819,9 +934,10 @@ it freely, subject to the following restrictions:
and must not be misrepresented as being the original software. and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any distribution. 3. This notice may not be removed or altered from any distribution.
</pre></div> </pre></div>
</div>
</td> </td>
</tr> </tr>
</table> </table>
</div> </table>
</body> </body>
</html> </html>

56
Contrib/VPatch/Readme.html
View file

@ -14,12 +14,12 @@ body
font-family: Verdana, Arial, Helvetica, sans-serif; font-family: Verdana, Arial, Helvetica, sans-serif;
font-size: 13px; font-size: 13px;
font-weight: normal; font-weight: normal;
text-align: left;
} }
p p, li
{ {
font-size: 100%; font-size: 13px;
margin: 20px;
} }
.center .center
@ -30,7 +30,7 @@ p
table table
{ {
margin: auto; margin: auto;
text-align: left; font-size: 13px;
background-color: #FFFFFF; background-color: #FFFFFF;
} }
@ -48,31 +48,29 @@ table
h1 h1
{ {
font-size: 220%; font-size: 30px;
color: #333333; color: #333333;
font-weight: normal; font-weight: normal;
text-align: center; text-align: center;
margin: 20px; margin-top: 20px;
} }
h2 h2
{ {
font-size: 165%; font-size: 20px;
color: #7A7272; color: #7A7272;
font-weight: normal; font-weight: normal;
} }
h3 h3
{ {
font-size: 140%; font-size: 17px;
font-weight: normal font-weight: bold;
color: #303030; color: #303030;
margin: 20px;
} }
pre { pre {
font-size: 100%; font-size: 13px;
margin: 20px;
} }
div div
@ -85,7 +83,7 @@ a:link, a:visited, a:active
color: #294F75; color: #294F75;
text-decoration: none; text-decoration: none;
} }
a:hover a:hover
{ {
color: #182634; color: #182634;
@ -97,19 +95,23 @@ a:hover
</head> </head>
<body> <body>
<div class="center"> <div class="center">
<table width="750" class="maintable" cellspacing="0" cellpadding="0"> <table width="750" class="maintable" cellspacing="0" cellpadding="0" align="center">
<tr> <tr>
<td> <td>
<h1>VPatch 2</h1> <h1>VPatch 2</h1>
<div> <div>
<h2>Introduction</h2> <h2>Introduction</h2>
<div>
<p>VPatch allows to create a patch file to update previous versions <p>VPatch allows to create a patch file to update previous versions
of your software. The GenPat utitily generates the patch file. The of your software. The GenPat utitily generates the patch file. The
plug-in can use the patch to update a file. Using a patch, you can plug-in can use the patch to update a file. Using a patch, you can
reduce the download size of your updates, because only the differences reduce the download size of your updates, because only the differences
between the files are included in the patch file.</p> between the files are included in the patch file.</p>
</div>
<h2>How to use</h2> <h2>How to use</h2>
<div>
<h3>Generate the patch file</h3> <h3>Generate the patch file</h3>
<div>
<p>Make sure you have the source file (original version) and the target <p>Make sure you have the source file (original version) and the target
file (version to update to). For example, DATA.DTA (currently on user file (version to update to). For example, DATA.DTA (currently on user
system) and DATA_20.DTA (version 2.0 of this data file). Now call system) and DATA_20.DTA (version 2.0 of this data file). Now call
@ -122,7 +124,9 @@ GENPAT data.dta data_20.dta data.pat
after the filenames), you can use a different block size. A smaller after the filenames), you can use a different block size. A smaller
block size may result in a smaller patch, but the generation will block size may result in a smaller patch, but the generation will
take more time (the default blocksize is 64).</p> take more time (the default blocksize is 64).</p>
</div>
<h3>Update the file during installation</h3> <h3>Update the file during installation</h3>
<div>
<p>Use the VPatch plug-in to update a file using a patch file:</p> <p>Use the VPatch plug-in to update a file using a patch file:</p>
<pre> <pre>
vpatch::vpatchfile "pathfile.pat" "source.file" "new.file" vpatch::vpatchfile "pathfile.pat" "source.file" "new.file"
@ -137,7 +141,9 @@ vpatch::vpatchfile "pathfile.pat" "source.file" "new.file"
<li>No suitable patches were found</li> <li>No suitable patches were found</li>
</ul> </ul>
<p>Check <a href="example.nsi">example.nsi</a> for an example.</p> <p>Check <a href="example.nsi">example.nsi</a> for an example.</p>
</div>
<h3>Multiple patches in one file</h3> <h3>Multiple patches in one file</h3>
<div>
<p>GenPat appends a patch to the file you specified. If there is already <p>GenPat appends a patch to the file you specified. If there is already
a patch for the same orginal file in the patch file, the patch will a patch for the same orginal file in the patch file, the patch will
be replaced. For example, if you want to be able to upgrade version be replaced. For example, if you want to be able to upgrade version
@ -148,7 +154,9 @@ vpatch::vpatchfile "pathfile.pat" "source.file" "new.file"
from file B version 1 to file B version 2. Just call the plug-in multiple from file B version 1 to file B version 2. Just call the plug-in multiple
times with the same patch file. It will automatically select the right times with the same patch file. It will automatically select the right
patch (based on the file CRC).</p> patch (based on the file CRC).</p>
</div>
<h3>GenPat exit codes</h3> <h3>GenPat exit codes</h3>
<div>
<p>In version 2.1 support was added for exit codes (known as error levels <p>In version 2.1 support was added for exit codes (known as error levels
in the DOS period) to GenPat. GenPat will return an exit code based in the DOS period) to GenPat. GenPat will return an exit code based
on succes of the patch generation. Here is a list of the possible on succes of the patch generation. Here is a list of the possible
@ -202,22 +210,33 @@ vpatch::vpatchfile "pathfile.pat" "source.file" "new.file"
<p>These exit codes can be useful when you generate patch files through <p>These exit codes can be useful when you generate patch files through
a script.</p> a script.</p>
</div> </div>
</div>
</div>
<div> <div>
<h2>Source code</h2> <h2>Source code</h2>
<div>
<h3>NSIS plug-in (C++)</h3> <h3>NSIS plug-in (C++)</h3>
<div>
<p>The source of the NSIS plug-in that applies patches can be found <p>The source of the NSIS plug-in that applies patches can be found
in the Source\Plugin folder.</p> in the Source\Plugin folder.</p>
</div>
<h3>Patch Generator (Delphi)</h3> <h3>Patch Generator (Delphi)</h3>
<div>
<p>The most interesting part of VPatch, the actual patch generation <p>The most interesting part of VPatch, the actual patch generation
algoritm, can be found in Source\GenPat\PatchGenerator.pas. The header algoritm, can be found in Source\GenPat\PatchGenerator.pas. The header
of that file contains a brief explanation of the algoritm as well.</p> of that file contains a brief explanation of the algoritm as well.</p>
</div>
<h3>User interface (Delphi)</h3> <h3>User interface (Delphi)</h3>
<div>
<p>A user interface is included as well, which you will have to build <p>A user interface is included as well, which you will have to build
yourself because the GUI executable was too large to include. Besides yourself because the GUI executable was too large to include. Besides
Borland Delphi 6 or higher (you can use the freely available Personal Borland Delphi 6 or higher (you can use the freely available Personal
edition), you will also need to install the <a href= edition), you will also need to install the <a href=
"http://www.delphi-gems.com">VirtualTreeView</a> component by Mike Lischke.</p> "http://www.delphi-gems.com">VirtualTreeView</a> component by Mike Lischke.</p>
</div>
</div>
<h2>Version history</h2> <h2>Version history</h2>
<div>
<ul> <ul>
<li>2.1 <li>2.1
<ul> <ul>
@ -247,11 +266,15 @@ vpatch::vpatchfile "pathfile.pat" "source.file" "new.file"
</ul> </ul>
</li> </li>
</ul> </ul>
</div>
<h2>Credits</h2> <h2>Credits</h2>
<div>
<p>Written by Koen van de Sande<br /> <p>Written by Koen van de Sande<br />
C plug-in by Edgewize<br /> C plug-in by Edgewize<br />
New documentation and example by Joost Verburg</p> New documentation and example by Joost Verburg</p>
</div>
<h2>License</h2> <h2>License</h2>
<div>
<pre> <pre>
Copyright (C) 2001-2003 Koen van de Sande Copyright (C) 2001-2003 Koen van de Sande
@ -271,6 +294,7 @@ it freely, subject to the following restrictions:
and must not be misrepresented as being the original software. and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any distribution. 3. This notice may not be removed or altered from any distribution.
</pre> </pre>
</div>
</div> </div>
</td> </td>
</tr> </tr>