|
1 <html> |
|
2 <head> |
|
3 <title>ExperienceUI Documentation Content Frame</title> |
|
4 <link rel=stylesheet href=style.css type=text/css> |
|
5 <script type=text/javascript src=cmd.js></script> |
|
6 </head> |
|
7 |
|
8 <body bgcolor="#FFFFFF" style="background-color:#FFFFFF;margin:0px;padding:0px"> |
|
9 |
|
10 <table border=0 width=100% height=100%> |
|
11 |
|
12 <tr> |
|
13 |
|
14 <td valign=top style=margin:10px;padding:10px> |
|
15 |
|
16 <h1>Inserting Pages</h1> |
|
17 <p style="margin-left: 0.20in">There are two ways to insert pages with the ExperienceUI. The first - and easiest - way is via the ${Page} command. This command handles all but two of the pages in the ExperienceUI, and plus it is very easy to learn and understand. You <i>must</i> include XPUI.nsh before inserting pages.</p> |
|
18 <script type="text/javascript"> |
|
19 macro("${Page}", "page_name(Welcome|Welcome2|Components|Directory|InstConfirm|InstFiles|Finish|InstSuccess|Abort)", "Inserts an ExperienceUI page into the installer. See below for a description of each page.<br /><br /><i><b>Example:</b> ${Page} Welcome2</i>"); |
|
20 macro("${UnPage}", "<br />page_name(Welcome|Welcome2|Components|Directory|InstConfirm|InstFiles|Finish|InstSuccess|Abort|UnConfirm)", "The same as ${Page}, but for the uninstaller. Note the new option, UnConfirm, which is the NSIS Uninstall Confirm page. For consistency, InstConfirm and InstFiles are InstConfirm and InstFiles, not UninstConfirm and UninstFiles.<br /><br /><i><b>Example:</b> ${UnPage} InstFiles</i>"); |
|
21 macro("${LicensePage}", "text/rtf_file", "Inserts a license page into your installer. text/rtf_file should be the full or relative path to the plaintext or RTF file with your license agreement text."); |
|
22 macro("${StartMenuPage}", "Page_ID $var", "Inserts the start menu folder selection page into your installer. The start menu page asks the user what Start Menu program group the shortcuts to the program should be placed in. page_id can be any text value (no spaces) and var should be $0, $1, etc. It is recommended that you declare a user variable (<code>Var SMFOLDER</code> etc.) for <b>var</b> so that its value is not overwritten between the Start Menu page and the InstFiles page."); |
|
23 </script> |
|
24 |
|
25 <p style="margin-left: 0.20in">The other way to insert a page is using a macro. This is really what the ${Page} command does behind the scenes, so there is no difference in behavior. To insert a page using the commands below, use, for example, !insertmacro XPUI_PAGE_WELCOME.</p> |
|
26 <p style="margin-left: 0.20in"> |
|
27 <b>All of the pages listed here <i>except</i> the NSIS-Style uninstall confirmation page can be used in either the installer or the uninstaller.</b><br> |
|
28 <br> |
|
29 <script type="text/javascript"> |
|
30 macro("XPUI_PAGEMODE_INST", "", "Sets all of the pages inserted after this macro to be inserted into the installer. This macro can be used multiple times and is inserted automatically at the end of the header file."); |
|
31 macro("XPUI_PAGEMODE_UNINST", "", "Sets all of the pages inserted after this macro to be inserted into the uninstaller. This macro can be used multiple times."); |
|
32 macro("XPUI_PAGE_WELCOME", "", "Inserts the welcome page into your installer. This welcome page looks like Joost Verburg's Modern UI, without the bitmap on the left."); |
|
33 macro("XPUI_PAGE_WELCOME2", "", "Inserts the alternative welcome page into your installer. This page looks like the welcome page in the latest InstallShield® setup programs."); |
|
34 macro("XPUI_PAGE_LICENSE", "text/rtf_file", "Inserts the license page into your installer. The license page displays an agreement between the software maker and the end user, and asks the user to accept the agreement before installing the program."); |
|
35 macro("XPUI_PAGE_COMPONENTS", "", "Inserts the component selection page into your installer. The components page asks the user what parts of the program he/she wants to install."); |
|
36 macro("XPUI_PAGE_DIRECTORY", "", "Inserts the folder selection page into your installer. The directory page asks the user what folder he/she wants the main program files copied to."); |
|
37 macro("XPUI_PAGE_STARTMENU", "page_id var", "Inserts the start menu folder selection page into your installer. The start menu page asks the user what Start Menu program group the shortcuts to the program should be placed in. page_id can be any text value (no spaces) and var should be $0, $1, etc. It is recommended that you declare a user variable (<code>Var SMFOLDER</code> etc.) for <b>var</b> so that its value is not overwritten between the Start Menu page and the InstFiles page."); |
|
38 macro("XPUI_PAGE_INSTCONFIRM", "", "Inserts the installation confirmation page into your installer. The install confirm page asks the user to confirm the installation or maintenance operation."); |
|
39 macro("XPUI_PAGE_INSTFILES", "", "Inserts the file copy page into your installer. The files page is where the program's files are copied to the user's hard disk and a log is displayed in a list box."); |
|
40 macro("XPUI_PAGE_INSTSUCCESS", "", "Inserts the installation success page into your installer. The install success page alerts the user that the program was successfully copied to his/her computer's hard disk."); |
|
41 macro("XPUI_PAGE_FINISH", "", "Inserts the finish page into your installer. The finish page alerts the user that the program was successfully copied to his/her computer's hard disk, and asks the user if he/she wants to run the program, view the documentation, or reboot the computer."); |
|
42 macro("XPUI_PAGE_ABORT", "", "Inserts the Abort page into your installer. The Abort page is shown the after installer has been cancelled. <b>This has to be the last page inserted<\/b> and it requires XPUI_ABORTWARNING to be defined or it won't work. If you do use an Abort page, define XPUI_ABORTWARNING, insert language files, insert all other installer (as in not uninstaller) pages, and then insert XPUI_PAGE_ABORT. More information about the Abort page can be found in the <a href='visual_settings.htm#abort'>visual settings<\/a> section."); |
|
43 macro("XPUI_PAGE_UNINSTCONFIRM_NSIS", "", "Inserts the classic NSIS-style uninstall confirmation page into your installer. The NSIS-style uninstall confirmation page asks the user to confirm that he/she wants to uninstall the program, and shows the folder that the program is installed in."); |
|
44 //macro("", "", ""); |
|
45 </script> |
|
46 <font face=Verdana style="font-size:8pt"> |
|
47 <b>A note on page defines:</b> When you define a custom string, it is usually applied to the installer only. To make a custom string that applies to the uninstaller, define the string as normal, but add UN after the XPUI_ part of the define. An example would be XPUI_COMPONENTSPAGE_TITLE becomes XPUI_<b>UN</b>COMPONENTSPAGE_TITLE. Note that this does not apply to macros; to insert, for example, the welcome page into your uninstaller, insert XPUI_PAGEMODE_UNINST and then XPUI_PAGE_WELCOME, or just ${UnPage} Welcome.<br> |
|
48 </font> |
|
49 <br> |
|
50 </p> |
|
51 |
|
52 </td> |
|
53 |
|
54 </tr> |
|
55 |
|
56 <tr> |
|
57 |
|
58 <td valign=bottom style=margin:0px;padding:0px> |
|
59 |
|
60 <p class=footer>Copyright © 2004-2006 Dan Fuhry. All rights except those explicitly given in the <a href=license_agreement.htm style=color:#A0A0D0 onmouseover="this.style.color='#A0A0A0'" onmouseout="this.style.color='#A0A0D0'">license agreement</a> reserved.</p> |
|
61 |
|
62 </td> |
|
63 |
|
64 </tr> |
|
65 |
|
66 </table> |
|
67 |
|
68 </body> |
|
69 |
|
70 </html> |