openzim / libzim

Reference implementation of the ZIM specification
https://download.openzim.org/release/libzim/
GNU General Public License v2.0
163 stars 47 forks source link

Document ZIM major and minor versions #853

Closed benoit74 closed 5 months ago

benoit74 commented 6 months ago

We should:

mgautierfr commented 6 months ago

document what is ZIM minor 2 (of version 6)

This part is done

kelson42 commented 6 months ago

I will complete at https://wiki.openzim.org/wiki/ZIM_file_format#Header

kelson42 commented 5 months ago

I have completed an reshaped the documentation, see https://wiki.openzim.org/wiki/ZIM_file_format#Header

benoit74 commented 5 months ago

I don't get what "Backward compatible" means in your table, or there are some mistakes in your values.

I would assume that when present on a version N it could means that "an implementation reading version N-1 is capable to read version N" or "an implementation reading version N is capable to read ZIMs in version N-1 by design" but I feel like none of them makes sense with the value you provided (based on my very limited understanding). Plus it conflicts with the meaning you gave to major / minor versioning in the table above. And we are not sure whether the compatibility refers to the previous minor or major version.

You should at least add a sentence making it clearer I think.

Did you forget about the libzim table? (explaining which libzim version is producing which ZIM version)

mgautierfr commented 5 months ago

The value (and the description) in the wiki are wrong. At least for major 5. The extended cluster has been introduced by major version 6. (And it is why I've made a version 6)

mgautierfr commented 5 months ago

I have update the wiki.(https://wiki.openzim.org/w/index.php?title=ZIM_file_format&type=revision&diff=31347&oldid=31346) Please comment here if you agree or not with the changes.