Alignment Tool Plan

Based on MAP use case document: https://docs.google.com/document/d/1btdDbmcELpQyFLFDlUJ84bt-B6UsrLmWx3mrm-NzG-M/edit#heading=h.e4gfnlypg0ux

[186] tC Alignment Tool Development

Assumptions

• Mockups are still valid.
• The use case is UGNT to ULB.
• UGNT 0.2 is released and integrated into tC.
• Latest ULB release is integrated into tC.
• Updated later to handle Gateway languages and related issues.
• The tool should be usable without MAP, MAP will add value.
• Single chapter data used to statistically align in MAP.
• Saved alignments to be used as primary training data for MAP.
• User Interface can be developed concurrently to TACT/MAP Preparation.
• TACT/MAP Integration comes after User Interface is developed.
• Resulting tool will need testing and iterative improvements that will at least double effort.

[34] Prerequisites

These are the things that need to happen before development can begin (except non-blocking).

[5] Design

• [2] Locate mockups from Thomas.
• [3] Evaluate mockups to see if they are still applicable.

[29] Data Planning

[8] Blocking

These must be done before development work can begin.

• [8] Plan data format and structure for alignments.

[21] Non-blocking

These can be done while or even after UI development work is done.

• [8] Determine how alignment data should be stored in uW API.
• [13] Testing alignment data in API to match published content.

[73] Tool in tC

User Interface can be developed concurrently to TACT/MAP Preparation.

[73] User Interface

• [5] Create a new blank tool that brings in Scripture Pane and a new area for the rest of the checking area to be used for alignment.
• [13] Create Initial Layout for UI
• [5] Evaluate React D&D for creating drag and drop UI.
  • Example similar to what we could do: https://react.rocks/example/reword
• [21] Create D&D Interface for aligning words/phrases between source/target.
• [21] Create Actions/Reducers for storing/retrieving alignment data.
• [8] Style UI components

[79] TACT/MAP

This is the work that needs to happen for TACT/MAP to be usable in tC.

[39] Preparation

User Interface can be developed concurrently to TACT/MAP Preparation.

• [13] Publish TACT/MAP as an npm package.
• [5] Review TACT/MAP for this use case.
• [21] Address TACT/MAP issues for this use case.

[40] Integration

TACT/MAP Integration comes after User Interface is developed.

• [13] Integrate TACT/MAP to predict alignment.
• [21] Address additional TACT/MAP issues that come up in integration.
• [8] Export alignment data once complete to use for other projects.
• [8] Import alignment data from previous projects.

Mockups