Searchfield for help

[nicodh]

This PR adds a search field to the help page, using pagefind which generates an index which is then used to search and disply results in the static help page.

Needs latest main of https://github.com/deltachat/deltachat-pages/

[Simon-Laux]

Nice. For the translation keys I think it makes more sense to use the existing substitution pattern, you can convert it to the custom one in bin/help/help-translations.js.

• reasons: reusability and consistency

[Simon-Laux]

nice detail 👍

[Simon-Laux]

does not work out of the box and I agree with the idea that pagefind.js and wasm.unknown.pagefind should not be duplicated - maybe they could be imported via import statement from start-pagefind.js?

[Simon-Laux]

maybe https://pagefind.app/docs/ui/#bundle-path could help, Pagefind (the lib not ui) also has a basePath option

[nicodh]

does not work out of the box and I agree with the idea that pagefind.js and wasm.unknown.pagefind should not be duplicated - maybe they could be imported via import statement from start-pagefind.js?

Sorry - the problem was, that I didn't commit the changes needed after the update of deltachat-pages

[nicodh]

Concerning the redundant files: pagefind expects the wasm files to be at the same path as pagefind-ui.js & pagefind.js.
All together build the "bundle-path". The paths to the data are obviously relative.

What I did now is: copy the needed files to static/help/ and remove them from /static/help//pagefind/ in build process.
Then copy them to the current language dir on runtime when needed. (when language is switched)

[Simon-Laux]

Then copy them to the current language dir on runtime when needed. (when language is switched)

bad idea, app files at runtime should be treated immutable. what you can do is making a custom uri schema for the help and match on the name to return the same file in all sub directories, similar to how webxdc.js is served.
Or try understand how Pagefind works and adjust it to work the way we want, that would be the ideal solution.

[nicodh]

I found a solution: added a lang attribute to each help page and moved the pagefind indexing one level up, so all data goes into one pagefind directory while pagefind assigns the index per language and shows only appropriate matches

[Simon-Laux]

---

Icon/char for clear search is not loaded, but that no blocker in my eyes

[nicodh]

Icon/char for clear search is not loaded, but that no blocker in my eyes

You have an idea why? It's just a Unicode 🞫 ?

[Simon-Laux]

You have an idea why? It's just a Unicode 🞫 ?

you need to load a font that supports it

[nicodh]

You have an idea why? It's just a Unicode 🞫 ?

you need to load a font that supports it

You mean it depends if your system font supports it? Does it makes sense to look for another sign with better support? Maybe https://en.wikipedia.org/wiki/Multiplication_sign ?

[Simon-Laux]

• either add a font that supports it to the css of the help file
• use just the "X" letter character
• use a string/button with the text "clear"
• or use an image/icon.

[r10s]

this PR has reverted the help to a pretty old state, i'll did an update at #4725 , not sure, if pagefine script ran correctly there, that should be double-checked