alignmentapi/README.md

An API to align words from a source language sentence to other words from a target language sentence. It generates a JSON.

# ALIGNMENTAPI

## QUICK START

```js
const aligner = new Aligner({
  sourceUsfm:null,
  targetUsfm:null,
  verbose:false
});
aligner.setCurrentChapter(1);
aligner.setCurrentVerse(1);
aligner.setCurrentSourceSentence("Παῦλος, δοῦλος Θεοῦ, ἀπόστολος δὲ Ἰησοῦ Χριστοῦ, κατὰ πίστιν ἐκλεκτῶν Θεοῦ, καὶ ἐπίγνωσιν ἀληθείας, τῆς κατ’ εὐσέβειαν");
aligner.setCurrentTargetSentence("Paul, a servant of God and an apostle of Jesus Christ for the faith of the chosen people of God and the knowledge of the truth that agrees with godliness,");

aligner.addAlignment(0, 0); // "Παῦλος" : "Paul"
aligner.addAlignment(1, 1); // "δοῦλος" : "a"
aligner.addAlignment(1, 2); // "δοῦλος" : "a", "servant"
aligner.addAlignment(1, 3); // "δοῦλος" : "a", "servant", "of"
aligner.removeAlignment(1, 3); // "δοῦλος" : "a", "servant"
aligner.addAlignment(2, 3); // "Θεοῦ" : "of"
aligner.addAlignment(2, 4); // "Θεοῦ" : "of", "God"
```

## TO BE DONE

* handling a source usfm and a target usfm as an input
* being able to choose a verse/sentence in the given usfms
* enhance the output JSON (having lemmas and other informations could be great)
* using `PipelineHandler` from `proskomma-json-tools` to output a final aligned usfm from the JSON informations