Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Latest commit

 

History

History
71 lines (49 loc) · 3.96 KB

ivyeditor.adoc

File metadata and controls

71 lines (49 loc) · 3.96 KB
Raw

Apache IvyDE comes with an Ivy file editor that provides an editor that performs code completion for Ivy xml tags based on the real-time state of your repository. It also packs with an Ivy file creation wizard and HTML preview.

Creation Wizard

To use the creation wizard, choose File > New > Other > IvyDE > Ivy file in the Eclipse menu (Ctrl+N by default). Select it and click Next.

wizard1

The wizard contains only one page, and is very simple.

wizard2

Wizard fields:

  1. 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).

  2. File name: the Ivy file name (ivy.xml by default).

  3. 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 Ivy preference page.

  4. Module name: the component name.

  5. Status: the status of the project. (integration by default since we have just created its Ivy file. Please refer to the Ivy documentation for more details).

Ivy Editor

editor1

Apache IvyDE’s Eclipse editor provides XML syntax coloration, tag completion, tag attribute name completion, and dependency and configuration tag value completion.

Completion comes with contextual help. The completion popup is displayed when through the CTRL + SPACE shortcut.

Available completions:

  • XML structure: Allows you quickly to insert valid tags at the right place. If the tag can have nested children, both notations, simple tag and open tag, are proposed.

completion1

  • Tag attributes: When your cursor is placed in a tag bracket, the completion shows available attributes for the enclosing tag.

completion2

  • Attributes values: When your cursor is placed inside the quotes of an attribute value, the completion shows available values for the matching attribute.
    Available value completion:

    • info: organisation (preference based), module (Eclipse project name),

    • info/ivyauthor: name (preference based), url (pref based)

    • info/description: homepage (pref based)

    • info/license: name

    • 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 settings configured in the 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 Eclipse Ivy preference page. conf values are computed from the current ivy.xml file and the dependency ivy.xml file if any.

completion4