Skip to content
Alexander Nittka edited this page Sep 30, 2018 · 21 revisions

Installing Xturtle

Oomph does (almost) everything for you

If you do not want to read the lengthy installation instructions, consider using Oomph. Using the setup file Xturtle and all its requirements will be installed. You can choose between the released and the snapshot version upon installation.

If you have used Oomph, you can skip the next sections and continue reading at "My first Xturtle project".

Requirements

Xturtle requires Eclipse with the Xtext plugin installed. Eclipse plugins can be installed via Help->Install New Software and then adding the update site of the plugin.

Option 1: For those not having a pre-installed eclipse, the easiest option is to use an itemis distro where Xtext is already installed.

Option 2: If you are already using Eclipse, you are required to install Xtext. The composite Xtext update site is:

http://download.eclipse.org/modeling/tmf/xtext/updates/composite/releases/

For installing the necessary Xtext components. Minimal requirement is the Xtext Redistributable 2.6.0. If you experience problems with certain Xtext versions or Xturtle features, please report a bug.

Installation of Xturtle

Starting from an existing eclipse installation, you can install Xturtle by using the update site

http://xturtle.aksw.org/site.xml

or

https://raw.githubusercontent.com/AKSW/Xturtle/gh-pages/site.xml

During the installation, you have to trust a certificate named cn=Sebastian Tramp with the Thumbprint D4 30 D2 EF 31 78 40 DF F8 DA 6A F7 F7 EC 89 BB CF 92 44 82. This may change in the future.

The latest snaphot version including bug fixes and enhancements can be installed via the snapshot update site

http://xturtle.nittka.de/snapshot/site.xml

You'll know that the editor is working, if you open a .ttl file and you are asked if you want to add the Xtext-Nature to the project. Further, on invoking code completion (ctrl-space) in the first line, something should happen...

My first Xturtle project.

Creating the project

In the file menu choose New->Other->Xtext->Xturtle Project and hit Next. Enter the project name my.first.xturtle.project and hit Finish. The project is created and an initial file is opened. Type the following text at the end of the file: <> a o Now invoke code completion (ctrl-space). The only entry "owl" is already selected (it is proposed as there is a prefix directive for owl). Hit enter. Invoke code completion again and note that no subject of the owl namespace is proposed.

Importing default vocabulary into the workspace

In the Xturtle repository we provide some commonly used vocabulary.

When installing Xturtle using the Oomph setup the first step can be skipped. The zip file (master.zip) containing the vocabulary will have been downloaded to the workspace root location.

  1. Download develop.zip and save it somewhere on your disk.
  2. In the file menu choose Import->General->Existing Projects into Workspace and hit Next. Choose Select archive file, browse to the file's location, select and open it. In the Import dialog, you now see all available projects. Deselect all the ones starting with "de.itemis" and hit Finish.
  3. Your workspace should now contain the vocabulary projects.

Making the vocabluary available

Open the context menu of example.ttl (either in the editor or in the package explorer) and choose Validate. This is necessary as importing new projects does not cause revalidation of a file. There should be a quickfix marker for the first line of the file (light bulb with blue i left of @prefix). Click on that. A single quick fix add project reference to xturtle.core should appear. Select it and hit enter.

If you now continue typing the last line <> a owl:Ont and invoke code completion, the list should not be empty anymore.

Clone this wiki locally