svn commit: r539701 - in /incubator/nmaven/branches/SI_XPT/site/src/site/apt: ide/ ide/sharp-develop.apt ide/visual-studio.apt net-plugins.apt

[si...@apache.org]

Author: sisbell
Date: Sat May 19 00:05:08 2007
New Revision: 539701

URL: http://svn.apache.org/viewvc?view=rev&rev=539701
Log:
Updated site docs. Still incomplete.

Added:
    incubator/nmaven/branches/SI_XPT/site/src/site/apt/ide/
    incubator/nmaven/branches/SI_XPT/site/src/site/apt/ide/sharp-develop.apt
    incubator/nmaven/branches/SI_XPT/site/src/site/apt/ide/visual-studio.apt
    incubator/nmaven/branches/SI_XPT/site/src/site/apt/net-plugins.apt

Added: incubator/nmaven/branches/SI_XPT/site/src/site/apt/ide/sharp-develop.apt
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/site/src/site/apt/ide/sharp-develop.apt?view=auto&rev=539701
==============================================================================
--- incubator/nmaven/branches/SI_XPT/site/src/site/apt/ide/sharp-develop.apt (added)
+++ incubator/nmaven/branches/SI_XPT/site/src/site/apt/ide/sharp-develop.apt Sat May 19 00:05:08 2007
@@ -0,0 +1 @@
+Sharp Develop
\ No newline at end of file

Added: incubator/nmaven/branches/SI_XPT/site/src/site/apt/ide/visual-studio.apt
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/site/src/site/apt/ide/visual-studio.apt?view=auto&rev=539701
==============================================================================
--- incubator/nmaven/branches/SI_XPT/site/src/site/apt/ide/visual-studio.apt (added)
+++ incubator/nmaven/branches/SI_XPT/site/src/site/apt/ide/visual-studio.apt Sat May 19 00:05:08 2007
@@ -0,0 +1,40 @@
+Visual Studio 2005
+
+* Installing
+
+ After following the build instructions here: {{{getting-started.html#Building NMaven}Building NMaven}}, you will need
+ to run:
+
+ +----+
+ mvn org.apache.maven.dotnet.plugins:maven-vsinstaller-plugin:install
+ +----+
+
+ This plugin will resolve (and download if needed) all of NMaven's dependencies and will create the Visual Studio
+ addin file in the user home directory: ${user.home}\My Documents\Visual Studio 2005\Addins.
+
+ Sample Addin file:
+
+ +----+
+<?xml version="1.0" encoding="utf-16"?>
+<Extensibility xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+xmlns="http://schemas.microsoft.com/AutomationExtensibility">
+  <HostApplication>
+    <Name>Microsoft Visual Studio</Name>
+    <Version>8.0</Version>
+  </HostApplication>
+  <Addin>
+    <Assembly>
+        C:\Documents and Settings\shane\.m2\repository\NMaven\VisualStudio\NMaven.VisualStudio.Addin\0.14-SNAPSHOT\NMaven.VisualStudio.Addin.dll
+    </Assembly>
+    <FullClassName>NMaven.VisualStudio.Addin.Connect</FullClassName>
+    <FriendlyName>NMaven.VisualStudio.Addin</FriendlyName>
+    <Description>NMaven provides Maven 2.x plugins to support building of .NET applications</Description>
+    <LoadBehavior>0</LoadBehavior>
+    <CommandLineSafe>0</CommandLineSafe>
+    <CommandPreload>1</CommandPreload>
+  </Addin>
+</Extensibility>
+ +----+
+
+Next startup Visual Studio 2005. 

Added: incubator/nmaven/branches/SI_XPT/site/src/site/apt/net-plugins.apt
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/site/src/site/apt/net-plugins.apt?view=auto&rev=539701
==============================================================================
--- incubator/nmaven/branches/SI_XPT/site/src/site/apt/net-plugins.apt (added)
+++ incubator/nmaven/branches/SI_XPT/site/src/site/apt/net-plugins.apt Sat May 19 00:05:08 2007
@@ -0,0 +1,107 @@
+Writing .NET Mojos
+
+ The first thing to do is to create an implementation of the NMaven.Plugin.AbstractMojo class. You will need to become
+ familiar with two attributes:
+
+   [[1]] ClassAttribute - provides the phase and goal info for the Mojo
+
+   [[2]] FieldAttribute - provides the Java fieldName, Java fieldType and Maven expression. The Expression parameter should
+ be the same as you would specify within a Java Mojo
+
+ It is important to note that the plugin framework currently only handles String types and the maven project types: it
+ also does not handle collections. Additional types will be added in future versions.
+
++----+
+ using System;
+ using NMaven.Plugin;
+
+ namespace NMaven.Plugins.Test
+ {
+ 	[ClassAttribute(Phase = "compile", Goal = "Hello")]
+ 	public sealed class MyMojo : AbstractMojo
+ 	{
+
+ 		[FieldAttribute("basedir", Expression = "${basedir}", Type = "java.lang.String")]
+ 		public String basedir;
+
+ 		[FieldAttribute("mavenProject", Expression = "${project}",
+ 		                                Type = "org.apache.maven.project.MavenProject")]
+ 		public NMaven.Model.Model mavenProject;
+
+ 		public override Type GetMojoImplementationType()
+ 		{
+ 			return this.GetType();//LEAVE THIS UNCHANGED
+ 		}
+
+ 		public override void Execute()
+ 		{
+ 		    Console.WriteLine("My  First Mojo"):
+            //DO SOMETHING HERE
+ 		}
+ 	}
+ }
+
++----+
+
+ After that, add a pom.xml file to your project. Notice that the packaging type must be "netplugin". You must also
+ add the NMaven.Plugin dependency, as that assembly contains the base AbstractMojo class and the attributes. The
+ NMaven.Model.Pom dependency is only needed if you are injecting the MavenProject into a field.
+
++----+
+
+<project xmlns="http://maven.apache.org/POM/4.0.0">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>NMaven.Plugins</groupId>
+  <artifactId>NMaven.Plugins.Test</artifactId>
+  <packaging>netplugin</packaging>
+  <version>0.14-SNAPSHOT</version>
+  <name>NMaven.Plugins.Test</name>
+  <dependencies>
+    <dependency>
+      <groupId>NMaven.Plugin</groupId>
+      <artifactId>NMaven.Plugin</artifactId>
+      <type>library</type>
+      <version>0.14-SNAPSHOT</version>
+    </dependency>
+    <dependency>
+      <groupId>NMaven.Model</groupId>
+      <artifactId>NMaven.Model.Pom</artifactId>
+      <type>library</type>
+      <version>0.14-SNAPSHOT</version>
+    </dependency>
+  </dependencies>
+</project>
+
++----+
+
+ Now compile and install the module containing your plugin:
+
++----+
+ mvn install
++----+
+
+ Next generate the JavaBinding classes for the .NET Plugin.
+
++----+
+ mvn org.apache.maven.dotnet.plugins:maven-mojo-generator-plugin:generate-bindings
++----+
+
+ You will see that the maven-mojo-generator-plugin generates a Java class - containing an implementation of a Maven AbstractMojo - for
+ each corresponding .NET AbstractMojo class within your plugin. It also generates a pom-java.xml file. Type:
+
++----+
+ mvn intall -f pom-java.xml
++----+
+
+ This generates a traditional Maven plugin (in Java) that binds to your .NET version. Now type
+
++----+
+ mvn NMaven.Plugins:NMaven.Plugins.Test.JavaBinding:Hello
++----+
+
+ and on your screen, you will see
+
++----+
+ My First Mojo
++----+
+