You are viewing a plain text version of this content. The canonical link for it is here.
Posted to nmaven-commits@incubator.apache.org by si...@apache.org on 2007/05/21 04:06:57 UTC
svn commit: r540013 [1/2] - in /incubator/nmaven/www: ./ ide/ images/
plugins/
Author: sisbell
Date: Sun May 20 21:06:55 2007
New Revision: 540013
URL: http://svn.apache.org/viewvc?view=rev&rev=540013
Log:
Updated website
Added:
incubator/nmaven/www/conventions.html
incubator/nmaven/www/ide/
incubator/nmaven/www/ide/sharp-develop.html
incubator/nmaven/www/ide/visual-studio.html
incubator/nmaven/www/images/SD-Menu.JPG (with props)
incubator/nmaven/www/images/VS2005-Menu.JPG (with props)
incubator/nmaven/www/images/VS2005-SHUTDOWN.JPG (with props)
incubator/nmaven/www/images/VS2005-StartAddin.JPG (with props)
incubator/nmaven/www/net-plugins.html
Modified:
incubator/nmaven/www/adding-executables.html
incubator/nmaven/www/adding-plugins.html
incubator/nmaven/www/dependencies.html
incubator/nmaven/www/environment-configuration.html
incubator/nmaven/www/features.html
incubator/nmaven/www/getting-started.html
incubator/nmaven/www/images/Thumbs.db
incubator/nmaven/www/index.html
incubator/nmaven/www/integration.html
incubator/nmaven/www/issue-tracking.html
incubator/nmaven/www/license.html
incubator/nmaven/www/mail-lists.html
incubator/nmaven/www/plugins/index.html
incubator/nmaven/www/project-info.html
incubator/nmaven/www/project-summary.html
incubator/nmaven/www/source-repository.html
incubator/nmaven/www/team-list.html
Modified: incubator/nmaven/www/adding-executables.html
URL: http://svn.apache.org/viewvc/incubator/nmaven/www/adding-executables.html?view=diff&rev=540013&r1=540012&r2=540013
==============================================================================
--- incubator/nmaven/www/adding-executables.html (original)
+++ incubator/nmaven/www/adding-executables.html Sun May 20 21:06:55 2007
@@ -45,7 +45,7 @@
<div class="xleft">
- Last Published: 02/11/2007
+ Last Published: 05/20/2007
</div>
<div class="xright"> <a href="http://incubator.apache.org/projects/nmaven.html">Project Site</a>
|
@@ -95,6 +95,10 @@
</li>
<li class="none">
+ <a href="conventions.html">Conventions</a>
+ </li>
+
+ <li class="none">
<a href="plugins/index.html">Plugins</a>
</li>
@@ -102,10 +106,25 @@
<a href="environment-configuration.html">Configuration</a>
</li>
</ul>
+ <h5>IDE Integration</h5>
+ <ul>
+
+ <li class="none">
+ <a href="ide/visual-studio.html">Visual Studio</a>
+ </li>
+
+ <li class="none">
+ <a href="ide/sharp-develop.html">Sharp Develop</a>
+ </li>
+ </ul>
<h5>Developer Documentation</h5>
<ul>
<li class="none">
+ <a href="net-plugins.html">Writing .NET Mojos</a>
+ </li>
+
+ <li class="none">
<a href="adding-plugins.html">Adding Compilers</a>
</li>
@@ -156,7 +175,7 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2>Adding Executables</h2><div class="section"><h3>Adding Executable Info to Config Files</h3><p>NMaven has a concept of two types of executables:</p><ol type="1"><li>An executable plugin that exists in a predetermined place on the file system. These are typically executables that are part of the .NET framework or part of some other 3rd party program.</li><li>An executable plugin that is resolved from a Maven repo. The NMaven .NET plugins, nmaven-utility-rex and nmaven-utility-settings fall into this category.</li></ol><p>How you handle each case is slightly different. In the first case, where the executable is already installed on the file system, you add support for the executable by adding an entry in the <a href="components/dotnet-model/executable-plugins/executable-plugin.html">executable-plugins.xml</a> file. Take the example below where XSD is part of the .NET framework. The MS:XSD:SCHEMA entry uses a standard DefaultNetExecutable impleme
ntation. The <b>executable</b> tag denotes the command as it is executed from the commandline, in this case xsd. The <b>commandFilter</b> gives a list of command options that the plugin will accept from the invoking AbstractMojo implementation.</p><p>NMaven will look at the <b>vendor</b> and <b>framework</b> to see if the xsd executable exists within the framework's install root. If it does, then it constructs the absolute path. If it does not find the file, it will execute without a path (so in this case you will need to make sure that the executable exists within the system path).</p><div class="source"><pre>
+ <div class="section"><h2>Adding Executables</h2><div class="section"><h3>Adding Executable Info to Config Files</h3><p>NMaven has a concept of two types of executables:</p><ol type="1"><li>An executable plugin that exists in a predetermined place on the file system. These are typically executables that are part of the .NET framework or part of some other 3rd party program.</li><li>An executable plugin that is resolved from a Maven repo. The NMaven .NET plugins NMaven.Plugin.Resx and NMaven.Plugin.Settings fall into this category.</li></ol><p>How you handle each case is slightly different. In the first case, where the executable is already installed on the file system, you add support for the executable by adding an entry in the <a href="components/dotnet-model/executable-plugins/executable-plugin.html">executable-plugins.xml</a> file. Take the example below where XSD is part of the .NET framework. The MS:XSD:SCHEMA entry uses a standard DefaultNetExecutable implement
ation. The <b>executable</b> tag denotes the command as it is executed from the commandline, in this case xsd. The <b>commandFilter</b> gives a list of command options that the plugin will accept from the invoking AbstractMojo implementation.</p><p>NMaven will look at the <b>vendor</b> and <b>frameworkVersion</b> to see if the xsd executable exists within the framework's install or SDK root for either Microsoft of Mono, depending on which vendor you are using to build. If the executable does exist in one of these locations, then it constructs the absolute path. In the xsd case, on windows NMaven may find the xsd file at: C:\Program Files\Microsoft.NET\SDK\v2.0\Bin or C:\Program Files\Mono-1.2.3.1\bin. If NMaven does not find the file, it will execute without a path (so in this case you will need to make sure that the executable exists within the system path).</p><p>Sample executable plugins entry:</p><div class="source"><pre>
<executablePlugins>
<executablePlugin>
<identifier>MS:XSD:SCHEMA</identifier>
@@ -207,7 +226,85 @@
</platforms>
</executablePlugin>
</executablePlugins>
-
</pre></div><p>In the second case, where the executable is not already installed, you add an entry within the net-dependencies.xml file. This file tells NMaven how to resolve the executable from a Maven repository.</p><div class="source"><pre>
+
</pre></div></div><div class="section"><h3>Adding an executable plugin that exists in a predetermined place</h3><p>To create an executable plugin that exists in a predetermined place, do the following:</p><ol type="1"><li>Create your module directory</li><li>From the root of your module directory, type:<div class="source"><pre>mvn archetype:create
+ -DgroupId=[your project's group id]
+ -DartifactId=[your project's artifact id]
+ -DarchetypeArtifactId=maven-archetype-netexecutable
</pre></div></li><li>Make sure to add an entry in the net-executables.xml file, located within the dotnet-core module. Replace each param: $<a name="vendor">vendor</a>, $<a name="exe">exe</a>, .. with the appropriate values.<div class="source"><pre> <executablePlugin>
+ <identifier>${ID}</identifier>
+ <pluginClass>org.apache.maven.dotnet.executable.impl.DefaultNetExecutable</pluginClass>
+ <vendor>${vendor}</vendor>
+ <executable>${exe}</executable>
+ <profile>${profile}</profile>
+ <frameworkVersions>
+ <frameworkVersion>2.0.50727</frameworkVersion>
+ <frameworkVersion>1.1.4322</frameworkVersion>
+ </frameworkVersions>
+ <platforms>
+ <platform>
+ <operatingSystem>Windows</operatingSystem>
+ </platform>
+ </platforms>
+ </executablePlugin>
</pre></div></li><li>Add profile <b>ADD_PROFILE</b> to the meta-data of the profile field of this class. This profile name should match the $<a name="profile">profile</a> within the net-executables.xml.</li><li>Add any special commands to the getCommands method.</li><li>Recompile the dotnet-core component.</li><li>Rename this class and install this Mojo component.<div class="source"><pre>public class NetExecutableMojo
+ extends AbstractMojo
+{
+ /**
+ * @component
+ */
+ private org.apache.maven.dotnet.executable.NetExecutableFactory netExecutableFactory;
+
+ /**
+ * The maven project.
+ *
+ * @parameter expression="${project}"
+ * @required
+ */
+ private MavenProject project;
+
+ /**
+ * The Vendor for the executable.
+ *
+ * @parameter expression="${vendor}"
+ */
+ private String vendor;
+
+ /**
+ * @parameter expression = "${frameworkVersion}"
+ */
+ private String frameworkVersion;
+
+ /**
+ * The profile that the executable should use.
+ *
+ * @parameter expression = "${profile}" default-value = "<<ADD_PROFILE>>"
+ */
+ private String profile;
+
+ public void execute()
+ throws MojoExecutionException
+ {
+ try
+ {
+ netExecutableFactory.getNetExecutableFor( vendor, frameworkVersion,
+ profile, getCommands(), null ).execute();
+ }
+ catch ( ExecutionException e )
+ {
+ ...
+ }
+ catch ( PlatformUnsupportedException e )
+ {
+ ...
+ }
+ }
+
+ public List<String> getCommands()
+ throws MojoExecutionException
+ {
+ List<String> commands = new ArrayList<String>();
+ //<<ADD COMMANDS HERE>>
+ return commands;
+ }
+}
</pre></div></li></ol></div><div class="section"><h3>Creating an executable plugin that is resolved from a Maven repo</h3><p>In the second case, where the executable is not already installed, you add an entry within the net-dependencies.xml file. This file tells NMaven how to resolve the executable from a Maven repository.</p><div class="source"><pre>
<netDependencies>
<netDependency>
<groupId>NMaven.Utility.ResX</groupId>
@@ -222,9 +319,9 @@
<type>exe</type>
</netDependency>
</netDependencies>
-
</pre></div></div><div class="section"><h3>Executing an executable from a Mojo</h3><p>In the case where you have added the executable entry in the executable-plugins.xml file, you should use the NetExecutableFactory.getNetExecutableFor method within the Mojo's execute method.</p><div class="source"><pre> netExecutableFactory.getNetExecutableFor(vendor, frameworkVersion, profile,
- project, getCommands(), null).execute();
</pre></div><p>In the case where you have added the net dependency entry in the net-dependencies.xml file, you should use the NetExecutableFactory.getNetExecutableFromRepository method within the Mojo's execute method.</p><div class="source"><pre> netExecutableFactory.getNetExecutableFromRepository("NMaven.Utility.ResX", "resx",
- vendorInfo, project, localRepository, commands).execute();
</pre></div></div></div>
+
</pre></div></div><div class="section"><h3>Executing an executable from a Mojo</h3><p>In the case where you have added the executable entry in the executable-plugins.xml file, you should use the NetExecutableFactory.getNetExecutableFor method within the Mojo's execute method.</p><div class="source"><pre> netExecutableFactory.getNetExecutableFor(vendor, frameworkVersion, profile,
+ project, getCommands(), null).execute();
</pre></div><p>In the case where you have added the net dependency entry in the net-dependencies.xml file, you should use the NetExecutableFactory.getNetExecutableFromRepository method within the Mojo's execute method.</p><div class="source"><pre> netExecutableFactory.getNetExecutableFromRepository("NMaven.Plugin.ResX", "resx",
+ vendorInfo, project, localRepository, commands).execute();
</pre></div></div></div>
</div>
</div>
<div class="clear">
Modified: incubator/nmaven/www/adding-plugins.html
URL: http://svn.apache.org/viewvc/incubator/nmaven/www/adding-plugins.html?view=diff&rev=540013&r1=540012&r2=540013
==============================================================================
--- incubator/nmaven/www/adding-plugins.html (original)
+++ incubator/nmaven/www/adding-plugins.html Sun May 20 21:06:55 2007
@@ -45,7 +45,7 @@
<div class="xleft">
- Last Published: 02/11/2007
+ Last Published: 05/20/2007
</div>
<div class="xright"> <a href="http://incubator.apache.org/projects/nmaven.html">Project Site</a>
|
@@ -95,6 +95,10 @@
</li>
<li class="none">
+ <a href="conventions.html">Conventions</a>
+ </li>
+
+ <li class="none">
<a href="plugins/index.html">Plugins</a>
</li>
@@ -102,10 +106,25 @@
<a href="environment-configuration.html">Configuration</a>
</li>
</ul>
+ <h5>IDE Integration</h5>
+ <ul>
+
+ <li class="none">
+ <a href="ide/visual-studio.html">Visual Studio</a>
+ </li>
+
+ <li class="none">
+ <a href="ide/sharp-develop.html">Sharp Develop</a>
+ </li>
+ </ul>
<h5>Developer Documentation</h5>
<ul>
<li class="none">
+ <a href="net-plugins.html">Writing .NET Mojos</a>
+ </li>
+
+ <li class="none">
<strong>Adding Compilers</strong>
</li>
@@ -156,7 +175,7 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2>Adding Compilers</h2><p>You can add support for additional compilers in two different ways:</p><ol type="1"><li>Add a compiler-plugins.xml file, similar to the examples below, in the root of each module that you are building. NMaven will pick it up and add it to the list of supported compilers.</li><li>Add a compilerPlugin entry to the master file: components/dotnet-core/src/resources/META-INF/nmaven/compiler-plugins.xml.</li></ol><p>Of course, if your compiler does not work with the <tt>org.apache.maven.dotnet.executable.compiler.impl.DefaultCompiler</tt>, you will also need to create your own implementation of <tt>org.apache.maven.dotnet.executable.compiler.CompilerExecutable</tt> and add the fully-qualified class name implementation to the pluginClass tag.</p><div class="section"><h3>compiler-plugins.xml</h3><ul><li><a href="https://svn.apache.org/repos/asf/incubator/nmaven/trunk/components/dotnet-core/src/main/resources/META-INF/nmaven/co
mpiler-plugins.xml">compiler-plugins.xml</a> is the master plugin file.</li><li><a href="http://incubator.apache.org/nmaven/components/dotnet-model/compiler-plugins/compiler-plugin.html">Compiler Plugins Model</a><p>Example:</p><div class="source"><pre>
+ <div class="section"><h2>Adding Compilers</h2><p>You can add support for additional compilers in two different ways:</p><ol type="1"><li>Add a compiler-plugins.xml file, similar to the examples below, in the root of each module that you are building. NMaven will pick it up and add it to the list of supported compilers.</li><li>Add a compilerPlugin entry to the master file: components/dotnet-core/src/resources/META-INF/nmaven/compiler-plugins.xml.</li></ol><p>Of course, if your compiler does not work with the <tt>org.apache.maven.dotnet.executable.compiler.impl.DefaultCompiler</tt>, you will also need to create your own implementation of <tt>org.apache.maven.dotnet.executable.compiler.CompilerExecutable</tt> and add the fully-qualified class name implementation to the <b>pluginClass</b> tag.</p><div class="section"><h3>compiler-plugins.xml</h3><ul><li><a href="https://svn.apache.org/repos/asf/incubator/nmaven/trunk/components/dotnet-core/src/main/resources/META-INF/nm
aven/compiler-plugins.xml">compiler-plugins.xml</a> is the master plugin file.</li><li><a href="http://incubator.apache.org/nmaven/components/dotnet-model/compiler-plugins/compiler-plugin.html">Compiler Plugins Model</a><p>Example:</p><div class="source"><pre>
<compilerPlugins>
<compilerPlugin>
<identifier>MS-CS</identifier>
Added: incubator/nmaven/www/conventions.html
URL: http://svn.apache.org/viewvc/incubator/nmaven/www/conventions.html?view=auto&rev=540013
==============================================================================
--- incubator/nmaven/www/conventions.html (added)
+++ incubator/nmaven/www/conventions.html Sun May 20 21:06:55 2007
@@ -0,0 +1,319 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+<html>
+ <head>
+ <title>NMaven - </title>
+ <style type="text/css" media="all">
+ @import url("./css/maven-base.css");
+ @import url("./css/maven-theme.css");
+ @import url("./css/site.css");
+ </style>
+ <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <span id="bannerLeft">
+
+ NMaven
+
+ </span>
+ <span id="bannerRight">
+
+ <img src="./images/apache-incubator-logo.png" alt="" />
+
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 05/20/2007
+ </div>
+ <div class="xright"> <a href="http://incubator.apache.org/projects/nmaven.html">Project Site</a>
+ |
+ <a href="">NMaven</a>
+ |
+ <a href="http://svn.apache.org/repos/asf/incubator/nmaven/">NMaven SVN</a>
+ |
+ <a href="http://maven.apache.org/">Maven</a>
+ |
+ <a href="http://www.mono-project.com/">Mono Project</a>
+ |
+ <a href="http://dotgnu.org/">DotGNU</a>
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+ <h5>General Info</h5>
+ <ul>
+
+ <li class="none">
+ <a href="index.html">About</a>
+ </li>
+
+ <li class="none">
+ <a href="features.html">Features</a>
+ </li>
+
+ <li class="none">
+ <a href="getting-started.html">Getting Started</a>
+ </li>
+
+ <li class="none">
+ <strong>Conventions</strong>
+ </li>
+
+ <li class="none">
+ <a href="plugins/index.html">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="environment-configuration.html">Configuration</a>
+ </li>
+ </ul>
+ <h5>IDE Integration</h5>
+ <ul>
+
+ <li class="none">
+ <a href="ide/visual-studio.html">Visual Studio</a>
+ </li>
+
+ <li class="none">
+ <a href="ide/sharp-develop.html">Sharp Develop</a>
+ </li>
+ </ul>
+ <h5>Developer Documentation</h5>
+ <ul>
+
+ <li class="none">
+ <a href="net-plugins.html">Writing .NET Mojos</a>
+ </li>
+
+ <li class="none">
+ <a href="adding-plugins.html">Adding Compilers</a>
+ </li>
+
+ <li class="none">
+ <a href="adding-executables.html">Adding Executables</a>
+ </li>
+
+ <li class="none">
+ <a href="apidocs/index.html">JavaDocs</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="project-info.html">Project Information</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy">
+ <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <div id="contentBox">
+ <div class="section">
+ <h2>Conventions</h2>
+ <p>The following sections describe the conventions used within NMaven itself. This section is useful for
+ developers wishing to contribute to NMaven, as well as developers looking for a baseline for their own
+ projects. These conventions are evolving and subject to change as better ideas emerge:
+ <a href="mailto:nmaven-dev@incubator.apache.org">Got better ideas?</a>
+ </p>
+ <ul>
+ <li>Artifact ID - specified within the pom - is equivalent to the project's module name.
+ <div class="source">
+ <pre> |-- <font size="+1"><b>NMaven.Artifact</b></font>
+ | `-- main
+ | `-- csharp
+ | `-- NMaven
+ | `-- Artifact
+ | `-- ArtifactContext.cs
+ | `-- Artifact.cs
+ `-- pom.xml
+</pre>
+ </div>
+ <div class="source">
+<pre><project xmlns="http://maven.apache.org/POM/4.0.0">
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>NMaven.Artifact</groupId>
+ <artifactId><font size="+1"><b>NMaven.Artifact</b></font><artifactId>
+ <packaging>library</packaging>
+ <version>0.14-SNAPSHOT</version>
+ <name>NMaven.Artifact</name>
+</project>
+</pre>
+ </div>
+ </li>
+
+
+ <li>If the module does not contain children modules, the Group ID is the same as the artifact ID.</li>
+ <div class="source">
+<pre><project xmlns="http://maven.apache.org/POM/4.0.0">
+ <modelVersion>4.0.0</modelVersion>
+ <groupId><font size="+1"><b>NMaven.Artifact</b></font></groupId>
+ <artifactId><font size="+1"><b>NMaven.Artifact</b></font><artifactId>
+ <packaging>library</packaging>
+ <version>0.14-SNAPSHOT</version>
+ <name>NMaven.Artifact</name>
+</project>
+</pre>
+ </div>
+
+
+ <li>If a module contains children modules, the child module Group ID should either be equivalent to a pluralized
+ parent module Group ID or be a deriviative of the parent module Group ID.</li>
+ <pre>
+ parent Group ID: NMaven.Model
+ child Group ID: NMaven.Model, NMaven.Models or NMaven.Model.VSContent
+ </pre>
+
+
+
+ <li>The directory structure of the source directory (typically src/main/csharp) will follow the same pattern
+ as the artifact ID.</li>
+ <div class="source">
+ <pre> |-- NMaven.Artifact
+ | `-- main
+ | `-- csharp
+ | `-- <font size="+1"><b>NMaven</b></font>
+ | `-- <font size="+1"><b>Artifact</b></font>
+ | `-- ArtifactContext.cs
+ | `-- Artifact.cs
+ `-- pom.xml
+</pre>
+ </div>
+ <div class="source">
+<pre><project xmlns="http://maven.apache.org/POM/4.0.0">
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>NMaven.Artifact</groupId>
+ <artifactId><font size="+1"><b>NMaven.Artifact</b></font><artifactId>
+ <packaging>library</packaging>
+ <version>0.14-SNAPSHOT</version>
+ <name>NMaven.Artifact</name>
+</project>
+</pre>
+ </div>
+
+
+ <li>If an assembly will only compile under a specific platform, those values should be specified within the
+ compiler-config.<div class="source"><pre>
+ <project xmlns="http://maven.apache.org/POM/4.0.0">
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>NMaven.Plugins</groupId>
+ <artifactId>NMaven.Plugins</artifactId>
+ <packaging>pom</packaging>
+ <version>0.14-SNAPSHOT</version>
+ <name>NMaven.Plugins</name>
+ <build>
+ <sourceDirectory>src/main/csharp</sourceDirectory>
+ <testSourceDirectory>src/test/csharp</testSourceDirectory>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.dotnet.plugins</groupId>
+ <artifactId>maven-compile-plugin</artifactId>
+ <extensions>true</extensions>
+ <configuration>
+ <vendor><font size="+1"><b>MONO</b></font></vendor>
+ <frameworkVersion><font size="+1"><b>2.0.50727</b></font></frameworkVersion>
+ <vendorVersion><font size="+1"><b>1.2.3.1</b></font></vendorVersion>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+</project>
+</pre></div></li>
+
+
+
+ <li>Use the default setup within the nmaven-settings.xml is to configure cross-platform builds.</li>
+ </ul>
+ </div>
+</div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2007
+
+ NMaven
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Modified: incubator/nmaven/www/dependencies.html
URL: http://svn.apache.org/viewvc/incubator/nmaven/www/dependencies.html?view=diff&rev=540013&r1=540012&r2=540013
==============================================================================
--- incubator/nmaven/www/dependencies.html (original)
+++ incubator/nmaven/www/dependencies.html Sun May 20 21:06:55 2007
@@ -45,7 +45,7 @@
<div class="xleft">
- Last Published: 02/22/2007
+ Last Published: 05/20/2007
</div>
<div class="xright"> <a href="http://incubator.apache.org/projects/nmaven.html">Project Site</a>
|
@@ -95,6 +95,10 @@
</li>
<li class="none">
+ <a href="conventions.html">Conventions</a>
+ </li>
+
+ <li class="none">
<a href="plugins/index.html">Plugins</a>
</li>
@@ -102,8 +106,23 @@
<a href="environment-configuration.html">Configuration</a>
</li>
</ul>
+ <h5>IDE Integration</h5>
+ <ul>
+
+ <li class="none">
+ <a href="ide/visual-studio.html">Visual Studio</a>
+ </li>
+
+ <li class="none">
+ <a href="ide/sharp-develop.html">Sharp Develop</a>
+ </li>
+ </ul>
<h5>Developer Documentation</h5>
<ul>
+
+ <li class="none">
+ <a href="net-plugins.html">Writing .NET Mojos</a>
+ </li>
<li class="none">
<a href="adding-plugins.html">Adding Compilers</a>
Modified: incubator/nmaven/www/environment-configuration.html
URL: http://svn.apache.org/viewvc/incubator/nmaven/www/environment-configuration.html?view=diff&rev=540013&r1=540012&r2=540013
==============================================================================
--- incubator/nmaven/www/environment-configuration.html (original)
+++ incubator/nmaven/www/environment-configuration.html Sun May 20 21:06:55 2007
@@ -45,7 +45,7 @@
<div class="xleft">
- Last Published: 02/11/2007
+ Last Published: 05/20/2007
</div>
<div class="xright"> <a href="http://incubator.apache.org/projects/nmaven.html">Project Site</a>
|
@@ -95,6 +95,10 @@
</li>
<li class="none">
+ <a href="conventions.html">Conventions</a>
+ </li>
+
+ <li class="none">
<a href="plugins/index.html">Plugins</a>
</li>
@@ -102,10 +106,25 @@
<strong>Configuration</strong>
</li>
</ul>
+ <h5>IDE Integration</h5>
+ <ul>
+
+ <li class="none">
+ <a href="ide/visual-studio.html">Visual Studio</a>
+ </li>
+
+ <li class="none">
+ <a href="ide/sharp-develop.html">Sharp Develop</a>
+ </li>
+ </ul>
<h5>Developer Documentation</h5>
<ul>
<li class="none">
+ <a href="net-plugins.html">Writing .NET Mojos</a>
+ </li>
+
+ <li class="none">
<a href="adding-plugins.html">Adding Compilers</a>
</li>
@@ -174,7 +193,7 @@
<frameworkVersion>2.0.50727</frameworkVersion>
</defaultSetup>
...
-</nmavenSettings>
</pre></div><p>There are 23 states of vendor-info and both a start and stop state (for a total of 25 states). The notation is {Vendor, Vendor Version, Framework Version}. For Vendor, M denotes Microsoft, N denotes Novell, G denotes DotGNU and F denotes false (unknown vendor). For Vendor Version and Framework Version, T denotes true (it exists), while F denotes false (does not exist). So NFT means that the NMaven knows that it needs to choose a Novell (MONO) compiler and knows the framework version but not the vendor version.</p><p>The 23 vendor-info states are defined below. They are divided between general states, states that can be determined through an nmaven-settings file and states that can be determined without an nmaven-settings file.</p><table class="bodyTable"><tbody><tr class="a"><td align="left"><b>STATE</b></td><td align="left"><b>Description</b></td></tr><tr class="b"><td align="left"><b>General States</b></td><td align="left"></td></tr><
tr class="a"><td align="left">MTT</td><td align="left">Vendor is Microsoft, vendor version exists, framework version exists</td></tr><tr class="b"><td align="left">MTF</td><td align="left">Vendor is Microsoft, vendor version does not exist, framework version exists</td></tr><tr class="a"><td align="left">MFT</td><td align="left">Vendor is Microsoft, vendor version does not exist, framework version does not exist</td></tr><tr class="b"><td align="left">NTT</td><td align="left">Vendor is Novell, vendor version exists, framework version exists</td></tr><tr class="a"><td align="left"><b>Settings File States</b></td><td align="left"></td></tr><tr class="b"><td align="left">MFF</td><td align="left">Vendor is Microsoft, vendor version does not exist, framework version does not exist</td></tr><tr class="a"><td align="left">FTF</td><td align="left">Vendor is unknown, vendor version exists, framework version does not exist</td></tr><tr class="b"><td align="left">FFT</td><td align="lef
t">Vendor is unknown, vendor version does not exist, framework version exists</td></tr><tr class="a"><td align="left">FTT</td><td align="left">Vendor is unknown, vendor version exists, framework version exists</td></tr><tr class="b"><td align="left">FFF</td><td align="left">Vendor is unknown, vendor version does not exist, framework version does not exist</td></tr><tr class="a"><td align="left">NFT</td><td align="left">Vendor is Novell, vendor version does not exist, framework version exists</td></tr><tr class="b"><td align="left">NTF</td><td align="left">Vendor is Novell, vendor version exists, framework version does not exist</td></tr><tr class="a"><td align="left">NTT</td><td align="left">Vendor is Novell, vendor version exists, framework version exist</td></tr><tr class="b"><td align="left">NFF</td><td align="left">Vendor is Novell, vendor version does not exist, framework version does not exist</td></tr><tr class="a"><td align="left">GFF</td><td align="left">Vendor is G
NU vendor version does not exist, framework version does not exist</td></tr><tr class="b"><td align="left"><b>No Settings File States</b></td><td align="left"></td></tr><tr class="a"><td align="left">MFF_NoSettings</td><td align="left">Vendor is Microsoft, vendor version does not exist, framework version does not exist</td></tr><tr class="b"><td align="left">NFT_NoSettings</td><td align="left">Vendor is Novell, vendor version exists, framework version does not exist</td></tr><tr class="a"><td align="left">NTF_NoSettings</td><td align="left">Vendor is Novell, vendor version exists, framework version does not exist</td></tr><tr class="b"><td align="left">FTF_NoSettings</td><td align="left">Vendor is unknown, vendor version exists, framework version does not exist</td></tr><tr class="a"><td align="left">FFT_NoSettings</td><td align="left">Vendor is unknown, vendor version does not exist, framework version exists</td></tr><tr class="b"><td align="left">FTT_NoSettings</td><td ali
gn="left">Vendor is unknown, vendor version exists, framework version exists</td></tr><tr class="a"><td align="left">FFF_NoSettings</td><td align="left">Vendor is unknown, vendor version does not exist, framework version does not exist</td></tr><tr class="b"><td align="left">NFF_NoSettings</td><td align="left">Vendor is Novell, vendor version does not exist, framework version does not exist</td></tr><tr class="a"><td align="left">GFF_NoSettings</td><td align="left">Vendor is GNU vendor version does not exist, framework version does not exist</td></tr></tbody></table><p>Going back to the sequence diagram, the <tt>NetExecutableFactory</tt> object fills in the missing vendor information into the <tt>CompilerRequirement</tt> object (8): we now have a complete <tt>CompilerRequirement</tt> to use for matching. The <tt>NetExecutableFactory</tt> object initializes the <tt>CompilerContext</tt>, passing in the <tt>CompilerRequirement</tt> and <tt>CompilerConfig</tt> objects. During in
itialization, the <tt>CompilerContext</tt> object invokes <tt>CompilerMatcher.matchCompilerCapabilitiesFor(requirement)</tt> (10). The <tt>CompilerMatcher</tt> class instance creates a list of platform capabilities (11) and matches <tt>CompilerCapability</tt> properties to the <tt>CompilerRequirement</tt> properties (12). The <tt>CompilerMatcher</tt> gets the class name of the <tt>CompilerExecutable</tt> by invoking <tt>CompilerRequirement.getPluginClassName()</tt> (13). The <tt>CompilerMatcher</tt> dynamically instatiates and initializes the <tt>CompilerExecutable</tt> (14).</p><p>The <tt>CompilerExecutable</tt> is returned to the <tt>CompilerMojo</tt> (16, 17, 18), which then executes the Compiler (19).</p></div></div><div class="section"><h2><a name="Sample Configuration Files">Sample Configuration Files</a></h2><div class="section"><h3>CSharp2.0:exe:Microsoft</h3><div class="source"><pre>
+</nmavenSettings>
</pre></div><p>There are 23 states of vendor-info and both a start and stop state (for a total of 25 states). The notation is {Vendor, Vendor Version, Framework Version}. For Vendor, M denotes Microsoft, N denotes Novell, G denotes DotGNU and F denotes false (unknown vendor). For Vendor Version and Framework Version, T denotes true (it exists), while F denotes false (does not exist). So NFT means that the NMaven knows that it needs to choose a Novell (MONO) compiler and knows the framework version but not the vendor version.</p><p>The 23 vendor-info states are defined below. They are divided between general states, states that can be determined through an nmaven-settings file and states that can be determined without an nmaven-settings file.</p><table class="bodyTable"><tbody><tr class="a"><td align="left"><b>STATE</b></td><td align="left"><b>Description</b></td></tr><tr class="b"><td align="left"><b>General States</b></td><td align="left"></td></tr><
tr class="a"><td align="left">MTT</td><td align="left">Vendor is Microsoft, vendor version exists, framework version exists</td></tr><tr class="b"><td align="left">MTF</td><td align="left">Vendor is Microsoft, vendor version does not exist, framework version exists</td></tr><tr class="a"><td align="left">MFT</td><td align="left">Vendor is Microsoft, vendor version does not exist, framework version does not exist</td></tr><tr class="b"><td align="left">NTT</td><td align="left">Vendor is Novell, vendor version exists, framework version exists</td></tr><tr class="a"><td align="left"><b>Settings File States</b></td><td align="left"></td></tr><tr class="b"><td align="left">MFF</td><td align="left">Vendor is Microsoft, vendor version does not exist, framework version does not exist</td></tr><tr class="a"><td align="left">FTF</td><td align="left">Vendor is unknown, vendor version exists, framework version does not exist</td></tr><tr class="b"><td align="left">FFT</td><td align="lef
t">Vendor is unknown, vendor version does not exist, framework version exists</td></tr><tr class="a"><td align="left">FTT</td><td align="left">Vendor is unknown, vendor version exists, framework version exists</td></tr><tr class="b"><td align="left">FFF</td><td align="left">Vendor is unknown, vendor version does not exist, framework version does not exist</td></tr><tr class="a"><td align="left">NFT</td><td align="left">Vendor is Novell, vendor version does not exist, framework version exists</td></tr><tr class="b"><td align="left">NTF</td><td align="left">Vendor is Novell, vendor version exists, framework version does not exist</td></tr><tr class="a"><td align="left">NTT</td><td align="left">Vendor is Novell, vendor version exists, framework version exist</td></tr><tr class="b"><td align="left">NFF</td><td align="left">Vendor is Novell, vendor version does not exist, framework version does not exist</td></tr><tr class="a"><td align="left">GFF</td><td align="left">Vendor is G
NU vendor version does not exist, framework version does not exist</td></tr><tr class="b"><td align="left"><b>No Settings File States</b></td><td align="left"></td></tr><tr class="a"><td align="left">MFF_NoSettings</td><td align="left">Vendor is Microsoft, vendor version does not exist, framework version does not exist</td></tr><tr class="b"><td align="left">NFT_NoSettings</td><td align="left">Vendor is Novell, vendor version exists, framework version does not exist</td></tr><tr class="a"><td align="left">NTF_NoSettings</td><td align="left">Vendor is Novell, vendor version exists, framework version does not exist</td></tr><tr class="b"><td align="left">FTF_NoSettings</td><td align="left">Vendor is unknown, vendor version exists, framework version does not exist</td></tr><tr class="a"><td align="left">FFT_NoSettings</td><td align="left">Vendor is unknown, vendor version does not exist, framework version exists</td></tr><tr class="b"><td align="left">FTT_NoSettings</td><td ali
gn="left">Vendor is unknown, vendor version exists, framework version exists</td></tr><tr class="a"><td align="left">FFF_NoSettings</td><td align="left">Vendor is unknown, vendor version does not exist, framework version does not exist</td></tr><tr class="b"><td align="left">NFF_NoSettings</td><td align="left">Vendor is Novell, vendor version does not exist, framework version does not exist</td></tr><tr class="a"><td align="left">GFF_NoSettings</td><td align="left">Vendor is GNU vendor version does not exist, framework version does not exist</td></tr></tbody></table><p>Going back to the sequence diagram, the <tt>NetExecutableFactory</tt> object fills in the missing vendor information into the <tt>CompilerRequirement</tt> object (8): we now have a complete <tt>CompilerRequirement</tt> to use for matching. The <tt>NetExecutableFactory</tt> object initializes the <tt>CompilerContext</tt>, passing in the <tt>CompilerRequirement</tt> and <tt>CompilerConfig</tt> objects. During in
itialization, the <tt>CompilerContext</tt> object invokes <tt>CompilerMatcher.matchCompilerCapabilitiesFor(requirement)</tt> (10). The <tt>CompilerMatcher</tt> class instance creates a list of platform capabilities (11) and matches <tt>CompilerCapability</tt> properties to the <tt>CompilerRequirement</tt> properties (12). The <tt>CompilerMatcher</tt> gets the class name of the <tt>CompilerExecutable</tt> by invoking <tt>CompilerRequirement.getPluginClassName()</tt> (13). The <tt>CompilerMatcher</tt> dynamically instatiates and initializes the <tt>CompilerExecutable</tt> (14).</p><p>The <tt>CompilerExecutable</tt> is returned to the <tt>CompilerMojo</tt> (16, 17, 18), which then executes the Compiler (19).</p><p>For those curious enough, if you add the -X full debug output flag, say "mvn install -X", you will see NMaven write out the states it goes through in choosing the vendor info.</p></div></div><div class="section"><h2><a name="Sample Configuration Files">Sampl
e Configuration Files</a></h2><div class="section"><h3>CSharp2.0:exe:Microsoft</h3><div class="source"><pre>
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>org.apache.maven.ms.csharp</groupId>
Modified: incubator/nmaven/www/features.html
URL: http://svn.apache.org/viewvc/incubator/nmaven/www/features.html?view=diff&rev=540013&r1=540012&r2=540013
==============================================================================
--- incubator/nmaven/www/features.html (original)
+++ incubator/nmaven/www/features.html Sun May 20 21:06:55 2007
@@ -45,7 +45,7 @@
<div class="xleft">
- Last Published: 02/11/2007
+ Last Published: 05/20/2007
</div>
<div class="xright"> <a href="http://incubator.apache.org/projects/nmaven.html">Project Site</a>
|
@@ -95,6 +95,10 @@
</li>
<li class="none">
+ <a href="conventions.html">Conventions</a>
+ </li>
+
+ <li class="none">
<a href="plugins/index.html">Plugins</a>
</li>
@@ -102,10 +106,25 @@
<a href="environment-configuration.html">Configuration</a>
</li>
</ul>
+ <h5>IDE Integration</h5>
+ <ul>
+
+ <li class="none">
+ <a href="ide/visual-studio.html">Visual Studio</a>
+ </li>
+
+ <li class="none">
+ <a href="ide/sharp-develop.html">Sharp Develop</a>
+ </li>
+ </ul>
<h5>Developer Documentation</h5>
<ul>
<li class="none">
+ <a href="net-plugins.html">Writing .NET Mojos</a>
+ </li>
+
+ <li class="none">
<a href="adding-plugins.html">Adding Compilers</a>
</li>
@@ -156,7 +175,7 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2>Features</h2><ul><li>Mono Support: C#, Nemerle, PHP</li><li>Microsoft Support: C#, VB, .NET Compact Profile</li><li>DotGNU Support: C#</li><li>Multiple Framework Version Support: 1.1, 2.0, 3.0</li><li>NUnit support</li><li>Resource generation and embedding</li><li>Autmomatic Generation of AssemblyInfo.* based on language and contents of the pom.</li><li>Web Application Packaging and Deployment</li><li>XSD and WSDL Generation</li><li>Pluggable architecture for adding new compilers and executables.</li><li>nmaven-settings file for selecting the environment (MONO/MS/GNU, vendor/framework version, install location, etc)</li><li>Assembly Signing</li></ul></div>
+ <div class="section"><h2>Key Features</h2><div class="section"><h3>Platforms</h3><ul><li>Mono Support: C#, Nemerle, PHP</li><li>Microsoft Support: C#, VB, .NET Compact Profile</li><li>DotGNU Support: C#</li><li>Multiple Framework Version Support: 1.1, 2.0, 3.0</li><li>Pluggable architecture for adding new compilers and executables.</li><li>nmaven-settings file for selecting the environment (MONO/MS/GNU, vendor/framework version, install location, etc)</li></ul></div><div class="section"><h3>Other</h3><ul><li>NUnit support</li><li>Resource generation and embedding</li><li>Web Application Packaging and Deployment</li><li>XSD and WSDL Generation</li><li>Assembly Signing</li></ul></div><div class="section"><h3>Cool New Features</h3><ul><li>Writing Maven Plugins in .NET (Microsoft Only)</li><li>Experimental IDE Support (VS2005, #develop)</li><li>Deploying and Retrieving of .NET Artifacts from a Remote Repository</li></ul></div></div>
</div>
</div>
<div class="clear">
Modified: incubator/nmaven/www/getting-started.html
URL: http://svn.apache.org/viewvc/incubator/nmaven/www/getting-started.html?view=diff&rev=540013&r1=540012&r2=540013
==============================================================================
--- incubator/nmaven/www/getting-started.html (original)
+++ incubator/nmaven/www/getting-started.html Sun May 20 21:06:55 2007
@@ -45,7 +45,7 @@
<div class="xleft">
- Last Published: 02/22/2007
+ Last Published: 05/20/2007
</div>
<div class="xright"> <a href="http://incubator.apache.org/projects/nmaven.html">Project Site</a>
|
@@ -95,6 +95,10 @@
</li>
<li class="none">
+ <a href="conventions.html">Conventions</a>
+ </li>
+
+ <li class="none">
<a href="plugins/index.html">Plugins</a>
</li>
@@ -102,10 +106,25 @@
<a href="environment-configuration.html">Configuration</a>
</li>
</ul>
+ <h5>IDE Integration</h5>
+ <ul>
+
+ <li class="none">
+ <a href="ide/visual-studio.html">Visual Studio</a>
+ </li>
+
+ <li class="none">
+ <a href="ide/sharp-develop.html">Sharp Develop</a>
+ </li>
+ </ul>
<h5>Developer Documentation</h5>
<ul>
<li class="none">
+ <a href="net-plugins.html">Writing .NET Mojos</a>
+ </li>
+
+ <li class="none">
<a href="adding-plugins.html">Adding Compilers</a>
</li>
@@ -156,15 +175,27 @@
</div>
<div id="bodyColumn">
<div id="contentBox">
- <div class="section"><h2>Getting Started</h2></div><div class="section"><h2>Sections</h2><ul><li><a href="getting-started.html#Building NMaven">Building NMaven</a></li><li><a href="getting-started.html#Assembly Info">Assembly Info</a></li><li><a href="getting-started.html#Unit Testing with NUnit">Unit Testing with NUnit</a></li><li><a href="getting-started.html#Building & Deploying Web Applications">Building & Deploying Web Applications</a></li><li><a href="getting-started.html#Building with .NET Modules">Building with .NET Modules</a></li><li><a href="getting-started.html#Installing Existing Assemblies in the Maven Repository">Installing Existing Assemblies in the Maven Repository</a></li><li><a href="getting-started.html#Generating Resources">Generating Resources</a></li><li><a href="getting-started.html#Signing Assemblies">Signing Assemblies</a></li><li><a href="getting-started.html#Using NMaven Settings File">Using NMaven Settings File</a></li></ul><div class
="section"><h3><a name="Building NMaven">Building NMaven</a></h3><div class="section"><h4>Prerequisites</h4><p>Prior to building NMaven, make sure that you have the following installed on your system:</p><ol type="1"><li><a href=" http://java.sun.com/javase/downloads/index_jdk5.jsp"> JDK 5.0 Update x</a></li><li><a href="http://msdn2.microsoft.com/en-us/netframework/default.aspx"> Microsoft .NET Framework</a> (1.1+) OR <a href="http://www.mono-project.com"> Mono</a> (1.1.13+ for Windows and 1.1.18+ for Linux)</li><li>Subversion client 1.3+ (although 1.4 will soon be required). Click here for <a href=" http://subversion.tigris.org/servlets/ProjectDocumentView?documentID=35379&showInfo=true"> Windows Subversion Client</a>.</li><li><a href="http://nunit.org/index.php?p=download"> NUnit 2.2+</a></li></ol></div><div class="section"><h4>Bootstrap Build</h4><p>To build NMaven:</p><ol type="1"><li>Do an SVN checkout: svn co https://svn.apache.org/repos/asf/incubator/nmaven/trunk nma
ven.</li><li>If compiling on Windows:<ol type="a"><li>the csc executable directory should be located on the system path. This is only needed for the initial bootstrap build and may be removed afterwards.</li><li>the directory path containing nunit-console should also be located on the system path. After the bootstrap build, you should leave the directory path containing the nunit-console executable within the system path. For other options, see: <a href="getting-started.html#Unit Testing with NUnit">Unit Testing with NUnit</a></li><li>If using Mono on Windows, both the csc executable and the nunit-console executable are located within the same path: typically something like "C:\Program Files\Mono-1.1.18\bin"</li></ol></li><li>Execute bootstrap-build.bat (or bootstrap-build.sh) from the nmaven directory.</li></ol><p>During step (1), you may receive an error similar to the following:</p><div class="source"><pre>
- svn: This client is too old to work with working copy 'nmaven-utility-resx\src\main\csharp'; please get a newer Subversion client
</pre></div><p>In this case will need to upgrade to subversion 1.4 or higher.</p></div><div class="section"><h4>Linux Specific Setup</h4><p>Building on Linux, may take some extra steps. By default, on many Linux environments, the GNU Compiler for Java is already installed. The current GNU version will not work with NMaven. To check which version the system uses, type "java -version" on the command line. If you see something similar to the following, you will need to take additional steps to get the build setup:</p><div class="source"><pre>
+ <div class="section"><h2>Getting Started</h2></div><div class="section"><h2>Sections</h2><ul><li><a href="getting-started.html#Building NMaven">Building NMaven</a></li><li><a href="getting-started.html#Creating a Simple Project">Creating a Simple Project</a></li><li><a href="getting-started.html#Generating VS2005 Solution Files">Generating VS2005 Solution Files</a></li><li><a href="getting-started.html#Assembly Info">Assembly Info</a></li><li><a href="getting-started.html#Unit Testing with NUnit">Unit Testing with NUnit</a></li><li><a href="getting-started.html#Building & Deploying Web Applications">Building & Deploying Web Applications</a></li><li><a href="getting-started.html#Building with .NET Modules">Building with .NET Modules</a></li><li><a href="getting-started.html#Installing Existing Assemblies in the Maven Repository">Installing Existing Assemblies in the Maven Repository</a></li><li><a href="getting-started.html#Generating Resources">Generating Resourc
es</a></li><li><a href="getting-started.html#Signing Assemblies">Signing Assemblies</a></li><li><a href="getting-started.html#Using NMaven Settings File">Using NMaven Settings File</a></li></ul><div class="section"><h3><a name="Building NMaven">Building NMaven</a></h3><div class="section"><h4>Prerequisites</h4><p>Prior to building NMaven, make sure that you have the following installed on your system:</p><ol type="1"><li><a href=" http://java.sun.com/javase/downloads/index_jdk5.jsp"> JDK 5.0 Update x</a></li><li><a href="http://msdn2.microsoft.com/en-us/netframework/default.aspx"> Microsoft .NET Framework</a> (2.0+) OR <a href="http://www.mono-project.com"> Mono</a> (1.2.3.1+). Note that the 2.0+ framework (either MONO or Microsoft) is required to run NMaven but you can still target 1.1 for your builds provided that the 1.1 version is installed.</li><li>Subversion client 1.3+ (although 1.4 will soon be required). Click here for <a href=" http://subversion.tigris.org/servlets
/ProjectDocumentView?documentID=35379&showInfo=true"> Windows Subversion Client</a>.</li><li><a href="http://nunit.org/index.php?p=download"> NUnit 2.2+</a>.</li><li><a href="http://maven.apache.org/download.html"> Maven 2.0.4 or higher</a></li><li><p>If you are planning on using NMaven with Visual Studio 2005, you will also need VS installed prior to building NMaven.</p></li></ol></div><div class="section"><h4>Bootstrap Build</h4><p>To build NMaven:</p><ol type="1"><li>Do an SVN checkout<ol type="a"><li>For the latest, unstable version:<div class="source"><pre>svn co https://svn.apache.org/repos/asf/incubator/nmaven/trunk nmaven
</pre></div></li><li>For a stable version:<div class="source"><pre>svn ls https://svn.apache.org/repos/asf/incubator/nmaven/tags
</pre></div><p>You will see something like:</p><div class="source"><pre>STABLE-2007-05-18/
+STABLE-2007-05-20/
</pre></div><p>Choose the latest stable date, which in this case is:</p><div class="source"><pre>svn co https://svn.apache.org/repos/asf/incubator/nmaven/tags/STABLE-2007-05-20 nmaven
</pre></div></li></ol></li><li>If compiling on Windows with either Microsoft or Mono:<ol type="a"><li>the csc (or gmcs) executable directory should be located on the system path. This is only needed for the initial bootstrap build and may be removed afterwards.</li><li>the directory path containing nunit-console should also be located on the system path. After the bootstrap build, you should leave the directory path containing the nunit-console executable within the system path. For other options, see: <a href="getting-started.html#Unit Testing with NUnit">Unit Testing with NUnit</a></li><li>If using Mono on Windows, both the csc executable and the nunit-console executable are located within the same path: typically something like "C:\Program Files\Mono-1.2.3.1\bin"
</li></ol></li><li>Execute bootstrap-build.bat (or bootstrap-build.sh) from the nmaven directory. If you want to compile with Visual Studio 2005 support (Windows only) execute: bootstrap-build.bat -DVisualStudio2005</li></ol><p>During step (1), you may receive an error similar to the following:</p><div class="source"><pre>
+ svn: This client is too old to work with working copy 'nmaven-utility-resx\src\main\csharp';
+ please get a newer Subversion client
</pre></div><p>In this case will need to upgrade to subversion 1.4 or higher.</p></div><div class="section"><h4>Linux Specific Setup</h4><p>Building on Linux, may take some extra steps. By default, on many Linux environments, the GNU Compiler for Java is already installed. The current GNU version will not work with NMaven. To check which version the system uses, type "java -version" on the command line. If you see something similar to the following, you will need to take additional steps to get the build setup:</p><div class="source"><pre>
java version "1.4.2"
gij (GNU libgcj) version 4.1.1 20060525 (Red Hat 4.1.1-1)
</pre></div><p>Create a file "/etc/profile.d/java.sh" with the following entries:</p><div class="source"><pre>
export JAVA_HOME=/usr/java/jdk1.5.0_09
export PATH=$JAVA_HOME/bin:$PATH
</pre></div><p>Type "mvn -version" from the command line. You should see the following:</p><div class="source"><pre>
java version "1.5.0_09"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_09-b01)
-Java HotSpot(TM) Client VM (build 1.5.0_09-b01, mixed mode, sharing)
</pre></div><p>On Linux, you also need Mono version 1.1.18 or higher. Type "mono -V" on the command line to see what version you are running. If it is below 1.1.18, then download the latest mono version, unzip and run rpm from the commandline. Detailed instructions are located here: <a href=" http://www.mono-project.com/Getting_Mono">Installing Mono</a></p></div></div><div class="section"><h3><a name="Assembly Info">Assembly Info</a></h3><p>Provided that you do not have your own AssemblyInfo class in your project, NMaven will automatically generate an AssemblyInfo.* for you. It does the following mapping:</p><table class="bodyTable"><tbody><tr class="a"><td align="left">AssemblyDescription</td><td align="left">${project.description}</td></tr><tr class="b"><td align="left">AssemblyVersion</td><td align="left">${project.version}</td></tr><tr class="a"><td align="left">AssemblyTitle</td><td align="le
ft">${project.name}</td></tr><tr class="b"><td align="left">AssemblyCompany</td><td align="left">${project.organization.name}</td></tr><tr class="a"><td align="left">AssemblyProduct</td><td align="left">${project.organization.name}-${project.name}</td></tr><tr class="b"><td align="left">AssemblyCopyright</td><td align="left">place a COPYRIGHT.txt file in your module directory and NMaven will pick it up and put it in the assembly</td></tr></tbody></table><p>Since the pom version is mapped to the assembly manifest, you MUST follow the 0.0.0.0 version convention specified by Microsoft (or the build will fail).</p></div><div class="section"><h3><a name="Unit Testing with NUnit">Unit Testing with NUnit</a></h3><p>Add the org.nunit dependency to your pom.xml (as shown below). You will only need to add the nmaven-test-plugin to the pom under the following circumstances:</p><ol type="1"><li>If you do not add the nunit bin to your path;</li><li>If you have the mono bin in your path a
nd you want to use another installation of NUnit ;</li><li>If you have both the mono bin and the NUnit bin in your path and you want to choose a specific one.</li></ol><p>Sample configuration of the test-plugin:</p><div class="source"><pre>
+Java HotSpot(TM) Client VM (build 1.5.0_09-b01, mixed mode, sharing)
</pre></div><p>On Linux, you also need Mono version 2.1.3.1 or higher. Type "mono -V" on the command line to see what version you are running. If it is below 2.1.3.1, then download the latest mono version, unzip and run rpm from the commandline. Detailed instructions are located here: <a href=" http://www.mono-project.com/Getting_Mono">Installing Mono</a>. Make sure that su to root before installing with these instructions!</p></div></div><div class="section"><h3><a name="Creating a Simple Project">Creating a Simple Project</a></h3><p>To create a simple project:</p><div class="source"><pre> mvn archetype:create -DgroupId=<<myGroupid>> \
+ -DartifactId=<<myArtifactId>> \
+ -DarchetypeArtifactId=maven-archetype-dotnet-simple \
+ -DarchetypeGroupId=org.apache.maven.dotnet \
+ -DarchetypeVersion=0.14-SNAPSHOT
</pre></div><p>You will see the following project generated:</p><div class="source"><pre>.
+ |-- src
+ | `-- main
+ | `-- csharp
+ | `-- Sample
+ | `-- MyApp.cs
+ `-- pom.xml
</pre></div><p>Note that due to a limitation of the existing maven archetype plugin, the generated project does not follow the recommended conventions. See here: <a href="conventions.html">Conventions</a></p></div><div class="section"><h3><a name="Generating VS2005 Solution Files">Generating VS2005 Solution Files</a></h3><p>To generate the solution and project files (csharp only) for a project with a prexisting pom, go to the directory containing the pom and type</p><div class="source"><pre>mvn NMaven.Plugins:NMaven.Plugin.Solution.JavaBinding:Solution
</pre></div><p>This plugin generates a solution file and project file for each project that exists within the project.modules.module tag of the pom (or just the parent pom if no project.modules.module entry exists). The solution generator will add all of the dependencies that exist within pom into the cs project file. The generator will also look through the class files, attempting to locate and add any reference
s that exist within the gac.</p><p>The latest solution generator runs as a .NET Maven plugin. Unfortunately due to a bug in Mono, .NET Maven plugins don't work with Mono. This is a high priority item, so expect a working solution to be offered in the near feature.</p></div><div class="section"><h3><a name="Assembly Info">Assembly Info</a></h3><p>Provided that you do not have your own AssemblyInfo class in your project, NMaven will automatically generate an AssemblyInfo.* for you. It does the following mapping:</p><table class="bodyTable"><tbody><tr class="a"><td align="left">AssemblyDescription</td><td align="left">${project.description}</td></tr><tr class="b"><td align="left">AssemblyVersion</td><td align="left">${project.version}</td></tr><tr class="a"><td align="left">AssemblyTitle</td><td align="left">${project.name}</td></tr><tr class="b"><td align="left">AssemblyCompany</td><td align="left">${project.organization.name}</td></tr><tr class="a"><td align="left">AssemblyPr
oduct</td><td align="left">${project.organization.name}-${project.name}</td></tr><tr class="b"><td align="left">AssemblyCopyright</td><td align="left">place a COPYRIGHT.txt file in your module directory and NMaven will pick it up and put it in the assembly</td></tr></tbody></table><p>Since the pom version is mapped to the assembly manifest, you MUST follow the 0.0.0.0 version convention specified by Microsoft (or the build will fail). You may, however, optionally add -SNAPSHOT to the version. Valid versions would include 1.3.4 or 1.2-SNAPSHOT. 1.2-RC1 is invalid because NMaven would not recognize the RC1 identifier. The SNAPSHOT within the version will not be included within the file name, but rather is contained both within the InformationalVersion attribute of the AssemblyInfo class and within the pom.xml file.</p><p>Due to a bug, SNAPSHOTS are only supported for C#: <a href="http://jira.codehaus.org/browse/NMAVEN-62"> NMAVEN-62</a></p></div><div class="section"><h3><a nam
e="Unit Testing with NUnit">Unit Testing with NUnit</a></h3><p>Add the NUnit dependency to your pom.xml (as shown below). You will only need to add the nmaven-test-plugin to the pom under the following circumstances:</p><ol type="1"><li>If you do not add the nunit bin to your path;</li><li>If you have the mono bin in your path and you want to use another installation of NUnit ;</li><li>If you have both the mono bin and the NUnit bin in your path and you want to choose a specific one.</li></ol><p>Sample configuration of the test-plugin:</p><div class="source"><pre>
<project>
....
<dependencies>
@@ -174,19 +205,16 @@
<type>module</type>
<version>2.0.0.0</version>
</dependency>
-
<dependency>
- <groupId>org.nunit</groupId>
- <artifactId>nunit.framework</artifactId>
- <version>2.2.8.0</version>
- <type>library</type>
+ <groupId>NUnit</groupId>
+ <artifactId>NUnit.Framework</artifactId>
+ <version>2.2.8.0</version>
+ <type>library</type>
</dependency>
</dependencies>
-
<build>
<sourceDirectory>src/main/csharp</sourceDirectory>
<testSourceDirectory>src/test/csharp</testSourceDirectory>
-
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -231,16 +259,12 @@
<artifactId>maven-compile-plugin</artifactId>
<extensions>true</extensions>
<configuration>
- <language>C_SHARP</language>
- <vendor>MONO</vendor>
<frameworkVersion>1.1.4322</frameworkVersion>
- <testLanguage>VB</testLanguage>
- <testVendor>MICROSOFT</testVendor>
<testFrameworkVersion>1.1.4322</testFrameworkVersion>
</configuration>
</plugin>
</plugins>
-
</pre></div><p>To disable the NUnit tests, add the system property -Dmaven.test.skip=true to the command line. You can also disable tests by adding <skipTests>true</skipTests> to the configuration above.</p></div><div class="section"><h3><a name="Building & Deploying Web Applications">Building & Deploying Web Applications</a></h3><p>To enable building of the Web application, specify the packaging as "nar" - .NET Archive. NMaven will compile classes in the source and test directories and then proceed to place the newly generated artifacts and its dependencies into the target/${project.build.finalname}/bin directory. NMaven will also copy any files from the src/main/webapp directory into the target/${project.build.finalname} directory, allowing you to add any additional resources such as Web.Config and ASPX files.</p><p>You will only need to add the nmaven-webapp-plugin to the pom if you are planning on deploying the web application. In that case, ad
d the deployPath pom configuration as shown below. Type "mvn deploy" from the command line and NMaven will copy the web application to the deployPath location.</p><div class="source"><pre>
+
</pre></div><p>You also have the option of changing the framework version by modifying the default setup within the nmaven-settings.xml file. See <a href="getting-started.html#Using NMaven Settings File">Using NMaven Settings File</a>.</p><p>To disable the NUnit tests, add the system property -Dmaven.test.skip=true to the command line. You can also disable tests by adding <skipTests>true</skipTests> to the configuration above.</p></div><div class="section"><h3><a name="Building & Deploying Web Applications">Building & Deploying Web Applications</a></h3><p>To enable building of the Web application, specify the packaging as "nar" - .NET Archive. NMaven will compile classes in the source and test directories and then proceed to place the newly generated artifacts and its dependencies into the target/${project.build.finalname}/bin directory. NMaven will also copy any files from the src/main/webapp directory into the target/${project.build.finalname} di
rectory, allowing you to add any additional resources such as Web.Config and ASPX files.</p><p>You will only need to add the nmaven-webapp-plugin to the pom if you are planning on deploying the web application. In that case, add the <b>deployPath</b> pom configuration as shown below. Type "mvn deploy" from the command line and NMaven will copy the web application to the <b>deployPath</b> location.</p><div class="source"><pre>
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>org.apache.maven.sample</groupId>
@@ -256,7 +280,6 @@
<version>2.0.0</version>
</dependency>
</dependencies>
-
<build>
<sourceDirectory>src/main/csharp</sourceDirectory>
<testSourceDirectory>src/test/csharp</testSourceDirectory>
@@ -288,7 +311,7 @@
<version>2.2.8.0</version>
<type>library</type>
</dependency>
- </dependencies>
</pre></div><p>Note that there is no current support for the use of classifiers within NMaven.</p></div><div class="section"><h3><a name="Generating Resources">Generating Resources</a></h3><p>There are four types of resources to include within an assembly: linked resources, embedded resources, win32 resources and win32 icon. By placing your files in the appropriate directory, NMaven will pick them up and embed/link them during the compile phase.</p><table class="bodyTable"><tbody><tr class="a"><td align="left">src/main/resources/linkresource</td><td align="left">Link all files in this directory to the assembly</td></tr><tr class="b"><td align="left">src/main/resources/resource</td><td align="left">Embed all files in this directory to the assembly</td></tr><tr class="a"><td align="left">src/main/resources/resgen</td><td align="left">Generate a resx file from all files in this directory and embed the resource in the assembly</td></tr><tr class="b"><td
align="left">src/main/resources/win32res</td><td align="left">Embed the resources in the assembly</td></tr><tr class="a"><td align="left">src/main/resources/win32icon</td><td align="left">Embed the icon within the assembly (icon will show up in file viewer)</td></tr></tbody></table></div><div class="section"><h3><a name="Signing Assemblies">Signing Assemblies</a></h3><p>NMaven supports compile-time signing of assemblies. You can sign assemblies by using the keyfile field in the maven-compile-plugin.</p><div class="source"><pre> <build>
+ </dependencies>
</pre></div><p>Note that there is no current support for the use of classifiers within NMaven: <a href="http://jira.codehaus.org/browse/NMAVEN-2"> NMAVEN-2</a></p></div><div class="section"><h3><a name="Generating Resources">Generating Resources</a></h3><p>There are four types of resources to include within an assembly: linked resources, embedded resources, win32 resources and win32 icon. By placing your files in the appropriate directory, NMaven will pick them up and embed/link them during the compile phase.</p><table class="bodyTable"><tbody><tr class="a"><td align="left">src/main/resources/linkresource</td><td align="left">Link all files in this directory to the assembly</td></tr><tr class="b"><td align="left">src/main/resources/resource</td><td align="left">Embed all files in this directory to the assembly</td></tr><tr class="a"><td align="left">src/main/resources/resgen</td><td align="left">Generate a resx file from all files in this directory
and embed the resource in the assembly</td></tr><tr class="b"><td align="left">src/main/resources/win32res</td><td align="left">Embed the resources in the assembly</td></tr><tr class="a"><td align="left">src/main/resources/win32icon</td><td align="left">Embed the icon within the assembly (icon will show up in file viewer)</td></tr></tbody></table></div><div class="section"><h3><a name="Signing Assemblies">Signing Assemblies</a></h3><p>NMaven supports compile-time signing of assemblies. You can sign assemblies by using the keyfile field in the maven-compile-plugin.</p><div class="source"><pre> <build>
<sourceDirectory>src/main/csharp</sourceDirectory>
<plugins>
<plugin>
@@ -301,7 +324,7 @@
</plugin>
</plugins>
</build>
-</project>
</pre></div><p>For both Mono framework versions 1.1/2.0 and Microsoft 2.0, NMaven uses the keyfile and keycontainer compiler parameters. For Microsoft 1.1, NMaven adds the KeyName and KeyFile entries into the project's AssemblyInfo.cs. Future NMaven features will include delayed-signing and post-compilation signing of assemblies.</p></div><div class="section"><h3><a name="Using NMaven Settings File">Using NMaven Settings File</a></h3><p>On Windows, NMaven will read the Windows Registry - regarding information about Mono, Microsoft and DotGNU installations - and will then output the registry info into a ~/.m2/nmaven-settings.xml file. This file assists NMaven in determining the capabilities of the build platform and in choosing the correct compiler and vendor for the build. By going into the defaultSetup tag, you can change which vendor and framework version that NMaven will use without needing to specify this information within the various pom.xml files.</p>
<p>In the case of Linux, there is no registry so the nmaven-settings.xml file is not automatically generated. You may, however, create one by hand, allowing you to specify the location of DotGNU and Mono implementations.</p><div class="source"><pre> <?xml version="1.0" encoding="utf-8"?>
+</project>
</pre></div><p>For both Mono framework versions 1.1/2.0 and Microsoft 2.0, NMaven uses the keyfile and keycontainer compiler parameters. For Microsoft 1.1, NMaven adds the KeyName and KeyFile entries into the project's AssemblyInfo.cs. Future NMaven features will include delayed-signing and post-compilation signing of assemblies.</p></div><div class="section"><h3><a name="Using NMaven Settings File">Using NMaven Settings File</a></h3><p>On Windows, NMaven will read the Windows Registry - regarding information about Mono, Microsoft and DotGNU installations - and will then output the registry info into a ~/.m2/nmaven-settings.xml file. This file assists NMaven in determining the capabilities of the build platform and in choosing the correct compiler and vendor for the build. By going into the defaultSetup tag, you can change which vendor and framework version that NMaven will use without needing to specify this information within the various pom.xml files.</p>
<p>The nmaven-settings default values will be ignored if they are specified either through the command line of the pom file. The values that NMaven uses for building and testing, in order of priority, are</p><ol type="1"><li>commandline: -Dvendor, -DframeworkVersion, -DvendorVersion</li><li>pom.xml file configuration of the compiler</li><li>nmaven-settings.xml file</li></ol><p>In the case of Linux, there is no registry so the nmaven-settings.xml file is not automatically generated. You may, however, create one by hand, allowing you to specify the location of DotGNU and Mono implementations.</p><div class="source"><pre> <?xml version="1.0" encoding="utf-8"?>
<nmavenSettings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<operatingSystem>Microsoft Windows NT 5.1.2600 Service Pack 2</operatingSystem>
<defaultSetup>
Added: incubator/nmaven/www/ide/sharp-develop.html
URL: http://svn.apache.org/viewvc/incubator/nmaven/www/ide/sharp-develop.html?view=auto&rev=540013
==============================================================================
--- incubator/nmaven/www/ide/sharp-develop.html (added)
+++ incubator/nmaven/www/ide/sharp-develop.html Sun May 20 21:06:55 2007
@@ -0,0 +1,202 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+<html>
+ <head>
+ <title>NMaven - </title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <span id="bannerLeft">
+
+ NMaven
+
+ </span>
+ <span id="bannerRight">
+
+ <img src=".././images/apache-incubator-logo.png" alt="" />
+
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 05/20/2007
+ </div>
+ <div class="xright"> <a href="http://incubator.apache.org/projects/nmaven.html">Project Site</a>
+ |
+ <a href="../">NMaven</a>
+ |
+ <a href="http://svn.apache.org/repos/asf/incubator/nmaven/">NMaven SVN</a>
+ |
+ <a href="http://maven.apache.org/">Maven</a>
+ |
+ <a href="http://www.mono-project.com/">Mono Project</a>
+ |
+ <a href="http://dotgnu.org/">DotGNU</a>
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+ <h5>General Info</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../index.html">About</a>
+ </li>
+
+ <li class="none">
+ <a href="../features.html">Features</a>
+ </li>
+
+ <li class="none">
+ <a href="../getting-started.html">Getting Started</a>
+ </li>
+
+ <li class="none">
+ <a href="../conventions.html">Conventions</a>
+ </li>
+
+ <li class="none">
+ <a href="../plugins/index.html">Plugins</a>
+ </li>
+
+ <li class="none">
+ <a href="../environment-configuration.html">Configuration</a>
+ </li>
+ </ul>
+ <h5>IDE Integration</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../ide/visual-studio.html">Visual Studio</a>
+ </li>
+
+ <li class="none">
+ <strong>Sharp Develop</strong>
+ </li>
+ </ul>
+ <h5>Developer Documentation</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../net-plugins.html">Writing .NET Mojos</a>
+ </li>
+
+ <li class="none">
+ <a href="../adding-plugins.html">Adding Compilers</a>
+ </li>
+
+ <li class="none">
+ <a href="../adding-executables.html">Adding Executables</a>
+ </li>
+
+ <li class="none">
+ <a href="../apidocs/index.html">JavaDocs</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../project-info.html">Project Information</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <div class="section"><h2>Sharp Develop</h2><div class="section"><h3>About</h3><p>The initial protoype of the SharpDevelop Addin is further discussed <a href="http://jroller.com/page/random7?entry=completed_prototype_of_apache_nmaven">here</a>.</p><img src="../images/SD-Menu.JPG" /><p>There are still a number of manual steps needed to get the addin compiled and running outside of the initial test environment. They include:</p><ol type="1"><li>Getting the dependent #develop assemblies imported into the local maven repo (or GAC)</li><li>Creating the pom file for the NMaven.SharpDevelop.Addin module</li><li>Packaging of the addin</li><li>Starting the maven embedder automatically</li></ol><p>If you need the functionality sooner than later and you want to take this on, you can submit a patch to get things moving: <a href="http://jira.codehaus.org/browse/NMAVEN"> NMaven Issue Tracking</a></p></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2007
+
+ NMaven
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>