Metadata

From openZIM
Jump to: navigation, search

In order to provide a description to each ZIM file that can be easily extracted we defined a special namespace M and a standardized set of keywords that should be used.

Every key is defined like an article, the key name is used as the article name, the key value is put into the article text. This way also metadata is compressed, but extendable. Further keys could be used in a ZIM file without breaking the standard but please be aware that maybe the openZIM project will define additional keys in the future. Any ZIM library reading this metadata should ignore missing keys / values and just return NULL values in such cases.

Keys

Key Mandatory Description Example
Name yes A human readable identifier for the resource. It's the same across versions (should be stable across time). MUST be prefixed by the packager name. kiwix.wikipedia_en.nopics
Title yes title of zim file English Wikipedia
Creator yes creator(s) of the ZIM file content English speaking Wikipedia contributors
Publisher yes creator of the ZIM file itself Wikipedia user Foobar
Date yes create date (ISO - YYYY-MM-DD) 2009-11-21
Description yes description of content (one short sentence) All articles (without images) from the english Wikipedia
LongDescription no description of content (small paragraph) This ZIM file contains all articles (without images) from the english Wikipedia by 2009-11-10. The topics are ...
Language yes ISO639-3 language identifier (if many, comma separated) eng
License No License code of the content. CC-BY
Tags no A list of tags nopic;wikipedia
Relation no URI of external related ressources
Source no URI of the original source http://en.wikipedia.org/
Counter no Number of non-redirect entries per mime-type image/jpeg=5;image/gif=3;image/png=2;...

Favicon

A favicon (48x48) is also mandatory and should be located at /-/favicon.

You can also provide n optional /-/favicon_[heigt]x[width] entries for high resolution version of the favicon.

Illustration

A picture illustrating the content and should be located at /-/illustration

You can provide n optional /-/illustration.*_[heigt]x[width] entries

See also