Use title snippets if available #505

maneeshpm · 2021-05-08T19:30:08Z

Fixes #82

With openzim/libzim#545 we now support snippet generation for titles. It can be used as the display label on the ui for highlighted titles via the "label" field. The old version used plain-title which is still available in the value field.

Changes included in this pr:

Sets label to title snippet if available
Set up proper rendering of snippet using _renderItem property of autocomplete ui

codecov · 2021-05-08T19:30:20Z

Codecov Report

Merging #505 (1b56680) into master (b82fff9) will increase coverage by 0.02%.
The diff coverage is 100.00%.

❗ Current head 1b56680 differs from pull request most recent head 7b81795. Consider uploading reports for the commit 7b81795 to get more accurate results

@@            Coverage Diff             @@
##           master     #505      +/-   ##
==========================================
+ Coverage   64.57%   64.60%   +0.02%     
==========================================
  Files          50       50              
  Lines        3562     3565       +3     
  Branches     1802     1805       +3     
==========================================
+ Hits         2300     2303       +3     
  Misses       1260     1260              
  Partials        2        2

Impacted Files	Coverage Δ
src/reader.cpp	`44.04% <100.00%> (+0.20%)`	⬆️
src/server/internalServer.cpp	`87.05% <100.00%> (+0.05%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b82fff9...7b81795. Read the comment docs.

maneeshpm · 2021-05-08T19:32:30Z

@veloman-yunkan The HTML seems to be getting escaped in the front end. How to fix this?

kelson42 · 2021-05-09T05:16:37Z

@MananJethwani Maybe you can help @maneeshpm on that one?

MananJethwani · 2021-05-09T07:09:45Z

this I suppose is a problem with jquery-ui. because the data is received in taskbar.js as we expect it to be, and to stop this behavior we might have to use _renderItem property of autocomplete UI.

maneeshpm · 2021-05-10T06:33:53Z

@MananJethwani It seems like we are already using _renderItem
https://github.com/kiwix/kiwix-lib/blob/02c3dff142caff2d5713262b3e3604e6b1331794/static/skin/jquery-ui/jquery-ui.js#L7202-L7215

MananJethwani · 2021-05-10T06:50:43Z

@maneeshpm jquery-ui.js is the library file from where we import suggestion system.

maneeshpm · 2021-05-10T07:42:50Z

Thanks a lot for your help @MananJethwani, front end is not really my strong point 😅

Final result of the modification:

@kelson42 I believe this feature can be improved further by modifications in stemming and stopwords(openzim/libzim#324) to ensure all the matching terms are highlighted.

kelson42 · 2021-05-10T10:59:17Z

@maneeshpm Great to see this implemented and great you see the connection to the other ticket :)

src/reader.cpp

maneeshpm · 2021-05-16T05:41:51Z

Rebasing temporarily on #526

include/reader.h

kelson42 · 2021-05-19T04:56:01Z

@maneeshpm rebasing maybe?

kelson42 · 2021-05-25T14:31:13Z

@mgautierfr I have rebased this branch. We should really review/merge.

With openzim/libzim#545 we now support snippet generation of titles which can be used as the display label on the ui for highlighted titles via the "label" field. The old version used plain title which is still available in the value field.

To render the snippets properly, we need to use the _renderItem property of the autocomple ui.

This is a helper class that allows to create and manage individual suggestion item and their data.

Each sugestions used to be stored as vector of strings to hold various values such as title, path etc inside them. With this commit, we use the new dedicated class `SuggestionItem` to do the same.

mgautierfr · 2021-05-26T09:04:48Z

Rebased-fixup on master (and fix conflicts). We are good.

maneeshpm marked this pull request as draft May 8, 2021 19:31

maneeshpm force-pushed the suggestion_snippets branch from 2308bf8 to 9bba054 Compare May 10, 2021 07:28

maneeshpm force-pushed the suggestion_snippets branch from 9bba054 to 1b56680 Compare May 10, 2021 14:59

maneeshpm marked this pull request as ready for review May 10, 2021 14:59

maneeshpm requested a review from mgautierfr May 10, 2021 15:51

mgautierfr requested changes May 12, 2021

View reviewed changes

src/reader.cpp Outdated Show resolved Hide resolved

maneeshpm force-pushed the suggestion_snippets branch from 7b81795 to 947000f Compare May 16, 2021 05:33

maneeshpm changed the base branch from master to lizim_search_api_change May 16, 2021 05:33

Base automatically changed from lizim_search_api_change to master May 17, 2021 13:06

maneeshpm force-pushed the suggestion_snippets branch from 947000f to 27c7842 Compare May 17, 2021 14:04

maneeshpm requested a review from mgautierfr May 17, 2021 14:10

mgautierfr requested changes May 17, 2021

View reviewed changes

include/reader.h Show resolved Hide resolved

maneeshpm requested a review from mgautierfr May 18, 2021 18:49

maneeshpm force-pushed the suggestion_snippets branch from 7e85e22 to a5707a7 Compare May 19, 2021 06:22

kelson42 force-pushed the suggestion_snippets branch from a5707a7 to 2bbe0fa Compare May 25, 2021 14:30

maneeshpm force-pushed the suggestion_snippets branch from 2bbe0fa to 5f4b8d8 Compare May 25, 2021 14:37

maneeshpm added 3 commits May 26, 2021 10:52

Set label to title snippet if present

56434de

With openzim/libzim#545 we now support snippet generation of titles which can be used as the display label on the ui for highlighted titles via the "label" field. The old version used plain title which is still available in the value field.

Render suggestion snippet properly

3288cd8

To render the snippets properly, we need to use the _renderItem property of the autocomple ui.

Introduce SuggestionItem class

5315034

This is a helper class that allows to create and manage individual suggestion item and their data.

Replace std::vector<std::string> with SuggestionItem

5567d8c

Each sugestions used to be stored as vector of strings to hold various values such as title, path etc inside them. With this commit, we use the new dedicated class `SuggestionItem` to do the same.

mgautierfr force-pushed the suggestion_snippets branch from 5f4b8d8 to 5567d8c Compare May 26, 2021 08:55

mgautierfr approved these changes May 26, 2021

View reviewed changes

mgautierfr merged commit 7f0d300 into master May 26, 2021

mgautierfr deleted the suggestion_snippets branch May 26, 2021 09:04

This was referenced May 28, 2021

Fix kiwix-read to use SuggestionItem member functions kiwix/kiwix-tools#460

Closed

Fix suggestionListWorker to use SuggestionItem class methods kiwix/kiwix-desktop#648

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use title snippets if available #505

Use title snippets if available #505

maneeshpm commented May 8, 2021 •

edited

Loading

codecov bot commented May 8, 2021 •

edited

Loading

maneeshpm commented May 8, 2021

kelson42 commented May 9, 2021

MananJethwani commented May 9, 2021

maneeshpm commented May 10, 2021

MananJethwani commented May 10, 2021

maneeshpm commented May 10, 2021

kelson42 commented May 10, 2021

maneeshpm commented May 16, 2021

kelson42 commented May 19, 2021

kelson42 commented May 25, 2021

mgautierfr commented May 26, 2021

Use title snippets if available #505

Use title snippets if available #505

Conversation

maneeshpm commented May 8, 2021 • edited Loading

codecov bot commented May 8, 2021 • edited Loading

Codecov Report

maneeshpm commented May 8, 2021

kelson42 commented May 9, 2021

MananJethwani commented May 9, 2021

maneeshpm commented May 10, 2021

MananJethwani commented May 10, 2021

maneeshpm commented May 10, 2021

kelson42 commented May 10, 2021

maneeshpm commented May 16, 2021

kelson42 commented May 19, 2021

kelson42 commented May 25, 2021

mgautierfr commented May 26, 2021

maneeshpm commented May 8, 2021 •

edited

Loading

codecov bot commented May 8, 2021 •

edited

Loading