Invalidated Checks

[benjore]

User Story

As an aligner, I want to be able to update my translation and only re-aligning what has changed so that it saves me time and keeps me from discouragement.

As a checker, I want to be able to edit my translation and know which checks have been invalidated and have to be redone.

Notes

• If there is an invalidation, the alignment for the whole verse is reset. (If the text for the verse is different.)

[PhotoNomad0]

@benjore - can you verify my understanding (listed below) of the logic for the display of badges?

Notes:

• Badges (only show one at a time):
  • bookmark badge - show if bookmark - remains until removed?
  • comment badge - show if comment set - remove when comment is removed?
  • broken link badge - show if verse has been edited after checking, cleared when new selection is made?
  • check badge - show if checked and no bookmark, no comments, and verse has not been changed since last edit
  • no badge - if not checked and no bookmark, no comments

[richmahn]

My issue, #3676, is what displays the Badges @PhotoNomad0 . I even have an invalidated icon all set up for this issue which I spent a lot of time on yesterday. This issue just needs to make a .json like we have for verseEdits, reminders, etc. is updated when ever a verse is edited which changes text that was either highlighted in tW or aligned in wA. We need to be able to know all at once for a whole project what verses are invalid. Right now we only look when a user clicks on that verse in the group menu.

[richmahn]

@PhotoNomad0 To hook this up to what I did, the contextIdReducer needs to have a boolean named 'invaludated' set to true like we do with contextId.reminders, contextId.comments, etc.

[richmahn]

Used here: https://github.com/unfoldingWord-dev/translationCore/blob/7532881e43329eebecf1c1bfc2653f3fa578a3c8/src/js/containers/GroupMenuContainer.js#L117

[richmahn]

Screen shot of what is already in place (This is from my branch, but I forced the invalidated boolean to be true for a few):

[PhotoNomad0]

Dependent on #3676.

[PhotoNomad0]

Tasks:

• [5] Update TW tool to set invalidate flag
• [5] Unit tests
• [5] PR Review for [3086]

[PhotoNomad0]

@benjore - Question: In WA tools when verse is invalidated, we currently reset the alignments. Should we also flag all checks in the verse as being invalidated?

Answer: no

[PhotoNomad0]

@benjore - Question: when we do an usfm3 import, should we be checking each verse for changes and invalid selections before we open the tW tool.

Answer: On tw open, we recheck all alignments.

[cckozie]

@PhotoNomad0 This is what is in the mockups that I am not seeing:

[PhotoNomad0]

Tasks:

• [5] Update TW tool to display selection invalidated text.
• [5] Unit tests
• [5] PR Review for [3086]

[benjore]

@PhotoNomad0 Also note the invalidated icon that shows up in the blue bar (next to the other icons). The invalidated icon never shows up transparent (like the other icons) - it is either there in white, or completely gone.

This will cover #4442

[PhotoNomad0]

@cckozie - discussed this with Ben: since the current tooltip component we use does not natively support grey backgrounds, we are implementing invalidated popup with black background such as:

[PhotoNomad0]

Blocked waiting for #4318

[PhotoNomad0]

Still need to fix showing invalidated on default verse. See this problem when you have selected an invalidated verse in tw, exit tool, and reopen tw tool. new branch to fix in UI toolkit: feature-mcleanb-3086/ShowInvalidatedSelection.5

[PhotoNomad0]

Localization is still not in for invalidation warning.

Localization is in now.

[PhotoNomad0]

@cckozie - you should be able to test this now.