ifixit icon indicating copy to clipboard operation
ifixit copied to clipboard

¨Problem" around ZIM metadata "Description" and "LongDescription"

Open kelson42 opened this issue 1 year ago • 2 comments

Here is why I see on Kiwix Library when I search for the IFixit ZIM file in French: image

I'm not satisfied by the tile because the sentence is shorten although there is plenty of space for the description.

If I look to the metadata, I see:

  • The shorten (with ellipsis) "Description" because of the 80 characters limit of the ZIM specification. Makes sense and could be differently specified (with proper description as for now this is automatically retrieved from the upstream Web site) in corresponding Zimfarm recipe.
  • "LongDescription" is empty for now although it could have the proper sentence (without ellipsis) and can not be specified differently in Zimfarm recipe.

It looks like here to me the Description/LongDescription metadata are not and can not be specified properly.

kelson42 avatar Apr 21 '24 15:04 kelson42

To me, it is clear that part of the solution is in Zimfarm/Kiwix serve, but without having proper Metadata in the ZIM, this does not help. I would propose to:

  • Add support to --zimLongDescription command line to specific the ZIM Metdata LongDescription
  • Put in LongDescription the description coming from the upstream if longer than 80 characters.

kelson42 avatar Apr 21 '24 15:04 kelson42

  • Add support to --zimLongDescription command line to specific the ZIM Metdata LongDescription
  • Put in LongDescription the description coming from the upstream if longer than 80 characters.

Both already there, but both are either buggy (we do not store the long description in the ZIM while it is properly fetched and computed ...) and not properly exposed in the Zimfarm (just forgot about it ...)

I suggest we do not change the way the short description is currently computed, we just need editors to override it with a more tangible thing in Zimfarm for our use case. Do you agree?

benoit74 avatar Apr 30 '24 10:04 benoit74