Revision: 235 http://mindtreeinsight.svn.sourceforge.net/mindtreeinsight/?rev=235&view=rev Author: bindul Date: 2009-03-27 21:00:18 +0000 (Fri, 27 Mar 2009)
Log Message: ----------- FRQ-2685076: Allow non English installer creations Modified Paths: -------------- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/pom.xml releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/changes/changes.xml releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/actions/NsisScriptConstants.java releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/actions/ScriptGenerationAction.java releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/io/DefaultProjectFileReader.java releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/mdo/nsisproj.mdo releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/resources/velocity/mui-pages.vm releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/resources/velocity/sections.vm releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/index.apt releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/insight-nsis-proj.apt releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/usage.apt releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/site.xml Added Paths: ----------- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/velocityutil/NSISLanguageTool.java releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/0.1.0/ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/0.1.0/usage.apt Modified: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/pom.xml =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/pom.xml 2009-03-27 15:45:57 UTC (rev 234) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/pom.xml 2009-03-27 21:00:18 UTC (rev 235) @@ -27,7 +27,6 @@ <groupId>com.mindtree.techworks.insight.releng</groupId> <artifactId>mvn-plugins-parent</artifactId> <version>1.2.0</version> - <relativePath>../mvn-plugins-parent/pom.xml</relativePath> </parent> <modelVersion>4.0.0</modelVersion> <groupId>com.mindtree.techworks.insight.releng</groupId> @@ -76,22 +75,54 @@ <goal>xpp3-reader</goal> <goal>xpp3-writer</goal> <goal>java</goal> + </goals> + </execution> + <execution> + <id>nsisproj-src-xsd</id> + <phase>generate-sources</phase> + <goals> <goal>xsd</goal> </goals> + <configuration> + <outputDirectory>${basedir}/target/generated-sources/resources/xsd</outputDirectory> + <packageWithVersion>true</packageWithVersion> + <packagedVersions> + <packagedVersion>0.1.0</packagedVersion> + </packagedVersions> + </configuration> </execution> <execution> + <id>nsisproj-site-xsd</id> + <phase>pre-site</phase> + <goals> + <goal>xsd</goal> + </goals> + <configuration> + <outputDirectory>${basedir}/target/generated-site/resources/xsd</outputDirectory> + <packageWithVersion>true</packageWithVersion> + <packagedVersions> + <packagedVersion>0.1.0</packagedVersion> + </packagedVersions> + </configuration> + </execution> + <execution> <id>nsisproj-site</id> <phase>pre-site</phase> <goals> <goal>xdoc</goal> </goals> + <configuration> + <packagedVersions> + <packagedVersion>0.1.0</packagedVersion> + </packagedVersions> + </configuration> </execution> </executions> <configuration> <models> <model>src/main/mdo/nsisproj.mdo</model> </models> - <version>0.1.0</version> + <version>0.2.0</version> <useJava5>false</useJava5> </configuration> </plugin> Modified: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/changes/changes.xml =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/changes/changes.xml 2009-03-27 15:45:57 UTC (rev 234) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/changes/changes.xml 2009-03-27 21:00:18 UTC (rev 235) @@ -38,6 +38,9 @@ <action type="add" date="2009-03-10" dev="bindul" issue="2014237" system="featureRequests"> Added support to run the plug-in on Linux </action> + <action type="add" date="2009-03-27" dev="bindul" issue="2685076" system="featureRequests"> + Added support to use a installer language other than English + </action> </release> <release version="0.1.0" date="2008-01-13" description="Initial release to support Insight"> </release> Modified: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/actions/NsisScriptConstants.java =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/actions/NsisScriptConstants.java 2009-03-27 15:45:57 UTC (rev 234) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/actions/NsisScriptConstants.java 2009-03-27 21:00:18 UTC (rev 235) @@ -1,5 +1,5 @@ /* - * $HeadURL: $ + * $HeadURL$ * * Copyright (c) 2007 MindTree Consulting Ltd. * @@ -24,7 +24,7 @@ * Constants for use in Nsis Scripts * * @author <a href="mailto:bindul_bhow...@mindtree.com">Bindul Bhowmik</a> - * @version $Revision: $ $Date: $ + * @version $Revision$ $Date$ * */ public interface NsisScriptConstants { @@ -44,6 +44,11 @@ */ public static final String VAR_RESOLVE = "resolveTool"; + /** + * The language tool + */ + public static final String VAR_LANG = "langTool"; + /* * The Project Info File */ Modified: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/actions/ScriptGenerationAction.java =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/actions/ScriptGenerationAction.java 2009-03-27 15:45:57 UTC (rev 234) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/actions/ScriptGenerationAction.java 2009-03-27 21:00:18 UTC (rev 235) @@ -72,6 +72,12 @@ */ private VelocityTool resolveTool; + /** + * The velocity tool to handle Installer language settings. + * @plexus.requirement role-hint="lang-tool" + */ + private VelocityTool langTool; + /* * (non-Javadoc) * @@ -81,6 +87,7 @@ this.mojoInfo = mojoInfo; pathResolveTool.setMojoInfo(mojoInfo); resolveTool.setMojoInfo(mojoInfo); + langTool.setMojoInfo(mojoInfo); // Execute the project info vm File projectInfoFile = generateProjectInfo(); @@ -161,8 +168,9 @@ throw new NsisActionExecutionException("Unable to create temporary file", e1); } - Map contextInfo = new HashMap(2); + Map contextInfo = new HashMap(3); contextInfo.put(VAR_MUI_PAGES_MUI_PAGES, mojoInfo.getNsisProject().getMuiPages()); + contextInfo.put(VAR_LANG, langTool); contextInfo.put(VAR_NULL, nullTool); try { @@ -188,11 +196,12 @@ String tempDirPath = new File(System.getProperty("java.io.tmpdir")).getAbsolutePath(); - Map contextInfo = new HashMap(4); + Map contextInfo = new HashMap(5); contextInfo.put(VAR_SECTIONS_INSTALLER_SECTIONS, mojoInfo.getNsisProject().getSections()); contextInfo.put(VAR_NULL, nullTool); contextInfo.put(VAR_RESOLVE, resolveTool); contextInfo.put(VAR_SECTIONS_INCLUDE_FUNCTIONS, functionsFile.getAbsolutePath().substring(tempDirPath.length())); + contextInfo.put(VAR_LANG, langTool); try { processVelocityTemplate(TEMPLATE_SECTIONS, contextInfo, sectionsOutputFile, true); Modified: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/io/DefaultProjectFileReader.java =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/io/DefaultProjectFileReader.java 2009-03-27 15:45:57 UTC (rev 234) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/io/DefaultProjectFileReader.java 2009-03-27 21:00:18 UTC (rev 235) @@ -1,5 +1,5 @@ /* - * $HeadURL: $ + * $HeadURL$ * * Copyright (c) 2007 MindTree Consulting Ltd. * @@ -33,7 +33,7 @@ * Default Xpp3 implementation of the project file reader. * * @author <a href="mailto:bindul_bhow...@mindtree.com">Bindul Bhowmik</a> - * @version $Revision: $ $Date: $ + * @version $Revision$ $Date$ * * @plexus.component role="com.mindtree.techworks.insight.releng.mvn.nsis.io.ProjectFileReader" role-hint="default" */ @@ -48,7 +48,9 @@ try { return reader.read(fileReader); } catch (XmlPullParserException e) { - throw new IOException("Error parsing Xml"); + throw new IOException("Error parsing Xml: " + e.getMessage() + + " at Line:" + e.getLineNumber() + " Column:" + + e.getColumnNumber()); } } Added: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/velocityutil/NSISLanguageTool.java =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/velocityutil/NSISLanguageTool.java (rev 0) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/velocityutil/NSISLanguageTool.java 2009-03-27 21:00:18 UTC (rev 235) @@ -0,0 +1,84 @@ +/* + * $HeadURL$ + * + * Copyright (c) 2009 MindTree Ltd. + * + * This file is part of Insight Release Engineering Tools. + * + * Insight Release Engineering Tools is free software: you can redistribute it + * and/or modify it under the terms of the GNU General Public License as + * published by the Free Software Foundation, either version 3 of the License, + * or (at your option) any later version. + * + * Insight Release Engineering Tools is distributed in the hope that it will be + * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General + * Public License for more details. + * + * You should have received a copy of the GNU General Public License along with + * Insight Release Engineering Tools. If not, see <http://www.gnu.org/licenses/>. + */ +package com.mindtree.techworks.insight.releng.mvn.nsis.velocityutil; + +import com.mindtree.techworks.insight.releng.mvn.nsis.actions.MojoInfo; +import com.mindtree.techworks.insight.releng.mvn.nsis.model.NsisProject; + +/** + * An NSIS tool to handle language settings for the NSIS compiler + * + * If you set the instance with a key of 'langTool', then you can check the + * value of references using: + * + * <pre> + * $langTool.defaultLanguageName -> Returns the name of the default + * language. Example - English + * $langTool.defaultLanguageNsisFormat -> Returns the NSIS formatted version + * of the default language. Example - + * ${LANG_ENGLISH} + * </pre> + * + * @author <a href="mailto:bindul_bhow...@mindtree.com">Bindul Bhowmik</a> + * @version $Revision$ $Date$ + * + * @plexus.component role="com.mindtree.techworks.insight.releng.mvn.nsis.velocityutil.VelocityTool" role-hint="lang-tool" + */ +public class NSISLanguageTool implements VelocityTool { + + /** + * The Nsis Project + */ + private NsisProject nsisProject; + + /* (non-Javadoc) + * @see com.mindtree.techworks.insight.releng.mvn.nsis.velocityutil.VelocityTool#setMojoInfo(com.mindtree.techworks.insight.releng.mvn.nsis.actions.MojoInfo) + */ + public void setMojoInfo(MojoInfo mojoInfo) { + this.nsisProject = mojoInfo.getNsisProject(); + } + + /** + * Returns the default language for the installer + * + * @return The default language of the installer + * @see #getDefaultLanguageNsisFormat() + */ + public String getDefaultLanguageName() { + return nsisProject.getProjectInfo().getDefaultInstallerLanguage(); + } + + /** + * Returns the default language of the installer in the NSIS format. So, if + * English is the default language, this method will return + * <code>${LANG_ENGLISH}</code>. + * + * @return The NSIS formatted default language. + * @see #getDefaultLanguageName() + */ + public String getDefaultLanguageNsisFormat() { + StringBuffer buffer = new StringBuffer("${LANG_"); + buffer.append(getDefaultLanguageName()); + buffer.append('}'); + + return buffer.toString(); + } +} Property changes on: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/java/com/mindtree/techworks/insight/releng/mvn/nsis/velocityutil/NSISLanguageTool.java ___________________________________________________________________ Added: svn:mime-type + text/plain Added: svn:keywords + Date Author Id Revision HeadURL Added: svn:eol-style + native Modified: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/mdo/nsisproj.mdo =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/mdo/nsisproj.mdo 2009-03-27 15:45:57 UTC (rev 234) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/mdo/nsisproj.mdo 2009-03-27 21:00:18 UTC (rev 235) @@ -21,9 +21,13 @@ | | $Id$ --> +<!-- See reference at http://modello.codehaus.org/modello.html --> <model - xsd.namespace="http://mindtreeinsight.sourceforge.net/releng/mvn/nsis/0.1.0" - xsd.targetNamespace="http://mindtreeinsight.sourceforge.net/releng/mvn/nsis/0.1.0"> + xmlns="http://modello.codehaus.org/MODELLO/1.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://modello.codehaus.org/MODELLO/1.0.0 http://modello.codehaus.org/xsd/modello-1.0.0.xsd" + xml.namespace="http://mindtreeinsight.sourceforge.net/releng/mvn/nsis/${version}" + xml.schemaLocation="http://mindtreeinsight.sourceforge.net/releng/maven-nsis-plugin/xsd/${version}/NsisProject-${version}.xsd"> <id>NsisProject</id> <name>NsisProject</name> <description> @@ -48,7 +52,7 @@ </default> </defaults> <classes> - <class rootElement="true" xml.tagname="nsisproj"> + <class rootElement="true" xml.tagName="nsisProject"> <name>NsisProject</name> <description> <![CDATA[ @@ -58,7 +62,7 @@ </description> <version>0.1.0+</version> <fields> - <field xml.tagname="projectinfo"> + <field xml.tagName="projectInfo"> <name>projectInfo</name> <version>0.1.0+</version> <required>true</required> @@ -77,7 +81,7 @@ ]]> </description> </field> - <field xml.tagname="installerSettings"> + <field xml.tagName="installerSettings"> <name>installerSettings</name> <version>0.1.0+</version> <association> @@ -89,7 +93,7 @@ ]]> </description> </field> - <field xml.tagname="muiInstallerSettings"> + <field xml.tagName="muiInstallerSettings"> <name>muiInstallerSettings</name> <version>0.1.0+</version> <association> @@ -102,7 +106,7 @@ ]]> </description> </field> - <field xml.tagname="muiPages"> + <field xml.tagName="muiPages"> <name>muiPages</name> <version>0.1.0+</version> <association> @@ -110,7 +114,7 @@ </association> <description>The pages to display in the installer</description> </field> - <field xml.tagname="sections"> + <field xml.tagName="sections"> <name>sections</name> <version>0.1.0+</version> <association> @@ -133,7 +137,7 @@ </field> </fields> </class> - <class xml.tagname="projectinfo"> + <class xml.tagName="projectinfo"> <name>ProjectInfo</name> <description> <![CDATA[ @@ -190,9 +194,32 @@ <type>String</type> <description>The readme file</description> </field> + <field xml.trim="true"> + <name>defaultInstallerLanguage</name> + <alias>installerLanguage</alias> + <type>String</type> + <defaultValue>English</defaultValue> + <required>false</required> + <description> + This is the language of the installer for single language + installers and the default language for multi lingual + installers. The value of this should be one of the + available languages in the 'Contrib/Language files' + directory of your NSIS Installation. The language name + should be case sensitive. It defaults to 'English' if + not set. + </description> + <version>0.2.0+</version> + <comment> + <![CDATA[ + Added to fix enhancement FRQ-2685076 + (https://sourceforge.net/tracker/?func=detail&aid=2685076&group_id=212019&atid=1020095) + ]]> + </comment> + </field> </fields> </class> - <class xml.tagname="installerSettings"> + <class xml.tagName="installerSettings"> <name>InstallerSettings</name> <version>0.1.0+</version> <description> @@ -283,9 +310,10 @@ </description> <defaultValue>$INSTDIR\\${project.build.finalName}.exe</defaultValue> </field> + </fields> </class> - <class xml.tagname="muiInstallerSettings"> + <class xml.tagName="muiInstallerSettings"> <name>MuiInstallerSettings</name> <version>0.1.0+</version> <description> @@ -339,7 +367,7 @@ </field> </fields> </class> - <class xml.tagname="muiPages"> + <class xml.tagName="muiPages"> <name>MuiPages</name> <version>0.1.0+</version> <description> @@ -464,7 +492,7 @@ </field> </fields> </class> - <class xml.tagname="welcomePageSettings"> + <class xml.tagName="welcomePageSettings"> <name>WelcomePageSettings</name> <description> To add a newline to any of these texts, use \r\n instead @@ -498,7 +526,7 @@ </field> </fields> </class> - <class xml.tagname="licensePageSettings"> + <class xml.tagName="licensePageSettings"> <name>LicensePageSettings</name> <description> The description of the license page @@ -591,7 +619,7 @@ </field> </fields> </class> - <class xml.tagname="componentsPageSettings"> + <class xml.tagName="componentsPageSettings"> <name>ComponentsPageSettings</name> <version>0.1.0+</version> <description>Settings for the components page</description> @@ -638,7 +666,7 @@ </field> </fields> </class> - <class xml.tagname="directoryPageSettings"> + <class xml.tagName="directoryPageSettings"> <name>DirectoryPageSettings</name> <version>0.1.0+</version> <description>The Directory Page Settings</description> @@ -677,7 +705,7 @@ </field> </fields> </class> - <class xml.tagname="startMenuFolderPageSettings"> + <class xml.tagName="startMenuFolderPageSettings"> <name>StartMenuFolderPageSettings</name> <description>The settings for the start menu folder selection page</description> <version>0.1.0+</version> @@ -740,7 +768,7 @@ </field> </fields> </class> - <class xml.tagname="installationPageSettings"> + <class xml.tagName="installationPageSettings"> <name>InstallationPageSettings</name> <description>Settings for the Installation Page</description> <version>0.1.0+</version> @@ -779,7 +807,7 @@ </field> </fields> </class> - <class xml.tagname="finishPageSettings"> + <class xml.tagName="finishPageSettings"> <name>FinishPageSettings</name> <version>0.1.0+</version> <description>The settings of the finish page</description> @@ -971,7 +999,7 @@ </field> </fields> </class> - <class xml.tagname="uninstallConfirmPageSettings"> + <class xml.tagName="uninstallConfirmPageSettings"> <name>UninstallConfirmPageSettings</name> <version>0.1.0+</version> <description>The settings about the un-install page</description> @@ -994,7 +1022,7 @@ </field> </fields> </class> - <class xml.tagname="installerSections"> + <class xml.tagName="installerSections"> <name>InstallerSections</name> <version>0.1.0+</version> <description> @@ -1027,7 +1055,7 @@ </field> </fields> </class> - <class xml.tagname="section"> + <class xml.tagName="section"> <name>Section</name> <description>Defines a section</description> <version>0.1.0+</version> @@ -1611,7 +1639,7 @@ </field> </fields> </class> - <class xml.tagname="functions"> + <class xml.tagName="functions"> <name>Functions</name> <version>0.1.0+</version> <description> @@ -1728,7 +1756,7 @@ </field> </fields> </class> - <class xml.tagname="functionDef"> + <class xml.tagName="functionDef"> <name>FunctionDefinition</name> <description>A user defined function</description> <version>0.1.0+</version> Modified: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/resources/velocity/mui-pages.vm =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/resources/velocity/mui-pages.vm 2009-03-27 15:45:57 UTC (rev 234) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/resources/velocity/mui-pages.vm 2009-03-27 21:00:18 UTC (rev 235) @@ -250,5 +250,5 @@ ; End Pages ; Languages -!insertmacro MUI_LANGUAGE "English" +!insertmacro MUI_LANGUAGE "${langTool.defaultLanguageName}" ; End Languages \ No newline at end of file Modified: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/resources/velocity/sections.vm =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/resources/velocity/sections.vm 2009-03-27 15:45:57 UTC (rev 234) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/main/resources/velocity/sections.vm 2009-03-27 21:00:18 UTC (rev 235) @@ -32,7 +32,7 @@ #set($nsisIconsGroup = '$ICONS_GROUP') #set($nsisProdUninstKey = '${PRODUCT_UNINST_KEY}') #set($nsisProdUninstRootKey = '${PRODUCT_UNINST_ROOT_KEY}') -#set($nsisLangEnglish = '${LANG_ENGLISH}') +#set($nsisLangDefault = ${langTool.defaultLanguageNsisFormat}) #set($nsisProdUninstIcon = '${PRODUCT_UNINST_ICON}') #set($nsisProdVersion = '${PRODUCT_VERSION}') #set($nsisProdWebSite = '${PRODUCT_WEB_SITE}') @@ -129,7 +129,7 @@ #set($sectionPrefix = '${Section_') #set($descSectionPrefix = '$(DESC_Section_') #foreach($section in ${installerSections.sections}) -LangString DESC_Section_$velocityCount $nsisLangEnglish "${section.description}" +LangString DESC_Section_$velocityCount $nsisLangDefault "${section.description}" #end ## #foreach($section in ${installerSections.sections}) !insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN Added: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/0.1.0/usage.apt =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/0.1.0/usage.apt (rev 0) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/0.1.0/usage.apt 2009-03-27 21:00:18 UTC (rev 235) @@ -0,0 +1,103 @@ + ------ + Maven NSIS Plugin Usage + ------ + Bindul Bhowmik + ------ + $Date $ + +Usage + + The NSIS Plug-in is designed to participate in the package phase of the + build process. Once you configure the plugin, you may execute the plug-in + by invoking + +---- +mvn package +---- + + The individual goals of the package can also be invoked as + +---- +mvn nsis:<goal> +---- + + Where <goal> is one of the existing goals of the plug-in. + +* nsis:clean Goal + + Unlike the Maven <clean> goal, the <nsis:clean> goal does not clean the + entire target directory but just the plug-ins work directory. By default + this is <$\{project.build.directory\}/nsis-work> + +Configuration + + This plug-in requires two configurations to run: + +* pom.xml Configuration + + The plugin needs to be defined in the pom.xml with the following required + configuration: + +---- +<project> + ... + <build> + ... + <plugins> + ... + <plugin> + <groupId>com.mindtree.techworks.insight.releng</groupId> + <artifactId>maven-nsis-plugin</artifactId> + <configuration> + <projectFile>/path/to/nsis/project/file</projectFile> + </configuration> + </plugin> + ... + </plugins> + ... + </build> + ... +</project> +---- + + The other optional configurations of this section can be seen in the + {{{../plugin-info.html}goal}} configuration page. + +** NSIS Install Directory + + This plug-in requires NSIS to be installed on the system where the build + is being executed. Once NSIS has been installed, there are multiple + ways in which the plug-in can get to the <makensis.exe> file requried. + + * <<System Path>>: The directory containing the <makensis.exe> file can + be defined in the system path, and the plug-in can get to it. + + * <<pom.xml configuration>>: The plug-in configuration parameter + {{{../compile-mojo.html#nsisPath}nsisPath}} can be configured to point to + the directory containing the <makensis.exe> + + * <<Command line option OR System Variable>>: The variable <nsisPath> can + be defined at runtime as a system variable or using the maven runtime option + as <-DnsisPath=/path/to/dir/containing/makensis.exe>. + + Please note however that the NSIS Install directory is required only for the + {{{../compile-mojo.html}compile}} goal. + +* NSIS Project configuration + + The NSIS project configuration is used for information to generate + information and specialization of the installer script for information not + available from the pom.xml file of the project. + + An annotated configuration of the current version of the project xml is + available at {{{NsisProject.html}NSIS Project Xref}}. + +Maven Repository Configuration + + The NSIS plugin is currently not available at the Maven Central repository, + hence to get your maven build system to get the plugin, you may use the + temporary Insight Maven 2 repository at: + + * {{http://mindtreeinsight.svn.sourceforge.net/svnroot/mindtreeinsight/maven-repo/trunk/release/}} - For released versions + + * {{http://mindtreeinsight.svn.sourceforge.net/svnroot/mindtreeinsight/maven-repo/trunk/snapshot/}} - For snapshot versions \ No newline at end of file Property changes on: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/0.1.0/usage.apt ___________________________________________________________________ Added: svn:mime-type + text/plain Added: svn:keywords + Date Author Id Revision HeadURL Added: svn:eol-style + native Modified: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/index.apt =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/index.apt 2009-03-27 15:45:57 UTC (rev 234) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/index.apt 2009-03-27 21:00:18 UTC (rev 235) @@ -56,8 +56,11 @@ * Usage - Instructions on using the plug-in is described {{{usage.html}here}}. + Instructions on using the current version of the plug-in is described at + {{{usage.html}here}}. + For the stable version see {{{0.1.0/usage.html}here}}. + * Examples An example for configuring the plug-in is available {{{insight-nsis-proj.html}here}}. \ No newline at end of file Modified: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/insight-nsis-proj.apt =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/insight-nsis-proj.apt 2009-03-27 15:45:57 UTC (rev 234) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/insight-nsis-proj.apt 2009-03-27 21:00:18 UTC (rev 235) @@ -25,7 +25,7 @@ <plugin> <groupId>com.mindtree.techworks.insight.releng</groupId> <artifactId>maven-nsis-plugin</artifactId> - <version>0.1.0</version> + <version>0.2.0</version> <executions> <execution> <phase>package</phase> @@ -52,9 +52,9 @@ ---- <nsisProject - xmlns="http://mindtreeinsight.sourceforge.net/releng/mvn/nsis/0.1.0" + xmlns="http://mindtreeinsight.sourceforge.net/releng/mvn/nsis/0.2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://mindtreeinsight.sourceforge.net/releng/mvn/nsis/0.1.0 http://mindtreeinsight.sourceforge.net/xsds/NsisProject-0.1.0.xsd"> + xsi:schemaLocation="http://mindtreeinsight.sourceforge.net/releng/mvn/nsis/0.2.0 http://mindtreeinsight.sourceforge.net/releng/maven-nsis-plugin/xsd/0.2.0/NsisProject-0.2.0.xsd"> <projectInfo> <productName>Insight</productName> <readmeFile>README.txt</readmeFile> Modified: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/usage.apt =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/usage.apt 2009-03-27 15:45:57 UTC (rev 234) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/apt/usage.apt 2009-03-27 21:00:18 UTC (rev 235) @@ -48,6 +48,7 @@ <plugin> <groupId>com.mindtree.techworks.insight.releng</groupId> <artifactId>maven-nsis-plugin</artifactId> + <version>0.2.0M1</version> <configuration> <projectFile>/path/to/nsis/project/file</projectFile> </configuration> @@ -163,6 +164,27 @@ and {{{http://maven.apache.org/shared/file-management/}File Management}} modules in the future for better file, folder and artifact handling. <<<Note to self: open feature requests for these>>>. + +** Default Language Selection + + The default language of any installer generated by this plug-in is + English, but it is possible to change the default language of the + installer. To do so, set the <<<defaultInstallerLanguage>>> element under + <<<nsisProject/projectInfo>>>. + ++---------------------------------------------+ +<nsisProject> + <projectInfo> + ... + <defaultInstallerLanguage>English</defaultInstallerLanguage> + </projectInfo> + ... +</nsisProject> ++---------------------------------------------+ + + The language selected should be one that is present under + <<<Contrib/Language files>>> directory of your NSIS installation and is + case sensitive. Maven Repository Configuration Modified: releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/site.xml =================================================================== --- releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/site.xml 2009-03-27 15:45:57 UTC (rev 234) +++ releng/maven-nsis-plugin/branches/maven-nsis-plugin-0.2.0/src/site/site.xml 2009-03-27 21:00:18 UTC (rev 235) @@ -1,23 +1,29 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<!-- - xmlns="http://maven.apache.org/POM/4.0.0" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://mindtreeinsight.sourceforge.net/xsds/decoration-1.0.0.xsd" +<?xml version="1.0" encoding="UTF-8"?> +<!-- + | + | Copyright (c) 2007-2009 MindTree Ltd. + | + | This file is part of Insight Release Engineering Tools. + | + | Insight Release Engineering Tools is free software: you can redistribute + | it and/or modify it under the terms of the GNU General Public License as + | published by the Free Software Foundation, either version 3 of the License, + | or (at your option) any later version. + | + | Insight Release Engineering Tools is distributed in the hope that it will + | be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of + | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General + | Public License for more details. + | + | You should have received a copy of the GNU General Public License along with + | Insight Release Engineering Tools. If not, see + | <http://www.gnu.org/licenses/>. + | --> -<project name="NSIS Plugin" xmlns="http://maven.apache.org/POM/4.0.0" +<project name="NSIS Plugin" xmlns="http://maven.apache.org/DECORATION/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd"> - <skin> - <groupId>com.mindtree.techworks.insight.releng</groupId> - <artifactId>maven-site-skin</artifactId> - </skin> - <poweredBy> - <logo name="SourceForge.net Logo" - href="https://sourceforge.net/projects/mindtreeinsight/" - img="http://sflogo.sourceforge.net/sflogo.php?group_id=212019&type=1" /> - <logo name="Build with Maven 2" href="http://maven.apache.org" - img="http://maven.apache.org/images/logos/maven-feather.png" /> - </poweredBy> + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd"> + <version position="left"/> <bannerLeft> <name>NSIS Plugin</name> <href>http://mindtreeinsight.sourceforge.net/releng/maven-nsis-plugin/index.html</href> @@ -27,15 +33,20 @@ <href>http://mindtreeinsight.sourceforge.net/</href> </bannerRight> <body> + <head> + <piwik siteId="1" baseUrl="apps.sourceforge.net/piwik/mindtreeinsight/"/> + <privacy href="http://mindtreeinsight.sourceforge.net/privacy.html"/> + <meta name="keywords" value="maven,plugin,plug-in,nsis,nullsoft install system,mindtree,insight,maven2,mindtree ltd,packaging,java,installer,windows"/> + </head> <links> <item name="MindTree" href="http://www.mindtree.com/" /> - <item name="Insight" href="http://mindtreeinsight.sourceforge.net/"/> <item name="Insight Release Engineering" href="http://mindtreeinsight.sourceforge.net/releng/index.html"/> </links> <menu name="Maven NSIS Plugin"> <item name="Introduction" href="index.html"/> <item name="Goals" href="plugin-info.html" /> <item name="Usage" href="usage.html"/> + <item name="Xml Schema" href="xsd/0.2.0/NsisProject-0.2.0.xsd" /> <item name="Wishlist" href="todo.html"/> </menu> <menu name="Configuration Reference"> @@ -44,6 +55,12 @@ <menu name="Examples"> <item name="Insight NSIS Project Configuration" href="insight-nsis-proj.html"/> </menu> + <menu name="Release - 0.1.0"> + <item name="Usage" href="0.1.0/usage.html"/> + <item name="Xml Schema" href="xsd/0.1.0/NsisProject-0.1.0.xsd" /> + <item name="NSIS Project Xref" href="NsisProject.html"/> + </menu> <menu ref="reports"/> + <menu ref="parent"/> </body> </project> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. ------------------------------------------------------------------------------ _______________________________________________ MindTreeInsight-commits mailing list MindTreeInsight-commits@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/mindtreeinsight-commits