Mercurial Mercurial > repos > experienceui / annotate
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs/ExperienceUI/pages/page_macros.htm
author Dan
Wed, 20 Jan 2010 13:53:52 -0500
changeset 20 0e4433768c8e
parent 0 d5ce4c64ef88
permissions -rwxr-xr-x
Version bump to 1.3.2, pending doc changes; fixed absence of "LockWindow off" in uninstconfirm page init
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
     1
 
<html>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
     2
 
  <head>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
     3
 
    <title>ExperienceUI Documentation Content Frame</title>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
     4
 
    <link rel=stylesheet href=style.css type=text/css>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
     5
 
    <script type=text/javascript src=cmd.js></script>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
     6
 
  </head>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
     7
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
     8
 
  <body bgcolor="#FFFFFF" style="background-color:#FFFFFF;margin:0px;padding:0px">
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
     9
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    10
 
    <table border=0 width=100% height=100%>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    11
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    12
 
      <tr>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    13
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    14
 
        <td valign=top style=margin:10px;padding:10px>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    15
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    16
 
          <h1>Inserting Pages</h1>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    18
 
          <script type="text/javascript">
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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>");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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>");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    23
 
          </script>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    24
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    26
 
	  <p style="margin-left: 0.20in">
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    28
 
	    <br>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    29
 
            <script type="text/javascript">
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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.");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    44
 
              //macro("", "", "");
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    45
 
            </script>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    46
 
            <font face=Verdana style="font-size:8pt">
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    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>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    48
 
            </font>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    49
 
	    <br>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    50
 
	  </p>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    51
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    52
 
	</td>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    53
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    54
 
      </tr>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    55
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    56
 
      <tr>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    57
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    58
 
        <td valign=bottom style=margin:0px;padding:0px>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    59
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    60
 
          <p class=footer>Copyright &copy; 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>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    61
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    62
 
        </td>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    63
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    64
 
      </tr>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    65
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    66
 
    </table>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    67
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    68
 
  </body>
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    69
d5ce4c64ef88 Initial population with stock ExUI 1.11pre + a couple of fixes needed to compile the installer
Dan
parents:
diff changeset 
    70
 
</html>
ExperienceUI for NSIS