dion 2004/07/04 21:45:42
Modified: nsis/xdocs customizing.xml
Log:
Add section on the provided templates and customization points
Revision Changes Path
1.3 +70 -1 maven-plugins/nsis/xdocs/customizing.xml
Index: customizing.xml
===================================================================
RCS file: /home/cvs/maven-plugins/nsis/xdocs/customizing.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- customizing.xml 5 Jul 2004 03:41:35 -0000 1.2
+++ customizing.xml 5 Jul 2004 04:45:42 -0000 1.3
@@ -35,7 +35,7 @@
</section>
<section name="Customizing">
<p>
- You can customize the resultant executable installer either
+ You can customize the installer either
by providing your own scripts that the existing templates
includes, or you can provide your own templates.
</p>
@@ -98,6 +98,75 @@
</table>
</subsection>
<subsection name="setup.jelly">
+ <p>
+ This template produces a file (<code>${maven.build.dir}/setup.nsi</code>)
+ which is used by the NSIS 'compiler', <code>makensis.exe</code> to
+ produce the installer.
+ </p>
+ <p>
+ The file, when processed, includes other files which you can optionally
+ provide, to add functionality to the installer. The property,
+ <code><a href="properties.html">${maven.nsis.src}</a></code>, which
defaults to
+ <code>${basedir}/src/nsis</code>, is where you can place any NSIS source
+ files which you want included.
+ </p>
+ <p>
+ The <code>setup.nsh</code> file that is generated uses following list
+ of directories to search for files to include:
+ <ol>
+ <li><code>${maven.nsis.src}</code> if it exists,</li>
+ <li><code>${maven.build.dir}</code></li>
+ <li><code>${plugin.resources}</code></li>
+ </ol>
+ So anything in your NSIS source will override the defaults.
+ </p>
+ <p>
+ The generated setup.nsh file includes the following files:
+ </p>
+ <table>
+ <tr><th>File</th><th>Purpose</th></tr>
+ <tr>
+ <td>before-install.nsh</td>
+ <td>Allow customization of code to be run before the install, e.g.
check JAVA_HOME etc</td>
+ </tr>
+ <tr>
+ <td>BrandingImage.nsh</td>
+ <td>Adds a macro to display the project logo on the installer</td>
+ </tr>
+ <tr>
+ <td>desktop-shortcuts.nsh</td>
+ <td>Allow customization of desktop shortcuts to be added</td>
+ </tr>
+ <tr>
+ <td>Environment.nsh</td>
+ <td>Adds functionality to set environment variables</td>
+ </tr>
+ <tr>
+ <td>JDK.nsh</td>
+ <td>Adds a function to check for <code>JAVA_HOME</code> being set</td>
+ </tr>
+ <tr>
+ <td>project.nsh</td>
+ <td>The generated file with project details as constants</td>
+ </tr>
+ <tr>
+ <td>registry.nsh</td>
+ <td>Allow customization of environment variables and registry entries
to be written</td>
+ </tr>
+ <tr>
+ <td>registry-uninstall.nsh</td>
+ <td>Allow customization of environment variables and registry entries
to be removed on uninstall</td>
+ </tr>
+ <tr>
+ <td>startmenu-shortcuts.nsh</td>
+ <td>Allow start menu shortcuts to be added</td>
+ </tr>
+ </table>
+ <p>
+ Typically you wont provide overrides for BrandingImage.nsh,
+ Environment.nsh and JDK.nsh, as these are utilities used in the setup.nsh
+ script.
+ </p>
</subsection>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
