Author: vsiveton
Date: Thu Aug 6 12:52:40 2009
New Revision: 801632
URL: http://svn.apache.org/viewvc?rev=801632&view=rev
Log:
o fixed ambiguous links
o added Doxia xsd
o updated license header
Modified:
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/trouble-shooting/index.apt
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/usage.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/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt?rev=801632&r1=801631&r2=801632&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 Thu Aug 6
12:52:40 2009
@@ -6,86 +6,105 @@
12 July 2006
------
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
Maven Eclipse Plugin
The Eclipse Plugin is used to generate Eclipse IDE files (*.classpath,
*.wtpmodules and the .settings folder) for use with a project.
-
+
Note: Starting at version 2.6, by default, the generated .classpath now
includes "**/*.java" for source directories
- and excludes "**/*.java" for resource directories. See the example on
- {{{examples/specifying-source-path-inclusions-and-exclusions.html}specifying
source path inclusions and exclusions}}
- for more details on how to change this behavior.
+ and excludes "**/*.java" for resource directories. See the example on
+
{{{./examples/specifying-source-path-inclusions-and-exclusions.html}specifying
source path inclusions and exclusions}}
+ for more details on how to change this behavior.
* Goals Overview
The Maven Eclipse Plugin has several goals.
-
+
** Standard eclipse goals
- * {{{configure-workspace-mojo.html}eclipse:configure-workspace}} is used to
add the
- classpath variable M2_REPO to Eclipse which points to your local repository
and
+ * {{{./configure-workspace-mojo.html}eclipse:configure-workspace}} is used
to add the
+ classpath variable M2_REPO to Eclipse which points to your local repository
and
optional to configure other workspace features.
- * {{{eclipse-mojo.html}eclipse:eclipse}} generates the Eclipse configuration
+ * {{{./eclipse-mojo.html}eclipse:eclipse}} generates the Eclipse
configuration
files.
-
- * {{{clean-mojo.html}eclipse:clean}} is used to delete the files used by the
+
+ * {{{./clean-mojo.html}eclipse:clean}} is used to delete the files used by
the
Eclipse IDE.
** Specific goals
*** Specific goals to support m2eclipse
- * {{{m2eclipse-mojo.html}eclipse:m2eclipse}} generates the Eclipse
configuration
+ * {{{./m2eclipse-mojo.html}eclipse:m2eclipse}} generates the Eclipse
configuration
files that are already configured for
{{{http://m2eclipse.codehaus.org}M2eclipse}}.
-
+
*** Specific goals for PDE developments
-
- * {{{to-maven-mojo.html}eclipse:to-maven}} Add eclipse artifacts from an
eclipse installation
+
+ * {{{./to-maven-mojo.html}eclipse:to-maven}} Add eclipse artifacts from an
eclipse installation
to the local repo. This mojo automatically analize the eclipse directory,
copy plugins jars
to the local maven repo, and generates appropriate poms. This is the
official central repository
builder for Eclipse plugins, so it has the necessary default values. For
customized repositories
- see {{{make-artifacts-mojo.html}eclipse:make-artifacts}}.
-
- * {{{install-plugins-mojo.html}eclipse:install-plugins}} installs all
resolved project
+ see {{{./make-artifacts-mojo.html}eclipse:make-artifacts}}.
+
+ * {{{./install-plugins-mojo.html}eclipse:install-plugins}} installs all
resolved project
dependencies of a particular type (usually 'eclipse-plugin') into the
specified Eclipse
installation directory.
- * {{{make-artifacts-mojo.html}eclipse:make-artifacts}} copies all Eclipse
plugins from an
+ * {{{./make-artifacts-mojo.html}eclipse:make-artifacts}} copies all Eclipse
plugins from an
installation directory to the local repository, generating POMs for each.
*** Specific goals to support myeclipse
- * {{{myeclipse-mojo.html}eclipse:myeclipse}} Generates the MyEclipse
configuration files.
+ * {{{./myeclipse-mojo.html}eclipse:myeclipse}} Generates the MyEclipse
configuration files.
- * {{{myeclipse-clean-mojo.html}eclipse:myeclipse-clean}} Deletes the config
files used by MyEclipse.
+ * {{{./myeclipse-clean-mojo.html}eclipse:myeclipse-clean}} Deletes the
config files used by MyEclipse.
*** Specific goals to support RAD v6
- * {{{rad-mojo.html}eclipse:rad}} Generates the Rad-6 configuration files.
+ * {{{./rad-mojo.html}eclipse:rad}} Generates the Rad-6 configuration files.
+
+ * {{{./rad-clean-mojo.html}eclipse:rad-clean}} Deletes the config files used
by Rad-6.
- * {{{rad-clean-mojo.html}eclipse:rad-clean}} Deletes the config files used
by Rad-6.
-
* Usage
- General instructions on how to use the Eclipse Plugin can be found on the
{{{usage.html}usage page}}. Some more
+ General instructions on how to use the Eclipse Plugin can be found on the
{{{./usage.html}usage page}}. Some more
specific use cases are described in the examples given below. Last but not
least, users occasionally contribute
additional examples, tips or errata to the
{{{http://docs.codehaus.org/display/MAVENUSER/Eclipse+Plugin}plugin's wiki
page}}.
- In case you still have questions regarding the plugin's usage, please have a
look at the {{{faq.html}FAQ}} and feel
- free to contact the {{{mail-lists.html}user mailing list}}. The posts to the
mailing list are archived and could
+ In case you still have questions regarding the plugin's usage, please have a
look at the {{{./faq.html}FAQ}} and feel
+ free to contact the {{{./mail-lists.html}user mailing list}}. The posts to
the mailing list are archived and could
already contain the answer to your question as part of an older thread.
Hence, it is also worth browsing/searching
- the {{{mail-lists.html}mail archive}}.
+ the {{{./mail-lists.html}mail archive}}.
If you feel like the plugin is missing a feature or has a defect, you can
fill a feature request or bug report in our
- {{{issue-tracking.html}issue tracker}}. When creating a new issue, please
provide a comprehensive description of your
+ {{{./issue-tracking.html}issue tracker}}. When creating a new issue, please
provide a comprehensive description of your
concern. Especially for fixing bugs it is crucial that the developers can
reproduce your problem. For this reason,
entire debug logs, POMs or most preferably little demo projects attached to
the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project
from our
- {{{source-repository.html}source repository}} and will find supplementary
information in the
+ {{{./source-repository.html}source repository}} and will find supplementary
information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to
helping with Maven}}.
* Examples
@@ -93,24 +112,26 @@
To provide you with better understanding on some usages of the Eclipse
Plugin,
you can take a look into the following examples:
- * {{{examples/prevent-module-references.html}Prevent Module References}}
+ * {{{./examples/prevent-module-references.html}Prevent Module References}}
+
+ * {{{./examples/attach-library-sources.html}Attach Library Sources}}
+
+ * {{{./examples/provide-project-natures-and-build-commands.html}Provide
Project Natures and Build Commands}}
+
+ * {{{./examples/additional-facets.html}Adding additional facets}}
+
+ * {{{./examples/load-code-styles.html}Load Code Style file}}
+
+ * {{{./examples/configure-checkstyle.html}Configure Checkstyle}}
- * {{{examples/attach-library-sources.html}Attach Library Sources}}
+ * {{{./examples/multi-module-projects.html}Multi-module projects with WTP}}
- * {{{examples/provide-project-natures-and-build-commands.html}Provide
Project Natures and Build Commands}}
+ * {{{./examples/ajdt-projects.html}AJDT projects}}
- * {{{examples/additional-facets.html}Adding additional facets}}
+ *
{{{./examples/specifying-source-path-inclusions-and-exclusions.html}Specifying
source path inclusions and exclusions}}
- * {{{examples/load-code-styles.html}Load Code Style file}}
-
- * {{{examples/configure-checkstyle.html}Configure Checkstyle}}
-
- * {{{examples/multi-module-projects.html}Multi-module projects with WTP}}
-
- * {{{examples/ajdt-projects.html}AJDT projects}}
-
- *
{{{examples/specifying-source-path-inclusions-and-exclusions.html}Specifying
source path inclusions and exclusions}}
+ []
* Trouble Shooting
- See {{{trouble-shooting/index.html}Trouble Shooting}} for more details.
\ No newline at end of file
+ See {{{./trouble-shooting/index.html}Trouble Shooting}} for more details.
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=801632&r1=801631&r2=801632&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 Thu Aug
6 12:52:40 2009
@@ -7,6 +7,26 @@
22-01-2006
------
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
Multiple Module Projects
* Project layout
@@ -72,9 +92,9 @@
+----+
<parent>
- <groupId>guide.ide.eclipse</groupId>
- <artifactId>guide-ide-eclipse</artifactId>
- <version>1.0-SNAPSHOT</version>
+ <groupId>guide.ide.eclipse</groupId>
+ <artifactId>guide-ide-eclipse</artifactId>
+ <version>1.0-SNAPSHOT</version>
</parent>
+----+
@@ -129,7 +149,7 @@
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
- {{{usage.html}Maven as an external tool}}. Of course, all referenced artifacts
+ {{{./usage.html}Maven as an external tool}}. Of course, all referenced
artifacts
must be available from your maven repository.
Modified:
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/trouble-shooting/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/trouble-shooting/index.apt?rev=801632&r1=801631&r2=801632&view=diff
==============================================================================
---
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/trouble-shooting/index.apt
(original)
+++
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/trouble-shooting/index.apt
Thu Aug 6 12:52:40 2009
@@ -6,13 +6,33 @@
03 June 2009
------
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
Trouble Shooting
A list of more in-depth trouble shooting guides
-
+
* The JDK being used is different than you expected.
After running mvn eclipse:eclipse your project's are using a different JDK
than expected.
-
- See {{{jdk-being-used-is-different-than-expected.html}jdk being used is
different than expected}}.
-
+
+ See {{{./jdk-being-used-is-different-than-expected.html}jdk being used is
different than expected}}.
+
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=801632&r1=801631&r2=801632&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 Thu Aug 6
12:52:40 2009
@@ -5,7 +5,27 @@
------
28 October 2005
------
-
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
Maven Eclipse Plugin: Usage
This mini guide explains howto use Maven in Eclipse IDE.
@@ -45,7 +65,7 @@
From the menu bar, select Window > Preferences. Select the Run/Debug > String
Substitution. Add a new variable e.g. <maven_exec>.
-
+
When you set up a new external launcher (from the menu bar, select Run >
External Tools. Select Program) you can refer to <maven_exec> in the location
field.
@@ -72,17 +92,17 @@
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.
-
+
* {Project with Dependencies}
If your maven project has dependencies, the eclipse classpath will be
synchronised with the current list of maven dependencies, as well as
any transitive maven dependencies.
-
+
After making changes to your maven dependencies inside the pom file,
rerun <eclipse:eclipse> and refresh your eclipse workspace for the
new dependencies to take effect.
-
+
* {Multiple Module Projects}
If your maven project consists of a number of aggregated projects with
@@ -90,17 +110,17 @@
each other, the <eclipse:eclipse> goal will configure each dependent
project in eclipse as an eclipse project dependency, rather than an
eclipse jar dependency.
-
+
By doing this, changes to code within project A will be available immediately
to project B, assuming that project B defines a dependency on project A.
-
- For further details, see {{{reactor.html}Multiple Module Projects}}.
-
+
+ For further details, see {{{./reactor.html}Multiple Module Projects}}.
+
* {Eclipse PDE Projects}
This plugin is capable of creating and / or synchronising an Eclipse
Plugin Development Environment project.
-
+
For further details, see the configuration instructions
- {{{pde.html}here}}.
-
+ {{{./pde.html}here}}.
+
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=801632&r1=801631&r2=801632&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 Thu Aug 6
12:52:40 2009
@@ -19,7 +19,11 @@
under the License.
-->
-<faqs id="FAQ" title="Frequently Asked Questions">
+
+<faqs xmlns="http://maven.apache.org/FML/1.0.1";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/FML/1.0.1
http://maven.apache.org/xsd/fml-1.0.1.xsd";
+ 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>
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=801632&r1=801631&r2=801632&view=diff
==============================================================================
--- maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml Thu Aug 6
12:52:40 2009
@@ -19,7 +19,10 @@
under the License.
-->
-<project>
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0
http://maven.apache.org/xsd/decoration-1.0.0.xsd";
+ name="Maven Eclipse plugin">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
