Jump to: navigation, search

Build your ZIM file

2,234 bytes added, 06:33, 30 July 2019
** Description (only a few words)
** 48x48 PNG logo
=== Create a ZIM file from existing HTML contents ===
See [[Zimwriterfs instructions]] for an overview and read the section below on zimwriterfs for some additional context.
== Developers ==
=== MWoffliner ===
MWoffliner is a tool which allows to "dump" a Wikimedia project (Wikipedia, Wiktionary, ...) to a local storage. It should also work for any [ Mediawiki ] instance having parsoid installed. It goes through all articles (or a selection if specified) of the project and write HTML/pictures to your local filesystemas plain HTML/JS/CSS/... files or in a ZIM file.
A virtual machine with MWoffliner It is provided distributed via [httphttps://downloadwww.kiwixnpmjs.orgcom/devpackage/ZIMmakermwoffliner npm] and [https://hub.docker.ova herecom/r/openzim/mwoffliner Docker]. You might have to update the source code to get the last improvements.
More information If you are available a developer, you can download it directly from its [ heregit repository].
=== zimwriterfs ===
zimwriterfs is a console tool to create ZIM files from a localy stored directory containing a "self-sufficient" HTML content (with pictures, javascript, stylesheets). The result will contain all the files of the local directory compressed and merged in the ZIM file. Nothing more, nothing less. For now, zimwriterfs only works on POSIX compatible systems. You simply need to compile it and run it. The software does not need a lot of resources, but if you create a pretty big ZIM files, then it could take a while to complete. Instructions on how to prepare and use zimwriterfs are here [[zimwriterfs_instructions]][ Go to zimwriterfs source code repository].
A virtual machine with zimwriterfs is provided [ here].
=== Zimbalaka ===
The following descirption is based on the notes published by the original author of Zimbalaka, as they're no longer available on the site they were published on. An archived copy is available on  Zimbalaka, is designed as a web hosted tool which allows to create enables #Wikipedia ZIM files to be created based on articles selections. It accepts two types of inputs: a list of pages or a Wikipedia category. Then Zimbalaka downloads those pages, removes all the clutter such as: sidebars, toolbox, edit links, etc., and provides a cleaned version as a ZIM file for download. It can be opened in Kiwix, etc. The ZIM is created with a simple welcome page with all the pages as a list of links.  Zimbalaka has multilingual and multi-site support. That is, you can create a ZIM file from pages of any language of the 280+ existing Wikipedias, and also from sites like WikiBooks, Wiktionary, Wikiversity and such. You can even input any custom url like (<nowiki></nowiki>), Zimblaka would add (/wiki/Page_title) to it and download the pages. ==== Pain points ====A small pain point is that, Zimbalaka also strips the external references that occur at the end of the Wikipedia articles, as the original author didn’t find these useful content intended to be used in an offline environment. You cannot add a custom Welcome page in the zim file. Not a very big priority. The current file does its work of listing all the pages. You cannot include pages from multiple sites as a single zim file. The workaround is to create multiple files or use a tool called zimwriterfs, which has to be compiled from source (this is used by zimbalaka behind the scenes).
You can give it a try at [http://zimbalaka==== Developers ====This tool is written using Flask – A simple Python web framework for the backend, Bootstrap as the frontend and uses the zimwriterfs compiled binary as the workhorse.openzimThe zimming tasks are run by Celery, which has been automated by]All the co-ordination and message passing happens via Redis.
More details in this [ blog post]. [ Here is the source code].
=== zimwriterdb ===
The [ zimmer] is package allows creating a command line JavaScript (nodejs) ZIM file creator. It's mostly dump from a dropMediawiki-in replacement for [[#zimwriterfs|zimwriterfs]] with a notable exception: it does't support ''withFullTextIndex'' option so farbased wiki. Zimmer doesn't depend on [[zimlib]] This package is relatively easy to install and supports both old and there new versions of Mediawiki. It is no need a kind of an alternative to compile it. That's probably why it could be useful for someoneMWoffliner.
There is also zimmerThe package consists of two Node.js scripts:* ''wikizimmer.js''s counterpart -- [https://githubcreates static HTML files from the wiki's articles. It requires public access both to the normal web interface and to the wiki's API unzimmer]Unlike mwoffliner, this script does not require Redis* ''zimmer. It unpacks js'' -- creates a ZIM file into a directory, which could be useful for some debuggingfrom the static HTML files (without requiring the libzim).
== See also ==
* [[ZIM File Archive]]
* [[Bindings]]
* [[ReaderReaders]]

Navigation menu