Page MenuHomePhabricator

Add support for custom description
Open, MediumPublic


Currently there is now way to add a custom description to a openZim generated file. In order for user of the Kiwix downloader to better understand what's in the content file we need to have the ability to provide an optional description.

Version: unspecified
Severity: trivial



Related Objects

Event Timeline

bzimport raised the priority of this task from to Medium.Nov 21 2014, 11:36 PM
bzimport added a project: Collection.
bzimport set Reference to bz29817.
80686 added a comment.Jul 12 2011, 6:21 AM

for description info please check out the metadata definition on

This data is stored in articles - like regular wiki articles - in the namespace M. So the string for "title" will be stored in an article called "/M/title".

"A favicon (48x48) is also mandatory and should be located at /-/favicon "

volker.haas wrote:

This enhancement depends on collection extension support for a metadata field ‘description' in collections and saved books.

Kelson added a comment.Oct 7 2012, 6:04 PM

It seems that the extension simply writes this information in the wrong place called "/M/Subtitle" instead of "/M/Description". Could you please fix that, this is trivial.

ralf_wikimedia wrote:

Well, that's the subtitle, which should be printed together with the title on the cover.

If it helps with the kiwix downloader and does provide enough information for a description, please open a pull request on github.

ralf_wikimedia wrote:

Well, thinking another minute about it, I think this is stupid...and the subtitle shouldn't be misused as a description.

I think both, "subtitle" and "description", are the same. I use them at least in the same way as ZIM publisher and Kiwix developer.

Other metadatas are there in the ZIM file to also "describe" the content.

I just have implemented in Kiwix, that if "/M/Description" is empty, it looks at "/M/Subtitle" in place.

In any case, "/M/Subtitle" is not defined in the ZIM format and we can not await that ZIM readers take care about it (to the opposite to "/M/Description").