glitchassassin / armorer Goto Github PK

Full-text search of the Scriptures. Results should include the passage (e.g. John 3:16), URL (e.g. /john/3#16), and verse text.

Evaluate options: compile index at build time, load in the client and query with JS; compile index into WASM module that can be loaded and queried with JS; something else?

You have created a nice program here and you are depending on node-sword-interface. node-sword-interface is licensed under the GPL version 2 (like the SWORD library) and therefore requires that software depending on it is also released under the GPL version 2 (see the GPL v2 FAQ). Could you therefore change the license of armorer to the GPL v2, since the currently used license is not compliant when depending on a GPLv2 software.

Currently, if the selected verse is towards the end of the chapter, navigating by verse (e.g. https://armorer.io/2-timothy/1/#18) will show the verse anywhere on the screen rather than at the top (since the page stops scrolling at the bottom).

A better UX would be to consistently scroll to the verse regardless of its position in the chapter (and perhaps subtly highlight the verse).

One way to accomplish this would be to just have a 100VH div below all the chapters, so it can scroll to the position even if the next chapter isn't loaded yet. This may create a flash of empty space before loading the chapter.

Another option may be to include the next chapter in each static page, without the verse number IDs. (While we're at it, we may want to dynamically hide the verse IDs in chapters that aren't "current" based on the URL.) This should get us closer, but for shorter chapters like Psalms (and depending on the screen size) we may still come up short.

Perhaps a combination of the two will give the best compromise.

When the user searches for a reference, this should create a new history state which includes the search query and the page number.

If I search for something (e.g. "count cost"), click a result, read the page, and then click back, it should display my previous search (on the same page of results). If I click back again, it should take me to any previous result pages, then to the passage I was reading before.

Look at intersect plugin, morph plugin

In conjunction with #13, consider making intersection blocks for each verse instead of for each chapter

If we link to verse 2 of a chapter on mobile, the rendered page is scrolled down just far enough that the intersection trigger to load the previous chapter doesn't fire.

Perhaps we just load the previous and next chapter as soon as any of the chapter intersects?

Map "LORD" to use small caps

Unfurl on Discord has Revelation 22 instead of the correct passage

Highlight verses on hover
Copy selections to clipboard automatically

Graph tags, unfurl, favicon, etc.

But ye shall be named the Priests of the Lord: men shall call you the Ministers of our God: ye shall eat the riches of the Gentiles, and in their glory shall ye boast yourselves.
Isaiah 61:6

Searching for priests and ministers misses this passage. Because of the capitalization?

The verse IDs overlap as more chapters are loaded in. Also, navigating to the verse ID may not be working correctly when the search pane is displayed instead of the verses themselves. Example: Try searching for and navigating to a verse within the current chapter.

Scrolling updates the chapter but does not update the verse. Consider setting a custom viewport and updating the URL for each verse rather than at chapter intervals.

Malachi 4 is not being updated on iphone

We are converting LORD to small caps, but the possessive is being ignored and is still normal caps. Handle this also

Scrolling and reference navigation makes the TOC less valuable. Remove chapter TOCs, redirecting automatically to ch. 1.

Consider removing Bible TOC or integrating with #4

The navigation arrows take up too much space on the sides. Let the content expand full width, and let the arrows float above the content unobtrusively.

Something is causing horizontal scrolling - stop that.

Remove the space set aside for the search button. We need the reference box to be larger.

Add a social link to the GitHub repo

Searching for "eye for eye" turns up every verse with "eye." Evaluate removing the stopwords tokenizer

See e.g.

The Lord Jesus Christ be with thy spirit. Grace be with you. Amen. The second epistle unto Timotheus, ordained the first bishop of the church of the Ephesians, was written from Rome, when Paul was brought before Nero the second time.
2 Timothy 4:22

May also be interfering with copy/paste script?

• Create HTML/CSS template for reading chapters.
• Create Table of Contents template.
• Render SWORD module to HTML static site using template.

Evaluate AlpineJS for this. Specifically, will Alpine register when new commands are loaded with x-html?

• Globally, track renderedChapters: number[] and currentChapter: number
• When currentChapter changes, unload any chapters more than 2 chapters distant from currentChapter. Load the next and previous chapter(s) (if needed). Insert the loaded chapter into the correct position in the DOM.

Despite not selecting the verse numbers, they are still being included in the copy text (argh).

Let's make sure they are excluded, and evaluate adding a reference range to the copied text.

Earlier searches sometimes return their results later (e.g., if you are typing out a long search term). Make sure earlier results are properly replaced by later results (or dropped if not needed).

Someone suggested offering a version of the KJV with Apocrypha. There is a SWORD module for this version, but chapter-and-verse does not include apocryphal books. In addition, verse numbering has nuances between the KJV and other versions that would need to be supported.

Once these hurdles are resolved, we can update the build to allow importing any SWORD Bible module, and deploy the alternative versions to different subdomains of armorer.io.