Author: epunzalan
Date: Tue Jul 11 03:19:14 2006
New Revision: 420786
URL: http://svn.apache.org/viewvc?rev=420786&view=rev
Log:
PR: MIDEA-59
- applied current documentation standards for the idea plugin
- removed parameter expressions for plexus components
- synced IdeaMojo parameters with the other Mojos
Added:
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/attach_library_src_doc.apt
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/customize_libraries.apt
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/enable_jvm_5_features.apt
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/prevent_module_references.apt
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/provide_deployment_descriptor_file.apt
maven/plugins/trunk/maven-idea-plugin/src/site/apt/index.apt (contents,
props changed)
- copied, changed from r419401,
maven/plugins/trunk/maven-idea-plugin/src/site/apt/introduction.apt
maven/plugins/trunk/maven-idea-plugin/src/site/apt/library.apt
maven/plugins/trunk/maven-idea-plugin/src/site/apt/usage.apt (contents,
props changed)
- copied, changed from r419401,
maven/plugins/trunk/maven-idea-plugin/src/site/apt/howto.apt
maven/plugins/trunk/maven-idea-plugin/src/site/fml/
maven/plugins/trunk/maven-idea-plugin/src/site/fml/faq.fml
Removed:
maven/plugins/trunk/maven-idea-plugin/src/site/apt/howto.apt
maven/plugins/trunk/maven-idea-plugin/src/site/apt/introduction.apt
Modified:
maven/plugins/trunk/maven-idea-plugin/pom.xml
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/AbstractIdeaMojo.java
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaModuleMojo.java
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaMojo.java
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaProjectMojo.java
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaWorkspaceMojo.java
maven/plugins/trunk/maven-idea-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-idea-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/pom.xml?rev=420786&r1=420785&r2=420786&view=diff
==============================================================================
--- maven/plugins/trunk/maven-idea-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-idea-plugin/pom.xml Tue Jul 11 03:19:14 2006
@@ -2,7 +2,7 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>1</version>
+ <version>2-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-idea-plugin</artifactId>
Modified:
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/AbstractIdeaMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/AbstractIdeaMojo.java?rev=420786&r1=420785&r2=420786&view=diff
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/AbstractIdeaMojo.java
(original)
+++
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/AbstractIdeaMojo.java
Tue Jul 11 03:19:14 2006
@@ -82,9 +82,7 @@
protected boolean overwrite;
/**
- * @parameter
expression="${component.org.apache.maven.artifact.factory.ArtifactFactory}"
- * @required
- * @readonly
+ * @component
*/
protected ArtifactFactory artifactFactory;
@@ -96,7 +94,7 @@
protected ArtifactRepository localRepo;
/**
- * @parameter
expression="${component.org.apache.maven.artifact.resolver.ArtifactResolver}"
+ * @component
*/
protected ArtifactResolver artifactResolver;
Modified:
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaModuleMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaModuleMojo.java?rev=420786&r1=420785&r2=420786&view=diff
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaModuleMojo.java
(original)
+++
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaModuleMojo.java
Tue Jul 11 03:19:14 2006
@@ -47,6 +47,8 @@
import java.util.regex.Pattern;
/**
+ * Creates the module (*.iml) files for IntelliJ Idea
+ *
* @author Edwin Punzalan
* @goal module
* @execute phase="generate-sources"
@@ -64,9 +66,7 @@
private List reactorProjects;
/**
- * @parameter
expression="${component.org.apache.maven.artifact.manager.WagonManager}"
- * @required
- * @readonly
+ * @component
*/
private WagonManager wagonManager;
@@ -78,6 +78,8 @@
private boolean linkModules;
/**
+ * Specify the location of the deployment descriptor file, if one is
provided
+ *
* @parameter expression="${deploymentDescriptorFile}"
*/
private String deploymentDescriptorFile;
@@ -164,6 +166,8 @@
private static Map attemptedDownloads = new HashMap();
/**
+ * Tell IntelliJ IDEA that this module is an IntelliJ IDEA Plugin
+ *
* @parameter default-value="false"
*/
private boolean ideaPlugin;
@@ -176,7 +180,7 @@
WagonManager wagonManager, boolean linkModules,
boolean useFullNames,
boolean downloadSources, String sourceClassifier,
boolean downloadJavadocs,
String javadocClassifier, Library[] libraries, Set
macros, String exclude,
- boolean useShortDependencyNames )
+ boolean useShortDependencyNames, String
deploymentDescriptorFile, boolean ideaPlugin )
{
super.initParam( project, artifactFactory, localRepo,
artifactResolver, artifactMetadataSource, log,
overwrite );
@@ -204,6 +208,10 @@
this.exclude = exclude;
this.dependenciesAsLibraries = useShortDependencyNames;
+
+ this.deploymentDescriptorFile = deploymentDescriptorFile;
+
+ this.ideaPlugin = ideaPlugin;
}
/**
Modified:
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaMojo.java?rev=420786&r1=420785&r2=420786&view=diff
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaMojo.java
(original)
+++
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaMojo.java
Tue Jul 11 03:19:14 2006
@@ -44,9 +44,7 @@
private List reactorProjects;
/**
- * @parameter
expression="${component.org.apache.maven.artifact.manager.WagonManager}"
- * @required
- * @readonly
+ * @component
*/
private WagonManager wagonManager;
@@ -58,6 +56,13 @@
private boolean linkModules;
/**
+ * Specify the location of the deployment descriptor file, if one is
provided
+ *
+ * @parameter expression="${deploymentDescriptorFile}"
+ */
+ private String deploymentDescriptorFile;
+
+ /**
* Whether to use full artifact names when referencing libraries.
*
* @parameter expression="${useFullNames}" default-value="false"
@@ -168,6 +173,13 @@
*/
private boolean dependenciesAsLibraries;
+ /**
+ * Tell IntelliJ IDEA that this module is an IntelliJ IDEA Plugin
+ *
+ * @parameter default-value="false"
+ */
+ private boolean ideaPlugin;
+
public void execute()
throws MojoExecutionException
@@ -200,7 +212,7 @@
mojo.initParam( executedProject, artifactFactory, localRepo,
artifactResolver, artifactMetadataSource, getLog(),
overwrite, executedProject, reactorProjects,
wagonManager, linkModules, useFullNames,
downloadSources, sourceClassifier, downloadJavadocs,
javadocClassifier, libraries, macros,
- exclude, dependenciesAsLibraries );
+ exclude, dependenciesAsLibraries,
deploymentDescriptorFile, ideaPlugin );
mojo.rewriteModule();
}
Modified:
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaProjectMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaProjectMojo.java?rev=420786&r1=420785&r2=420786&view=diff
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaProjectMojo.java
(original)
+++
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaProjectMojo.java
Tue Jul 11 03:19:14 2006
@@ -35,6 +35,8 @@
import java.util.StringTokenizer;
/**
+ * Creates the Project files (*.ipr) for IntelliJ Idea
+ *
* @author Edwin Punzalan
* @goal project
* @execute phase="generate-sources"
Modified:
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaWorkspaceMojo.java
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaWorkspaceMojo.java?rev=420786&r1=420785&r2=420786&view=diff
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaWorkspaceMojo.java
(original)
+++
maven/plugins/trunk/maven-idea-plugin/src/main/java/org/apache/maven/plugin/idea/IdeaWorkspaceMojo.java
Tue Jul 11 03:19:14 2006
@@ -25,6 +25,8 @@
import java.io.IOException;
/**
+ * Creates workspace files (*.iws) for IntelliJ Idea
+ *
* @author Edwin Punzalan
* @goal workspace
* @execute phase="generate-sources"
Added:
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/attach_library_src_doc.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/attach_library_src_doc.apt?rev=420786&view=auto
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/attach_library_src_doc.apt
(added)
+++
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/attach_library_src_doc.apt
Tue Jul 11 03:19:14 2006
@@ -0,0 +1,43 @@
+ ------
+ Examples
+ ------
+ Edwin Punzalan
+ ------
+ 10 July 2006
+ ------
+
+
+Attach Sources and/or Javadocs to Library Dependencies
+
+ Artifacts with source and javadoc deployed can be attached to idea libraries
+ using <<<downloadSources>>> and <<<downloadJavadocs>>> respectively. The
+ following example shows how to do this in the command-line:
+
++-----
+mvn idea:idea -DdownloadSources=true -DdownloadJavadocs=true
++-----
+
+ or if one prefers putting the configuration in your pom.xml:
+
++-----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-idea-plugin</artifactId>
+ <configuration>
+ <downloadSources>true</downloadSources>
+ <downloadJavadocs>true</downloadJavadocs>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ [...]
+ </build>
+ [...]
+</project>
++-----
\ No newline at end of file
Added:
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/customize_libraries.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/customize_libraries.apt?rev=420786&view=auto
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/customize_libraries.apt
(added)
+++
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/customize_libraries.apt
Tue Jul 11 03:19:14 2006
@@ -0,0 +1,71 @@
+ ------
+ Examples
+ ------
+ Edwin Punzalan
+ ------
+ 10 July 2006
+ ------
+
+
+Customize the Project's Libraries
+
+ If you do not want to use the packaged artifacts in your local repository and
+ would want to use an alternate url, you can use:
+
++-----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-idea-plugin</artifactId>
+ <configuration>
+ <libraries>
+ <library>
+ <name>junit</name>
+ <sources>file://C:/junit/src/main/java</sources>
+ <classes>file://C:/junit/target/classes</classes>
+ </library>
+ </libraries>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ [...]
+ </build>
+ [...]
+</project>
++-----
+
+ Or to exclude a dependency from appearing on IntelliJ Idea's list of
+ Libraries, you can do:
+
++-----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-idea-plugin</artifactId>
+ <configuration>
+ <libraries>
+ <library>
+ <name>junit</name>
+ <exclude>true</exclude>
+ </library>
+ </libraries>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ [...]
+ </build>
+ [...]
+</project>
++-----
Added:
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/enable_jvm_5_features.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/enable_jvm_5_features.apt?rev=420786&view=auto
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/enable_jvm_5_features.apt
(added)
+++
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/enable_jvm_5_features.apt
Tue Jul 11 03:19:14 2006
@@ -0,0 +1,42 @@
+ ------
+ Examples
+ ------
+ Edwin Punzalan
+ ------
+ 10 July 2006
+ ------
+
+
+Enable Assertions and other JVM 5.0 features supported by IDEA
+
+ IntelliJ IDEA supports JVM 5.0 and its new features. These are not enabled by
+ default if the JVM running is less than 1.5. To enable them, you can use the
+ following command:
+
++-----
+mvn idea:idea -DjdkLevel=1.5
++-----
+
+ or in your pom.xml:
+
++-----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-idea-plugin</artifactId>
+ <configuration>
+ <jdkLevel>1.5</jdkLevel>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ [...]
+ </build>
+ [...]
+</project>
++-----
\ No newline at end of file
Added:
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/prevent_module_references.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/prevent_module_references.apt?rev=420786&view=auto
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/prevent_module_references.apt
(added)
+++
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/prevent_module_references.apt
Tue Jul 11 03:19:14 2006
@@ -0,0 +1,41 @@
+ ------
+ Examples
+ ------
+ Edwin Punzalan
+ ------
+ 10 July 2006
+ ------
+
+
+Prevent Using Module Library References And Use Local Repository Artifacts
+
+ For some reason, if one do not want to use modular (*.iml) references of IDEA
+ projects, one can choose do so using:
+
++-----
+mvn idea:idea -DlinkModules=false
++-----
+
+ or in your pom.xml:
+
++-----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-idea-plugin</artifactId>
+ <configuration>
+ <linkModules>true</linkModules>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ [...]
+ </build>
+ [...]
+</project>
++-----
\ No newline at end of file
Added:
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/provide_deployment_descriptor_file.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/provide_deployment_descriptor_file.apt?rev=420786&view=auto
==============================================================================
---
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/provide_deployment_descriptor_file.apt
(added)
+++
maven/plugins/trunk/maven-idea-plugin/src/site/apt/examples/provide_deployment_descriptor_file.apt
Tue Jul 11 03:19:14 2006
@@ -0,0 +1,53 @@
+ ------
+ Examples
+ ------
+ Edwin Punzalan
+ ------
+ 11 July 2006
+ ------
+
+
+Provide Deployment Descriptor File
+
+ The default deployment descriptor files are:
+
+ * <<<src/main/webapp/WEB-INF/web.xml>>> for war projects.
+
+ * <<<target/application.xml>>> for ear projects.
+
+ * <<<src/main/resources/META-INF/ejb-jar.xml>>> for ejb projects.
+
+ []
+
+ In cases where you want to provide your own descriptor files or if the
+ descriptor files are located somewhere else, you can use the following:
+
+ In the command-line:
+
++-----
+mvn idea:idea -DdeploymentDescriptorFile=src/webapp/WEB-INF/web.xml
++-----
+
+ Or in your pom.xml:
+
++-----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-idea-plugin</artifactId>
+ <configuration>
+
<deploymentDescriptorFile>src/webapp/WEB-INF/web.xml</deploymentDescriptorFile>
+ </configuration>
+ </plugin>
+ [...]
+ </plugins>
+ [...]
+ </build>
+ [...]
+</project>
++-----
\ No newline at end of file
Copied: maven/plugins/trunk/maven-idea-plugin/src/site/apt/index.apt (from
r419401, maven/plugins/trunk/maven-idea-plugin/src/site/apt/introduction.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/apt/index.apt?p2=maven/plugins/trunk/maven-idea-plugin/src/site/apt/index.apt&p1=maven/plugins/trunk/maven-idea-plugin/src/site/apt/introduction.apt&r1=419401&r2=420786&rev=420786&view=diff
==============================================================================
--- maven/plugins/trunk/maven-idea-plugin/src/site/apt/introduction.apt
(original)
+++ maven/plugins/trunk/maven-idea-plugin/src/site/apt/index.apt Tue Jul 11
03:19:14 2006
@@ -1,14 +1,51 @@
------
- Maven 2 Idea Plugin
+ Overview
------
- Johnny R. Ruiz III
- <[EMAIL PROTECTED]>
+ Edwin Punzalan
------
- September 21, 2005
+ 05 July 2006
+ ------
+
+
+Maven IDEA Plugin
+
+ The IDEA Plugin is used to generate files (ipr, iml, and iws) for a project
+ so you can work on it using the IDE, IntelliJ Idea.
+
+* Goals Overview
+
+ The IDEA Plugin has four goals.
+
+ * {{{idea-mojo.html}idea:idea}} is used to execute the other three goals of
+ this plugin: <<<project>>>, <<<module>>>, and <<<workspace>>>.
+
+ * {{{project-mojo.html}idea:project}} is used to generate the project files
+ (*.ipr) needed for an IntelliJ Idea Project.
+
+ * {{{module-mojo.html}idea:module}} is used to generate the module files
+ (*.iml) needed for an IntelliJ Idea Module.
+
+ * {{{workspace-mojo.html}idea:workspace}} is used to generate the workspace
+ files (*.iws) needed for an IntelliJ Idea Project.
+
+ * {{{clean-mojo.html}idea:clean}} is used to delete the files relevant to
+ IntelliJ Idea.
+
+* How To Use
+
+ Instructions on how to use the IDEA Plugin can be found {{{usage.html}here}}.
+
+* Examples
+
+ To provide you with better understanding on some usages of the IDEA Plugin,
+ you can take a look into the following examples:
+
+ * {{{examples/attach_library_src_doc.html}Attach Library Sources And/Or
Javadocs}}
+
+ * {{{examples/customize_libraries.html}Customize Your Libraries}}
-Introduction
+ * {{{examples/enable_jvm_5_features.html}Enable JVM 5 Features}}
- This plugin generates IDEA project file, workspace file, and module file for
a project.
-
-
+ * {{{examples/prevent_module_references.html}Disable Links Between Modules}}
+ * {{{examples/provide_deployment_descriptor_file.html}Provide Deployment
Descriptor File}}
\ No newline at end of file
Propchange: maven/plugins/trunk/maven-idea-plugin/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-idea-plugin/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/plugins/trunk/maven-idea-plugin/src/site/apt/library.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/apt/library.apt?rev=420786&view=auto
==============================================================================
--- maven/plugins/trunk/maven-idea-plugin/src/site/apt/library.apt (added)
+++ maven/plugins/trunk/maven-idea-plugin/src/site/apt/library.apt Tue Jul 11
03:19:14 2006
@@ -0,0 +1,30 @@
+ ------
+ Libraries
+ ------
+ Edwin Punzalan
+ ------
+ 11 July 2006
+ ------
+
+
+Using the Maven IDEA Plugin's <<<Libraries>>> Parameter
+
+ You can control the libraries that are generated by
+ <<<maven-idea-plugin>>> with the use of the <<<library>>>
+ parameter.
+
+ The <<<Library>>> Object can be defined with the following elements:
+
+ * <<<name>>> - The <<<artifactId>>> of the artifact that the
+ Library Object represents.
+
+ * <<<classes>>> - When provided, replaces the jar package from the
+ local repository. These can be comma-separated URLs pointing to the location
+ of this artifact's class files.
+
+ * <<<sources>>> - When provided, replaces the <<<-sources>>> package from the
+ local repository. These can be comma-separated URLs pointing to the location
+ of this artifact's source files.
+
+ * <<<exclude>>> - When set to <<<true>>>, makes the plugin ignore the
artifact
+ from its list of libraries.
Copied: maven/plugins/trunk/maven-idea-plugin/src/site/apt/usage.apt (from
r419401, maven/plugins/trunk/maven-idea-plugin/src/site/apt/howto.apt)
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/apt/usage.apt?p2=maven/plugins/trunk/maven-idea-plugin/src/site/apt/usage.apt&p1=maven/plugins/trunk/maven-idea-plugin/src/site/apt/howto.apt&r1=419401&r2=420786&rev=420786&view=diff
==============================================================================
--- maven/plugins/trunk/maven-idea-plugin/src/site/apt/howto.apt (original)
+++ maven/plugins/trunk/maven-idea-plugin/src/site/apt/usage.apt Tue Jul 11
03:19:14 2006
@@ -1,36 +1,62 @@
------
- Maven 2 Idea Plugin
+ Usage
------
- Johnny R. Ruiz III
- <[EMAIL PROTECTED]>
+ Edwin Punzalan
------
- September 21, 2005
+ 05 July 2006
-How to Use
+Maven IDEA Plugin: Usage
- You can directly use this plugin without configuring anything using the
command "mvn idea:idea".
-
- To configure what JDK name you want to use, you must specify the parameter
"jdkName" in the pom.xml
-
--------------------
-<project>
- ...
- <build>
- ...
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-idea-plugin</artifactId>
- <configuration>
- <jdkName>Put_jdkName_Here</jdkName>
- </configuration>
- </plugin>
- </plugins>
- ...
- </build>
- ...
-</project>
--------------------
+* Generating the IntelliJ Idea project files
- For full documentation, click {{{index.html}here}}.
-
+ To generate the files needed for an IntelliJ Idea Project setup, you need
+ only to execute the main plugin goal, which is <<<idea:idea>>> like so:
+
++-----
+mvn idea:idea
++-----
+
+ The above command will execute the other three goals needed to setup your
+ project for IntelliJ Idea: <<<idea:project>>>, <<<idea:module>>>, and
+ <<<idea:workspace>>>.
+
+ Please note that this plugin has no way to determine the name of the jdk
+ library you are using. By default, this uses the jdk name equivalent to
+ <<<java -version>>> in your machine. If you know the name of the jdk library
+ to use, for example, 1.5, you can then execute:
+
++-----
+mvn idea:idea -DjdkName=1.5
++-----
+
+* Deleting Idea project files
+
+ To delete the project files used by IntelliJ Idea, you can execute the
+ command below:
+
++-----
+mvn idea:clean
++-----
+
+* Creating the Idea project files separately
+
+ If, for some reason, you want to create just the one of the <<<ipr>>>,
+ <<<iml>>>, or <<<iws>>> files, you can still do it.
+
+ To generate just the <<<ipr>>> file, use:
+
++-----
+mvn idea:project
++-----
+
+ To generate just the <<<iml>>> files, use:
+
++-----
+mvn idea:module
++-----
+
+ To generate just the <<<iws>>> file, use:
+
++-----
+mvn idea:workspace
++-----
Propchange: maven/plugins/trunk/maven-idea-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-idea-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/plugins/trunk/maven-idea-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/fml/faq.fml?rev=420786&view=auto
==============================================================================
--- maven/plugins/trunk/maven-idea-plugin/src/site/fml/faq.fml (added)
+++ maven/plugins/trunk/maven-idea-plugin/src/site/fml/faq.fml Tue Jul 11
03:19:14 2006
@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="1">
+ <question>How does the idea plugin work on multi-project</question>
+ <answer>
+ <p>
+ Maven IDEA Plugin, by default, creates the project files (*.ipr) and
+ the workspace files (*.iws) from where the root pom is located. Then
+ module files (*.iml) are created for each of the projects inside the
+ reactor.
+ </p>
+ <p>
+ If some projects depend on another project in the reactor, then the
+ reference to the project is given instead of the hard-references to
+ the local repository copies of the artifacts.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
\ No newline at end of file
Modified: maven/plugins/trunk/maven-idea-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-idea-plugin/src/site/site.xml?rev=420786&r1=420785&r2=420786&view=diff
==============================================================================
--- maven/plugins/trunk/maven-idea-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-idea-plugin/src/site/site.xml Tue Jul 11 03:19:14
2006
@@ -33,9 +33,21 @@
</links>
<menu name="Overview">
- <item name="Introduction" href="introduction.html"/>
- <item name="How to Use" href="howto.html"/>
+ <item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
+ <item name="Usage" href="usage.html"/>
+ <item name="Library Definition" href="library.html"/>
+ <item name="FAQ" href="faq.html"/>
</menu>
+
+ <menu name="Examples">
+ <item name="Attach Library Sources And/Or Javadocs"
href="examples/attach_library_src_doc.html"/>
+ <item name="Customize Your Libraries"
href="examples/customize_libraries.html"/>
+ <item name="Enable JVM 5 Features"
href="examples/enable_jvm_5_features.html"/>
+ <item name="Disable Links Between Modules"
href="examples/prevent_module_references.html"/>
+ <item name="Provide Deployment Descriptor File"
href="examples/provide_deployment_descriptor_file.html"/>
+ </menu>
+
${reports}
</body>
</project>
