6
edits
Difference between revisions of "Catalog"
Jump to navigation
Jump to search
Add the optional / required fields
(Add the optional / required fields) |
|||
| Line 1: | Line 1: | ||
If this looks broken, please zoom out. | |||
<nowiki>*</nowiki> means required. | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 12: | Line 14: | ||
|- | |- | ||
|<br> | |<br> | ||
| | |id* | ||
|Unique version (different for different versions) | |Unique version (different for different versions) | ||
|550d12b5-4b9c-4841-b92c-b229488c47b8 | |550d12b5-4b9c-4841-b92c-b229488c47b8 | ||
| Line 20: | Line 22: | ||
|- | |- | ||
|<br> | |<br> | ||
| | |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 28: | Line 30: | ||
|- | |- | ||
|<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 36: | Line 38: | ||
|- | |- | ||
|<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 44: | Line 46: | ||
|- | |- | ||
|<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 52: | Line 54: | ||
|- | |- | ||
|<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 60: | Line 62: | ||
|- | |- | ||
|<br> | |<br> | ||
|checksum | |checksum* | ||
|the checksum of the content | |the checksum of the content | ||
|<br> | |<br> | ||
| Line 68: | Line 70: | ||
|- | |- | ||
|<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 76: | Line 78: | ||
|- | |- | ||
|<br> | |<br> | ||
|size | |size* | ||
|The size of the content (in bytes) | |The size of the content (in bytes) | ||
|42 | |42 | ||
| Line 84: | Line 86: | ||
|- | |- | ||
|<br> | |<br> | ||
|mimetype | |mimetype* | ||
|The mimetype of the file | |The mimetype of the file | ||
|application/zip | |application/zip | ||
| Line 92: | Line 94: | ||
|- | |- | ||
|<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 187: | Line 189: | ||
|} | |} | ||
Items for discussion: | |||
- Should description be optional or required ? | |||