[Crum/Xooxle] Improve User Experience

[pishoyg]

TODO:

• Add an option to search for a whole word only.
• Fix query highlighting using :~:text=. Support it for both whole-word and simple search.
• Add an option to search using regex.
• Performance: Load the index at most once.
• Responsiveness: Load the page first and let the index load in the background.
• Responsiveness: Update the display with partial results, instead of waiting for the whole list before updating display.

[pishoyg]

Status:
All suggestions in the first comment have been addressed. Now we have a few ones:

Summary TODO:

• Add a third column in the search results that shows the context (where the match occurs in the text).
• The matching text should be highlighted in that context.
• If multiple matches are found, they should all be highlighted.
• The text that we search (which is generated by make xooxle) should be retained on several lines. So '\n'.join(' '.join(line.split()) for line in text.split('\n')) instead of your current ' '.join(line.split()).
• The context should be shown on a line-by-line basis. We could perhaps highlight the match in one line at a time.
• It's not possible for the text fragment directive to highlight several matches. Mention that in a popup that shows when you hover? Or maybe just ignore this fact, since the context column will show all matches.
• Show the dialects in the title.
• Display a warning message about Google's index not getting updated often.
• (slightly more involved) Exclude irrelevant elements (such as Dawoud and Crum, or the keys).
• (slightly more involved) Implement dialect-oriented search, perhaps utilizing the fact that your text now goes on several lines.

[pishoyg]

This is, at least partially, highly desirable (and feasible). Moving to the v1.0 milestone.

[pishoyg]

TODO: Number the list with Roman numerals.

[pishoyg]

Most elements in the HTML seem to have classes that we can use to exclude them from the search, except "Crum", "Dawoud", and the page numbers below the Dawoud dictionary scans.

[pishoyg]

Status:

• Many of the suggestions made earlier have been implemented (particularly removing noise from the text that we search, retaining lines, showing context).
• We will NOT use Roman numerals because the list already has numbers.
• We are starting to question whether we actually want the dialects to appear in the title.

Summary TODO:

1. (nit) Separate the rows by lines to make it more reader-friendly.
2. (nit) If multiple matches are found on the same line, they should all be highlighted.
3. (more involved) Implement dialect-oriented search, perhaps utilizing the fact that your text now goes on several lines.
4. (implementation unclear) If you could update the display as users type, that would be great. Right now, it seems to cause some jitter (which could be remedied by perhaps updating the display only once per search, rather than yielding to update the display for each search result), and the text that gets searched is always missing the last letter!
5. (reconsidered) It's not possible for the text fragment directive to highlight several matches. Mention that in a popup that shows when you hover? Or maybe just ignore this fact, since the context column will show all matches.
6. (reconsidered) Show the dialects in the title.

[pishoyg]

TODO: Words have a hyperlink to the page, don't put the page on a separate column.

[pishoyg]

TODO:

• (reconsidered) Results open in a new tab.
• (reconsidered) When you search for an English word, consider the word's synonyms and inflections, so you can make the search experience even better.

[pishoyg]

Status:

Done:

1. If you could update the display as users type, that would be great. Right now, it seems to cause some jitter (which could be remedied by perhaps updating the display only once per search, rather than yielding to update the display for each search result), and the text that gets searched is always missing the last letter!
2. Words have a hyperlink to the page, don't put the page on a separate column.
3. Separate the rows by lines to make it more reader-friendly.

Rejected:

1. It's not possible for the text fragment directive to highlight several matches. Mention that in a popup that shows when you hover? Or maybe just ignore this fact, since the context column will show all matches.
2. Results open in a new tab.

TODO:

Nit:

1. Search responds to keypresses, not just input.
2. Show the dialects in the title.
3. If multiple matches are found on the same line, they should all be highlighted.
4. Implement your own highlighting and scrolling in JavaScript. Don't rely on Chrome.

More involved:

1. Implement dialect-oriented search, perhaps utilizing the fact that your text now goes on several lines.

Low-priority:

1. When you search for an English word, consider the word's synonyms and inflections, so you can make the search experience even better.

[pishoyg]

Status:

Moved:

1. Perform normalization beyond changing to lower case. (Then close [Crum/Xooxle] Perform Normalization beyond Changing to Lower Case #253 as completed.)

TODO (low-priority):

1. Eliminate view cell jitter, which results from removing and readding indexes!
2. Make it possible to copy the results to the clipboard, or export them to a CSV or excel!
3. When you search for an English word, consider the word's synonyms and inflections, so you can make the search experience even better.
4. A long press on n or p should keep scrolling through the results!

[pishoyg]

Status:

DONE:

1. A long press on n or p should keep scrolling through the results (fixed in 6f7e309)!

TODO (low-priority):

1. Eliminate view cell jitter, which results from removing and readding indexes!
2. Make it possible to copy the results to the clipboard, or export them to a CSV or excel!
3. When you search for an English word, consider the word's synonyms and inflections, so you can make the search experience even better.¹

Footnotes

1. Although we have enabled the Google search panel, it seems good at recognizing basic inflections, but not great at working with synonyms! ↩

[pishoyg]

Status:

Moved:

1. Eliminate view cell jitter, which results from removing and readding indexes! [Site/Xooxle] Eliminte view Cell Jitter #300
2. Make it possible to copy the results to the clipboard, or export them to a CSV or excel! [Site/Xooxle] Add copy Buttons for Cells / Rows #301
3. When you search for an English word, consider the word's synonyms and inflections, so you can make the search experience even better.¹ [Site/Xooxle] Consider English Synonyms and Inflections in Xooxle Search #302

Footnotes

1. Although we have enabled the Google search panel, it seems good at recognizing basic inflections, but not great at working with synonyms! ↩

[pishoyg]

Huge, general-purpose issues are a bad idea! See!