Difference between revisions of "FeedFormat"

Line 15:

=== <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''':

* '''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):

Difference between revisions of "FeedFormat"

Navigation menu

Search

@@ Line 15: / Line 15: @@
 === <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''':
-* '''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):