Installation Instructions for Tricia Software Developers
Please note that these instructions specifically target software developers.The instructions for users who want to download and install Tricia can be found here.
Prerequisites
There are two major prerequisites, which have to be in place to install Tricia:
- As a first prerequisiste, a current (1.6) Java runtime has to be installed. Java can be downloaded from http://www.java.com.
- We use Mercurial as our version control system, so you have to install Mercurial on your machine. We recommend, you install a graphical client for Mercurial, e.g., TortoiseHg, which includes a Mercurial installation. A good introduction on how to use ssh on Windows can be found here: http://www.codza.com/mercurial-with-ssh-setup-on-windows. A good book about Mercurial (including a brief basic tutorial) can be found here.
For persistent storage, Tricia requires a relational database. The Tricia workspace contains the relational in-memory database hsqldb, which is fine for testing purposes. If you want to develop using a production-ready relational database, you have to install MySQL (see Installing MySQL).
Eclipse
Since we believe, that a modern IDE improves the developer experience a lot ,we strongly recommend using the Eclipse IDE for developing Tricia applications. We provide special Tricia Eclipse plugins, which are necessary for some development tasks. The easiest way to get these plugins is by cloning our BitBucket repository eclipse-dropins. This repository additionally contains some useful existing plugins (Aptana, QuantumDB, JAutoDoc, RegExp). The following steps explain the installation of a fresh Eclipse:
- Download Eclipse 3.5 from http://download.eclipse.org/eclipse/downloads/, and extract the zip file to %ECLIPSE_HOME%.
- Go on the command-line into %ECLIPSE_HOME%, and delete the empty dropins folder.
- Call hg clone http://bitbucket.org/infoasset/eclipse-dropins dropins , which creates a new dropins-folder containing the bundled plugins.
- Start Eclipse.
- The Tricia plugins now can be activated in Eclipse by Window -> Show View -> Other -> IMF -> Consistency
Tricia Download
As already mentioned, we use Mercurial as our version control system. The code of the core Tricia plugins is hosted in the repository tricia-core on BitBucket, so ultimately you have to clone this repository.
To enable the use of more than one repositories the Tricia development workspace contains a folder repos, which may contain more than many repositories. The following steps explain in detail how to set up a Tricia development workspace:
- Create a folder [your path]/repos in the directory in which you want to develop Tricia (e.g., C:\development)
- Clone the main Tricia repository in the repos folder by running hg clone http://bitbucket.org/infoasset/tricia-core on the command line.
- Now you have to update to the most recent release of Tricia by running the Mercurial command hg update 2.5
- (Optional) As a best practice, we recommend you create a folder [your path]/eclipse-workspace, in which you store your Eclipse workspace information.
- Finally, you must import the Tricia plugins into your Workspace. Start Eclipse and select "File -> Import and then General -> Existing Projects into Workspace". In the "Select root directory" box, browse to the Directory [your path]/repos/tricia-core/. In the selection box, a whole list of projects will appear. The simplest option is to import all of them.
Eclipse Preferences
Tricia comes with some Eclipse preferences, which make the development of Tricia applications easier. These preferences can be activated in Eclipse by File -> Import -> General -> Preferences, then select in From preference file the file /repos/tricia-core/toro/preferences.epf, and click Finish.
Running Tricia
Now you can start each plugin by running the provides Eclipse run configurations. For instance the wiki plugin contains a file wiki-test.launch, which can be started by right-clicking, and then Run As -> wiki-test.
From now on, documentation in Javadoc is available:
- Open class IndexDoc (Ctrl-Shift-R, DocumentationDoc.java) and view the documentation with the Eclipse Javadoc view
- or see the HTML version here.
-
Wiki Page
Tricia - Printout
Leave a comment: