d-flood / standalone_collation_editor

The standalone version of the collation editor. This version uses locally stored data files and does not require embedding in another platform.

This was forked so that I could make a few small changes to make my own research and collation more convenient.

• Changed font to Cambria, which seems to work better for Greek text and diacritics
• Added the underdot unicode character to 'ignore unclear' rule
• Changed default xml collation download filename to be the current collation unit. {"context": <collation unit>
• Changes so far include syntax that requires Python 3.6+ (f strings)

Introduction

This is a standalone version of the collation editor. It works with the local file system on your computer. A small example of a single Greek verse is included as a sample file.

The collation editor is a GUI wrapper around collateX. A version of that software is included with this editor.

Requirements

The collation editor requires Python3.

The version of collateX packaged with this code requires Java Runtime Environment (JRE) version 8 or higher.

The collation editor has primarily been tested in Firefox but should also work in Chrome.

Installation and Start up

On Mac and Linux

To start the collation editor download the code from github and navigate to the collation_editor directory. From here run the start up script startup.sh. This script should start both collateX and the server that runs the collation editor.

If collate has started sucessfully you should be able to see it at: localhost:7369

If the script has been successful you should be able to see the collation editor when you visit: localhost:8080/collation

On Windows

To start the collation editor download the code from github and navigate to the collation_editor directory. From here run the start up script startup.bat. This script should start both collateX and the server that runs the collation editor.

If collate has started sucessfully you should be able to see it at: localhost:7369

If the collation editor has started successfully you should be able to see the collation editor when you visit: localhost:8080/collation

Further Documentation

For details of how to collate the example and prepare your own data for use in the standalone collation editor see the project wiki https://github.com/itsee-birmingham/standalone_collation_editor/wiki

Referencing

To cite the standalone collation editor please use the DOI: