Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
kelson42 opened this issue Apr 21, 2024 · 2 comments
Open

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

kelson42 opened this issue Apr 21, 2024 · 2 comments
Labels
bug Something isn't working good first issue Good for newcomers priority 1 High priority
Milestone

Comments

@kelson42
Copy link
Contributor

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 kelson42 added enhancement New feature or request good first issue Good for newcomers question Further information is requested labels Apr 21, 2024
@kelson42
Copy link
Contributor Author

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.

@benoit74
Copy link
Collaborator

  • 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 benoit74 added bug Something isn't working good first issue Good for newcomers and removed enhancement New feature or request good first issue Good for newcomers question Further information is requested labels Apr 30, 2024
@benoit74 benoit74 added this to the 0.4.0 milestone Apr 30, 2024
@benoit74 benoit74 added the priority 1 High priority label Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers priority 1 High priority
Projects
None yet
Development

No branches or pull requests

2 participants