You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by hi...@apache.org on 2008/05/09 22:15:17 UTC
svn commit: r654930 - in /ant/ivy/ivyde/trunk/doc: ./ images/
Author: hibou
Date: Fri May 9 13:15:16 2008
New Revision: 654930
URL: http://svn.apache.org/viewvc?rev=654930&view=rev
Log:
Updated documentation to be synchronized with the trunk version of the plugin
Added:
ant/ivy/ivyde/trunk/doc/images/build_path_edit.jpg (with props)
ant/ivy/ivyde/trunk/doc/images/cp_advanced_conf.jpg (with props)
Removed:
ant/ivy/ivyde/trunk/doc/images/ivy_console_selection.jpg
ant/ivy/ivyde/trunk/doc/images/project_pref.jpg
Modified:
ant/ivy/ivyde/trunk/doc/cp_container.html
ant/ivy/ivyde/trunk/doc/editor.html
ant/ivy/ivyde/trunk/doc/images/add_lib.jpg
ant/ivy/ivyde/trunk/doc/images/build_path_menu.jpg
ant/ivy/ivyde/trunk/doc/images/cp_configuration.jpg
ant/ivy/ivyde/trunk/doc/images/cp_node.jpg
ant/ivy/ivyde/trunk/doc/images/cp_resolve.jpg
ant/ivy/ivyde/trunk/doc/images/ivy_console.jpg
ant/ivy/ivyde/trunk/doc/images/ivy_file_def.jpg
ant/ivy/ivyde/trunk/doc/images/pref.jpg
ant/ivy/ivyde/trunk/doc/index.html
ant/ivy/ivyde/trunk/doc/maven.html
ant/ivy/ivyde/trunk/doc/toc.json
Modified: ant/ivy/ivyde/trunk/doc/cp_container.html
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/cp_container.html?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/cp_container.html (original)
+++ ant/ivy/ivyde/trunk/doc/cp_container.html Fri May 9 13:15:16 2008
@@ -35,32 +35,25 @@
</tr>
</table>
</div>
-<h1>Content</h1>
-<ul>
-<li><a href="#start">Start with IvyDE</a></li>
-<li><a href="#inlife">IvyDE in Project Life</a></li>
-<li><a href="#console">Ivy Console</a></li>
-<li><a href="maven.html">Using IvyDE with a maven pom ...</a></li>
-</ul>
-<h1><a name="start"></a>Start with IvyDE</h1>
+<h1><a name="start"></a>Create the container</h1>
You've just installed the IvyDE plugin from our <a href="../../download.html">updatesite</a>, and now you want to enjoy it quickly!<br/>
Nothing easier, just follow these steps:
<ul>
-<li>Ensure the ivyconf URL is set in your <a href="index.html#project_pref">project properties</a> or <a href="index.html#pref">eclipse preferences</a>.<br/><br/></li>
<li>Ensure the ivy.xml file or <a href="maven.html">maven pom.xml</a> can be accessed under the project folder of your eclipse "Navigator" view.<br/><br/></li>
<li>Open the "Add Library" form of Eclipse (In package Explorer, in popup menu of your project choose : [Build Path]/[Add Libraries]).<br/><br/><center><img src="images/build_path_menu.jpg"/></center><br/><br/></li>
<li>Select "IvyDE Managed Dependencies" item.<br/><br/><center><img src="images/add_lib.jpg"/></center><br/><br/></li>
-<li>Select an ivy.xml file or a <a href="maven.html">maven pom.xml</a> and the desired configurations.<br/><br/><center><img src="images/ivy_file_def.jpg"/></center></li>
+<li>Select an ivy.xml file or a <a href="maven.html">maven pom.xml</a> and the desired configurations.<br/><br/><center><img src="images/ivy_file_def.jpg"/></center><br/><br/></li>
+<li><a name="localconf"></a>You then might want to have a special configuration for your project, a configuration different from the <a href="index.html#pref">global one</a>. Then select the "Advanced" panel and click on "Enable project specific settings". Every configuration entry behaves exactly is the same way as the <a href="index.html#pref">global ones</a>.<br/><br/><center><img src="images/cp_advanced_conf.jpg"/></center></li>
</ul><br/>
Your class path is set and you can see all dependencies in one unique folder of the package explorer (folder name = &amp;lt;ivy file name&amp;gt;[&amp;lt;configuration&amp;gt;]).<br/><br/>
<center>
<img src="images/cp_node.jpg">
</center>
+<h1><a name="inlife"></a>Edit the container configuration</h1>
-<h1><a name="inlife"></a>IvyDE in project life</h1>
<h2>Configure Ivy file and configuration</h2>
During life of your project you can change the ivy.xml file or <a href="maven.html">maven pom.xml</a> and change the configuration you want
to use.<br/>
@@ -68,19 +61,19 @@
<br/><br/>
<center><img src="images/cp_configuration.jpg"></center>
<br/>
+You can also edit it via the build path configuration. Open the build path configuration dialog, select the "Libraries" panel and select the IvyDE classpath container. Then you will be able to click on the button "Edit": the IvyDE classpath container configuration dialog will pop up.
+This is particularly useful when Eclipse hides the empty classpath containers (since Eclipse 3.3), and then this is only way to trigger a resolve.
+<br/><br/>
+<center><img src="images/build_path_edit.jpg"></center>
+<br/>
<h2>Resolve dependencies</h2>
You can explicitly ask for a dependencies resolution from your class path container.
-<br/>This command will invoke the "resolve" ivy task and update your class path container.
-<br/><br/>
-<center><img src="images/cp_resolve.jpg"></center>
-<h1><a name="console"></a>The Ivy Console</h1>
-The Ivy console provide you all the Ivy working traces that you were used to see in your command console. This view will be really useful to understand what Ivy and IvyDE are performing for you.<br/>
-The Ivy Console can be accessed with your eclipse Console view, selecting the "Ivy Console" item.<br/>
-<br/>
-<center><img src="images/ivy_console_selection.jpg"></center><br/>
-<br/>
-<center><img src="images/ivy_console.jpg"></center><br/>
+This command will invoke the "resolve" ivy task and update your class path container.
+
+There is also a "refresh" action: this action is similar to the resolve one, it just doesn't do a full resolve if a report already exists in the cache. This is particularly useful if you work also with ant and a command line so you won't do two full resolve.
+<br/><br/>
+<center><img src="images/cp_resolve.jpg"></center><br/>
</textarea>
<script type="text/javascript">xooki.postProcess();</script>
</body>
Modified: ant/ivy/ivyde/trunk/doc/editor.html
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/editor.html?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/editor.html (original)
+++ ant/ivy/ivyde/trunk/doc/editor.html Fri May 9 13:15:16 2008
@@ -38,8 +38,8 @@
</ul>
-<h1><a name="wizard">Wizard</a></h1>
-IvyDE comes with a wizard that allows you to create an ivy file for your project.<br/>
+<h1><a name="wizard"></a>Wizard</h1>
+IvyDE comes with a wizard that allows you to create an ivy.xml file for your project.<br/>
To open the wizard choose File->New->Other in the Eclipse menu (Ctrl+N by default)<br/>
The Ivy wizard is accessible in the category Other. Select it then click Next<br/><br/>
<img src="images/wizard1.jpg"/><br/><br/>
@@ -48,19 +48,19 @@
<ol><b>Wizard fields:</b>
<li> Container: you have to select the targeted project. (This is already set if you access the wizard thanks right click menu on your project root folder)</li>
<li> File name: the ivy file name. (ivy.xml by default and its better to keep it in most of case)</li>
- <li> Organisation: the component owner name. (your company name or the company that provides the component if you are writing ivy file for 3rd party jars). Note this value can be set in the <a href="../ivyde.html#pref">ivy preference page</a></li>
+ <li> Organisation: the component owner name. (your company name or the company that provides the component if you are writing ivy.xml file for 3rd party jars). Note this value can be set in the <a href="index.html#pref">Ivy preference page</a></li>
<li> Module name: the component name.</li>
- <li> Status: the status of the project. (integration by default since we have just created its ivy file :-). Please refer to <a href="http://ant.apache.org/ivy/history/latest-milestone/index.html">Ivy documentation for more details</a>)</li>
+ <li> Status: the status of the project. (integration by default since we have just created its ivy file :-). Please refer to <a href="../../../history/latest-milestone/index.html">Ivy documentation for more details</a>)</li>
</ol>
-When the form is correctly filled you can press Finish button. Eclipse will automatically open the Ivy <a href="editor.html#editor">editor</a>.<br/>
+When the form is correctly filled you can press Finish button. Eclipse will automatically open the Ivy <a href="#editor">editor</a>.<br/>
-<h1><a name="editor">Ivy Editor</a></h1>
+<h1><a name="editor"></a>Ivy Editor</h1>
-<h2><a name="xmleditor">Xml Editor</a></h2><br/>
+<h2><a name="xmleditor"></a>Xml Editor</h2><br/>
<img src="images/editor1.jpg"/><br/><br/>
The Ivy's eclipse editor provides xml syntax coloration, tag completion, tag's attribute names completion, and for dependency and configuration tag value completion.<br/>
-Completion comes with contextual help. The completion popup is displayed when hitting simultaneously the CTRL and the SPACE keys.</br>
-<ul><b>Available completions:</b>
+Completion comes with contextual help. The completion popup is displayed when hitting simultaneously the CTRL and the SPACE keys.<br/><br/>
+<b>Available completions:</b><ul>
<li><b>Xml structure</b>: allows you quickly to insert the good tag at its right place. If the tag can have nested children both notations, simple tag and open tag, are proposed<br/><br/><img src="images/completion1.jpg"/></li>
<li><b>Tag attributes</b>: when your cursor is placed in a tag bracket the completion show available attributes for the enclosing tag.<br/><br/><img src="images/completion2.jpg"/></li>
<li><b>Attributes values</b>: when your cursor is placed in the quote of an attribute value the completion shows available values for the matching attribute.
@@ -79,7 +79,7 @@
</li>
</ul>
-<h2><a name="htmlrendering">Html rendering</a></h2><br/>
+<h2><a name="htmlrendering"></a>Html rendering</h2><br/>
Ivy editor is a multi tabs editor. Located on the bottom of the editor you will found a tab named preview that allows to view the ivy file as an html file.<br/>
Note : for now, as we let the browser do the XSLT processing on a remote file this feature only work with IE. Mozilla browser will display a blank page due its security policy. (If you know a workaround please put it on the mailing list)<br/><br/>
<img src="images/preview.jpg"/>
Modified: ant/ivy/ivyde/trunk/doc/images/add_lib.jpg
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/add_lib.jpg?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
Binary files - no diff available.
Added: ant/ivy/ivyde/trunk/doc/images/build_path_edit.jpg
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/build_path_edit.jpg?rev=654930&view=auto
==============================================================================
Binary file - no diff available.
Propchange: ant/ivy/ivyde/trunk/doc/images/build_path_edit.jpg
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Modified: ant/ivy/ivyde/trunk/doc/images/build_path_menu.jpg
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/build_path_menu.jpg?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
Binary files - no diff available.
Added: ant/ivy/ivyde/trunk/doc/images/cp_advanced_conf.jpg
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/cp_advanced_conf.jpg?rev=654930&view=auto
==============================================================================
Binary file - no diff available.
Propchange: ant/ivy/ivyde/trunk/doc/images/cp_advanced_conf.jpg
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Modified: ant/ivy/ivyde/trunk/doc/images/cp_configuration.jpg
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/cp_configuration.jpg?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
Binary files - no diff available.
Modified: ant/ivy/ivyde/trunk/doc/images/cp_node.jpg
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/cp_node.jpg?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
Binary files - no diff available.
Modified: ant/ivy/ivyde/trunk/doc/images/cp_resolve.jpg
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/cp_resolve.jpg?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
Binary files - no diff available.
Modified: ant/ivy/ivyde/trunk/doc/images/ivy_console.jpg
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/ivy_console.jpg?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
Binary files - no diff available.
Modified: ant/ivy/ivyde/trunk/doc/images/ivy_file_def.jpg
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/ivy_file_def.jpg?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
Binary files - no diff available.
Modified: ant/ivy/ivyde/trunk/doc/images/pref.jpg
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/pref.jpg?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
Binary files - no diff available.
Modified: ant/ivy/ivyde/trunk/doc/index.html
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/index.html?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/index.html (original)
+++ ant/ivy/ivyde/trunk/doc/index.html Fri May 9 13:15:16 2008
@@ -30,36 +30,34 @@
<li><a href="cp_container.html">Class path container</a>: Automatic downloads, access "resolve" task from your IDE</li>
</ul>
-<h1>Content</h1>
-<ul>
-<li><a href="#install">Installation</a></li>
-<li><a href="#pref">Eclipse Preference</a></li>
-<li><a href="#project_pref">Project Preference</a></li>
-</ul>
+Then you are probably interested by the [[console Ivy console]] which contains every log from Ivy. So it is really helpful when trying to find why a resolve failed.
<h1><a name="install"></a>Plugin installation</h1>
-IvyDE has not yet been released within the Apache Software Foundation. For the moment you can use the old location of IvyDE for installation:
-<ul>
-<li>the update site : http://update.jayasoft.org/ </li>
-<li><a href="download.html">download</a> the binaries and unzip it in your eclipse root folder</li>
-</ul>
+
+Before trying to use it, let's install it!
+
+The trunk version has not been release yet, so you should install it by [[build building it yourself]].
<h1><a name="pref"></a>Eclipse Preference Page</h1>
-<img src="images/pref.jpg"/><br/><br/><br/>
-<ol><b>Preference fields:</b>
- <li> Ivyconf URL : specify here the path to your ivyconf file. Leave it blank to use ivy default resolvers</li>
- <li> Retrieve option : specify here if you want ivy to do a retrieve after the resolve.<br/> If you check retrieve you must provide a the retreive pattern. Check <a href="ivy/doc/use/retrieve.html">ivy documentation</a> for pattern explanation.
-</li>
- <li> Organisation: your company name for ivy editor completion </li>
- <li> Organisation Url: your company web site url for ivy editor completion </li>
-</ol>
+There is a global configuration page, which control the behaviour of every Ivy instance in every project. You can also configure it <a href="cp_container.html#localconf">by project</a>.
-<h1><a name="project_pref"></a>Project Preference Page</h1>
-<img src="images/project_pref.jpg"/><br/><br/><br/>
+The global configuration can be found in the global configuration panel of Eclipse (menu Window>Preferences for Windows and Linux users, Eclipse>Preferences for mac users), and select the item Ivy.
+
+<img src="images/pref.jpg"/><br/>
<ol><b>Preference fields:</b>
- <li> URL : specify here the path to your ivyconf file in scope of project. Leave it blank to use ivyconf file defined in eclipse properties (see <a href="ivyde.html#pref">eclipse properties</a>) or use "default" to use ivy default resolvers</li>
+ <li><u>Ivy settings URL:</u> specify here the path to your ivy settings file. Leave it blank to use Ivy default resolvers</li>
+ <li><u>Retrieve option:</u> specify here if you want ivy to do a retrieve after the resolve.<br/> If you check retrieve you must provide a the retrieve pattern. Check <a href="../../../history/latest-milestone/use/retrieve.html">Ivy documentation</a> for pattern explanation.</li>
+ <li><u>Accepted types:</u> a comma separated list of extensions which will make IvyDE add the artifact to the classpath</li>
+ <li><u>Sources types:</u> a comma separated list of ivy "type" which will make IvyDE consider them as sources</li>
+ <li><u>Sources suffixes:</u> a comma separated list of suffixes which will make IvyDE attach as source the artifact with the suffix to the artifact without the suffix. For instance, "commons-lang-sources.jar" will be attached as source to "commons-lang.jar" with the default value.</li>
+ <li><u>Javadoc types:</u> same as sources types but for javadocs</li>
+ <li><u>Javadoc suffixes:</u> same as sources suffixes but for javadocs</li>
+ <li><u>Order alphabetically:</u> by default in the classpath container the entries are ordered by order of declaration. When there are many entries, it could be useful to have them ordered alphabetically so that you can find them faster.</li>
+ <li><u>Organisation:</u> your company name for ivy editor completion </li>
+ <li><u>Organisation URL:</u> your company web site url for ivy editor completion </li>
</ol>
+
</textarea>
<script type="text/javascript">xooki.postProcess();</script>
</body>
Modified: ant/ivy/ivyde/trunk/doc/maven.html
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/maven.html?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/maven.html (original)
+++ ant/ivy/ivyde/trunk/doc/maven.html Fri May 9 13:15:16 2008
@@ -33,7 +33,7 @@
</ul>
<h1><a name="one"></a>Maven1 Sample</h1>
<p>This sample presents a simple use case of maven pom for IvyDE class path container. We are going to create an eclipse project on commons-httpclient sources.</p>
-<p><b> - Download the <a href="">commons httpclient sources</a></b></p>
+<p><b> - Download the <a href="http://archive.apache.org/dist/httpcomponents/commons-httpclient/3.0/source/commons-httpclient-3.0-src.zip">commons httpclient sources</a></b></p>
<p><b> - Unzip this file (c:/tmp/commons-httpclient/)</b></p>
<p><b> - Create a new Eclipse java project based on the unzipped sources (c:/tmp/commons-httpclient/)</b><br />
<center><img src="images/httpProject_errors.jpg"><br/><br />
@@ -50,21 +50,21 @@
<h1><a name="two"></a>Maven2 Sample</h1>
<p>This sample shows that IvyDE Class path container on a Maven2 pom can handle transitive dependancies.</p>
<p><b> - Create a new empty java project in eclipse.</b></p>
-<p><b> - In your Ivy project configuration, set the ivy conf file below (Project/Properties/Ivy):</b></p>
-<code><ivyconf>
- <conf defaultResolver="ibiblio-maven2"/>
+<p><b> - In your Ivy project configuration, set the ivy settings file below (Project/Properties/Ivy):</b></p>
+<code><ivysettings>
+ <conf defaultResolver="ibiblio"/>
<resolvers>
- <ibiblio name="ibiblio-maven2" m2compatible="true" />
+ <ibiblio name="ibiblio" />
</resolvers>
-</ivyconf>
+</ivysettings>
</code>
<p>Using the m2compatible attribute, you can benefit from Maven2 repository compatibility.<br/><br />
<b> - Add the pom below in your project and select it for an IvyDE class path container choosing "compile" and "runtime" configurations.</b><br/></p>
<code>
<project>
<modelVersion>4.0.0</modelVersion>
- <groupId>fr.jayasoft</groupId>
- <artifactId>maven2sample</artifactId>
+ <groupId>com.mycompany</groupId>
+ <artifactId>myproject</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
Modified: ant/ivy/ivyde/trunk/doc/toc.json
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/toc.json?rev=654930&r1=654929&r2=654930&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/toc.json (original)
+++ ant/ivy/ivyde/trunk/doc/toc.json Fri May 9 13:15:16 2008
@@ -26,6 +26,13 @@
]
},
{
+ "id":"console",
+ "title":"Ivy Console",
+ "children": [
+
+ ]
+ },
+ {
"id":"build",
"title":"Building IvyDE",
"children": [