Metadata

From openZIM
Revision as of 10:52, 22 July 2010 by Kelson (talk | contribs)
Jump to navigation Jump to 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 Description Example
Title title of zim file English Wikipedia
Creator creator of the ZIM file English speaking Wikipedia contributors
Date create date (ISO - YYYY-MM-DD) 2009-11-21
Description description of content This ZIM file contains all articles (without images) from the english Wikipedia by 2009-11-10.
Language ISO639-3 language identifier eng
Relation URI of external related ressources
Source URI of the original source http://en.wikipedia.org/

see also [1]