Jump to: navigation, search

Difference between revisions of "XQuery Development Tools/Workspace Setup for Dummies"

(Getting the XQDT code)
Line 3: Line 3:
  
 
= Requirements =
 
= Requirements =
* Eclipse at least 3.4 (Ganymede)
+
* Eclipse at least 3.5 (Galileo)
 
* Dynamic Languages Toolkit (DLTK) Core Frameworks SDK, version 1.0
 
* Dynamic Languages Toolkit (DLTK) Core Frameworks SDK, version 1.0
 
** EMF Common
 
** EMF Common
Line 18: Line 18:
 
In order to have have access also to the DLTK Framework source code you must install, besides the DLTK Core Framewors, also the DLTK Core Frameworks SDK. For this, follow the following steps in Eclipse:
 
In order to have have access also to the DLTK Framework source code you must install, besides the DLTK Core Framewors, also the DLTK Core Frameworks SDK. For this, follow the following steps in Eclipse:
  
* Eclipse 3.5
 
 
# Help menu -> Install New Software...
 
# Help menu -> Install New Software...
 
# Click the "Add" button and in the pop up dialog, add only "http://download.eclipse.org/technology/dltk/updates-dev/1.0" in the "Location" field. Click "OK"
 
# Click the "Add" button and in the pop up dialog, add only "http://download.eclipse.org/technology/dltk/updates-dev/1.0" in the "Location" field. Click "OK"
 
# In the tree view, expand the "Dynamic Languages Toolkit (DLTK)" node and select: "Dynamic Languages Toolkit - Core Frameworks SDK". This feature includes both the DLTK binaries and the source code of the DLTK Core Frameworks. Click "Next".
 
# In the tree view, expand the "Dynamic Languages Toolkit (DLTK)" node and select: "Dynamic Languages Toolkit - Core Frameworks SDK". This feature includes both the DLTK binaries and the source code of the DLTK Core Frameworks. Click "Next".
 
# On the "Install Details" page, click "Next".
 
# On the "Install Details" page, click "Next".
# On the "Review Licenses" page, select "I accepts the terms of the license agreements". Note on this page that DLTK will automatically pull its own dependency: "EMF - Eclipse Modeling Framework Core Runtime". Click "Finish" and wait for the installation to complete.
 
# Restart Eclipse when prompted.
 
 
* Eclipse 3.4
 
# Help menu -> Software Updates...
 
# In the "Available Software" tab, click the "Add Site..." button and in the pop up dialog, add "http://download.eclipse.org/technology/dltk/updates-dev/1.0" in the "Location" field. Click "OK"
 
# In the tree view, expand the newly added site and in the "Dynamic Languages Toolkit (DLTK)" group, select: "Dynamic Languages Toolkit - Core Frameworks SDK". This feature includes both the DLTK binaries and the source code of the DLTK Core Frameworks. Click "Install..." and wait for the install wizard to appear.
 
# On the "Install" page, make sure "Dynamic Languages Toolkit - Core Frameworks SDK" is selected. Click "Next".
 
 
# On the "Review Licenses" page, select "I accepts the terms of the license agreements". Note on this page that DLTK will automatically pull its own dependency: "EMF - Eclipse Modeling Framework Core Runtime". Click "Finish" and wait for the installation to complete.
 
# On the "Review Licenses" page, select "I accepts the terms of the license agreements". Note on this page that DLTK will automatically pull its own dependency: "EMF - Eclipse Modeling Framework Core Runtime". Click "Finish" and wait for the installation to complete.
 
# Restart Eclipse when prompted.
 
# Restart Eclipse when prompted.
Line 44: Line 35:
 
# On the "Review Licenses" page, select "I accepts the terms of the license agreement". Click "Finish" and wait for the installation to complete.
 
# On the "Review Licenses" page, select "I accepts the terms of the license agreement". Click "Finish" and wait for the installation to complete.
 
# Restart Eclipse when prompted.
 
# Restart Eclipse when prompted.
 
* Eclipse 3.4 or 3.5 (download)
 
# Go to the [http://download.eclipse.org/webtools/downloads/ WebTools Project download site]. And click on the latest release. (We tested this with version 3.1.2)
 
# From the "Faceted Project Framework" category, download the "wtp-common-fproj" package. (No SDK or JDT packages are needed)
 
# Unzip the archive in your Eclipse "dropins" directory.
 
  
 
= Getting the XQDT code =
 
= Getting the XQDT code =
Line 65: Line 51:
 
