Difference between revisions of "FeedFormat"

From Kiwix
Jump to navigation Jump to search
()
Line 15: Line 15:


=== <book> ===
=== <book> ===
* '''id''': Unique id of a book/ZIM. It comes from the ZIM file itself and is automatically generated at the ZIM file creation.  
* '''id''' (mandatory): Unique id of a book/ZIM. It comes from the ZIM file itself, see [http://openzim.org/Metadata].  
* '''path''': 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.
* '''title''': Title of the book. It comes from the ZIM file itself and is configured at during the ZIM file creation process by the ZIM file creator.
* '''title''' (recommended): Title of the book. It comes from the ZIM file itself, see [http://openzim.org/Metadata].
* '''description''': Small text describing the content of the book. It comes from the ZIM file itself and is configured at during the ZIM file creation process by the ZIM file creator.
* '''description''' (recommended): Small text describing the content of the book. It comes from the ZIM file itself, see [http://openzim.org/Metadata].
* '''language''':
* '''language''' (mandatory): ISO code of the conent language(s). It comes from the ZIM file itself, see [http://openzim.org/Metadata].
* '''date''':
* '''date''' (mandatory): Date of the creation of the ZIM file. It comes from the ZIM file itself, see [http://openzim.org/Metadata].
* '''creator''':
* '''creator''' (mandatory): Name or description of the Creator of the content. It comes from the ZIM file itself, see [http://openzim.org/Metadata].
* '''url''':
* '''url''' (recommended): HTTP URL of the Metalink file where the file may be downloaded
* '''community''':
* '''community''':
* '''articleCount''':
* '''articleCount''' (mandatory): Number of articles (excepting redirects) of the namesapce A in the file.
* '''mediaCount''':
* '''mediaCount''' (mandatory): Number of articles (excepting redirects) of the names
* '''size''':
* '''size''' (mandatory):
* '''favicon''':
* '''favicon''' (recommended):
* '''faviconMimeType''' (recommended):

Revision as of 11:10, 14 May 2011

Example

<library current="">
<book id="c998cd0c-63fb-4184-4184-68ea2410e8e272bf" path="wmf_fa_all_07_2010_rc2.zim" 
  title="Wikipedia, Wikibooks, Wikisource and Wikiquote in Parsi" 
  description="All the articles from the Wikipedia, Wikibooks, Wikisource and Wikiquote in Parsi." 
  language="fa" date="2010-09-26" creator="Wikimedia community" url="http://download.kiwix.org/zim/0.9/wmf_fa_all_07_2010_rc2.zim.metalink"
  articleCount="174559" mediaCount="52775" />
</library>

Parameters

<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].
  • 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): ISO code of the conent 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].
  • url (recommended): HTTP URL of the Metalink file where the file may be downloaded
  • community:
  • 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):
  • favicon (recommended):
  • faviconMimeType (recommended):
Retrieved from "https://wiki.kiwix.org/w/index.php?title=FeedFormat&oldid=3719"