Difference between revisions of "Metadata"

Jump to navigation Jump to search
1,267 bytes added ,  09:09, 13 April 2022
m
(13 intermediate revisions by 4 users not shown)
Line 4: Line 4:


== Keys ==
== Keys ==
{|{{Prettytable}}
{| class="sortable" style="border-width:1px; border-style:solid; border-color:#888888; background-color:#eeeeee; border-collapse:collapse; empty-cells:show" cellspacing="0" cellpadding="4" {{Prettytable}}
! Key    !! Mandatory    !! Description !! Example
! Key    !! Mandatory    !! Description !! Example
|-
|-
! Name
! Name
| yes
| 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.
| A human readable identifier for the resource. It's the same across versions (should be stable across time).
| ''kiwix.wikipedia_en.nopics''
| ''wikipedia_fr_football''
|-
|-
! Title
! Title
Line 29: Line 29:
! Date
! Date
| yes
| yes
| create date (ISO - YYYY-MM-DD)
| ZIM creation date (ISO - YYYY-MM-DD)
| ''2009-11-21''
| ''2009-11-21''
|-
|-
Line 37: Line 37:
| ''All articles (without images) from the english Wikipedia''
| ''All articles (without images) from the english Wikipedia''
|-
|-
! Long description
! LongDescription
| no
| no
| description of content (small paragraph)
| description of content (small paragraph)
Line 54: Line 54:
! Tags
! Tags
| no
| no
| A list of tags
| A list of [[tags]]
| ''nopic;wikipedia''
| ''wikipedia;_category:wikipedia;_pictures:no;_videos:no;_details:yes;_ftindex:yes''
|-
|-
! Relation
! Relation
Line 61: Line 61:
| URI of external related ressources
| URI of external related ressources
|  
|  
|-
! Flavour
| no
| A human readable string describing the way how the content has been scraped. It's the same across versions (should be stable across time).
| ''nopic''
|-
|-
! Source
! Source
| no
| no
| URI of the original source
| URI of the original source
| ''http://en.wikipedia.org/''
| ''https://en.wikipedia.org/''
|-
|-
! Counter
! Counter
Line 72: Line 77:
| image/jpeg=5;image/gif=3;image/png=2;...
| image/jpeg=5;image/gif=3;image/png=2;...
|-
|-
! Illustration
! Scraper
| no
| no
| List of semi-colon separated ZIM paths of pictures illustrating the content.
| Details about the software used to scrape the content, with its version
| -/illustration_1_234x23.png;-/illustration_2_234x293.png;-/illustration_434x23.png
| mwoffliner 1.2.3
|-
!Illustration_[height]x[width]@[scale]
|yes
|A png image (resolution [height] by [width]) to illustrate the zim file.
This must be a binary content (png) with mimeytpe `image/png`.
 
We follow the same specification than freedesktop  https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html for the size and scale of the icon.
 
<code>height</code>, <code>width</code>, <code>scale</code> describe the '''target''' size (where the icon is intended to be displayed) :
 
- <code>Illustration_48x48@1</code> is a 48x48 pixels image to be displayed as a 48x48 icon on a scale 1 screen.
 
- <code>Illustration_48x48@2</code> is a 96x96 pixels image to be displayed as a 48x48 icon on a scale 2 screen.
 
- <code>Illustration_96x96@1</code> is a 96x96 pixels image to be displayes as a 96x96 icon on a scale 1 screen.
 
 
<code>Illustration_48x48@1</code> is mandatory. Others are optional.
!
|}
|}


== Favicon ==
== Favicon (Old zim file) ==
 
Old zim file may have a illustration in <code>-/favicon</code> (it can be a redirection to the real content).


A favicon (48x48) is also mandatory and should be located at /-/favicon.
Reader must be able to read the illustration using this path.


You can also provide ''n'' optional /-/favicon_[heigt]x[width] entries for high resolution version of the favicon.
Writer must not set a <code>-/favicon</code>


== See also ==
== See also ==
* [http://dublincore.org/documents/dces/ Dublin Core]
* [http://dublincore.org/documents/dces/ Dublin Core]
28

edits

Navigation menu