Difference between revisions of "Metadata"

From openZIM
Jump to navigation Jump to search
Line 1: Line 1:
We put metadata of zim files into the namespace 'M'. These keys are defined:
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.


* Title - title of zim file
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.
* Creator - creator of the zim file
 
* Date - create date (ISO - YYYY-MM-DD)
== Keys ==
* Description - description of content
{|{{Prettytable}}
* Language - ISO639-3 language identifier
! Key        !! Description !! Example
* Relation - link to some external relation
|-
* Source - pointer to original source (e.g. url to wikipedia)
! Title
| title of zim file
| ''english Wikipedia''
|-
! Creator
| creator of the ZIM file
| ''Wikimedia Foundation''
|-
! 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
| [http://www.sil.org/iso639-3/codes.asp ISO639-3 language identifier]
| ''eng'''
|-
! Relation
| URI of external related ressources
|
|-
! Source
| URI of the original source
| ''http://en.wikipedia.org/''
|}


see also [http://dublincore.org/documents/dces/]
see also [http://dublincore.org/documents/dces/]

Revision as of 09:07, 14 June 2010

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 Wikimedia Foundation
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]