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

ZIM name vs Book name confusion in documentation #663

Closed
veloman-yunkan opened this issue Mar 4, 2024 · 0 comments · Fixed by #664
Closed

ZIM name vs Book name confusion in documentation #663

veloman-yunkan opened this issue Mar 4, 2024 · 0 comments · Fixed by #664
Assignees
Milestone

Comments

@veloman-yunkan
Copy link
Collaborator

kiwix-serve documentation has incorrectly merged two ways of referring to a library entry. In the current implementation there are two kind of names associated with a ZIM file:

  1. An identifier derived from the file path.
  2. An identifier recorded in the ZIM archive metadata, library XML file or the OPDS feed (only one of these is associated with a book entry at a time).

As an example of a mistake in the documentation, it follows that the books.name and books.filter.name filtering parameters are equivalent, whereas the former filters by identifier#1 from above and the latter by identifier#2.

I will fix the documentation but I think that we should also try to eliminate the source of such confusion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants