search

thegrumpys / odop

Open Design Optimization Platform (ODOP) - Coil spring design app; mechanical springs; compression spring, extension spring, torsion spring
https://www.springdesignsoftware.org
MIT License
4 stars 5 forks source link

Improvements to full-text Help doc indexing w/ Lunr #684

Closed grumpyinca closed 2 years ago

grumpyinca commented 2 years ago

This issue lists possible improvements to the full-text Help document indexing that was created as part of #676.

  1. DONE: Add an additional "Close" button at the top of the "Help lookup for terms "xxx" modal.
  2. DONE: Add a context Help button (or two).
  3. MOVED to #693; Limit the number of hits displayed on the "Help lookup for terms "xxx" modal to (10?) entries. Page forward / back ?
  4. DONE: Document how to apply multi-word terms to get intuitive results ("and", not "or" between the words)
  5. DONE: Change blurb sentence algorithm to always show the found words and highlight around them
  6. DONE: Improve build_index/blurb sentence algorithm. See below comment.
1fifoto commented 2 years ago

For item 1 do google search of “Bootstrap modal close button 4.5” and insert button icon html construct into modal title

1fifoto commented 2 years ago

I have created docLookup.md. In it I referred to Lunr Searching Guide, but that page is written in "programmer-eeze" explaining Lunr search parameters. I need Mike to write a detailed description of the search syntax from a user's point-of-view (using that article). Alternatively see Refine web searches for how Google explains their search syntax to users.

grumpyinca commented 2 years ago

I have integrated content from docLookup.md into branch #677 helpLookup.md. Also, I used the Lunr Searching Guide to create a short bullet list of control characters with examples there. I propose that #677 helpLookup.md supersede docLookup.md.

1fifoto commented 2 years ago

Change blurb sentence algorithm to always show the found words and highlight them with n words surrounds it. for example, a b c d e f g. If n=2 and f is found them show 2 words around it. ... d e f g ...

Somehow mark the content with sentence boundaries by the build_index algorithm. Then in the blurb algorithm use these boundaries instead of using '\b.\s reg ex. This should enhance blurb algorithm to not include lists of topics, etc.

1fifoto commented 2 years ago

https://react-bootstrap.github.io/components/pagination/ https://github.com/react-bootstrap-table/react-bootstrap-table2/blob/master/packages/react-bootstrap-table2-paginator/README.md

1fifoto commented 2 years ago

Merged into master, closing. Will split off Item 3 in description to a separate issue #693: Filter amount by Page, Sentence, and Word.