CollateX is a Java software for collating textual sources, for example, to produce a critical apparatus. As the designated successor of Peter Robinson's Collate it is developed jointly by several partner institutions and individuals under the umbrella of the European initiative "Interedition".
We strive for a component-oriented architecture, where our users can mix and match parts of CollateX as they see fit for their particular usage scenarios. Currently, we offer three components:
The CollateX project is at an early stage of development and therefore has not been very well documented yet. We are working on making tutorials for common use cases and a complete reference documentation available soon. Meanwhile please refer to the Javadoc for usage instructions. Or even better: Use the force and read the source.
You can download the CollateX core library with all its dependencies in one JAR from the download section of the developer's site. The preferred way to use CollateX in your project though, is to use Apache Maven and its dependency management. Just add the following repository declaration to your project descriptor
<repositories> <repository> <id>maven.collatex.sourceforge.net</id> <name>CollateX Maven repository</name> <url>http://collatex.sourceforge.net/maven-repository/</url> </repository> </repositories>
and declare the following dependency with the appropriate version, e.g. 1.0:
<dependency> <groupId>eu.interedition.collatex</groupId> <artifactId>collatex</artifactId> <version>1.0</version> </dependency>
We are always happy when people want to contribute. If you feel inclined to do so, please do not hesitate to contact us via e-mail or meet us on IRC. As a starting point you might want to check out the source from our developer site at launchpad.net. For a guide on how to do that (using launchpad.net and its SCM Bazaar), see here.