You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by br...@apache.org on 2005/01/20 12:19:18 UTC
svn commit: r125756 - in maven/maven-1/core/trunk/xdocs: . developers project reference reference/ide
Author: brett
Date: Thu Jan 20 03:19:17 2005
New Revision: 125756
URL: http://svn.apache.org/viewcvs?view=rev&rev=125756
Log:
documentation updates
Added:
maven/maven-1/core/trunk/xdocs/reference/ide/
maven/maven-1/core/trunk/xdocs/reference/ide/idea.xml
maven/maven-1/core/trunk/xdocs/reference/ide/index.xml
Modified:
maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml
maven/maven-1/core/trunk/xdocs/navigation.xml
maven/maven-1/core/trunk/xdocs/project/components.xml
maven/maven-1/core/trunk/xdocs/reference/index.xml
maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml
Modified: maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml?view=diff&rev=125756&p1=maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml&r1=125755&p2=maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml&r2=125756
==============================================================================
--- maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml (original)
+++ maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml Thu Jan 20 03:19:17 2005
@@ -26,7 +26,7 @@
<body>
<section name="Documentation Conventions">
- <!-- TODO [later]:
+ <!-- TODO [later]: NOT LINKED IN
DRAFT - needs to be reviewed by developers
Think about things like:
Modified: maven/maven-1/core/trunk/xdocs/navigation.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/navigation.xml?view=diff&rev=125756&p1=maven/maven-1/core/trunk/xdocs/navigation.xml&r1=125755&p2=maven/maven-1/core/trunk/xdocs/navigation.xml&r2=125756
==============================================================================
--- maven/maven-1/core/trunk/xdocs/navigation.xml (original)
+++ maven/maven-1/core/trunk/xdocs/navigation.xml Thu Jan 20 03:19:17 2005
@@ -88,6 +88,9 @@
<item name="Project Descriptor" href="/reference/project-descriptor.html" />
<item name="Properties Reference" href="/reference/properties.html" />
<item name="Command Line" href="/reference/command-line.html" />
+ <item name="IDE Integration" href="/reference/ide/index.html" collapse="true">
+ <item name="IntelliJ IDEA" href="/reference/ide/idea.html" />
+ </item>
</item>
</menu>
@@ -107,8 +110,9 @@
<item name="Maven Wagon" /><!-- href="/wagon/index.html" /> -->
<item name="Maven SCM" /><!-- href="/scm/index.html" /> -->
<item name="Components" collapse="true" href="/project/components.html">
- <item name="Maven Model Loader" /><!-- href="/components/maven-model/index.html" /> -->
- <item name="Maven Jelly Tags" /><!-- href="/jelly-tags/index.html" /> -->
+ <item name="Maven Model Library" /><!-- href="/components/maven-model/index.html" /> -->
+<!-- TODO: check link -->
+ <item name="Maven Jelly Tags" /><!-- href="/jelly-tags/index.html" /> -->
</item>
</menu>
@@ -121,7 +125,7 @@
<item name="Jelly" href="http://jakarta.apache.org/commons/jelly/"/>
</menu>
-<!-- TODO: contributing a better name? include submitting patches, etc -->
+<!-- TODO: contributing a better name? include submitting patches, etc. Borrow, share with /dev/ and jakarta -->
<!-- TODO [later]: actually, may want to fold up the whole top of the site when entering the "developer section" -->
<menu name="Developers" type="footer">
<item name="Building from Source" href="/developers/building-from-source.html" />
Modified: maven/maven-1/core/trunk/xdocs/project/components.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/project/components.xml?view=diff&rev=125756&p1=maven/maven-1/core/trunk/xdocs/project/components.xml&r1=125755&p2=maven/maven-1/core/trunk/xdocs/project/components.xml&r2=125756
==============================================================================
--- maven/maven-1/core/trunk/xdocs/project/components.xml (original)
+++ maven/maven-1/core/trunk/xdocs/project/components.xml Thu Jan 20 03:19:17 2005
@@ -26,8 +26,30 @@
<body>
<section name="Components">
- <!-- TODO -->
- <p>...</p>
+ <p>
+ Current versions of Maven are being developed from a series of reusable components.
+ These components, while not fully fledged subprojects, can be reused in your own applications
+ to utilise some of Maven's behaviour.
+ </p>
+ <subsection name="Maven Model Library">
+ <p>
+ The <a href="/components/maven-model/index.html">Maven Model Library</a> is used in Maven 1.1 and above
+ to read project descriptors (<code>project.xml</code> and <code>pom.xml</code>). It also contains
+ the object definitions of the model. It does not, however, handle interpolation or inheritence - this is a
+ job left to the Maven core.
+ </p>
+ <p>
+ You should use this library if you need to load, save, or convert between versions of the Maven model in
+ Java.
+ </p>
+ </subsection>
+ <subsection name="Maven Jelly Tag Library">
+ <p>
+ The <a href="/jelly-tags/index.html">Maven Jelly Tag Library</a> can be used from a Jelly based application
+ to perform the tasks of any of the <code><maven:*/></code> tags.
+ </p>
+ </subsection>
</section>
</body>
</document>
+
Added: maven/maven-1/core/trunk/xdocs/reference/ide/idea.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/ide/idea.xml?view=auto&rev=125756
==============================================================================
--- (empty file)
+++ maven/maven-1/core/trunk/xdocs/reference/ide/idea.xml Thu Jan 20 03:19:17 2005
@@ -0,0 +1,109 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright 2001-2004 The Apache Software Foundation.
+ *
+ * Licensed 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.
+ */
+ -->
+
+<document>
+
+ <properties>
+ <title>Using Maven in IntelliJ IDEA</title>
+ <author email="brett@apache.org">Brett Porter</author>
+ </properties>
+
+ <body>
+ <section name="Using Maven in IntelliJ IDEA">
+ <p>
+ Currently, there is no MevenIDE support for IntelliJ IDEA, however it can still be very useful to
+ configure it as an external tool so that it can be run inside the IDE.
+ </p>
+ <p>
+ To add Maven as an external tool in IntelliJ 4.0+, open the IDE settings, and click the "External Tools" button.
+ From there, press "Add..." to open a new dialog. The following settings should be used:
+ </p>
+ <table>
+ <tr>
+ <th>Name:</th>
+ <td><code>Maven (prompt)</code></td>
+ </tr>
+ <tr>
+ <th>Group:</th>
+ <td><code>Maven</code></td>
+ </tr>
+ <tr>
+ <th>Description:</th>
+ <td><code>Run Maven, prompting me for the goals to run</code></td>
+ </tr>
+ <tr>
+ <th>Program:</th>
+ <td><i>select <code>maven.bat</code> or <code>maven</code> from the <code>MAVEN_HOME/bin</code> directory
+ using the file browser</i></td>
+ </tr>
+ <tr>
+ <th>Parameters:</th>
+ <td><code>$Prompt$</code></td>
+ </tr>
+ <tr>
+ <th>Working Directory:</th>
+ <td><code>$ProjectFileDir$</code></td>
+ </tr>
+ </table>
+ <p>
+ When selected from the tools menu, this will prompt you for the goals to run, and run it from the main
+ project directory.
+ </p>
+ <p>
+ There are other tools you might like to set up in a similar fashion. You can quickly do this by pressing the
+ "Copy..." button and renaming the new tool. Here are some examples:
+ <ul>
+ <li>
+ As above, but use <code>console</code> as the parameters instead of <code>$Prompt$</code>.
+ This will start Maven's console in a small pane inside IntelliJ</li>
+ <li>
+ As above, but use <code>idea</code> (or <code>idea:multiproject</code>) as the parameters.
+ Name this "Regenerate IntelliJ project". When run, it will regenerate all your IntelliJ projects, and
+ IntelliJ will prompt you to reload your project. For more information, see the
+ <a href="/reference/plugins/idea/">IntelliJ IDEA Plugin</a> documentation.
+ </li>
+ <li>
+ As above, but use <code>$FileDir$</code> instead of <code>$ProjectFileDir$</code>. This is useful
+ in a multiproject setup to run a specific goal on a particular module. In this case you should
+ select the "context menu" option instead of the "tools menu" option so that you can right-click on
+ a file in the navigation pane.</li>
+ </ul>
+ </p>
+ <p>
+ Finally, you might like to set up an output filter. In the external tools dialog, press the
+ "Output Filters..." button, and use the following settings:
+ </p>
+ <table>
+ <tr>
+ <th>Name:</th>
+ <td><code>Maven error link</code></td>
+ </tr>
+ <tr>
+ <th>Description:</th>
+ <td><code>Highlight the error of the maven compile goal</code></td>
+ </tr>
+ <tr>
+ <th>Regular expression to match output:</th>
+ <td><code>$FILE_PATH$:$LINE$:.*</code></td>
+ </tr>
+ </table>
+ </section>
+ </body>
+</document>
+
Added: maven/maven-1/core/trunk/xdocs/reference/ide/index.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/ide/index.xml?view=auto&rev=125756
==============================================================================
--- (empty file)
+++ maven/maven-1/core/trunk/xdocs/reference/ide/index.xml Thu Jan 20 03:19:17 2005
@@ -0,0 +1,61 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright 2001-2004 The Apache Software Foundation.
+ *
+ * Licensed 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.
+ */
+ -->
+
+<document>
+
+ <properties>
+ <title>Using Maven in your IDE</title>
+ <author email="brett@apache.org">Brett Porter</author>
+ </properties>
+
+ <body>
+ <section name="Using Maven in your IDE">
+ <p>
+ There are three ways to use Maven with your IDE:
+ <ul>
+ <li>Integrated into the project support</li>
+ <li>As an external tool</li>
+ <li>Using Maven to generate your IDE project settings</li>
+ </ul>
+ </p>
+ <p>
+ Support for IDE integration is provided by the <a href="http://mevenide.codehaus.org/">MevenIDE</a>
+ project. Currently, they support project editing in NetBeans 4.0+ and Eclipse.
+ </p>
+ <p>
+ Using Maven as an external tool is usually quite simple, and allows you to run Maven goals from
+ within your IDE. Specific instructions for setting up your IDE are listed here:
+ <ul>
+ <li><a href="idea.html">IntelliJ IDEA</a></li>
+ </ul>
+ </p>
+ <p>
+ Maven also provides plugins for several IDEs that will generate project files from your Maven
+ project descriptor. Please refer the the plugin documentation for your IDE:
+ <ul>
+ <li><a href="/reference/plugins/idea/">IntelliJ IDEA</a></li>
+ <li><a href="/reference/plugins/eclipse/">Eclipse</a></li>
+ <li><a href="/reference/plugins/jbuilder/">JBuilder</a></li>
+ <li><a href="/reference/plugins/jdee/">JDEE</a></li>
+ </ul>
+ </p>
+ </section>
+ </body>
+</document>
+
Modified: maven/maven-1/core/trunk/xdocs/reference/index.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/index.xml?view=diff&rev=125756&p1=maven/maven-1/core/trunk/xdocs/reference/index.xml&r1=125755&p2=maven/maven-1/core/trunk/xdocs/reference/index.xml&r2=125756
==============================================================================
--- maven/maven-1/core/trunk/xdocs/reference/index.xml (original)
+++ maven/maven-1/core/trunk/xdocs/reference/index.xml Thu Jan 20 03:19:17 2005
@@ -26,8 +26,51 @@
<body>
<section name="Reference">
- <!-- TODO -->
- <p>...</p>
+ <p>
+ The reference section contains the following documents:
+ </p>
+ <table>
+ <tr>
+ <th><a href="glossary.html">Glossary</a></th>
+ <td>
+ The glossary lists several terms used throughout the documentation that you should become familiar with.
+ </td>
+ </tr>
+ <tr>
+ <th><a href="conventions.html">Conventions</a></th>
+ <td>
+ The conventions reference describes some of the best practices recommended by Maven, such as
+ project source layout.
+ </td>
+ </tr>
+ <tr>
+ <th><a href="project-descriptor.html">Project Descriptor</a></th>
+ <td>
+ The project descriptor reference lists all of the fields available in the project descriptor,
+ what they mean and how they are treated.
+ </td>
+ </tr>
+ <tr>
+ <th><a href="properties-reference.html">Properties Reference</a></th>
+ <td>
+ The properties reference lists all of the properties used by the Maven core, their meaning and defaults.
+ It does not describe special properties that configure the various plugins: for those, you should
+ consult the individual plugin documentation.
+ </td>
+ </tr>
+ <tr>
+ <th><a href="command-line.html">Command Line Reference</a></th>
+ <td>
+ The command line reference lists all of the options that can be passed to Maven and their meaning.
+ </td>
+ </tr>
+ <tr>
+ <th><a href="ide/index.html">IDE Integration</a></th>
+ <td>
+ The IDE integration reference includes documentation for using Maven with your favourite IDE.
+ </td>
+ </tr>
+ </table>
</section>
</body>
</document>
Modified: maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml?view=diff&rev=125756&p1=maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml&r1=125755&p2=maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml&r2=125756
==============================================================================
--- maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml (original)
+++ maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml Thu Jan 20 03:19:17 2005
@@ -25,10 +25,52 @@
</properties>
<body>
-<!-- TODO -->
<section name="Internal Repositories">
- <p>...</p>
+ <p>
+ When using Maven, particularly in a corporate environment, connecting to the internet to download dependencies
+ is not acceptable for security, speed or bandwidth reasons. For that reason, it is desirable to set up an
+ internal repository to house a copy of artifacts, and to publish private artifacts to.
+ </p>
+ <p>
+ Such an internal repository can be downloaded from using HTTP or the file system (using a <code>file://</code>
+ URL), and uploaded to using SCP, FTP, or a file copy.
+ </p>
+ <p>
+ Note that as far as Maven is concerned, there is nothing special about this repository: it is another
+ <i>remote repository</i> that contains artifacts to download to a user's local cache, and is a publish
+ destination for artifact releases.
+ </p>
+ <p>
+ Additionally, you may want to share the repository server with your generated project sites. For more
+ information on creating and deploying sites, see <a href="/using/site.html">Creating a Site</a>.
+ </p>
+ <subsection name="Setting up the Internal Repository">
+ <p>
+ To set up an internal repository just requires that you have a place to put it, and then start copying
+ required artifacts there using the same layout as in a remote repository such as
+ <a href="http://www.ibiblio.org/maven/">Ibiblio</a>.
+ </p>
+ <p>
+ It is <b>not</b> recommended that you scrape or rsync:// a full copy of Ibiblio as there is a large amount
+ of data there. You can use a program such as <a href="http://maven-proxy.codehaus.org/">Maven Proxy</a>,
+ running on your internal repository's server, to download from the internet as required and then hold
+ the artifacts in your internal repository for faster downloading later.
+ </p>
+ <p>
+ The other options available are to manually download and vet releases, then copy them to the internal
+ repository, or to have Maven download them for a user, and manually upload the vetted artifacts to the
+ internal repository which is used for releases. This step is the only one available for artifacts where
+ the license forbids their distribution automatically, such as several J2EE JARs provided by Sun.
+ Refer to the <a href="standard-sun-jar-names.html">Standard Sun JAR Names</a> document for more information.
+ </p>
+ <p>
+ It should be noted that Maven intends to include enhanced support for such features in the future,
+ including click through licenses on downloading, and verification of signatures.
+ </p>
+ </subsection>
+<!-- TODO: next sections: using your internal repository (maven.repo.remote), and uploading to your internal
+repository (artifact settings - reference that, and intertwine with releases doco) -->
</section>
-
</body>
</document>
+
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org