Author: epunzalan Date: Wed Jul 19 04:59:43 2006 New Revision: 423442 URL: http://svn.apache.org/viewvc?rev=423442&view=rev Log: PR: MECLIPSE-125
Improved documentation based on Dennis Lundberg's review: http://www.nabble.com/Please-review-maven-eclipse-plugin-tf1957957.html Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/provide-project-natures-and-build-commands.apt maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/reactor.apt maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.apt maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/wtp.apt maven/plugins/trunk/maven-eclipse-plugin/src/site/fml/faq.fml maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/provide-project-natures-and-build-commands.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/provide-project-natures-and-build-commands.apt?rev=423442&r1=423441&r2=423442&view=diff ============================================================================== --- maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/provide-project-natures-and-build-commands.apt (original) +++ maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/provide-project-natures-and-build-commands.apt Wed Jul 19 04:59:43 2006 @@ -1,75 +1,75 @@ - ------ - Provide Build Commands - ------ - Edwin Punzalan - ------ - 14 July 2006 - ------ - - -Provide Project Natures And Build Commands for Eclipse - - The default project nature by projects created by the Eclipse Plugin is - <<<org.eclipse.jdt.core.javanature>>> and the default build command is - <<<org.eclipse.jdt.core.javabuilder>>>. Additional project natures and build - commands are also added as needed when WTP is enabled. - - If you want to provide additional project natures and build commands for your - project, i.e. Spring project, you can add them in your pom.xml like: - -+----- -<project> - [...] - <build> - [...] - <plugins> - [...] - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-eclipse-plugin<artifactId> - <configuration> - <additionalProjectnatures> - <projectnature>org.springframework.ide.eclipse.core.springnature</projectnature> - </additionalProjectnatures> - <additionalBuildcommands> - <buildcommand>org.springframework.ide.eclipse.core.springbuilder</buildcommand> - </additionalBuildcommands> - </configuration> - </plugin> - [...] - </plugins> - [...] - </build> - [...] -</project> -+----- - - To provide your own project natures and build commands which will override - the defaults, you can put them in your pom.xml as follows: - -+----- -<project> - [...] - <build> - [...] - <plugins> - [...] - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-eclipse-plugin<artifactId> - <configuration> - <projectnatures> - <projectnature>my.own.project.nature</projectnature> - </projectnatures> - <buildcommands> - <buildcommand>my.own.build.command</buildcommand> - </buildcommands> - </configuration> - </plugin> - [...] - </plugins> - [...] - </build> - [...] -</project> -+----- + ------ + Provide Build Commands + ------ + Edwin Punzalan + ------ + 14 July 2006 + ------ + + +Provide Project Natures And Build Commands for Eclipse + + The default project nature for projects created by the Eclipse Plugin is + <<<org.eclipse.jdt.core.javanature>>> and the default build command is + <<<org.eclipse.jdt.core.javabuilder>>>. Additional project natures and build + commands are also added as needed when WTP is enabled. + + If you want to provide additional project natures and build commands for your + project, i.e. Spring project, you can add them in your pom.xml like this: + ++----- +<project> + [...] + <build> + [...] + <plugins> + [...] + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-eclipse-plugin<artifactId> + <configuration> + <additionalProjectnatures> + <projectnature>org.springframework.ide.eclipse.core.springnature</projectnature> + </additionalProjectnatures> + <additionalBuildcommands> + <buildcommand>org.springframework.ide.eclipse.core.springbuilder</buildcommand> + </additionalBuildcommands> + </configuration> + </plugin> + [...] + </plugins> + [...] + </build> + [...] +</project> ++----- + + To provide your own project natures and build commands which will override + the defaults, you can put them in your pom.xml as follows: + ++----- +<project> + [...] + <build> + [...] + <plugins> + [...] + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-eclipse-plugin<artifactId> + <configuration> + <projectnatures> + <projectnature>my.own.project.nature</projectnature> + </projectnatures> + <buildcommands> + <buildcommand>my.own.build.command</buildcommand> + </buildcommands> + </configuration> + </plugin> + [...] + </plugins> + [...] + </build> + [...] +</project> ++----- Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt?rev=423442&r1=423441&r2=423442&view=diff ============================================================================== --- maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt (original) +++ maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt Wed Jul 19 04:59:43 2006 @@ -23,7 +23,7 @@ * {{{clean-mojo.html}eclipse:clean}} is used to delete the files used by the Eclipse IDE. - * {{{eclipse-mojo.html}eclipse:eclipse}} generates the eclipse configuration + * {{{eclipse-mojo.html}eclipse:eclipse}} generates the Eclipse configuration files. * Usage Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/reactor.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/reactor.apt?rev=423442&r1=423441&r2=423442&view=diff ============================================================================== --- maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/reactor.apt (original) +++ maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/reactor.apt Wed Jul 19 04:59:43 2006 @@ -1,5 +1,5 @@ ------ - Multiple Module Project with eclipse + Multiple Module Project with Eclipse ------ Bernd Mau, [EMAIL PROTECTED] Fabrizio Giustina @@ -11,44 +11,44 @@ * Project layout - Due to the workspace idea many eclipse users are used to a flat layout and + Due to the workspace idea many Eclipse users are used to a flat layout and therefore want to keep this structure. The following sample shows how to - handle maven multiple module projects with eclipse for both the standard - maven hierachical project layout and the flat eclipse-like layout. + handle maven multiple module projects with Eclipse for both the standard + maven hierachical project layout and the flat Eclipse-like layout. ** Hierachical project layout - Suppose eclipse is your favorite SCM client, this step by step example shows + Suppose Eclipse is your favorite SCM client, this step by step example shows how to set up a new mutiple module project. - [[1]] Set up a new eclipse workspace called <step-by-step> and add the + [[1]] Set up a new Eclipse workspace called <step-by-step> and add the <M2_REPO> classpath variable. - [[1]] Open the command line shell and change to the newly created workspace + [[2]] Open the command line shell and change to the newly created workspace directory. - [[1]] From the command line change to newly created <step-by-step> workspace - and create a new maven project using the archetype plugin. + [[3]] From the command line, create a new maven project using the archetype + plugin. +----+ mvn archetype:create -DgroupId=guide.ide.eclipse -DartifactId=guide-ide-eclipse +----+ - [[1]] Create a new simple project <guide-ide-eclipse> inside the - <step-by-step> workspace with eclipse (From the menu bar, select File >New > + [[4]] Create a new simple project <guide-ide-eclipse> inside the + <step-by-step> workspace with Eclipse (From the menu bar, select File >New > Project. Select Simple > Project). Eclipse will create a simple <.project>-file for your <guide-ide-eclipse>-project and you should be able to see the <pom.xml>-file. - [[1]] Delete the <src>-folder and open the <pom.xml>-file to change the + [[5]] Delete the <src>-folder and open the <pom.xml>-file to change the packaging of your parent project to <pom>. +----+ <packaging>pom</packaging> +----+ - [[1]] From the command line change to the <guide-ide-eclipse> project + [[6]] From the command line change to the <guide-ide-eclipse> project directory and create some modules. +----+ @@ -58,7 +58,7 @@ mvn archetype:create -DgroupId=guide.ide.eclipse.module1 -DartifactId=guide-ide-eclipse-module1 +----+ - [[1]] Add the newly created modules to your parent pom. + [[7]] Add the newly created modules to your parent pom. +----+ <modules> @@ -68,7 +68,7 @@ </modules> +----+ - [[1]] Add the parent to the POMs of the new modules: + [[8]] Add the parent to the POMs of the new modules: +----+ <parent> @@ -78,7 +78,7 @@ </parent> +----+ - [[1]] Add dependency from <module1> to the <core>-module: + [[9]] Add dependency from <module1> to the <core>-module: +----+ <dependency> @@ -88,7 +88,7 @@ </dependency> +----+ - [[1]] Install the project in your local repository and generate the eclipse + [[10]] Install the project in your local repository and generate the Eclipse files: +----+ @@ -96,9 +96,9 @@ mvn eclipse:eclipse +----+ - [[1]] Check in your project using the eclipse team support (select from the + [[11]] Check in your project using the Eclipse team support (select from the context menu Team > Share Project). <Note:> Do not check in the generated - eclipse files. If you use CVS you should have a <.cvsignore>-file with the + Eclipse files. If you use CVS you should have a <.cvsignore>-file with the following entries for each module: +----+ @@ -115,22 +115,22 @@ [] From now on you have different options to proceed. If you are working on all - modules simultanously and you'd rather have eclipse project dependencies than + modules simultanously and you'd rather have Eclipse project dependencies than binary dependencies, you should set up a new workspace and import all projects from <step-by-step/guide-ide-eclipse>. Note, you have to delete the <.project>-file of your parent project before. The result is the same as checking out the whole project from the command line, running - <mvn eclipse:eclipse> and finally importing the projects into your eclipse + <mvn eclipse:eclipse> and finally importing the projects into your Eclipse workspace. In both cases you will be able to synchronize your changes using - eclipse. + Eclipse. In case of large projects with many developers involved, it can be tedious to check out all modules and keep them up to date. Especially if you are only interested in one or two modules. In this case using binary dependencies is much more comfortable. Just check out the modules you want to work on with - eclipse and run <mvn eclipse:eclipse> for each module (see also {{{#Maven as - an external tool}Maven as an external tool}}). Of course, all referenced - artifacts must be available from your maven repository. + Eclipse and run <mvn eclipse:eclipse> for each module (see also {{{usage.html} + Maven as an external tool}). Of course, all referenced artifacts must be + available from your maven repository. ** {Flat Project Layout} @@ -144,7 +144,7 @@ [[1]] Create a new directory under <guide-ide-eclipse> called <guide-ide-eclipse-project> and move the parent POM to it. - [[1]] Change the module references in the parent POM to: + [[2]] Change the module references in the parent POM to: +----+ <modules> Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.apt?rev=423442&r1=423441&r2=423442&view=diff ============================================================================== --- maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.apt (original) +++ maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.apt Wed Jul 19 04:59:43 2006 @@ -25,16 +25,16 @@ mvn -Declipse.workspace=<path-to-eclipse-workspace> eclipse:add-maven-repo +----+ - You can also define a new classpath variable inside eclipse: From the menu + You can also define a new classpath variable inside Eclipse: From the menu bar, select Window > Preferences. Select the Java > Build Path > Classpath Variables page. * {Maven as an external tool} - You might want to execute some maven goals from inside eclipse. This is + You might want to execute some maven goals from inside Eclipse. This is possible by configuring an external launcher. - It is best practice to prepare eclipse by adding a variable, which points to + It is best practice to prepare Eclipse by adding a variable, which points to your local maven excutable (mvn.bat/mvn). From the menu bar, select Window > Preferences. Select the Run/Debug > String @@ -47,22 +47,22 @@ Furthermore refer to <project_loc> as the working directory and specify the maven goals of your choice as arguments, e.g. <eclipse:eclipse>. - For further information please refer to the eclipse help. + For further information please refer to the Eclipse help. * {Simple Project} If you have a simple java project which is made up of only one module, using - eclipse is very simple. To generate the eclipse project files from your POM + Eclipse is very simple. To generate the Eclipse project files from your POM you execute the following command: +----+ mvn eclipse:eclipse +----+ - If you have created or checked out the project with eclipse, you only have to + If you have created or checked out the project with Eclipse, you only have to refresh the project in your workspace. Otherwise you have to import the - project into your eclipse workspace (From the menu bar, select File > Import > + project into your Eclipse workspace (From the menu bar, select File > Import > Existing Projects into Workspace). In the latter case the project (directory) - should not be located in your workspace, because eclipse might come into - trouble, especially if you want to use eclipse as the scm client. \ No newline at end of file + should not be located in your workspace, because Eclipse might come into + trouble, especially if you want to use Eclipse as the scm client. \ No newline at end of file Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/wtp.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/wtp.apt?rev=423442&r1=423441&r2=423442&view=diff ============================================================================== --- maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/wtp.apt (original) +++ maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/wtp.apt Wed Jul 19 04:59:43 2006 @@ -8,10 +8,10 @@ WTP support - The eclipse plugin supports creating configurations for eclipse WTP (Web Tools + The Eclipse plugin supports creating configurations for Eclipse WTP (Web Tools Project). Projects with a WAR packaging can be setup as WTP dynamic web projects and runtime dependencies are configured to be used when running them - using eclipse internal servers. + using Eclipse internal servers. @@ -47,7 +47,7 @@ <<This means that only project-dependencies (in a multi-module build) will work, but any other dependency in the POM will be ignored when running the web - application inside eclipse.>> + application inside Eclipse.>> This bug has been fixed in release 1.0.1, so if you are still using WTP 1.0 be sure to update it to the 1.0.1 (or newer) release. Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/fml/faq.fml URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/fml/faq.fml?rev=423442&r1=423441&r2=423442&view=diff ============================================================================== --- maven/plugins/trunk/maven-eclipse-plugin/src/site/fml/faq.fml (original) +++ maven/plugins/trunk/maven-eclipse-plugin/src/site/fml/faq.fml Wed Jul 19 04:59:43 2006 @@ -1,45 +1,45 @@ -<?xml version="1.0"?> -<faqs id="FAQ" title="Frequently Asked Questions"> - <part id="General"> - <faq id="eclipse-plugin"> - <question>Is this the Eclipse Plugin that allows me to run maven commands from within Eclipse IDE?</question> - <answer> - <p>No. This is a maven plugin to generate eclipse files for a maven project. This is not an Eclipse Plugin for Maven.</p> - </answer> - </faq> - <faq id="import-project"> - <question>I already did <i>mvn eclipse:eclipse</i> but when I open Eclipse, my project is not there. Where is it?</question> - <answer> - <p>You may also need to import the project created by Maven Eclipse Plugin. More information can be found <a href="usage.html#Simple Project">here</a>.</p> - </answer> - </faq> - <faq id="use-add-maven-repo"> - <question>After runnning <i>mvn eclipse:eclipse</i>, the generated dependencies are pointing to a non-existing file. What needs to be done?</question> - <answer> - <p>Before you can setup any maven project to your eclipse IDE, you need to define first the location of your local repository to Eclipse. This is done by using:</p><pre>eclipse:add-maven-repo</pre> - </answer> - </faq> - <faq id="import-javadoc"> - <question>Can I make the eclipse plugin to download and attach javadocs to my libraries?</question> - <answer> - <p>Quoting what Fabrizio said in the mailing list...</p> - <i> - <p>"The current revision in svn of the eclipse plugin (which is expected - to be released as soon as an usable wtp 1.0.1 build will be out) has - support for javadoc attachments, as an alternative to source jars."</p> - - <p>"When using the downloadSources flag if a source jar is not found the - plugin will look for a javadoc jar. This is expecially useful for non - open source projects and when used with eclipse 3.2 (in eclipse 3.2 M4 - javadoc view and editor tooltips also work with javadoc archives)."</p> - - <p>"I didn't find useful to have both sources and javadocs attached, since - javadocs are automatically extracted by eclipse: if you think this - should be needed please post an enhancement request in Jira with the - reasons... "</p> - </i> - <p>To go the the mailing list thread of this topic, click <a href="http://www.nabble.com/forum/ViewPost.jtp?post=2370602&framed=y";>here</a></p> - </answer> - </faq> - </part> -</faqs> +<?xml version="1.0"?> +<faqs id="FAQ" title="Frequently Asked Questions"> + <part id="General"> + <faq id="eclipse-plugin"> + <question>Is this the Eclipse Plugin that allows me to run maven commands from within Eclipse IDE?</question> + <answer> + <p>No. This is a maven plugin to generate Eclipse files for a maven project. This is not an Eclipse Plugin for Maven.</p> + </answer> + </faq> + <faq id="import-project"> + <question>I already did <i>mvn eclipse:eclipse</i> but when I open Eclipse, my project is not there. Where is it?</question> + <answer> + <p>You may also need to import the project created by Maven Eclipse Plugin. More information can be found <a href="usage.html#Simple Project">here</a>.</p> + </answer> + </faq> + <faq id="use-add-maven-repo"> + <question>After running <i>mvn eclipse:eclipse</i>, the generated dependencies are pointing to a non-existing file. What needs to be done?</question> + <answer> + <p>Before you can setup any maven project to your Eclipse IDE, you need to define first the location of your local repository to Eclipse. This is done by using:</p><pre>eclipse:add-maven-repo</pre> + </answer> + </faq> + <faq id="import-javadoc"> + <question>Can I make the Eclipse plugin to download and to attach javadocs to my libraries?</question> + <answer> + <p>Quoting what Fabrizio said in the mailing list...</p> + <i> + <p>"The current revision in svn of the Eclipse plugin (which is expected + to be released as soon as an usable wtp 1.0.1 build will be out) has + support for javadoc attachments, as an alternative to source jars."</p> + + <p>"When using the downloadSources flag if a source jar is not found the + plugin will look for a javadoc jar. This is expecially useful for non + open source projects and when used with Eclipse 3.2 (in Eclipse 3.2 M4 + javadoc view and editor tooltips also work with javadoc archives)."</p> + + <p>"I didn't find useful to have both sources and javadocs attached, since + javadocs are automatically extracted by Eclipse: if you think this + should be needed please post an enhancement request in Jira with the + reasons... "</p> + </i> + <p>To go the the mailing list thread of this topic, click <a href="http://www.nabble.com/forum/ViewPost.jtp?post=2370602&framed=y";>here</a></p> + </answer> + </faq> + </part> +</faqs> Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml?rev=423442&r1=423441&r2=423442&view=diff ============================================================================== --- maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml (original) +++ maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml Wed Jul 19 04:59:43 2006 @@ -1,4 +1,14 @@ -<body> +<project name="Maven Compiler Plugin"> + <bannerLeft> + <name>Maven Compiler Plugin</name> + <src>http://maven.apache.org/images/apache-maven-project.png</src> + <href>http://maven.apache.org/</href> + </bannerLeft> + <bannerRight> + <src>http://maven.apache.org/images/maven-small.gif</src> + </bannerRight> + + <body> <links> <item name="Maven" href="http://maven.apache.org/maven2/"/> </links> @@ -21,3 +31,4 @@ ${reports} </body> +</project> \ No newline at end of file
