ZIM functionality: how to enhance title (suggestion) search results
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- html, javascript
- Domain
- search
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.
Description
In https://github.com/openzim/papers/issues/34, 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.
- Dominant language
- HTML
- Stars
- 12
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from openzim/overview
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
ZIMaker toolOpen
Difficulty 4/5 3-5 days Newbie friendliness 30/100
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
question
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
question
Difficulty 4/5 3-5 days Newbie friendliness 45/100
All issues in openzim/overview
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bovinemagnet/AdocFoundry#279 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
documentation needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
bug docusaurus-v4
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 2 days