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 13:20:07 UTC
svn commit: r654762 - in /ant/ivy/ivyde/trunk/doc: cp_container.html
editor.html index.html maven.html
Author: hibou
Date: Fri May 9 04:20:07 2008
New Revision: 654762
URL: http://svn.apache.org/viewvc?rev=654762&view=rev
Log:
- minor grammar, spelling and punctuation fixes
- make the internal links not visible (so that when moving the cursor upon them doesn't change the display of the headings)
Modified:
ant/ivy/ivyde/trunk/doc/cp_container.html
ant/ivy/ivyde/trunk/doc/editor.html
ant/ivy/ivyde/trunk/doc/index.html
ant/ivy/ivyde/trunk/doc/maven.html
Modified: ant/ivy/ivyde/trunk/doc/cp_container.html
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/cp_container.html?rev=654762&r1=654761&r2=654762&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/cp_container.html (original)
+++ ant/ivy/ivyde/trunk/doc/cp_container.html Fri May 9 04:20:07 2008
@@ -24,15 +24,14 @@
</head>
<body>
<textarea id="xooki-source">
-You are fed up with updating the class path of all your projects each time you add or remove one dependency!<br/>
-<a href="index.html">IvyDE</a> will help you ! Better ... it will work for you!<br/>
-Indeed, <a href="index.html">IvyDE</a> can manage for you all your dependencies, based on a dependencies descriptor file (like Ivy xml file) it will provide a class path container for your IDE.<br/>
+You are fed up with updating the class path of all your projects each time you add or remove one dependency! <a href="index.html">IvyDE</a> will help you ! Better ... it will work for you!<br/>
+Indeed, <a href="index.html">IvyDE</a> can manage for you all your dependencies, based on a dependencies descriptor file (like ivy.xml file) it will provide a class path container for your IDE.<br/>
<div style="padding:20px;">
<table>
<tr>
<td><a href="maven.html"><img src="images/genial.jpg"></a></td>
<td> </td>
-<td>Obviously IvyDe class path container can be based on a <b>Ivy xml</b> file, <br/>but it also manages <a href="maven.html">Maven Pom !!!</a></td>
+<td>Obviously IvyDE class path container can be based on a <b>ivy.xml</b> file, but it also manages <a href="maven.html">Maven pom.xml file!</a></td>
</tr>
</table>
</div>
@@ -44,43 +43,40 @@
<li><a href="maven.html">Using IvyDE with a maven pom ...</a></li>
</ul>
-<h1><a name="start">Start with IvyDE</a></h1>
+<h1><a name="start"></a>Start with IvyDE</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</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 pachage 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>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</a> and 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></li>
</ul><br/>
-Your class path is set and you can see all dependencies in one unique folder of package explorer (folder name = <ivy file name>[<configuration>]).<br/><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">IvyDE in project life</a></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</a> and change the configuration you want
+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/>
-These properties can be accessed by contextual menu of class path container.
+These properties can be accessed by contextual menu of the IvyDE class path container.
<br/><br/>
<center><img src="images/cp_configuration.jpg"></center>
<br/>
<h2>Resolve dependencies</h2>
-You can explicitly command a dependencies resolution from your class path container.
+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">The Ivy Console</a></h1>
-The Ivy console provide you all the Ivy working traces that you were used to see in<br/>
-your command console. This view will be really usefull to understand what Ivy and IvyDE<br/>
-are performing for you.<br/>
-The Ivy Console can be access by your eclipse Console view, selecting the "Ivy Console" item.<br/>
+<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/>
Modified: ant/ivy/ivyde/trunk/doc/editor.html
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/editor.html?rev=654762&r1=654761&r2=654762&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/editor.html (original)
+++ ant/ivy/ivyde/trunk/doc/editor.html Fri May 9 04:20:07 2008
@@ -39,41 +39,41 @@
<h1><a name="wizard">Wizard</a></h1>
-IvyDE comes with a wizard that allow you to create an ivy file for your projet.<br/>
-To open the wizard choose Fle->New->Other in the eclipse menu (Ctrl+N by default)<br/>
-The Ivy wizard is accesible in the category Other. Select it then click Next<br/><br/>
+IvyDE comes with a wizard that allows you to create an ivy 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/>
The wizard contains only one page, and is very simple.<br/><br/>
<img src="images/wizard2.jpg"/><br/>
<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> 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 ivy documentation for more details )</li>
+ <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> 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>
</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.html#editor">editor</a>.<br/>
<h1><a name="editor">Ivy Editor</a></h1>
<h2><a name="xmleditor">Xml Editor</a></h2><br/>
<img src="images/editor1.jpg"/><br/><br/>
-The Ivy's eclipse editor provides xml syntaxic coloration, tag completion, tag's attribute names completion, and for dependency and configuration tag value completion.<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>
- <li><b>Xml structure</b> : allow you quickly inserts the good tag at its right place. If the tag can have nested childs 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 brackets 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.
+ <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.
<br/>
<ul>Available value completion
- <li> <i>info :</i> organisation (pref based), module (eclipse project name), </li>
- <li> <i>info/ivyauthor : </i>name(pref based), url (pref based)</li>
- <li> <i>info/description : </i>homepage (pref based)</li>
- <li> <i>info/license : </i>name </li>
- <li> <i>info/repository : </i> name (the other attributes depend on it), url, ivys, pattern, artifacts</li>
- <li> <i>configurations/conf : </i> visibility, deprecated, extends </li>
- <li> <i>publications/artifact : </i>type, conf, ext</li>
- <li> <i>dependencies/dependency :</i> org, name, rev are resolved thanks ivy using the ivyconf set in the <a href="index.html#project_pref">project ivy preference page</a>. If not set to "default" ivy uses its defaults resolvers configuration (ie ivyrep + ibiblio), and if not set ivy uses the ivyconf set in the <a href="index.html#pref">eclipse ivy preference page</a>. conf values are computed from current ivy file and the dependency ivy file if any.<br/>
+ <li> <i>info:</i> organisation (pref based), module (eclipse project name), </li>
+ <li> <i>info/ivyauthor: </i>name (pref based), url (pref based)</li>
+ <li> <i>info/description: </i>homepage (pref based)</li>
+ <li> <i>info/license: </i>name </li>
+ <li> <i>info/repository: </i> name (the other attributes depend on it), url, ivys, pattern, artifacts</li>
+ <li> <i>configurations/conf: </i> visibility, deprecated, extends </li>
+ <li> <i>publications/artifact: </i>type, conf, ext</li>
+ <li> <i>dependencies/dependency: </i>org, name, rev are resolved thanks to Ivy using the ivyconf set in the <a href="index.html#project_pref">project Ivy preference page</a>. If not set to "default" Ivy uses its defaults resolvers configuration (ie ivyrep + ibiblio), and if not set Ivy uses the ivyconf set in the <a href="index.html#pref">Eclipse Ivy preference page</a>. conf values are computed from current ivy.xml file and the dependency ivy.xml file if any.<br/>
<br/><img src="images/completion4.jpg"/></li>
</ul>
</li>
@@ -81,7 +81,7 @@
<h2><a name="htmlrendering">Html rendering</a></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 the moment, 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/>
+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"/>
</textarea>
<script type="text/javascript">xooki.postProcess();</script>
Modified: ant/ivy/ivyde/trunk/doc/index.html
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/index.html?rev=654762&r1=654761&r2=654762&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/index.html (original)
+++ ant/ivy/ivyde/trunk/doc/index.html Fri May 9 04:20:07 2008
@@ -37,14 +37,14 @@
<li><a href="#project_pref">Project Preference</a></li>
</ul>
-<h1><a name="install">Plugin installation</a></h1>
+<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>
-<h1><a name="pref">Eclipse Preference Page</a></h1>
+<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>
@@ -55,7 +55,7 @@
<li> Organisation Url: your company web site url for ivy editor completion </li>
</ol>
-<h1><a name="project_pref">Project Preference Page</a></h1>
+<h1><a name="project_pref"></a>Project Preference Page</h1>
<img src="images/project_pref.jpg"/><br/><br/><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>
Modified: ant/ivy/ivyde/trunk/doc/maven.html
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/maven.html?rev=654762&r1=654761&r2=654762&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/maven.html (original)
+++ ant/ivy/ivyde/trunk/doc/maven.html Fri May 9 04:20:07 2008
@@ -25,25 +25,25 @@
<body>
<textarea id="xooki-source">
<h1>General</h1>
-<p>If you want to use a maven pom instead of Ivy xml file, you just have to select a pom file in the configuration form of IvyDE class path.<br/>When a maven pom is selected, the configurations list is updated with all maven scopes.</p>
-<p>Both exemples below are a good illustration of maven pom use simplicity :</p>
+<p>If you want to use a maven pom.xml instead of ivy.xml file, you just have to select a pom file in the configuration form of IvyDE class path.<br/>When a maven pom is selected, the configurations list is updated with all maven scopes.</p>
+<p>Both examples below are a good illustration of maven pom use simplicity :</p>
<ul>
<li><a href="#one">Maven1 sample</a></li>
<li><a href="#two">Maven2 sample</a></li>
</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>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> - 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 />
+<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 />
-<u><b>Notes :</b></u> your project do not compile : some imports cannot be resolved.<br />
+<u><b>Notes:</b></u> your project do not compile: some imports cannot be resolved.<br />
</center><br />
<b> - Add a new class path container based on the "project.xml" pom and select "default" configuration (maven scope)</b><br />
<center><br />
<img src="images/httpProject_pom.jpg"><br />
</center><br />
-<b> - That's All : Your project compiles !</b><br />
+<b> - That's all : your project compiles !</b><br />
<center><br />
<img src="images/httpProject_clean.jpg"><br />
</center></p>
@@ -76,7 +76,7 @@
</project>
</code>
-<p><b> - That's All ! Your IvyDE class path container get all dependencies even those that were transitive to the commons-httpclient module !</b><br />
+<p><b> - That's all ! Your IvyDE class path container gets all dependencies even those that were transitive to the commons-httpclient module !</b><br />
<br/><br />
<img src="images/maven2classpath.jpg"/></p>
</textarea>