Align to unexpected verse

[benjore]

Specs

• [ ] If two verses are added before or after the verse, the middle verse can't be removed without the outside verse being removed first. E.g. When checking 3:9, if the user adds 3:8 and 3:7, then 3:8 cannot be removed without 3:7 first being removed (disable the "Remove previous verse").
• [ ] Adding another verse only adds it to the alignment area (not to the side menu nor the scripture pane).

[pjoakes]

Because of discrepancies in versification between Greek and English (and other languages), in order to align the text, we need to be able to align text across verse boundaries, i.e., we need to grab words from one verse and drag them into an adjacent verse.

[benjore]

[20] NEED: a spike to figure out how to pull this off without blowing everything up.

[RoyalSix]

~~Tasks:

• Add Previous / Next Buttons - M
• Add Previous / Next Sections in word bank - M
• Make Dialog After Dropping Word in Previous / Next Section - S

• Add Word From Last Word List to next / previous one - L

  Added by @PhotoNomad0 :

• Add verse number label to alignment section - S ~~

[RoyalSix]

Potential Pitfalls:

• USFM 3 Export for old reference
  • Do they keep the (3:9) ?

[PhotoNomad0]

Notes from Klappy:

• add column to CSV with reference in "JAS001002".

examples:

USFM

\zaln-s | x-strong="G23160" x-lemma="θεός" x-morph="Gr,N,,,,,GMS," x-occurrence="1" x-occurrences="1" x-content="Θεοῦ"
\w परमेश्‍वर|x-occurrence="1" x-occurrences="1" x-reference="JAS001002"\w*
\zaln-e\*

JSON

{
 "contextId": {
  "reference": {
   "bookId": "tit",
   "chapter": 1,
   "verse": 1
  },
  "tool": "translationWords",
  "groupId": "apostle",
  "quote": "ἀπόστολος",
  "strong": [
   "G06520"
  ],
  "occurrence": 1
 },
 "selections": [
  {
   "text": "an",
   "occurrence": 1,
   "occurrences": 1,
   "reference": {
    "bookId": "tit",
    "chapter": "1",
    "verse": "2"
   }
  },
  {
   "text": "apostle",
   "occurrence": 1,
   "occurrences": 1
  }
 ],
 "userName": "klappy",
 "modifiedTimestamp": "2018-06-14T22:56:18.251Z",
 "gatewayLanguageCode": "en",
 "gatewayLanguageQuote": "apostle, apostles, apostleship"
}

[PhotoNomad0]

Tasks:

WA:

• update drop word (Original Language - OrigL) object to include reference - S
• update Target Language (TL) drop method -L
  • when dropping on alignment - add reference in alignment if OrigL is different than TL current verse - S
  • when dropping on wordbank (unaligning) - add to wordbank of TL verse it came from and update progress for that verse. If TL word was not from current verse, show toast to user that it was returned to that verse's wordbank - L
  • when splitting alignments - add support if OrigL verse is different than current TL verse. If TL word(s) was not from current verse, show toast to user that it was returned to that verse's wordbank - M
  • when merging alignments - add support if OrigL verse is different than current verse. prevent merge across verse boundaries (Greek words stay in their own verse) - S
  • display warning in UI if user tries to merge OrigL word across verse barrier (similar to trying to unmerge a middle word) - S
• write method to add OrigL previous/next verse to alignment - M
• write method to remove OL first or last verse in range from alignment (with checking to make sure not inside verse) - S
• write method to find all alignments in book for OrigL word in verse - M
• Always shows all OrigL verses that contain words from the current Target verse - M

NEED: Spike to figure out invalidation.

UI (in alignment pane):

• Render a range of verses in the alignment pane - L
• Add Show Previous Verse / Show Next Verse Buttons should only be placed on the outside verses - M
  • Remove Previous/Next should only be placed in verse next to an outside verse - M
  • Disable Remove Previous/Next if there are aligned words in the verse above/below - M
  • If a Previous/Next verse is added, make sure it can be viewable with scrolling and auto-scrolling - M
  • Add verse number label to alignment pane - S
  • Show "Remove Previous/Next verse" as long as there are no cross-verse alignments. When there are cross-verse alignments, disable the "Remove Previous/Next Verse" option for that verse - M

tCore/word-aligner

• write sharable methods to convert between x-reference format and reference object format (need 2 algorithms: convert from/to x-reference and reference object) [Ping Klappy for specifics]- M
• add column to CSV export for reference in x-reference format if present (different than target language verse) - M
• On USFM3 unmerge (import) & (merge) export: - M
  • unmerge - convert x-reference to reference object in alignment object. Change unmerge to move TL word to alignment in different verse if necessary.
  • merge - convert reference object in alignment object to x-reference format). Change merge to add x-reference to OrigL word in alignments if from different verse.

Optional Additional (Save for later):

• convert project alignment data (on disk) to be new wordMap format to remove all the conversions WA currently does:
  • do project migrations
  • on USFM3 imports convert alignment object to wordMap alignment object
  • on USFM3 exports convert wordMap alignment object to USFM3 alignment format

[PhotoNomad0]

@benjore @neutrinog - Any comments?

[da1nerd]

That looks like a decent overview.

One point to add would be to finalize an official spec for the alignment output from wordMAP. We have a working spec but I'd like to see it reviewed, documented, tagged, and published some place before we formally migrate to it. @klappy has there been any feedback on adjustments that might need to be made to that spec?

Under the optional section, note that the wordMAP-usfm module supports exporting the new alignment data format to usfm3 with plans to support extracting it as well.

[da1nerd]

@benjore should users be allowed to re-align words from the "unexpected" verses? e.g. if I have selected verse 9, can I drag an aligned word (that is not from the verse 9 target language) from verse 8 into verse 9?

[benjore]

Whatever cards "on the board" should be movable. If I am aligning v9 and I drag a word from v8 back to the "Word Bank", the card should be removed from the "board" but it will only show up in the v8 word bank.

(If any of this is wildly complex, let me know and we'll reconsider.)