Repository: ant-ivyde Updated Branches: refs/heads/master 3f5e4c61d -> c92ed1b92
Review the documentation Project: http://git-wip-us.apache.org/repos/asf/ant-ivyde/repo Commit: http://git-wip-us.apache.org/repos/asf/ant-ivyde/commit/c92ed1b9 Tree: http://git-wip-us.apache.org/repos/asf/ant-ivyde/tree/c92ed1b9 Diff: http://git-wip-us.apache.org/repos/asf/ant-ivyde/diff/c92ed1b9 Branch: refs/heads/master Commit: c92ed1b9247642dfaa67e5cf84528cfa20931c47 Parents: 3f5e4c6 Author: Gintas Grigelionis <[email protected]> Authored: Mon Jun 18 07:51:51 2018 +0200 Committer: Gintas Grigelionis <[email protected]> Committed: Mon Jun 18 07:51:51 2018 +0200 ---------------------------------------------------------------------- doc/src/console.adoc | 2 +- doc/src/cp_container.adoc | 2 +- doc/src/cpc/create.adoc | 8 ++++---- doc/src/cpc/edit.adoc | 2 +- doc/src/cpc/jarmapping.adoc | 26 +++++++++++++------------- doc/src/cpc/launch.adoc | 4 ++-- doc/src/cpc/maven.adoc | 10 +++++----- doc/src/cpc/resolve.adoc | 2 +- doc/src/cpc/workspace.adoc | 2 +- doc/src/cpc/wtp.adoc | 12 ++++++------ doc/src/dev/build.adoc | 6 +++--- doc/src/dev/dev-env-setup.adoc | 2 +- doc/src/index.adoc | 2 +- doc/src/ivyeditor.adoc | 6 +++--- doc/src/non-java.adoc | 10 +++++----- doc/src/preferences.adoc | 12 ++++++------ doc/src/release-notes.adoc | 4 ++-- doc/src/revdepexplorer.adoc | 2 +- 18 files changed, 57 insertions(+), 57 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/console.adoc ---------------------------------------------------------------------- diff --git a/doc/src/console.adoc b/doc/src/console.adoc index 020a3cd..bcff4a1 100644 --- a/doc/src/console.adoc +++ b/doc/src/console.adoc @@ -35,7 +35,7 @@ The colors in the console correspond to the different log levels. Here is the de There are two kinds of logs. The ones from Ivy itself and the ones from IvyDE. The ones from Ivy are the ones you should be used to see when you use it via Ant. -The IvyDE logs are here to help you understand what IvyDE actually do when launching a resolve or refreshing a project. They can be especially useful in debug mode when reporting a bug to the developers of IvyDE. +The IvyDE logs are here to help you understand what IvyDE actually does when launching a resolve or refreshing a project. They can be especially useful in debug mode when reporting a bug to the developers of IvyDE. == Configuration http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/cp_container.adoc ---------------------------------------------------------------------- diff --git a/doc/src/cp_container.adoc b/doc/src/cp_container.adoc index d05fc6e..0e4a6cd 100644 --- a/doc/src/cp_container.adoc +++ b/doc/src/cp_container.adoc @@ -27,5 +27,5 @@ Some of the tasks that can be performed on the container include: * link:cpc/retrieve{outfilesuffix}[Retrieve] the dependencies in your project * Resolve dependencies within the Eclipse link:cpc/workspace{outfilesuffix}[workspace] * link:cpc/launch{outfilesuffix}[Launch] software or unit tests with a classpath managed by IvyDE -* Use IvyDE with link:cpc/maven{outfilesuffix}[Maven pom.xml] +* Use IvyDE with link:cpc/maven{outfilesuffix}[Maven `pom.xml`] * Use IvyDE in concert with link:cpc/wtp{outfilesuffix}[WTP] http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/cpc/create.adoc ---------------------------------------------------------------------- diff --git a/doc/src/cpc/create.adoc b/doc/src/cpc/create.adoc index 77c080c..272e0f7 100644 --- a/doc/src/cpc/create.adoc +++ b/doc/src/cpc/create.adoc @@ -17,11 +17,11 @@ under the License. //// -First, locate an ivy.xml file or a maven pom.xml ready to be used to build a classpath. Also, if necessary, locate a supporting ivysettings.xml. +First, locate an `ivy.xml` file or a Maven `pom.xml` ready to be used to build a classpath. Also, if necessary, locate a supporting `ivysettings.xml`. == Fast creation -For most of the projects, the ivy.xml file (or the pom.xml) is in the Java project. So you can just right click on the ivy.xml and select "Add Ivy Library..." and you can directly access the prefilled setup of the IvyDE classpath container +For most of the projects, the `ivy.xml` (or the `pom.xml`) file is in the Java project. So you can just right click on the `ivy.xml` and select "Add Ivy Library..." and you can directly access the prefilled setup of the IvyDE classpath container image::../images/addivylibrary.jpg[] @@ -37,7 +37,7 @@ image::../images/build_path_menu.jpg[] image::../images/add_lib.jpg[] -* Select an ivy.xml file or a link:maven{outfilesuffix}[Maven pom.xml] and the desired configurations. +* Select an `ivy.xml` or a link:maven{outfilesuffix}[Maven `pom.xml`] file and the desired configurations. image::../images/ivy_file_def.jpg[] @@ -45,6 +45,6 @@ image::../images/ivy_file_def.jpg[] image::../images/project_specific_settings.jpg[] -Now your classpath is set and you can see all dependencies in one unique folder of the package explorer (folder name = ivy-file-name[conf1,conf2]). +Now your classpath is set and you can see all dependencies in one unique folder of the package explorer (folder name = `ivy-file-name[conf1,conf2]`). image::../images/cp_node.jpg[] http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/cpc/edit.adoc ---------------------------------------------------------------------- diff --git a/doc/src/cpc/edit.adoc b/doc/src/cpc/edit.adoc index 423113f..306d957 100644 --- a/doc/src/cpc/edit.adoc +++ b/doc/src/cpc/edit.adoc @@ -17,7 +17,7 @@ under the License. //// -During the life of your project, you can change the ivy.xml file or link:maven{outfilesuffix}[Maven pom.xml] and change its configuration. +During the life of your project, you can change the `ivy.xml` file or link:maven{outfilesuffix}[Maven `pom.xml`] and change its configuration. == Context Menu http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/cpc/jarmapping.adoc ---------------------------------------------------------------------- diff --git a/doc/src/cpc/jarmapping.adoc b/doc/src/cpc/jarmapping.adoc index 248ec77..5130d33 100644 --- a/doc/src/cpc/jarmapping.adoc +++ b/doc/src/cpc/jarmapping.adoc @@ -21,11 +21,11 @@ Apache IvyDE will resolve the dependencies and artifacts you are requiring. Then == Finding jars types -There are three types of jars handled by Eclipse": +There are three types of jars handled by Eclipse: -* the binary jars: they will be added to the classpath in oder to compile and run; they contain the .class files. -* the source jars/zip: they will be bound to the binary one to browse dependency sources; they are basically a zip of .java files -* the javadoc jars/zip: they will be bound to the binary one to browse the API documentation of the dependencies of your project; they are a zip of .html files respectively in a layout produced by javadoc. +* the binary jars: they will be added to the classpath in oder to compile and run; they contain the `.class` files. +* the source jars/zip: they will be bound to the binary one to browse dependency sources; they are basically a zip of `.java` files +* the javadoc jars/zip: they will be bound to the binary one to browse the API documentation of the dependencies of your project; they are a zip of `.html` files respectively in a layout produced by javadoc. To find the binary jars, Apache IvyDE is relying on the "Accepted types" preference field you can find in the link:create{outfilesuffix}[container configuration panel], or in the link:../preferences{outfilesuffix}#classpath[global one]. If the artifact has a type listed here, it is then added to the classpath. @@ -39,13 +39,13 @@ For the javadocs, it is relying on the "Javadocs types". The second step is to bind a source artifact with a binary one. IvyDE has the following algorithm: -* first, it looks up for a specified name in the ivy.xml via the "ivyde" namespace (see bellow) +* first, it looks up for a specified name in the `ivy.xml` file via the "ivyde" namespace (see bellow) * next, if a binary jar has the same artifact name than a source one, there are bound together. * if none matched, then IvyDE search for sources which have one of the suffix specified in "Sources suffixes". === The IvyDE namespace -In the ivy.xml file in your repository, you can specifically bind a binary artifact to a source one and to a javadoc one, so IvyDE knows for sure which bind to the other. +In the `ivy.xml` file in your repository, you can specifically bind a binary artifact to a source one and to a javadoc one, so IvyDE knows for sure which bind to the other. In the link:https://ant.apache.org/ivy/history/latest-milestone/ivyfile/artifact.html[artifact] element, you can specify: @@ -54,20 +54,20 @@ In the link:https://ant.apache.org/ivy/history/latest-milestone/ivyfile/artifact === Examples -For instance, searching for the sources of mylib.jar (type=jar), with the default value of "Sources suffixes" ("-source,-sources,-src"), IvyDE will look to bind it to the first one existing of: +For instance, searching for the sources of mylib.jar (`type="jar"`), with the default value of "Sources suffixes" (`-source,-sources,-src`), IvyDE will look to bind it to the first one existing of: -* mylib.jar (type=source) -* mylib-source.jar (type=source) -* mylib-sources.jar (type=source) -* mylib-src.jar (type=source) +* mylib.jar (`type="source"`) +* mylib-source.jar (`type="source"`) +* mylib-sources.jar (`type="source"`) +* mylib-src.jar (`type="source"`) -Note that Apache IvyDE don't care about the extension, it can be .zip too. +Note that Apache IvyDE don't care about the extension, it can be `.zip` too. Same apply for javadocs with respectively "Javadocs suffixes". ''' -With the IvyDE namespace, having the ivy.xml file: +With the IvyDE namespace, having the `ivy.xml` file: [source] ---- http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/cpc/launch.adoc ---------------------------------------------------------------------- diff --git a/doc/src/cpc/launch.adoc b/doc/src/cpc/launch.adoc index fa9b0bb..1f5ebd7 100644 --- a/doc/src/cpc/launch.adoc +++ b/doc/src/cpc/launch.adoc @@ -43,11 +43,11 @@ Choose "IvyDE Managed dependencies": image::../images/launch_addivyde.jpg[] -Select the absolute path to your ivy.xml and select the proper configurations: +Select the absolute path to your `ivy.xml` file and select the proper configurations: image::../images/launch_manualconf.jpg[] -*Note:* in the launch configuration it is not possible to edit or launch a resolve manually on the container you are creating. But it is possible to launch a resolve before each launch. It is recommended to do so if the resolve process is not too long. Otherwise you will have to recreate the container each time you change something in the ivy.xml for instance. +*Note:* in the launch configuration it is not possible to edit or launch a resolve manually on the container you are creating. But it is possible to launch a resolve before each launch. It is recommended to do so if the resolve process is not too long. Otherwise you will have to recreate the container each time you change something in the `ivy.xml` file for instance. To enable the resolve before each launch, go into the "Advanced" tab and select "Resolve before launch". http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/cpc/maven.adoc ---------------------------------------------------------------------- diff --git a/doc/src/cpc/maven.adoc b/doc/src/cpc/maven.adoc index cd3d114..bef671f 100644 --- a/doc/src/cpc/maven.adoc +++ b/doc/src/cpc/maven.adoc @@ -17,7 +17,7 @@ under the License. //// -If you want to use a Apache Maven(TM) pom.xml instead of an ivy.xml file, you can select a pom file in the configuration options of the IvyDE classpath. +If you want to use a Apache Maven(TM) `pom.xml` instead of an `ivy.xml` file, you can select a POM file in the configuration options of the IvyDE classpath. When a Maven POM is selected, the configurations list is updated with all Maven scopes. @@ -40,7 +40,7 @@ image::../images/httpProject_errors.jpg[] *Note:* your project will not compile: some imports cannot be resolved. -* Add a new classpath container based on the "project.xml" pom and select "default" configuration (Maven scope) +* Add a new classpath container based on the "project.xml" POM and select "default" configuration (Maven scope) image::../images/httpProject_pom.jpg[] @@ -50,7 +50,7 @@ image::../images/httpProject_clean.jpg[] == [[two]]Maven2 Sample -This sample demonstrates how the IvyDE classpath container on a Apache Maven 2 pom can handle transitive dependencies. +This sample demonstrates how the IvyDE classpath container on a Apache Maven POM can handle transitive dependencies. * Create a new empty Java project in Eclipse. @@ -66,7 +66,7 @@ This sample demonstrates how the IvyDE classpath container on a Apache Maven 2 p </ivysettings> ---- -Using the m2compatible attribute, you can benefit from Apache Maven 2 repository compatibility. +Using the `m2compatible` attribute, you can benefit from Apache Maven 2 repository compatibility. * In your project, create a `pom.xml` file: @@ -87,7 +87,7 @@ Using the m2compatible attribute, you can benefit from Apache Maven 2 repository </project> ---- -* On the pom.xml file, open the context menu and click on "Add Ivy Library...": +* On the `pom.xml` file, open the context menu and click on "Add Ivy Library...": * Select the configurations `compile` and `runtime` http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/cpc/resolve.adoc ---------------------------------------------------------------------- diff --git a/doc/src/cpc/resolve.adoc b/doc/src/cpc/resolve.adoc index 6663cf2..6430b32 100644 --- a/doc/src/cpc/resolve.adoc +++ b/doc/src/cpc/resolve.adoc @@ -21,7 +21,7 @@ You can explicitly ask for Ivy dependency resolution from your classpath contain This command will invoke the "resolve" Ivy task and update your classpath container. -There is also a "refresh" action: this action is similar to the resolve one, but does not perform a full resolve if a report already exists in the cache. This is particularly useful if you work with Apache Ant and a command line so that you avoid two full resolves. It is also the default action performed on classpath containers when the Eclipse workspace is opened (*Windows > Preferences > Ivy*), in effect restoring the classpath container to its state prior to the last closing of the workspace if no other action is performed against the ivy.xml in the meantime. +There is also a "refresh" action: this action is similar to the resolve one, but does not perform a full resolve if a report already exists in the cache. This is particularly useful if you work with Apache Ant and a command line so that you avoid two full resolves. It is also the default action performed on classpath containers when the Eclipse workspace is opened (*Windows > Preferences > Ivy*), in effect restoring the classpath container to its state prior to the last closing of the workspace if no other action is performed against the `ivy.xml` file in the meantime. And there is a "reload settings" action: by default IvyDE does reload Ivy settings files each time a resolve it required. But in case the ivy settings file is remote, this take make the user experience quite slow. To work around that, you can check in the link:../preferences{outfilesuffix}[preference page] the option to only load on demand, and use the "reload settings" action in the context menu. http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/cpc/workspace.adoc ---------------------------------------------------------------------- diff --git a/doc/src/cpc/workspace.adoc b/doc/src/cpc/workspace.adoc index ae513f1..fa23a9e 100644 --- a/doc/src/cpc/workspace.adoc +++ b/doc/src/cpc/workspace.adoc @@ -29,7 +29,7 @@ To enable resolution in the workspace, go to the "classpath" panel of the classp image::../images/workspace.jpg[] -Important notes: to make the resolve in workspace work correctly the __info__ in the ivy.xml should be properly set: +Important notes: to make the resolve in workspace work correctly the __info__ in the `ivy.xml` file should be properly set: * The __org__ and __name__ * If there is a __rev__ specified, dependencies should specify the appropriate range http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/cpc/wtp.adoc ---------------------------------------------------------------------- diff --git a/doc/src/cpc/wtp.adoc b/doc/src/cpc/wtp.adoc index df386cb..097c9d4 100644 --- a/doc/src/cpc/wtp.adoc +++ b/doc/src/cpc/wtp.adoc @@ -33,14 +33,14 @@ image::../images/rad_jee_page.jpg[] *Note:* due to a bug in RAD 7.5.3, this IBM specific property is not persisted when we close the workbench and reopen it. To work around this: -* Export RSA preferences ( File > Export > General > Preferences) +* Export RSA preferences (File > Export > General > Preferences) -* Open the exported .epf file and replace + -/instance/org.eclipse.jst.j2ee/org.eclipse.jst.j2ee.preferences.allowClasspathDep=false + +* Open the exported `.epf` file and replace + +`/instance/org.eclipse.jst.j2ee/org.eclipse.jst.j2ee.preferences.allowClasspathDep=false` + with + -/instance/org.eclipse.jst.j2ee/org.eclipse.jst.j2ee.preferences.allowClasspathDep=true +`/instance/org.eclipse.jst.j2ee/org.eclipse.jst.j2ee.preferences.allowClasspathDep=true` -* Load the modified .epf +* Load the modified `.epf` file == [[resolve-in-workspace]]Resolve in workspace @@ -50,7 +50,7 @@ A feature request has been opened in WTP's Bugzilla: see link:https://bugs.eclip If you really want to link a Java project into the classpath of a WTP project, you should follow what is described in the link:https://bugs.eclipse.org/bugs/show_bug.cgi?id=184125#c12[comment #12] and the link:https://bugs.eclipse.org/bugs/show_bug.cgi?id=184125#c17[comment #17]: -* in your ivy.xml of your WTP project, exclude from your dependencies the Java projects you want to link to (you can create a specific Ivy configuration for that, so it won't mess with the configurations used by an Ant build for instance) +* in your `ivy.xml` file of your WTP project, exclude from your dependencies the Java projects you want to link to (you can create a specific Ivy configuration for that, so it won't mess with the configurations used by an Ant build for instance) * make sure your Java project is a WTP "utility" project http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/dev/build.adoc ---------------------------------------------------------------------- diff --git a/doc/src/dev/build.adoc b/doc/src/dev/build.adoc index 7f6e58c..249dc68 100644 --- a/doc/src/dev/build.adoc +++ b/doc/src/dev/build.adoc @@ -17,7 +17,7 @@ under the License. //// -This page describes how to build the Apache IvyDE plugin from the source. The build is based on the Eclipse(TM) build system so it requires an Eclipse install. You also need to have an Ivy bundle installed. +This page describes how to build the Apache IvyDE plugin from the source. The build is based on the Eclipse(TM) build system so it requires an Eclipse installation. You also need to have an Ivy bundle installed. == [[setup]]Setup of the build @@ -67,11 +67,11 @@ And run the build: ant build -DbaseLocation=$ECLIPSE_HOME ---- -Then in the created directory `work` you will find a subdirectory (something like `2.0.0.alpha1-200804171513`) in which you will find the zip archive ready to be unzipped in an Eclipse install. +Then in the created directory `work` you will find a subdirectory (something like `2.0.0.alpha1-200804171513`) in which you will find the zip archive ready to be unzipped in an Eclipse installation. == [[install]]Install -After a successful build you should have a zip file at `dist/org.apache.ivyde.feature-$VERSION.zip`. The zip file contains the `plugins` and `features` directories ready to be unzipped in an Eclipse install. So here is the process: +After a successful build you should have a zip file at `dist/org.apache.ivyde.feature-$VERSION.zip`. The zip file contains the `plugins` and `features` directories ready to be unzipped in an Eclipse installation. So here is the process: [source] ---- http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/dev/dev-env-setup.adoc ---------------------------------------------------------------------- diff --git a/doc/src/dev/dev-env-setup.adoc b/doc/src/dev/dev-env-setup.adoc index c12130b..4523fd2 100644 --- a/doc/src/dev/dev-env-setup.adoc +++ b/doc/src/dev/dev-env-setup.adoc @@ -17,7 +17,7 @@ under the License. //// -This page describe how to setup an environment to develop IvyDE. +This page describe how to set up an environment to develop IvyDE. == Requirement http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/index.adoc ---------------------------------------------------------------------- diff --git a/doc/src/index.adoc b/doc/src/index.adoc index 7845c39..7e39b40 100644 --- a/doc/src/index.adoc +++ b/doc/src/index.adoc @@ -17,7 +17,7 @@ under the License. //// -Apache IvyDE Eclipse plugin integrates Apache Ivy's dependency management into Eclipse(TM). It lets you manage your dependencies declared in an ivy.xml in your Java Eclipse projects, or any other kind of project which needs dependency management. +Apache IvyDE Eclipse plugin integrates Apache Ivy's dependency management into Eclipse(TM). It lets you manage your dependencies declared in an `ivy.xml` file in your Java Eclipse projects, or any other kind of project which needs dependency management. A summary of the features it provides follows: http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/ivyeditor.adoc ---------------------------------------------------------------------- diff --git a/doc/src/ivyeditor.adoc b/doc/src/ivyeditor.adoc index 78af9fa..e506f36 100644 --- a/doc/src/ivyeditor.adoc +++ b/doc/src/ivyeditor.adoc @@ -32,8 +32,8 @@ image::images/wizard2.jpg[] *Wizard fields:* . Container: you must select a target project. (This is already set if you access the wizard through the context menu on your project root folder). -. File name: the Ivy file name (ivy.xml by default). -. Organisation: the component owner name. (your company name or the company that provides the component if you are writing an ivy.xml file for 3rd party jars). Note that this value can be set in the link:preferences{outfilesuffix}[Ivy preference page.] +. File name: the Ivy file name (`ivy.xml` by default). +. Organisation: the component owner name. (your company name or the company that provides the component if you are writing an `ivy.xml` file for 3rd party jars). Note that this value can be set in the link:preferences{outfilesuffix}[Ivy preference page.] . Module name: the component name. . Status: the status of the project. (integration by default since we have just created its Ivy file. Please refer to the link:../../../history/latest-milestone/index.html[Ivy documentation for more details]). @@ -64,7 +64,7 @@ Available value completion: ** __info/repository__: name (the other attributes depend on it), url, ivys, pattern, artifacts ** __configurations/conf__: visibility, deprecated, extends ** __publications/artifact__: type, conf, ext -** __dependencies/dependency__: org, name, rev are resolved thanks to Ivy using the ivyconf set in the link:cpc/edit{outfilesuffix}[project Ivy preference page]. If not set to "default" Ivy uses its defaults resolvers configuration (ie Ivyrep + ibiblio), and if these are not set Ivy uses the ivyconf set in the link:preferences{outfilesuffix}[Eclipse Ivy preference page]. conf values are computed from the current ivy.xml file and the dependency ivy.xml file if any. +** __dependencies/dependency__: org, name, rev are resolved thanks to Ivy using the settings configured in the link:cpc/edit{outfilesuffix}[project Ivy preference page]. If not set to "default" Ivy uses its default resolver configuration (i.e. ivyrep + ibiblio), and if these are not set Ivy uses the settings configured in the link:preferences{outfilesuffix}[Eclipse Ivy preference page]. conf values are computed from the current `ivy.xml` file and the dependency `ivy.xml` file if any. image::images/completion4.jpg[] http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/non-java.adoc ---------------------------------------------------------------------- diff --git a/doc/src/non-java.adoc b/doc/src/non-java.adoc index 5100bf2..544656b 100644 --- a/doc/src/non-java.adoc +++ b/doc/src/non-java.adoc @@ -82,24 +82,24 @@ Now in the "Settings" tab, the setup entries are the same as the link:preference image::images/retrieve_setup_settings.jpg[] -For the sample project, we want to use the ivysettings in the Java project: `${workspace_loc:ivyde-sample-webapp-js-repo/ivysettings.xml}`. +For the sample project, we want to use the Ivy settings in the Java project: `${workspace_loc:ivyde-sample-webapp-js-repo/ivysettings.xml}`. Finally, click *OK* to finish. == Launch a retrieve -Now that the retrieve is setup, a new entry should be available in the "Ivy" context menu. The menu entry should be "Retrieve 'xxx'" where "xxx" is the name you gave to the retrieve setup. For the sample project, it will be "Retrieve 'javascripts'". +Now that the retrieve is set up, a new entry should be available in the "Ivy" context menu. The menu entry should be "Retrieve 'xxx'" where "xxx" is the name you gave to the retrieve setup. For the sample project, it will be "Retrieve 'javascripts'". -Select the entry to actually launch the retrieve. The Eclipse project get automatically refreshed with the retrieved files. For the sample project look into `src/org/apache/ivyde/sample/webappjsrepo/js/jquery-1.7.1.min.js`. +Select the entry to actually launch the retrieve. The Eclipse project gets automatically refreshed with the retrieved files. For the sample project look into `src/org/apache/ivyde/sample/webappjsrepo/js/jquery-1.7.1.min.js`. image::images/launch_standalone_retrieve.jpg[] == Launch the sample webapp -To see the result, we'll launch the Java webapp and look it it your browser locally. +To see the result, we'll launch the Java webapp and look at it in your browser locally. Right click the Java class `org.apache.ivyde.sample.webappjsrepo.HTTPServer` and select "Run As" / "Java Application". Now open the web page http://localhost:8888/index.html -If working properly, the JavaScript files should have been properly loaded and the input field should have automatically been filled with a default value. +If working properly, the JavaScript files should have been loaded and the input field should have automatically been filled with a default value. image::images/webapp-js-repo-launch.jpg[] http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/preferences.adoc ---------------------------------------------------------------------- diff --git a/doc/src/preferences.adoc b/doc/src/preferences.adoc index 35424ef..aceea2c 100644 --- a/doc/src/preferences.adoc +++ b/doc/src/preferences.adoc @@ -39,7 +39,7 @@ Specifies what Apache IvyDE should do in every project containing an IvyDE manag .On Ivy file change: -Controls whether a resolve is performed each time Eclipse detects a change on an ivy.xml file configured by an IvyDE container via a save in the editor, a refresh, or a team/update. +Controls whether a resolve is performed each time Eclipse detects a change on an `ivy.xml` file configured by an IvyDE container via a save in the editor, a refresh, or a team/update. .Organisation: @@ -51,7 +51,7 @@ Your company web site url for Ivy editor completion. .Open a popup on each failed resolve -On a resolve error, IvyDE mark an error on the ivy.xml of the project; if checked it will also open a popup with a detailed error message +On a resolve error, IvyDE mark an error on the `ivy.xml` file of the project; if checked it will also open a popup with a detailed error message == [[advanced]]Advanced @@ -75,11 +75,11 @@ Apache IvyDE allows Ivy dependencies between projects in the workspace to be rea .Resolve dependencies transitively -If unchecked, the dependencies will be resolved with transitivity disabled regardless to the settings in ivy.xml +If unchecked, the dependencies will be resolved with transitivity disabled regardless to the settings in `ivy.xml` file .Read OSGi metadata: -If your classpath is based on jars which are actually OSGi bundles, checking this option will make IvyDE read the jar manifests and setup the specific OSGi visibility constraints. +If your classpath is based on jars which are actually OSGi bundles, checking this option will make IvyDE read the jar manifests and set up the specific OSGi visibility constraints. .Accepted types: @@ -87,7 +87,7 @@ A comma separated list of extensions which will make IvyDE add the artifact to t .Order of the classpath entries: -By default, the classpath container entries are ordered by order of declaration in the ivy.xml. When there are many entries, it can be useful to have them ordered lexically for enhanced readability. +By default, the classpath container entries are ordered by order of declaration in the `ivy.xml` file. When there are many entries, it can be useful to have them ordered lexically for enhanced readability. .Build the classpath with: @@ -163,7 +163,7 @@ When a project is opened, IvyDE will trigger the resolve of every other project .Ignore version when resolving workspace projects: -This option forces the workspace resolver to ignore the version of a module specified in an ivy.xml if a project containing an Ivy file with that module organization and name is found in the workspace, instead substituting a project reference. This may have unintended consequences. +This option forces the workspace resolver to ignore the version of a module specified in an `ivy.xml` file if a project containing an Ivy file with that module organization and name is found in the workspace, instead substituting a project reference. This may have unintended consequences. For further information on how the workspace resolver works, checkout this link:cpc/workspace{outfilesuffix}[specific documentation]. http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/release-notes.adoc ---------------------------------------------------------------------- diff --git a/doc/src/release-notes.adoc b/doc/src/release-notes.adoc index dab12c0..7e12a7a 100644 --- a/doc/src/release-notes.adoc +++ b/doc/src/release-notes.adoc @@ -27,13 +27,13 @@ The Apache IvyDE project is pleased to announce its 2.3.0-rc1 release. -The Apache IvyDE Eclipse plugin integrates Apache Ivy's dependency management into Eclipse. It lets you manage your dependencies declared in an ivy.xml in your Java Eclipse projects, or any other kind of project which needs dependency management. Apache IvyDE will contribute to the classpath of your Java project or you can make it retrieve your dependencies directly into your project. Last but not least Apache IvyDE offer editors of ivy.xml and ivysettings.xml files with completion. Get some preview here: https://ant.apache.org/ivy/ivyde/screenshots.html +The Apache IvyDE Eclipse plugin integrates Apache Ivy's dependency management into Eclipse. It lets you manage your dependencies declared in an `ivy.xml` file in your Java Eclipse projects, or any other kind of project which needs dependency management. Apache IvyDE will contribute to the classpath of your Java project or you can make it retrieve your dependencies directly into your project. Last but not least Apache IvyDE offer editors of `ivy.xml` and `ivysettings.xml` files with completion. Get some preview here: https://ant.apache.org/ivy/ivyde/screenshots.html == [[what]]What is Apache IvyDE? Apache IvyDE is the Eclipse plugin which integrates Apache Ivy's dependency management into Eclipse(TM). -Apache IvyDE lets you manage your dependencies declared in an ivy.xml in your Java Eclipse projects, or any other kind of project which needs dependency management. Apache IvyDE will contribute to the classpath of your Java project or you can make it retrieve your dependencies directly into your project. Last but not least Apache IvyDE offer editors of `ivy.xml` and `ivysettings.xml` files with completion. Get some preview here: https://ant.apache.org/ivy/ivyde/screenshots.html. +Apache IvyDE lets you manage your dependencies declared in an `ivy.xml` file in your Java Eclipse projects, or any other kind of project which needs dependency management. Apache IvyDE will contribute to the classpath of your Java project or you can make it retrieve your dependencies directly into your project. Last but not least Apache IvyDE offer editors of `ivy.xml` and `ivysettings.xml` files with completion. Get some preview here: https://ant.apache.org/ivy/ivyde/screenshots.html. === [[majorchanges]]Major changes in this release: http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/c92ed1b9/doc/src/revdepexplorer.adoc ---------------------------------------------------------------------- diff --git a/doc/src/revdepexplorer.adoc b/doc/src/revdepexplorer.adoc index 73ead76..c683d5e 100644 --- a/doc/src/revdepexplorer.adoc +++ b/doc/src/revdepexplorer.adoc @@ -25,7 +25,7 @@ At other times it is instructive just to see what dependencies are being utilize The Reverse Dependency Explorer turns the dependency tree upside-down, exploring the workspace by organization, module, and revision and providing a mechanism to synchronize revisions across projects/classpath containers. -Consider the following workspace, with three projects, all of which have an ivy.xml file at their project root. Each of these Ivy files has an associated IvyDE managed classpath container. +Consider the following workspace, with three projects, all of which have an `ivy.xml` file at their project root. Each of these Ivy files has an associated IvyDE managed classpath container. image::images/revexplorer_project.jpg[]