# Click "Next".
 
# Click "Next".
 
# On the "Check Out As" page, make sure the "Check out into the workspace as projects" option is selected. Click "Finish".
 
# On the "Check Out As" page, make sure the "Check out into the workspace as projects" option is selected. Click "Finish".
 +
 +
= Running XQDT from your Workspace =
 +
# Open the "Run/Debug configurations..." Dialog.
 +
# Create one new "Eclipse Application".
 +
# Change the name of the "New_configuration" to "XQDT".
 +
# On the "Plug-ins" tab, select the "plug-ins selected below only" option from the "Launch with" drop-down list.
 +
# In the tree view below, from the "Workspace" group, select all the plugins starting with "org.eclipse.wst.xquery.".
 +
# Click the "Add Required Plug-ins".
 +
# Click "Run"/"Debug"
 +
 +
HAPPY PROGRAMMING/DEBUGGING !!!

Revision as of 17:19, 13 May 2010

Introduction

This article is meant to give you detailed instructions on how to set up your Workspace in order to build and test XQDT on your machine. We assume that you already have an Eclipse installation that meets the requirements below.

Requirements

  • Eclipse at least 3.5 (Galileo)
  • Dynamic Languages Toolkit (DLTK) Core Frameworks SDK, version 1.0
    • EMF Common
    • EMF ECore
  • Faceted Project Framework

Installing the requirements

Eclipse

We assume that you already have an Eclipse installation. You can have the latest one from here: Eclipse Downloads Page

DLTK

In order to have have access also to the DLTK Framework source code you must install, besides the DLTK Core Framewors, also the DLTK Core Frameworks SDK. For this, follow the following steps in Eclipse:

  1. Help menu -> Install New Software...
  2. Click the "Add" button and in the pop up dialog, add only "http://download.eclipse.org/technology/dltk/updates-dev/1.0" in the "Location" field. Click "OK"
  3. In the tree view, expand the "Dynamic Languages Toolkit (DLTK)" node and select: "Dynamic Languages Toolkit - Core Frameworks SDK". This feature includes both the DLTK binaries and the source code of the DLTK Core Frameworks. Click "Next".
  4. On the "Install Details" page, click "Next".
  5. On the "Review Licenses" page, select "I accepts the terms of the license agreements". Note on this page that DLTK will automatically pull its own dependency: "EMF - Eclipse Modeling Framework Core Runtime". Click "Finish" and wait for the installation to complete.
  6. Restart Eclipse when prompted.

Faceted Project Framework

The Faceted Project Framework is available from the WebTools Project download site or from the WebTools update site.

  • Eclipse 3.5 (update site)
  1. Help menu -> Install New Software...
  2. Select the "Galileo - http://download.eclipse.org/releases/galileo" update site in the "Work with" drop-down list.
  3. In the tree view, expand the "Web, XML, and Java EE Development" node and select: "Eclipse Faceted Project Framework". Click "Next".
  4. On the "Install Details" page, click "Next".
  5. On the "Review Licenses" page, select "I accepts the terms of the license agreement". Click "Finish" and wait for the installation to complete.
  6. Restart Eclipse when prompted.

Getting the XQDT code

  1. Open the "New Project" wizard.
  2. Select the "Projects from CVS" wizard from the "CVS" category. Click "Next"
  3. On the next page fill in only the repository location information below and click "Next":
    1. Host: dev.eclipse.org
    2. Repository path: /cvsroot/webtools
    3. User: anonymous
  4. On the "Select Module" page select the "Use existing module (this will...)" option.
  5. In the tree view navigate to: incubator -> source editing -> plugins.
  6. select the following plugins:
    1. com.google.gson
    2. org.antlr.runtime_v31
    3. all the plugins starting with "org.eclipse.wst.xquery."
  7. Click "Next".
  8. On the "Check Out As" page, make sure the "Check out into the workspace as projects" option is selected. Click "Finish".

Running XQDT from your Workspace

  1. Open the "Run/Debug configurations..." Dialog.
  2. Create one new "Eclipse Application".
  3. Change the name of the "New_configuration" to "XQDT".
  4. On the "Plug-ins" tab, select the "plug-ins selected below only" option from the "Launch with" drop-down list.
  5. In the tree view below, from the "Workspace" group, select all the plugins starting with "org.eclipse.wst.xquery.".
  6. Click the "Add Required Plug-ins".
  7. Click "Run"/"Debug"

HAPPY PROGRAMMING/DEBUGGING !!!