unfoldingword/bible-reference-rcl

Bible Reference Navigation RCL

unfoldingWord

bible-reference-rcl's Issues

Add Styling

Fix add TSV when no existing TSV Items

Fix Add TSV when no existing TSV Items in Resource

Settings popups should close when the user clicks away

When the user opens card settings the settings don't seem to be attached to the three dot icon - they tend to show up in center of screen. Settings popups should be closed when the user clicks outside of the popup.

DoD: A settings card, invoked from the 3 dot menu, will close when the user clicks outside of the settings card.

---

Also they are modal which means you can't interact with rest of screen. So we need to do one of

• dim the rest of the screen to indicate you can't make changes until popup is dismissed
• have the popup close whenever you click off
• or both of the above.

It would be nice to be able to resize cards by dragging on any edge

Only being able to resize from the lower right corner often causes the user to make extra sizing/dragging operations in order to accomplish their desired layout.
In the example below, it would be much simpler for the user if they could just adjust the left border of the tQ card.

https://images.zenhubusercontent.com/309394970/f8b0c868-3752-453f-b919-9d5e2bce15fa/issue_2_0_35.mp4

Email field in the feedback form is not validated.

Email input box displays text on hover "to include @" in the email address, but does not validate the text. The form is submitted successfully with a faulty email address(without an @ symbol).

Add test framework

It would be nice to be able to resize cards by dragging on any edge

Only being able to resize from the lower right corner often causes the user to make extra sizing/dragging operations in order to accomplish their desired layout.
In the example below, it would be much simpler for the user if they could just adjust the left border of the tQ card.

https://images.zenhubusercontent.com/309394970/f8b0c868-3752-453f-b919-9d5e2bce15fa/issue_2_0_35.mp4

Close button(X) required in the feedback form

There is no option currently to close the feedback form.

Font size settings are only persisted for scripture resources

The font size setting for all other resources is not persisted when the user logs out or when he opens a new session.

Publish bible-reference-rcl on NPM

[SPIKE] Cypress Recordings are no longer working in GitHub actions.

Notes:

• current state is that on GitHub actions we are getting about a 30second video with no screen changes.
• likely due to under powered GitHub actions runner. May need to investigate turning recording off for GitHub actions, but leaving it for local builds.
• maybe using macOS as running would fix problem (has 3 cores instead of 2 cores for linux) <= still a problem
• investigate other options.

When blank translation question is added, it does not show on Gateway Edit unless question/answer is input

Add ability to change the color of the input fields for the bible reference component

Bible Ref field line and dropdown arrows were black and are white in the mockup.
DoD: line and arrows are white

Cards being moved by the user should remain where they are dropped

One example is shown here and another one in the following comment
https://images.zenhubusercontent.com/309394970/576868be-3ae5-4f4b-9fd0-b2dbb189c42b/issue_2_0_34.mp4

SPIKE: Investigate Navigation RCL

mockup
https://projects.invisionapp.com/share/6VZ7U05QCMN#/screens/435786056

Notes:
https://docs.google.com/document/d/1dEYW59IGqiU2S94G7DJYdOiglIQzxqL00l_g2lLqC7c/edit#

Upgrade all dependencies to latest versions

tWL should be viewable in tsv format

Document API

Add properties/callbacks/navigation:

• initialize/control - book, chapter, verse
• whitelist of supported books
• callback for change of book, chapter, verse
• expose interface for previous/next book, chapter, verse

Add documentation to Styleguidist page.

Font sizing does not work on tA, tW, and tQ resources

The dialog for resizing appears, but the font size does not actually change regardless of the setting.

Reference dropdown cropping

The numbers in the chapter and verse dropdowns are getting cropped on Firefox and Safari when scrollbar appears:

Fix error messages resulting from upgrading to latest versions

Add up/down arrow navigation

Add ability to type/paste in book chapter:verse

Pasting a reference into the book field will navigate to that reference.

Reference should be in the format: '<bookname/abbv> []:[]' where bookname or abbreviation is required and optionally chapter and verse. A chapter without a verse should default to verse 1.

DoD: Pasting a reference into the book field navigates to the pasted reference.

---

For reference:
request from @RobH123

