Difference between revisions of "FeedFormat"

From Kiwix
Jump to navigation Jump to search
(Indexpath is not used anymore)
()
 
Line 33: Line 33:
* '''favicon''' (recommended): favicon of the file following the same rules as Web favicons. Encoding is base64. Recommended format is PNG in 48x48 pixels resolution. It comes from the ZIM file itself.
* '''favicon''' (recommended): favicon of the file following the same rules as Web favicons. Encoding is base64. Recommended format is PNG in 48x48 pixels resolution. It comes from the ZIM file itself.
* '''faviconMimeType''' (recommended): Mimetype of the favicon.
* '''faviconMimeType''' (recommended): Mimetype of the favicon.
* '''name''' (mandatory): 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.
* '''name''' (mandatory): A human readable identifier for the resource. It's the same across versions (should be stable across time).


== See also ==
== See also ==

Latest revision as of 07:04, 4 May 2021

Example

<library current="">
<book id="d113b3b5-1b24-dcbd-dcbd-829965e982b8e6ab" title="Wikipedia in Arabic" 
description="All articles, categories and thumbnails from the Wikipedia in Arabic" language="ara" 
date="2011-04-22" creator="Wikipedia community of contributors" url="http://download.kiwix.org/zim/0.9/wikipedia_ar_all_04_2011.zim.metalink" 
articleCount="271958" mediaCount="90446" size="1426754" favicon="iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYwIDYxLjEzNDc3NywgMjAxMC8wMi8xMi0xNzozMjowMCAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpGNzdGMTE3NDA3MjA2ODExOTI3OUFDOERGQkEwMkZBQSIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpDMTZDMTY3MDUzMjgxMUUwODkzRThEQzUyNjAyMkY5OCIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpDMTZDMTY2RjUzMjgxMUUwODkzRThEQzUyNjAyMkY5OCIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1IE1hY2ludG9zaCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkY5N0YxMTc0MDcyMDY4MTE5Mjc5QUM4REZCQTAyRkFBIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkY3N0YxMTc0MDcyMDY4MTE5Mjc5QUM4REZCQTAyRkFBIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+//M+AAAACoZJREFUeNrsGmmIldf13OdzS11GHVFEiUWsiRHTNE5rKuoYMVJFGKcKLg12XEfsuGvaiDQGxKVxqn/ECKlidap1iY1UNIkZSVGscWxAVBBn3JfgTBhFnXnvzftO7zl3/94gNiGg0E+/ud93z7nnnvWec+/3BCKCuSorK/HBgweQyWRACAHP2tWiRQvIy8uDwsJCy5wgAfbt2/deMpn84+DBgyE/Px+iKAssF6GhwTUd5tmSsI2gQYKg9AcDFCHpoILovxDQspQVQs5MpM9EogXcu3cPTp48KcnjKtn9Hguwf/9+HDduXExenjXktblLQPM4TxguYvJ9l+vw4cPQ1NQkBLlNv379IL9LPksvAk1DM9p/+osNIv7HsWjUL544f11dHVy8eBGS9fX10LVrV2U2o02hxUDdiVqdPhH0TB5AHJ4w6vb7m/NEYfhG8pNcQcj92JzCKoRcneI1mc1mdcCiYkYkmJDCT+j5lfdahgiWQC2TaGZCy73r4sk114aGMC4oaSU0rqcs1PMJS4t6Eoob2UmLTdKCiACagEp47uSEsg4vNGsJFZyWKWFVqeCsPBUIIuEHgGcY7ko4C3F/InRngWoeY21LQygBGAFEQFXkRKjvPo5Yjr9qGkZcASI3BHLcDnLmEP47u5C1Z4BqLWD83os+i2ldFtFq3vkleDnDmV5oXPRWpHByzy3NAqt93E1v3NXzBut1wglgmLUsC6EZwdjyJ4LUYLQrhCNo6AghPCt46cRaVYTz2dAQgXs5A4pgDRaBBYSfQYROYsrvUDgXUgp3k6NJXn6AawMGWhfoac4Ijk5oRC2Emj8c53DQ8OAJmAzFFJ5BhAvGQBsiNiTXoYWIu7Svba9PxINCxEIqJJrr1MqblUVZbUq/aPu89T4Os+9oYU79DmZoI7gWg+SNtiPIzoSLaMhxi/rB0jUWsDWK484GXzibB8N4TRSvg8y7y5AmuNFLXmHyw2ZKDAymx1hv0r6i8WlvxZcPhYXD4dKlS9CyZUto3bo1a+Xx48f8PmzoMCgaXwTLly+Hhw8fQrt27WQiTQAlR8Kh9zVr1sDEiRNh1Ki34MqVGkilUtCmTRuGk9+/9PJL8Plnn8va5p+wZMkSePToEdMmGGXaXr16QVXVGe3/lGxlG3nyyUoUs9kmeWe9Nmvfr1+/jgcOHMDOnTtb648fPx5Pnz6Nd+/eRTkhnjt3DhcsWGDhsuzF7du344ULF1AKxrTu3LmDVVVVOHz4cMZ55ZX+eOzYMbx16xbDpUBYU1ODFbsqLJ2FCxfi+fPnYzw5Pol3FqCpKevdEqjvJolI73Rv3rzZEpaakvCswqExRFC2P3vtNYa3bdsWL1dX27FZr509ezZKK+EFYsz2u7nrvq3DVq1a4dixY9X4bFPAm387ATIZzMgOWVswgNuMQVR9tbW12LNnT2aQrHFFaovGEF6GcTL40V8+skJOmzZNjc84nGtXr6J0H5w8ebKaR48z8xC91atX8/gv//WlGse8GP7MGEXTCpBOpzFNSPJOZ9KyVTf3pdVNz6vef98yuGjRogBO+LKyxb59+zJcxgt+/Z+vHY5saQzBqs5U8bu75VwSp7aulpVDbqZ4yOjx6tm0hmYowFPc5Mey9GYmZIBiTXUNpgiWStt248aNVsipU6fasTdv3mTXkhsn+Z6K0Vbva9eu5XFHjx61sJSEpQxeKh2MtQLIlYEB1PJzyj27O83t7995xzI4b968HHhd3bfW1eQ2VQbuWe6XKxX3nThxohnaKXbR7t26YUFBQbPw+E08Eu+myJX7YJM49A0ukfDGHyNu55SWQocOHXjMjh074NrVaxo/4nW3Xbsfwdy5cxkufRXKyzdAff192LJlC4wcORIGvf66S2r6Jn38dedOuPvNN7By5UqbrNS8Onmht9zLOzIZgaRoaGjAxsYGbhsa6blRPjdiI926n56pj+BlvyuzVpgzZ44ax/hq7O1bt62rdezYEYuKivi58osvFI7Gb2hULVmtR48eOHDgQF52mQcLN3Mr3lxfg7MAsgWcVqw1pJxRpCwQkQVIbgkrnVvKSYquXbt2QU11NVuIMSRuXuc8kMslw+/fvw8HDx6E0aNHwy8GD2YcVQooWtTu3v03uH37Nrz77h84Ecoung8ilXrV3KjfVQ6OdMpOuEovMnBQBoqYkG9q1HVN794/hgkTJvBQysAbN21S5iDBI8XY9JLp0KlTJ5swf/P2267GiTQD8r8MUFi3bh28LDPymF+N0XVPpBhXXDg3At/FvWKOB0TGx4xmQCNHrtaLHMGy+WVcEtC1U/rv5cuXg+qle/duMHPmTNt36JN/SGtGuihTGqW/u3fvAZntYenSpdAimVSaN4xqC0XsFdr3NU/gWyAy0qLSuopZzNFA5LU/6dsPzFmS9Eko31CuhNWmJ5wuXfK9kmU/nD17li0UaebSjSn44IM/wYsv9obi4l97itMLB4ANchY78qrb0IWiINJ9PwUjtSmQI73iyL+y/mGfpWvP3/ewFYx5qVj78MMt4Fa5CNavX68MrcjCJ9IqNGbZMqV91L6OWuvGbSM0Po+6H0IBIrtUOi27wRjGgSlr5bNcNWDMmDHOCuV/tsQrKipk9XlFMrcM5ErEOEeOHIEzX33FCsikpO9LgeTqo+LJC063ZDp+rNaD5dcPYh8BYu82HiAIaGplMrOb+r1790K1XJFIg+Xl5dCnTx9YsWKFFZLywoYNG3jsp599yidr8+fPB5mhY2u+n39i+ak5AXITmBkcD+TI7cJ0sL3xyzdg2LBh1gpbt26Fjw98DDdu3IDFixfzxkLmCpBZ2Vrh1L9PwSa5ctGJoCzsnLWNozbDeKjkmAvZjaFFUlmXV3azC4p07ovccoo6X5RJLZpr27ZtsHDRItZ+cXEx477601c5D9BFm52S35bAqVOnWLAO0r1cXnDzWGVql7WqM24VLqNuQ2pXIX/biKiDz61KqGKRx7755ggYNGgQj5eZGOi8lcqJNm1ag1n/5stl1wQ8JS0625xeUqLhXv7RURsF+2kTn2ZbiXq5tQKocx27ZHlLVWBSTwvGCiaj0IpkLlnMwaRJkyyY2oKCn8PQoUMtTolkPk8mukDbdn/vuUxsPnQ7fE8Az6f1YmUlNe5kzyVMDrH9SuZRb42CAQMG8GupLPheaPuCdxKh/sn9AMOpDJkxY4Z3uuAdSfiKsx7hnXKApzz/WMV6kUkmmlnrWp75HBG3ALRMtoSysjLo378/TJkyxdOioz9kyBC2wqxZs+yRfqB5r0RwdY0TzMnp8ARVdCMKC/XZqD6D9w81zMmwOX4HYU/j/IOW4CzTH2NP7TD8coDu5Do8LhSAwTcEQwHtqYk5Xz5eWWnOhcA7pImdiKLXE0iPOR9WvFMwjwpCDBR/cYdhKHJhEM6PMXji2fkG+d2+ij5DAsD/BXg+BcDv+8H2qT6d/oAC0EGqKXefsfh84kU8008PEnREUltb+9y5Dv3kgH43kRgxYoSgyrB9+/bPDfPEK/1egn70kdAbjVWHDh2CdDr9w7vT93Qb+rhNv5PQP/ZQv1Yx1/Hjx+mAlmv2Z+3iekvGK7k8eY3p/68AAwBJYdLmsZURNwAAAABJRU5ErkJggg==" 
faviconMimeType="image/png"/>
</library>

