-
Notifications
You must be signed in to change notification settings - Fork 4
ProjectRoadmap
This roadmap describes planned Juxta software releases for 2011.
In November of 2010, Nick Laiacona of Performant Software Solutions met with Abigail Firey and Mark Lauersdorf of Carolingian Canon Law Project at the University of Kentucky to discuss how Juxta could be modified to serve the needs of scholars working with Latin texts. From this discussion came the feature set for Juxta 1.6. This version of Juxta is sponsored by the Carolingian Canon Law Project, by the SHANTI group at the University of Virginia, by NINES and by a grant from Google.
Spot Correction of XML Sources - Juxta 1.6 adds a feature to the Document Source Tab so the user can actually edit the source document. Clicking on the “Update” button at the bottom of the panel will update the document and re-collate it against the other witnesses.
Changes to Revision Site Display - Juxta 1.6 changes the way revision sites are displayed, allowing the user to toggle between the original version of the text and the revised version. This replaces the red strikethroughs and blue brackets that are used in Juxta 1.4 to display text within TEI add, del, addSpan, and delSpan tags. This will make it easier to read and understand revision sites. Juxta 1.6 also adds revision site controls, allowing the user to accept or reject revisions on a case-by-case basis.
TEI Note Tag Support - Another feature makes the contents of TEI note tags visible in the margin when viewing a document in Juxta. This makes use of the existing “margin boxes” that are used to call out differences in the heat map view. These margin boxes are a different color and unlike the ones that mark differences, these margin boxes are always visible.
XML Parsing Templates - Juxta 1.6 allows users to create their own parsing templates and save them for reuse across multiple witnesses.
Juxta WS is a version of Juxta that runs as a web service. Juxta WS is designed to work in the server environment of the digital edition. It allows the scholar to collate witnesses within an edition during the editorial process. It can be part of a workflow for checking OCRed or hand-keyed texts, can help establish chronological or authorial relationships between texts, or track migrations of passages between texts. Juxta WS can operate in either a read/write mode or a read only mode, making it suitable for internal use as well as a resource for making editorial decision points visible to end users of the edition.
Juxta WS will allow users to upload and store XML documents for the purpose of collation and display. Juxta WS allows users to browse collations using a simple HTML interface. The user can explore questions such as the amount of textual difference between one witness and the rest of the set. Juxta WS is made to be part of a production pipeline and may be commanded using JSON or XML.
The Juxta WS protocol follows a RESTful model. It uses HTTP verbs to model CRUD operations on a set of objects. The objects defined in this protocol include: comparison sets, documents, tokens, collations (or alignments), analysis results, and views. Objects created from each of these types are given an ID. This ID may then be used to reference the object in subsequent operations. For example, a user might start by uploading some documents and then creating a comparison set which contains those documents. The user could then request an HTML view of two documents compared side-by-side.
Juxta WS will offer its operations both as an integrated whole and as discrete operations or ‘micro-services’. For example, the tokenization service may be called independently of other operations, allowing Juxta WS to act as a pre-processor for the user’s linguistic algorithms. Or, the user may wish to intervene, process the token stream and then feed the modified stream back into Juxta’s collation algorithm. These micro-services will conform to the Gothenburg Model developed in 2009 at a joint workshop of the EU-funded research projects COST Action 32 and Interedition in Gothenburg.
Juxta WS will start with just the side-by-side comparison view for visualizing differences. More view types will be added as they are developed for Juxta 2.0. All future changes to Juxta’s collation algorithm mentioned in this roadmap will automatically become part of JuxtaWS as well.
Juxta WS Integration - Allow a user of Juxta to upload and download collations from a running Juxta WS server. The user will be able to specify the URL or IP address of the Juxta WS server the user wishes to connect to. The user will then be presented with a list of the comparison sets that are available on the server. The user can then select a collation to download and automatically open it in Juxta. The user can also upload the current comparison set to the server. This will allow users of the web service to easily manage online collations using Juxta.
The Juxta 2.x series of the software will be purely web based. It is the easy-to-use version for users who may not yet be running a server for their edition or may be using Juxta for a smaller project or in a classroom setting. While Juxta WS allows edition builders to host their own copy of Juxta, Juxta 2.x will be hosted at juxtasoftware.com. Any user may create a free account and upload files for collation to a private storage area. The user may then set access permission levels on the comparison set, either setting a password for access or allowing them to be publicly accessible. The user may choose a Creative Commons license under which to make the work available. Free user accounts will offer a limited amount of storage, but for a small monthly fee the user can upgrade to increase storage space. Both the desktop and Juxta WS software will continue to allow the users to utilize unlimited storage space on their own servers at no cost.
The main task in Juxta 2.0 is to take the remaining functionality that already exists in the desktop Juxta application and port it to the web. In addition to the side-by-side comparison view already implemented in Juxta WS 1.0, Juxta 2.0 will provide support for the following operations:
Document Preparation Interface - An interactive way to select how Juxta interprets the structure of your XML witnesses.
Tokenizer Configuration Interface - Ignore white space, ignore capitalization, Latin Noise Filter, etc.
Comparison Set View - The ability to select a base text for the heat map view and see the summary of difference levels between texts.
Heat Map View - Implement the interactive heat map view.
Histogram View - Implement the histogram chart.
Interactive Moves - The ability of the user to select moves and have that feed back into the collation results.
Editorial Notes - Display of editorial notes in the sidebar as they are discovered in the XML file.
Revision Sites - Display of revision sites.