When the user clicks into any field on the reference navigator and pastes a '<bookname/abbv> :' the reference will be accepted and the current reference will change to the pasted reference just as if the user had chosen all 3 fields manually.

Katalon problems list

Creating a list here of elements that are problematic for Katalon to find reliably

The 2 dropdown lists on the Account Settings page both have the same id
The X to close the card settings modal is not findable
The open buttons for book, chapter, and verse all have same aria-label
The close buttons for book, chapter, and verse all have same aria-label
All of the buttons on the blue bar have the same aria-label

There are several differences between the tN columns displayed in tC Create 1.0 and tC Create 2.0

I'm not sure if these are intended, or are a result of the tsv format changing, or if one of them is wrong.

Should we reset the verse to 1 when we cross chapter boundaries?

The verse should reset to 1 when changing chapter by chapter, but not verse by verse. Verse by Verse navigation should go to the previous/next verse even if it crosses a chapter boundary.

Add Localization support

translation-helps-rcl

HTML styled Input field is editable but not multi line
Switch to use MUI TextareaAutosize instead

Release 0.9

• configure netlify to auto-build release branch release-v0.9.0 (add as additional branch to Deploy contexts under https://app.netlify.com/sites/gateway-edit/settings/deploys)

• create release branch release-v0.9.0

• Ping QA that release branch is ready for testing (https://release-v0-9-0--gateway-edit.netlify.app/)

• PR from version branch to Master

• Ping QA that release is live

• Final Go ahead for publish from QA

• tag release on Github vX.X

• publish release note

• Announce on forum.door43.org

• testing will be on: https://develop--gateway-edit.netlify.app/

Add OBS support

It would be nice to have tooltips on the chevrons in the navigation bar

Markdown view not available for translationWords Article

translation Notes and translationAcademy have a button to toggle the Markdown view but translationWords do not. Is that designed that way not to show MD?

Create a Bible Reference Navigation RCL for use in tc-create 2.0, etc.

@PhotoNomad0 commented on Mon Nov 02 2020

initial design spec are in https://docs.google.com/document/d/1dEYW59IGqiU2S94G7DJYdOiglIQzxqL00l_g2lLqC7c/edit?ts=5f99d09c# :

Bible Reference RCL

• Testament/Book/Chapter/Verse navigation
• Previous and next for Book/Chapter/Verse
• Drop-down selection for each
• Typeable (will filter list) <- phase 2
• UI and headless UI library (https://react-table.tanstack.com/docs/overview#what-is-a-headless-ui-library)
• May also have support for owner/repo/language <- will pass in current book, array of bookIDs available
• responsibility of each pane to find closest content to chapter/verse given
• apis so each component can change chapter/verse (as well as next/prev chapter/verse) - then all other components get updated
• chapter count and verse counts will be hard coded.
• Challenges: Verse ranges and alternate versifications <- future

Questions

• OBS support - story #/ frame #?
• do we want to read navigation from USFM? No

---

@mvahowe commented on Mon Nov 02 2020

If the USFM has \v1-2, and the UI is on "verse 1", what does "next verse" do? I can't see a safe answer to this question since, basically, the UI would be misleading the user. If "next" is v3, where is v2? If "next" is v2, with identical content to v1, doesn't that look like a bug? If \v1-2 is displayed as "verse 1", why wouldn't the user delete the part of the translation that is not in v1?

Add primitive Undo/Redo support for resource edits

We can use the git commit history on DCS to navigate backward and forward the git commit changes to allow reversion of edit changes. Note that if there are unsaved changes on the card, we should save those before pulling in old commits. That way redo would work if they have second thoughts.

Notes:

• this would not be as granular as the undo in a text editor (but in most browsers they already have that capability by doing CMD-Z
• need to test - this may not be fast.

Users should not be able to shrink the width or height of cards to the point where elements are moved off of the card

Here are some examples of the current problem

It would be nice to be able to resize cards by dragging on any edge

Only being able to resize from the lower right corner often causes the user to make extra sizing/dragging operations in order to accomplish their desired layout.
In the example below, it would be much simpler for the user if they could just adjust the left border of the tQ card.

https://images.zenhubusercontent.com/309394970/f8b0c868-3752-453f-b919-9d5e2bce15fa/issue_2_0_35.mp4

Add headless capability