Sphinx/getting

From Eclipsepedia

Jump to: navigation, search

This page is for developers of tools based on Sphinx. It aims at providing a procedure to get Sphinx for this purpose. People who want to get Sphinx sources to modify it may read this page.

Getting the last build

Builds are periodically performed. The last successful build can be downloaded from this page: https://hudson.eclipse.org/hudson/job/buckminster-sphinx-0.7-helios/

Other builds are also available here: http://eclipse.org/sphinx/download.php

Once downloaded, unzip the archive file in an empty directory. Then unjar each feature file that is contained in the features subdirectory.

Getting the last update contents

The previous download sites also offers an up-to-date archive file that consists in the contents of an update site. This file is called mdt-sphinx-Update-x.y.z.yymmdd-hhmm.zip. This file is perfect for people who develop tools based on Sphinx but do not modify Sphinx itself. Indeed, it can be used in a target definition, as explained below.

Suppose that your project uses the plug-in org.eclipse.sphinx.emf.explorer. You need to add Sphinx in your target platform to build your project.

  • Create a project called contribs in your workspace and copy the Sphinx update archive there. This archive is called mdt-sphinx-Update-0.7.0.20120418-1100.zip in this example;
  • Edit your target definition file and add the following lines:
<location includeAllPlatforms="false" includeMode="planner" includeSource="true" type="InstallableUnit">
  <unit id="org.eclipse.sphinx.emf" version="0.7.0.20120418-1100"/>
  <unit id="org.eclipse.sphinx.emf.explorer" version="0.7.0.20120418-1100"/>
  <repository location="jar:file:/${workspace_loc}/contribs/mdt-sphinx-Update-0.7.0.20120418-1100.zip!/"/>
</location>
  • Set this file as target platform.

Getting Sphinx through an update site

An update site for Sphinx is now available. Its address is: http://download.eclipse.org/sphinx/updates/interim