Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add details on the typical process

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115640 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
dion
2004-07-04 12:26:09 +00:00
parent 4a3c93fba3
commit c1f0fe96f1
2 changed files with 67 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
nsis/xdocs/navigation.xml
View File

@@ -28,6 +28,7 @@
<menu name="Overview">
<item href="/goals.html" name="Goals"/>
<item href="/properties.html" name="Properties"/>
<item href="/process.html" name="How it works"/>
</menu>
</body>
</project>

66
nsis/xdocs/process.xml Normal file
View File

@@ -0,0 +1,66 @@
<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>Maven NSIS Plug-in</title>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
<body>
<section name="How it works">
<p>
The process of creating an installer from your <code>${maven.dist.bin.dir}</code>
using the plugin is as follows:
<ol>
<li>
You, the user invoke the <code>nsis</code>, or <code>nsis:installer</code>
goal.
</li>
<li>
This calls the <code>nsis:generate-project</code> goal, which creates
a file, <code>${maven.build.dir}/project.nsh</code>. This file contains
details from your project.xml file as constants so they are available
for during the NSIS compilation step. The file is generated from a jelly
template specified by the <code>${maven.nsis.project.template}</code>
variable. See the <a href="properties.html">properties</a> documentation
for more information on the defaults for this variable.
</li>
<li>
Next the <code>nsis:generate-setup</code> goal is called, which creates
a file, <code>${maven.build.dir}/setup.nsi</code>. This file is later
the file passed to the NSIS executable compiler, <code>makensis.exe</code>.
This file is generated from a jelly template specified by the
<code>${maven.nsis.setup.template}</code> variable. See the
<a href="properties.html">properties</a> documentation
for more information on the defaults for this variable.
</li>
<li>
Lastly, <code>makensis.exe</code> is called to compile to generated
setup.nsi file.
</li>
</ol>
</p>
<!--p>
reference up coming customisation doc here
</p-->
</section>
</body>
</document>