Difference between revisions of "FeedFormat"

Jump to navigation Jump to search
(→‎Tags and attributes: update links)
()
 
(6 intermediate revisions by the same user not shown)
Line 10: Line 10:
</source>
</source>


''[http://www.kiwix.org/library.xml more...]''
''[http://download.kiwix.org/library/library_zim.xml more...]''


== Tags and attributes ==
== Tags and attributes ==
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 27: Line 26:
* '''creator''' (mandatory): Name or description of the Creator of the content. It comes from the ZIM file itself, see [http://www.openzim.org/wiki/Metadata].
* '''creator''' (mandatory): Name or description of the Creator of the content. It comes from the ZIM file itself, see [http://www.openzim.org/wiki/Metadata].
* '''publisher''' (mandatory): Name or description of the Publisher of the content. It comes from the ZIM file itself, see [http://www.openzim.org/wiki/Metadata].
* '''publisher''' (mandatory): Name or description of the Publisher of the content. It comes from the ZIM file itself, see [http://www.openzim.org/wiki/Metadata].
* '''tags''' (recommended): List of tags for the ZIM file. It comes from the ZIM file itself, see [http://www.openzim.org/wiki/Metadata].
* '''url''' (recommended): HTTP URL of the Metalink file where the file may be downloaded
* '''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.
* '''articleCount''' (mandatory): Number of articles (excepting redirects) of the namesapce A in the file.
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).


== See also ==
== See also ==
* [[kiwix-manage]]
* [[kiwix-manage]]
* [[Library]]
* [[Library]]
* [[OPDS]]
* [[Catalog]]

Navigation menu