You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by di...@apache.org on 2004/07/04 14:26:09 UTC

cvs commit: maven-plugins/nsis/xdocs process.xml navigation.xml

dion        2004/07/04 05:26:09

  Modified:    nsis/xdocs navigation.xml
  Added:       nsis/xdocs process.xml
  Log:
  Add details on the typical process
  
  Revision  Changes    Path
  1.4       +1 -0      maven-plugins/nsis/xdocs/navigation.xml
  
  Index: navigation.xml
  ===================================================================
  RCS file: /home/cvs/maven-plugins/nsis/xdocs/navigation.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- navigation.xml	1 Jul 2004 19:27:43 -0000	1.3
  +++ navigation.xml	4 Jul 2004 12:26:09 -0000	1.4
  @@ -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>
  
  
  
  1.1                  maven-plugins/nsis/xdocs/process.xml
  
  Index: process.xml
  ===================================================================
  <?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>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org