Overview

Chorus is version control system designed to enable workflows appropriate for typical language development teams who are geographically distributed. These teams need to edit a set of common files, working towards a publication. They want to share their work while, crucially, being able to defer dealing with conflicting edits for periods of time or until a qualified team member can make decisions about the conflicts. The system is implemented on top of a commonly used Open Source Distributed Version Control System. It works in scenarios in which users are connected by Local Area Network, Internet, or hand-carried storage devices. Chorus supports several workflow models, including those that maintain a “master” database separate from the incoming submissions of team members. Quite unlike the version control systems commonly in use, the system works invisibly for the common cases and is kept simple for even beginner computer users.
Distinctive Features

These features come for free with any Distribute Version Control System:

  • Share files between users, even if they are never connected to the internet.
  • Every member of the team has access to a full history of all work done by the rest of the team.
  • In a crisis, work can be "rolled back" to a previous version.

However, "raw" Distributed Version Controls Systems are relatively difficult to understand, configure and use, even for computer-savvy workers.

The following list of features should help you understand why we built this layer over a raw version control system:

  • silently synchronize; will never tell the user to manually merge conflicts first
  • automatically check for team members & devices with which to synchronize
  • Support a Master branch which does not automatically accept changes from anyone
  • Files can be marked as shared by the team or user-specific. This allows things like preferences/configurations to be part of the repository, but kept separate for each individual. This will also allow one team member to make configuration changes for another, remote member, and push those changes through the system to that user, without physically accessing their computer.
  • 3-Way, schema-savvy XML merging. Various policies can be implemented for choosing a winner in the case of conflicts. Regardless of the policy, details of the conflict are logged in an xml file which also under version control. At a time and place of the team's choosing, these automatic choices can be reviewed and reversed.
  • Configuration help from applications. Applications generally know where their important files are, which files are individual-specific, and which should not be backed-up/shared at all. Applications that know about Chorus pass this information to it, so that users don't need to become experts in how all the files work.
  • Synchronization help from application. Applications often know what points are good ones for checking data in. For example, when exiting, before doing a large and possibly undesirable operation, like deleting a large number of items or importing a new data set.
  • In-Application conflict and change history. Rather than ask users to learn version-control specific tools, the Chorus model is that Chorus provides the raw information applications need to provide a smooth, integrated workflow in the same environment as the user has for editing. For example, a dictionary-editing program using Chorus will allow the user to see a full history of the current record, including who made what changes, and what conflicts (if any) were encountered during synchronization.
  • A built-in "notes" system which makes it very cheap to give users the ability to add notes to any piece of data, and to carry on conversations about about the data until they mark the issue as "resolved".

Status

Chorus is functional and being used in 4 applications, by 4 different development teams, while a 5th (FieldWorks) is building it in. However, we are not really interested in supporting any further uses until things mature and someone writes good develop documentation. Documentation, where it exists, drips out in the form of occasional blogs here .

Testers

Please see Tips for Testing Palaso Software

Developers

Mailing List

Sign up here: https://groups.google.com/forum/#!forum/chorusdev

Road Map & Workflow

https://trello.com/board/chorus/4f3a90277ae2b69b010988ac

Coding Standards

Palaso Coding Standards

Source Code

Chorus is written in c#. The UI widgets uses Windows Forms, but you could make your own using a different platform and just use the engine.

To get the source code, you'll need Mercurial. Windows users, install TortoiseHg. Then from a command line, go to where you keep your development projects, and give this command:

hg clone http://hg.palaso.org/chorus

You should now have a solution which you can build using any 2010 edition of Visual Studio 2010, including the free Express version. We could help you do it in VS 2008, if necessary.

Getting up-to-date libraries

Some of the dependencies are very large, and others are updated frequently. For both of those reasons, you can't just pull the code and expect it to compile. First, you will have to do some extra work to get Chorus's library dependencies up to date.

1) Palaso Libraries

Get binaries of Palaso libraries from http://build.palaso.org/repository/downloadAll/bt32/.lastSuccessful/artifacts.zip. This is really the latest, so don't be disheartened if there's some API change which Chorus hasn't updated to yet. We keep them in sync generally, but a few times a year they may be out of sync by a day or so.

Using the contents of the zip, update the palaso libraries in lib/debug.

2) Mercurial

If developing on windows, unzip the file lib/net2.0/mercurial.zip into output/common/mercurial. That way, you know the tests are running against the approved version of Mercurial, not whatever you happen to have on your machine.

Latest news

Better error messages
When getting a project from the internet, Chorus now detects several common server error messages, and emits user-understandable messages.
Added by john hatton almost 3 years ago

Chorus now can merge LDML (Writing Systems)
Chorus now can merge LDML (Writing Systems)
Added by john hatton about 3 years ago

4 Apps now using Chorus
LiftBridge is the latest client of the Chorus library.
Added by john hatton over 3 years ago

Blog moving
The Chorus blog has moved.
Added by john hatton almost 5 years ago

Using Chorus to download a project from the internet
Added by john hatton about 5 years ago

View all news