openzim / openzim/overview

ZIM functionality: how to enhance title (suggestion) search results

Open
#73 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
9
Forks
2
PR merge metrics
No merged PRs in 30d

Description

In https://github.com/openzim/gutenberg/issues/349, we realize that only the title in title search result is a bit "rough". The fact that what is put inside the title search index is exactly what is displayed on the screen is clearly a limitation.

In Vue-based ZIMs, we have to implement a kind of hack to have title search: we create "mostly fake" HTML pages which only serve to have a title in the index and to redirect the user to the "index.html" SPA with proper fragment value. For instance in `` ZIM, when open the search result for "Rubik", it opens the index/comment_ca_marche_07_rubik_s_cube_bluetooth_connecte-LQNG article, which is in fact only a redirect to `index.html#/watch/comment_ca_marche_07_rubik_s_cube_bluetooth_connecte-LQNG?list=videos-9HEg` thanks to `<meta http-equiv="refresh" ...>`.

It also means we have no solution to propose different results depending on "conditions". For instance, in Vue-based ZIMs, when the user opens the search result we want to show different result (article) depending whether the reader has JS enabled or not.

@Jaifroid has also implemented Wikipedia articles preview in Kiwix JS (see https://www.reddit.com/r/Kiwix/comments/1e5b1e5/release_kiwix_js_browser_extension_v410_unleash/), while from my PoV it should be the ZIM creator responsibility to provide adequate preview (and the ZIM reader responsibility to fetch and display these previews, which could even be reused at different places like search results, link hover, ...)

All this together makes me consider we probably need something better in terms of title (suggestion) results.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked openzim/gutenberg issue and reviewing the described fake HTML redirect pages, title indexes, and Vue/JavaScript ZIM behavior. Compare the current title search result limitations with the proposed previews and conditional destinations. Done would require an agreed design for richer, reusable search suggestions before implementation can be scoped.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, javascript
Domain
search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.