Start on customizing docs

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115645 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
dion
2004-07-04 14:47:25 +00:00
parent f7e958b09a
commit 765969131b
2 changed files with 86 additions and 0 deletions

View File

@@ -0,0 +1,85 @@
<?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="Overview">
<ol>
<li><a href="#Customizing">Customizing</a></li>
<li><a href="#Default_Templates">Default Templates</a></li>
<li><a href="#Default_Template_Scripts">Default Template Scripts</a></li>
<li><a href="#Custom_Templates">Custom Templates</a></li>
</ol>
</section>
<section name="Customizing">
<p>
You can customize the resultant executable installer either
by providing your own scripts that the existing templates
includes, or you can provide your own templates.
</p>
<p>
Of these, the easiest is to provide your own scripts to supplement the
default templates. The most complex is to provide your own custom
templates.
</p>
<p>
No matter which way you decide to customize the installation process,
you will need to be familiar with
<a href="http://nsis.sourceforge.net/">NSIS</a> and have easy
access to the <a href="http://nsis.sourceforge.net/Docs/">NSIS Docs</a>.
</p>
<p>
We've also found the <a href="http://hmne.sourceforge.net/">HM NIS EDIT</a>
tool, which is a free NSIS Editor/IDE, very useful.
</p>
</section>
<section name="Default Templates">
<p>
The plugin provides two templates by default:
<ol>
<li>
<code>project.jelly</code> to get access to information in
<code>project.xml</code> from within NSIS scripts.
</li>
<li>
<code>setup.jelly</code> which generates the final script for NSIS
compilation.
</li>
</ol>
</p>
<subsection name="project.jelly">
</subsection>
<subsection name="setup.jelly">
</subsection>
</section>
<section name="Default Template Scripts">
</section>
<section name="Custom Templates">
</section>
</body>
</document>

View File

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