The catalog remote file format should be (more) compatilbe with the "Esino" catalog specification.
During the kiwix sprint at Esino Lario, we defined a catalog specification for the metadatas associated to a package : http://wiki.kiwix.org/wiki/Catalog
At a point, we will make ideascube compatible with the Esino specification. We should start to slowly change the way we name things in ideascube to be more compatible with the Esino specification and so reduce the gap.
This issue is here to open a discussion to decide how we do thing. (And as a remainder for the future)
Here a first sight of the differences between the two catalog specifications :
Ideascube | Esino | Comments |
---|---|---|
id | id | Some bsf catalog has id in there metadata |
key | name | The 'keys' in the bsf yaml files are used as name in ideascube. However, it doesn't follow the exact same semantic than Esino spec* |
version | version | |
name | title | We could simply rename the 'name' attribute to 'title' |
description | description | |
language | languages | Only one in ideascube, may contains more languages in Esino (ISO 639-3) |
sha256sum | checksum | It has been proposed to rename checksum to sha256sum in Esino to explicit that we use sha256 for the checksum. Maybe nothing to do on our side. |
url | url | |
size | size | |
mimetype | ||
type | intended_use | Names let us think it is not the same, but we use it for the same thing : How to use the content. |
thumbnail_urls | To be defined in (in Esino as in ideascube) | |
requires | ||
tags | ||
extra_fields | ||
content_group | Could be used by ideascube to define how we display cards. | |
variants | ||
altenate_urls | ||
authors | Could simply be added to the ideascube metadata | |
publisher | Could simply be added to the ideascube metadata | |
packager | Could simply be added to the ideascube metadata | |
licences | Could simply be added to the ideascube metadata |
* The name in Esino follow the source.resource_name.variants
format (the lang potentially being part of the resource_name)
At bsf we follow the name.lang
format.