offspot / imager-service

Create Kiwix Hotspot microSD cards online
https://imager.kiwix.org/
GNU General Public License v3.0
14 stars 6 forks source link

Update ZIM catalog #315

Closed rgaudin closed 1 year ago

rgaudin commented 1 year ago

Current ZIM catalog is implemented as follows

IDs are the ones from the ideascube YAML. ex 3dprinting.stackexchange.com_en_all.en. those are computed using the filename (found in library.xml url) with some replacement and period removal, concatenated with the language code.

Proposal

Switching entirely to OPDS is the goal but the UI work it requires is too much at this stage and not worth the added value ; especially given we have heavy UI works planned for later.

This intermediate step would reproduce the current in-cardshop catalog api by consuming the full list of OPDS entries and caching it. Main change would be the switch from the ideascube IDs to a new cardshop-specific ID composed of Name and Flavour.

Additional change would be to fetch the favicon from OPDS-returned URL once needed. Caching TBD.

Hopefully most existing IDs would convert fine in a script ; we can add tweaks for those that don't.

kelson42 commented 1 year ago

I would recommend to add the Publisher information to the IDs from the OPDS to ensure there is no conflict once we will use ZIM created by third parties.