Difference between revisions of "Catalog"

From Kiwix
Jump to navigation Jump to search
(Add the optional / required fields)
m
Line 6: Line 6:
|-
|-
!'''Used by'''
!'''Used by'''
!'''Field name'''
!OPDS name
!'''Field name'''
! width="600px" | '''Description'''
! width="600px" | '''Description'''
! width="200px" | '''Example'''
! width="200px" | '''Example'''
Line 14: Line 15:
|-
|-
|<br>
|<br>
|id*
|
|id*
|Unique version (different for different versions)
|Unique version (different for different versions)
|550d12b5-4b9c-4841-b92c-b229488c47b8
|550d12b5-4b9c-4841-b92c-b229488c47b8
Line 22: Line 24:
|-
|-
|<br>
|<br>
|name*
|
|name*
|An human readable identifier for the resource. It's the same across versions (should be stable across time). MUST be prefixed by the packager name
|An 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
|kiwix.wikipedia_en.nopics
Line 30: Line 33:
|-
|-
|<br>
|<br>
|version*
|
|version*
|The version of the content. It MUST be the date of release
|The version of the content. It MUST be the date of release
|2016-06-18 or 2016-06-18-4
|2016-06-18 or 2016-06-18-4
Line 38: Line 42:
|-
|-
|<br>
|<br>
|title*
|
|title*
|The title of the resource
|The title of the resource
|Wikipedia in English (With pictures)
|Wikipedia in English (With pictures)
Line 46: Line 51:
|-
|-
|<br>
|<br>
|description (*?)
|
|description (*?)
|The description of the  resource.
|The description of the  resource.
|The famous encyclopedia, just for you...
|The famous encyclopedia, just for you...
Line 54: Line 60:
|-
|-
|<br>
|<br>
|languages*
|
|languages*
|The list of languages the content is written in
|The list of languages the content is written in
|eng;fra
|eng;fra
Line 62: Line 69:
|-
|-
|<br>
|<br>
|checksum*
|
|checksum*
|the checksum of the content
|the checksum of the content
|<br>
|<br>
Line 70: Line 78:
|-
|-
|<br>
|<br>
|url*
|
|url*
|An HTTP URL to the file
|An HTTP URL to the file
|<nowiki>http://download.kiwix.org/foobar.zim</nowiki>
|<nowiki>http://download.kiwix.org/foobar.zim</nowiki>
Line 78: Line 87:
|-
|-
|<br>
|<br>
|size*
|
|size*
|The size of the content (in bytes)
|The size of the content (in bytes)
|42
|42
Line 86: Line 96:
|-
|-
|<br>
|<br>
|mimetype*
|
|mimetype*
|The mimetype of the file
|The mimetype of the file
|application/zip
|application/zip
Line 94: Line 105:
|-
|-
|<br>
|<br>
|intended_use*
|
|intended_use*
|Describes the type of content this is; so clients can know what to do with it (open kiwix, unzip it somewhere, etc)
|Describes the type of content this is; so clients can know what to do with it (open kiwix, unzip it somewhere, etc)
|zim or static-html or kalite
|zim or static-html or kalite
Line 102: Line 114:
|-
|-
|IIAB, Kiwix
|IIAB, Kiwix
|thumbnail_urls
|
|thumbnail_urls
|A dictionary containing images in different sizes
|A dictionary containing images in different sizes
|{small : <nowiki>https://website.com/thumbnail.png</nowiki>, medium : url, big : url}
|{small : <nowiki>https://website.com/thumbnail.png</nowiki>, medium : url, big : url}
Line 110: Line 123:
|-
|-
|Maybe IIAB
|Maybe IIAB
|requires
|
|requires
|A list of mimetypes that if not supported will prevent this content from being played
|A list of mimetypes that if not supported will prevent this content from being played
|application/x-shockwave-flash
|application/x-shockwave-flash
Line 118: Line 132:
|-
|-
|BSF, IIAB
|BSF, IIAB
|tags
|
|tags
|A list of tags
|A list of tags
|School;Videos;Playing;Boats;Fun
|School;Videos;Playing;Boats;Fun
Line 126: Line 141:
|-
|-
|RACHEL
|RACHEL
|extra_fields
|
|extra_fields
|An object, containing key/values which are free form
|An object, containing key/values which are free form
|<br>
|<br>
Line 134: Line 150:
|-
|-
|IIAB, BSF
|IIAB, BSF
|content_group
|
|content_group
|A  group the content belongs to.
|A  group the content belongs to.
|Wikipedia or Wiktionary
|Wikipedia or Wiktionary
Line 142: Line 159:
|-
|-
|IIAB
|IIAB
|variants
|
|variants
|You can only have one variant at a time.
|You can only have one variant at a time.
|{has_pictures : true}
|{has_pictures : true}
Line 150: Line 168:
|-
|-
|RACHEL, Kiwix
|RACHEL, Kiwix
|alternate_urls
|
|alternate_urls
|List of alternative URLs to use in order to get the content
|List of alternative URLs to use in order to get the content
|<nowiki>magnet://?xt=urn:...</nowiki>:
|<nowiki>magnet://?xt=urn:...</nowiki>:
Line 158: Line 177:
|-
|-
|Everyone
|Everyone
|authors
|
|authors
|A list of authors
|A list of authors
|John Doe, MLK
|John Doe, MLK
Line 166: Line 186:
|-
|-
|Everyone
|Everyone
|publisher
|
|publisher
|Who is responsible of the content itself
|Who is responsible of the content itself
|Wikimedia folks <contact@wikimedia.org>
|Wikimedia folks <contact@wikimedia.org>
Line 174: Line 195:
|-
|-
|Everyone
|Everyone
|packager
|
|packager
|The person(s) responsible for the technical packaging
|The person(s) responsible for the technical packaging
|Super Emmanuel <kelson@kiwix.org>
|Super Emmanuel <kelson@kiwix.org>
Line 182: Line 204:
|-
|-
|Everyone
|Everyone
|licences
|
|licences
|A list of existing licences
|A list of existing licences
|MIT
|MIT

Revision as of 12:14, 22 June 2016

If this looks broken, please zoom out.

* means required.

Used by OPDS name Field name Description Example Format Notes

id* Unique version (different for different versions) 550d12b5-4b9c-4841-b92c-b229488c47b8 uuid-4

name* An 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 source.resource_name.variants

version* The version of the content. It MUST be the date of release 2016-06-18 or 2016-06-18-4 YYYY-MM-DD(-V), V being an optional number that you can add to differentiate between versions published at the same date. This is the date of the release of the packaged content.

title* The title of the resource Wikipedia in English (With pictures) String

description (*?) The description of the resource. The famous encyclopedia, just for you... String

languages* The list of languages the content is written in eng;fra ISO 639-3 separated with semicolons without spaces.

checksum* the checksum of the content
sha256 of the content (32 bytes)

url* An HTTP URL to the file http://download.kiwix.org/foobar.zim An URL as defined in the protocol (to add) Also see the "alternate_urls" field for alternate urls.

size* The size of the content (in bytes) 42 unsigned integer

mimetype* The mimetype of the file application/zip https://en.wikipedia.org/wiki/Media_type

intended_use* Describes the type of content this is; so clients can know what to do with it (open kiwix, unzip it somewhere, etc) zim or static-html or kalite String In order to know what this does, you can go to https://wiki.kiwix.org/catalog/{name}
IIAB, Kiwix thumbnail_urls A dictionary containing images in different sizes {small : https://website.com/thumbnail.png, medium : url, big : url} Exact size of the images needs to be defined
Maybe IIAB requires A list of mimetypes that if not supported will prevent this content from being played application/x-shockwave-flash The list contains mimetypes.
BSF, IIAB tags A list of tags School;Videos;Playing;Boats;Fun Strings, separated by semicolon
RACHEL extra_fields An object, containing key/values which are free form


IIAB, BSF content_group A group the content belongs to. Wikipedia or Wiktionary A string
IIAB variants You can only have one variant at a time. {has_pictures : true} Dictionary of variant names and values You want to install one of these in the list, but never both at the same time.
RACHEL, Kiwix alternate_urls List of alternative URLs to use in order to get the content magnet://?xt=urn:...:

Everyone authors A list of authors John Doe, MLK

Everyone publisher Who is responsible of the content itself Wikimedia folks <contact@wikimedia.org>

Everyone packager The person(s) responsible for the technical packaging Super Emmanuel <kelson@kiwix.org>

Everyone licences A list of existing licences MIT String

Items for discussion:

- Should description be optional or required ?

Retrieved from "https://wiki.kiwix.org/w/index.php?title=Catalog&oldid=28978"