Docs/ExperienceUI/pages/wansis.htm
changeset 0 d5ce4c64ef88
equal deleted inserted replaced
-1:000000000000 0:d5ce4c64ef88
       
     1 <html>
       
     2   <head>
       
     3     <title>ExperienceUI Documentation Content Frame</title>
       
     4     <link rel=stylesheet href=style.css type=text/css>
       
     5   </head>
       
     6   
       
     7   <body bgcolor="#FFFFFF" style="background-color:#FFFFFF;margin:0px;padding:0px">
       
     8   
       
     9     <table border=0 width=100% height=100%>
       
    10     
       
    11       <tr>
       
    12       
       
    13         <td valign=top style=margin:10px;padding:10px>
       
    14     
       
    15           <h1>Skin the entire installer</h1>
       
    16           
       
    17           <p style=margin-left:0.2in>
       
    18           
       
    19             <font face=Verdana style=font-size:8pt>
       
    20             
       
    21               <b>The ExperienceUI includes support for WAnsis</b>, Saivert's skinning plugin.  WAnsis is a plugin for NSIS that uses Winamp
       
    22               2 skins to change the look of the installer completely.  The ExperienceUI natively supports WAnsis, and it is very easy to
       
    23               implement it into your script.<br>
       
    24               <br>
       
    25               <b>NOTES:</b> WAnsis support adds 22KB of overhead to the installer, and the plugin can sometimes be unstable.  If you are
       
    26               very concerned about size, or do not want to take risks concerning stability, you may want to leave WAnsis support out of the
       
    27               installer.
       
    28               
       
    29             </font>
       
    30           
       
    31           </p>
       
    32           
       
    33           <h1>WAnsis Settings</h1>
       
    34           
       
    35           
       
    36           <font face=Verdana style=font-size:8pt>
       
    37           
       
    38             <p style=margin-left:0.2in><b>XPUI_WANSIS</b> <font color=#294F75><i></i></font><p style=margin-left:0.4in>Define this to turn on all WAnsis support in the ExperienceUI. <b>WAnsis has been known to be unstable, so please test your installer thoroughly before you distribute it.</b>  (Default: by default, XPUI_WANSIS is undefined)</p>
       
    39             <p style=margin-left:0.2in><b>XPUI_WANSIS_SKIN</b> <font color=#294F75><i>Skin_folder_name</i></font><p style=margin-left:0.4in>Sets the WAnsis skin to Skin_folder_name, where Skin_folder_name is a folder inside the ExperienceUI's skin directory. (&lt;NSIS&gt;\Contrib\ExperienceUI\Skins)  If you plan to make WAnsis skins, it is different that making standard skins.  Please see the guide below.  (Default: "Forum")</p>
       
    40             <p style=margin-left:0.2in><b>XPUI_WANSIS_HEADERIMAGE</b> <font color=#294F75><i></i></font><p style=margin-left:0.4in>Define this to use a header image in your WAnsis-enabled installer.  If you don't define this, the installer's icon will appear in the spot where the header image would go.  (Default: not defined)</p>
       
    41             <p style=margin-left:0.2in><b>XPUI_WANSIS_HEADERIMAGE_BMP</b> <font color=#294F75><i>BMP_file</i></font><p style=margin-left:0.4in>Uses BMP_file as the header bitmap in a WAnsis installer.  Recommended size: <b>150</b>x<b>57</b>px.  (Default: &lt;NSIS&gt;\Contrib\ExperienceUI\Skins\&lt;WAnsis skin&gt;\Header.bmp)</p>
       
    42             <p style=margin-left:0.2in><b>XPUI_WANSIS_UI</b> <font color=#294F75><i>UI_file</i></font><p style=margin-left:0.4in>Uses UI_file as the UI for a WAnsis-enabled installer.  Don't change this unless you <i>really</i> know what you are doing.  (Default: &lt;NSIS&gt;\Contrib\ExperienceUI\UIs\WAnsis_ui.exe)</p>
       
    43             <p style=margin-left:0.2in><b>XPUI_WANSIS_GEN</b> <font color=#294F75><i>BMP_file</i></font><p style=margin-left:0.4in>The "gen" bitmap used for WAnsis.  Please refer to the WAnsis documentation and the Winamp Skinners' Guide for help on creating WAnsis skins.  (Default: &lt;NSIS&gt;\Contrib\ExperienceUI\Skins\&lt;WAnsis skin&gt;\gen.bmp)</p>
       
    44             <p style=margin-left:0.2in><b>XPUI_WANSIS_GENEX</b> <font color=#294F75><i>BMP_file</i></font><p style=margin-left:0.4in>The "genex" bitmap used for WAnsis.  Please refer to the WAnsis documentation and the Winamp Skinners' Guide for help on creating WAnsis skins.  (Default: &lt;NSIS&gt;\Contrib\ExperienceUI\Skins\&lt;WAnsis skin&gt;\genex.bmp)</p>
       
    45             
       
    46             <p style=margin-left:0.2in>
       
    47             
       
    48               To change the Bottom Image and the Left Logo, use XPUI_BOTTOMIMAGE_BMP and XPUI_LEFTLOGO, respectively.  See <a href=visual_settings.htm>this page</a> for more information.
       
    49             
       
    50             </p>
       
    51 
       
    52           </font>
       
    53           
       
    54           <h1>Creating WAnsis Skins</h1>
       
    55           
       
    56           <p style=margin-left:0.2in>
       
    57           
       
    58             <font face=Verdana style=font-size:8pt>
       
    59             
       
    60               You can created your own WAnsis skins, too.  The WAnsis skinning system is a little bit more limited than the standard
       
    61               skinning system, but it makes skin initialization faster and it means you don't need any scripting knowledge to make WAnsis
       
    62               skins.<br>
       
    63               <br>
       
    64               The ExperienceUI WAnsis skinning system has 5 mandatory bitmaps and 1 optional bitmap.  A description of each bitmap can be
       
    65               found below:<br>
       
    66               
       
    67             </font>
       
    68             
       
    69           </p>
       
    70               <ul>
       
    71                 <li><b>bottom.bmp</b> &ndash; The bottom image.  The best size is 693x70px, but the last two columns to the right are cut off.  I'm still trying to figure this one out.</li>
       
    72                 <li><b>checks.bmp</b> &ndash; The checkbox images used on the Components page.</li>
       
    73                 <li><b>gen.bmp</b> &ndash; The bitmap containing window border elements.  See the WAnsis documentation for more information.</li>
       
    74                 <li><b>genex.bmp</b> &ndash; The buttons, scrollbars, and color tables for the interior of the window.  Again, see the WAnsis doumentation for more information.</li>
       
    75                 <li><b>header.bmp</b> &ndash; Optional Modern UI-compatible header bitmap.  Will only be used if XPUI_WANSIS_HEADERIMAGE is defined.  If you don't include this and the user of the skin defines XPUI_WANSIS_HEADERIMAGE, MakeNSIS will halt.</li>
       
    76                 <li><b>leftlogo.bmp</b> &ndash; The image shown on the left of the installer window.  Recommended size is 240x349px.</li>
       
    77               </ul>
       
    78               
       
    79           <p style=margin-left:0.2in>
       
    80           
       
    81             <font face=Verdana style=font-size:8pt>
       
    82             
       
    83               To create a new WAnsis skin, navigate to the &lt;NSIS&gt;\Contrib\ExperienceUI\Skins folder and create a new directory.  Name
       
    84               the directory whatever you want your skin's screen name to be.<br>
       
    85               <br>
       
    86               Next, put the bitmap files listed above in the folder you just made.<br>
       
    87               <br>
       
    88               Last, test your skin by using compiling following script:<br>
       
    89             
       
    90           </p>
       
    91               
       
    92               <div style=margin-left:0.4in>
       
    93 <pre>
       
    94 <code><span style="font: 10pt Courier New;"><span class="nsis1-directive">!define</span><span class="nsis1-space"> XPUI_WANSIS
       
    95 </span><span class="nsis1-directive">!define</span><span class="nsis1-space"> XPUI_WANSIS_SKIN </span><span class="nsis1-string">&quot;&lt;Skin name&gt;&quot;
       
    96 </span><span class="nsis1-directive">!include</span><span class="nsis1-space"> XPUI.nsh
       
    97 </span><span class="nsis1-directive">!insertmacro</span><span class="nsis1-space"> XPUI_PAGE_WELCOME2
       
    98 </span><span class="nsis1-directive">!insertmacro</span><span class="nsis1-space"> XPUI_PAGE_LICENSE </span><span class="nsis1-string">&quot;</span><span class="nsis1-variable">${NSISDIR}</span><span class="nsis1-string">\Contrib\ExperienceUI\License.rtf&quot;
       
    99 </span><span class="nsis1-directive">!insertmacro</span><span class="nsis1-space"> XPUI_PAGE_COMPONENTS
       
   100 </span><span class="nsis1-directive">!insertmacro</span><span class="nsis1-space"> XPUI_PAGE_DIRECTORY
       
   101 </span><span class="nsis1-directive">!insertmacro</span><span class="nsis1-space"> XPUI_PAGE_INSTCONFIRM
       
   102 </span><span class="nsis1-directive">!insertmacro</span><span class="nsis1-space"> XPUI_PAGE_INSTFILES
       
   103 </span><span class="nsis1-directive">!insertmacro</span><span class="nsis1-space"> XPUI_PAGE_FINISH
       
   104 </span><span class="nsis1-directive">!insertmacro</span><span class="nsis1-space"> XPUI_PAGE_ABORT
       
   105 </span><span class="nsis1-directive">!define</span><span class="nsis1-space"> XPUI_ABORTWARNING
       
   106 </span><span class="nsis1-directive">!insertmacro</span><span class="nsis1-space"> XPUI_LANGUAGE English
       
   107 
       
   108 </span><span class="nsis1-reservedword">Name</span><span class="nsis1-space"> </span><span class="nsis1-string">&quot;Testing: ExperienceUI WAnsis Skin </span><span class="nsis1-variable">${XPUI_WANSIS_SKIN}</span><span class="nsis1-string">&quot;
       
   109 </span><span class="nsis1-reservedword">Caption</span><span class="nsis1-space"> </span><span class="nsis1-string">&quot;Testing: ExperienceUI WAnsis Skin </span><span class="nsis1-variable">${XPUI_WANSIS_SKIN}</span><span class="nsis1-string">&quot;
       
   110 </span><span class="nsis1-reservedword">OutFile</span><span class="nsis1-space"> </span><span class="nsis1-string">&quot;</span><span class="nsis1-variable">${XPUI_WANSIS_SKIN}</span><span class="nsis1-string"> Test.exe&quot;
       
   111 
       
   112 </span><span class="nsis1-reservedword">InstallDir</span><span class="nsis1-space"> C:\Test
       
   113 
       
   114 </span><span class="nsis1-reservedword">Section
       
   115 SectionEnd
       
   116 </span></span>
       
   117 </code></pre>
       
   118 
       
   119               </div>
       
   120               
       
   121               Be sure to replace "&lt;Skin name&gt;" with the name of the folder you created.
       
   122               
       
   123             </font>
       
   124           
       
   125           </p>
       
   126           
       
   127           
       
   128         </td>
       
   129         
       
   130       </tr>
       
   131       
       
   132       <tr>
       
   133       
       
   134         <td valign=bottom style=margin:0px;padding:0px>
       
   135     
       
   136           <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>
       
   137   
       
   138         </td>
       
   139         
       
   140       </tr>
       
   141       
       
   142     </table>
       
   143   
       
   144   </body>
       
   145   
       
   146 </html>