more...

Tags and attributes

<library>

  • current: This is the id of the book which has to be displayed per default.

<book>

  • id (mandatory): Unique id of a book/ZIM. It comes from the ZIM file itself, see [1].
  • origid (optional): Mandatory in case of diff ZIM file, it contains the id of the original ZIMfile the diff file should be applied.
  • path (optional): Filesystem path of the ZIM file. This does only make sense locally.
  • title (recommended): Title of the book. It comes from the ZIM file itself, see [2].
  • description (recommended): Small text describing the content of the book. It comes from the ZIM file itself, see [3].
  • language (mandatory): ISO3 code of the content language(s). It comes from the ZIM file itself, see [4].
  • date (mandatory): Date of the creation of the ZIM file. It comes from the ZIM file itself, see [5].
  • creator (mandatory): Name or description of the Creator of the content. It comes from the ZIM file itself, see [6].
  • publisher (mandatory): Name or description of the Publisher of the content. It comes from the ZIM file itself, see [7].
  • tags (recommended): List of tags for the ZIM file. It comes from the ZIM file itself, see [8].
  • url (recommended): HTTP URL of the Metalink file where the file may be downloaded
  • articleCount (mandatory): Number of articles (excepting redirects) of the namesapce A in the file.
  • mediaCount (mandatory): Number of articles (excepting redirects) of the names
  • size (mandatory): Size in KB of the content (ZIM file(s))
  • favicon (recommended): favicon of the file following the same rules as Web favicons. Encoding is base64. Recommended format is PNG in 48x48 pixels resolution. It comes from the ZIM file itself.
  • faviconMimeType (recommended): Mimetype of the favicon.
  • name (mandatory): A human readable identifier for the resource. It's the same across versions (should be stable across time).

See also