| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you 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. |
| --> |
| <html> |
| <head> |
| <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"> |
| <script type="text/javascript">var xookiConfig = {level: 0};</script> |
| <script type="text/javascript" src="xooki/xooki.js"></script> |
| </head> |
| <body> |
| <textarea id="xooki-source"> |
| Ivy use is entirely based on what is called ivy files. Ivy files are xml files, usually called ivy.xml, containing the description of the dependencies of a module, its published artifacts and its configurations. |
| |
| Here is the simplest ivy file you can write: |
| <code type="xml"> |
| <ivy-module version="1.3"> |
| <info organisation="myorg" |
| module="mymodule" |
| /> |
| </ivy-module> |
| </code> |
| |
| Since version 0.8, ivy publishes an xslt which help make ivy files more readable. You just have to add |
| a line like this one in your ivy file: |
| <code> |
| <?xml-stylesheet type="text/xsl" href="http://ivyrep.jayasoft.org/ivy-doc.xsl"?> |
| </code> |
| However, all information is not presented with the xslt (dependency configurations, in particular). |
| And due to security issues, it only works if the ivy file is in the same domain as the xsl... But they are particularly useful to browse the <a href="http://ivyrep.jayasoft.org/">ivy repository</a>. |
| |
| If you want to see a sample file using almost all possibilities of ivy files, check this one, <a href="samples/ivy-sample-xslt.xml">with</a> or <a href="samples/ivy-sample.xml">without</a> xslt. |
| |
| Before beginning the reference itself, it is required to have in mind the terminology defined in the <a href="reference.html">main page</a> of this reference documentation. |
| |
| For those familiar with xml schema, the schema used to validate ivy files can be found <a href="http://incubator.apache.org/schemas/ivy.xsd">here</a>. For those using xsd aware IDE, you can declare the xsd in your ivy files to benefit from code completion / validation: |
| <code type="xml"> |
| <?xml version="1.0" encoding="UTF-8"?> |
| <ivy-module version="1.3" |
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xsi:noNamespaceSchemaLocation= |
| "http://incubator.apache.org/ivy/schemas/ivy.xsd"> |
| <info organisation="myorg" |
| module="mymodule" |
| /> |
| </ivy-module> |
| </code> |
| |
| <h1>Hierarchical Index</h1> |
| <pre> |
| ivy-module |
| <a href="ivyfile/info.html">info</a> |
| <a href="ivyfile/license.html">license</a> |
| <a href="ivyfile/ivyauthor.html">ivyauthor</a> |
| <a href="ivyfile/repository.html">repository</a> |
| <a href="ivyfile/description.html">description</a> |
| <a href="ivyfile/configurations.html">configurations</a> |
| <a href="ivyfile/conf.html">conf</a> |
| <a href="ivyfile/publications.html">publications</a> |
| <a href="ivyfile/artifact.html">artifact</a> |
| <a href="ivyfile/artifact-conf.html">conf</a> |
| <a href="ivyfile/dependencies.html">dependencies</a> |
| <a href="ivyfile/dependency.html">dependency</a> |
| <a href="ivyfile/dependency-conf.html">conf</a> |
| <a href="ivyfile/mapped.html">mapped</a> |
| <a href="ivyfile/dependency-artifact.html">artifact</a> |
| <a href="ivyfile/dependency-artifact-conf.html">conf</a> |
| <a href="ivyfile/dependency-artifact.html">include</a> |
| <a href="ivyfile/dependency-artifact-conf.html">conf</a> |
| <a href="ivyfile/artifact-exclude.html">exclude</a> |
| <a href="ivyfile/artifact-exclude-conf.html">conf</a> |
| <a href="ivyfile/conflicts.html">conflicts</a> |
| <a href="ivyfile/manager.html">manager</a> |
| </pre> |
| |
| <h1>ivy-module</h1> |
| <b>Tag:</b> ivy-module |
| |
| Root tag of any ivy-file. |
| <h2>Attributes</h2> |
| <table class="ivy-attributes"> |
| <thead> |
| <tr><th class="ivy-att">Attribute</th><th class="ivy-att-desc">Description</th><th class="ivy-att-req">Required</th></tr> |
| </thead> |
| <tbody> |
| <tr><td>version</td><td>the version of the ivy file specification - should be '1.3' with current version of ivy</td> |
| <td>Yes</td></tr> |
| </tbody> |
| </table> |
| <h2>Child elements</h2> |
| <table class="ivy-children"> |
| <thead> |
| <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr> |
| </thead> |
| <tbody> |
| <tr><td>info</td><td>contains information about the described module</td> |
| <td>1</td></tr> |
| <tr><td>configurations</td><td>container for configuration elements</td> |
| <td>0..1</td></tr> |
| <tr><td>publications</td><td>container for published artifact elements</td> |
| <td>0..1</td></tr> |
| <tr><td>dependencies</td><td>container for dependency elements</td> |
| <td>0..1</td></tr> |
| <tr><td>conflicts</td><td>section to configure the conflict managers to use</td> |
| <td>0..1</td></tr> |
| </tbody> |
| </table> |
| </textarea> |
| <script type="text/javascript">xooki.postProcess();</script> |
| </body> |
| </html> |
