Difference between revisions of "FeedFormat"

Jump to navigation Jump to search
150 bytes removed ,  3 years ago
()
()
 
(One intermediate revision by the same user not shown)
Line 20: Line 20:
* '''origid''' (optional): Mandatory in case of ''diff ZIM file'', it contains the id of the original ZIMfile the diff file should be applied.
* '''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.
* '''path''' (optional): Filesystem path of the ZIM file. This does only make sense locally.
* '''indexPath''' (optional): Filesystem path of the fulltext search index. This does only make sense locally.
* '''title''' (recommended): Title of the book. It comes from the ZIM file itself, see [http://www.openzim.org/wiki/Metadata].
* '''title''' (recommended): Title of the book. It comes from the ZIM file itself, see [http://www.openzim.org/wiki/Metadata].
* '''description''' (recommended): Small text describing the content of the book. It comes from the ZIM file itself, see [http://www.openzim.org/wiki/Metadata].
* '''description''' (recommended): Small text describing the content of the book. It comes from the ZIM file itself, see [http://www.openzim.org/wiki/Metadata].
Line 34: 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 ==

Navigation menu