maven-plugins/nsis/xdocs/properties.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- 
  /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
  * The ASF licenses this file to You 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 Properties</title>
  </properties>
  <body>
    <section name="Maven NSIS Plug-in Settings">
      <subsection name="General Settings">
        <table>
          <tr>
            <th>Property</th>
            <th>Optional?</th>
            <th>Description</th>
          </tr>
          <tr>
            <td>maven.nsis.build.dir</td>
            <td>Yes</td>
            <td>
              <p>
                The directory containing contents to be bundled.
                <br />
                Default value is ${maven.dist.bin.assembly.dir}
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.final.name</td>
            <td>Yes</td>
            <td>
              <p>
                name of generated exe.
                <br />
                Default value is
                <code>${maven.final.name}</code>
                .
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.src</td>
            <td>Yes</td>
            <td>
              <p>
                Source of extra files for nsis.
                <br />
                Default value is
                <code>${basedir}/src/nsis</code>
                .
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.exe</td>
            <td>Yes</td>
            <td>
              <p>
                Location of makensis.exe.
                <br />
                Default value is
                <code>C:/Program Files/NSIS/makensis.exe</code>
                .
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.setup.template</td>
            <td>Yes</td>
            <td>
              <p>
                This is the jelly template used to create the setup.nsi file.
                <br />
                Default value is
                <code>${plugin.resources}/templates/setup.jelly</code>
                .
                <br />
                To generate an insaller with a MUI interface set this property to :
                <code>${plugin.resources}/templates/mui-setup.jelly</code>
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.project.template</td>
            <td>Yes</td>
            <td>
              <p>
                This is the jelly template used to create the project.nsh file.
                <br />
                Default value is
                <code>${plugin.resources}/templates/project.jelly</code>
                .
              </p>
            </td>
          </tr>
        </table>
      </subsection>
      <subsection name="Standard UI Settings">
        <p>
          Those properties are used only if
          <code>maven.nsis.setup.template=${plugin.resources}/templates/setup.jelly</code>
        </p>
        <table>
          <tr>
            <th>Property</th>
            <th>Optional?</th>
            <th>Description</th>
          </tr>
          <tr>
            <td>maven.nsis.license.text</td>
            <td>Yes</td>
            <td>
              <p>
                The License Text.
                <br />
                Default value is
                <code>This program is Licensed under The Apache Software License, Version 2.0.</code>
                .
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.logo</td>
            <td>Yes</td>
            <td>
              <p>
                Location of the logo file.
                <br />
                Default value is blank.
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.logo.position</td>
            <td>Yes</td>
            <td>
              <p>
                Position of the logo on the first page (left, right, top or bottom).
                <br />
                Default value is
                <code>left</code>
                .
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.logo.widthHeight</td>
            <td>Yes</td>
            <td>
              <p>
                size of the logo on the first page.
                <br />
                Default value is blank.
              </p>
            </td>
          </tr>
        </table>
      </subsection>
      <subsection name="Modern UI Settings">
        <p>
          Those properties are used only with the MUI template :
          <code>maven.nsis.setup.template=${plugin.resources}/templates/mui-setup.jelly</code>
        </p>
        <table>
          <tr>
            <th>Property</th>
            <th>Optional?</th>
            <th>Description</th>
          </tr>
          <tr>
            <td>maven.nsis.mui.icon</td>
            <td>Yes</td>
            <td>
              <p>
                Setup icon for install.
                <br />
                Default : not set (using NSIS MUI defaults)
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.mui.unicon</td>
            <td>Yes</td>
            <td>
              <p>
                Setup icon for uninstall.
                <br />
                Default : not set (using NSIS MUI defaults)
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.mui.headerbitmap</td>
            <td>Yes</td>
            <td>
              <p>
                Header bitmap for install.
                <br />
                Default : not set (using NSIS MUI defaults)
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.mui.unheaderbitmap</td>
            <td>Yes</td>
            <td>
              <p>
                Header bitmap for uninstall.
                <br />
                Default : not set (using NSIS MUI defaults)
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.mui.welcomebitmap</td>
            <td>Yes</td>
            <td>
              <p>
                Welcome bitmap for install.
                <br />
                Default : not set (using NSIS MUI defaults)
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.mui.unwelcomebitmap</td>
            <td>Yes</td>
            <td>
              <p>
                Welcome bitmap for uninstall.
                <br />
                Default : not set (using NSIS MUI defaults)
              </p>
            </td>
          </tr>
          <tr>
            <td>maven.nsis.mui.languages</td>
            <td>No</td>
            <td>The list of languages to propose in the setup.<br/>Default : English,French,Spanish,German</td>
          </tr>
        </table>
      </subsection>
    </section>
  </body>
</document>