518
edits
Difference between revisions of "Build your ZIM file"
Jump to navigation
Jump to search
→MWoffliner
Julianharty (talk | contribs) (→Users: Added mention users can create a ZIM file using local contents.) |
|||
| (16 intermediate revisions by 5 users not shown) | |||
| Line 28: | Line 28: | ||
=== Create a ZIM file from existing HTML contents === | === Create a ZIM file from existing HTML contents === | ||
See | See [[Zimwriterfs instructions]] for an overview and read the section below on zimwriterfs for some additional context. | ||
== Developers == | == Developers == | ||
| Line 35: | Line 35: | ||
=== MWoffliner === | === 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 | MWoffliner is a tool which allows to "dump" a Wikimedia project (Wikipedia, Wiktionary, ...) to a local storage. It should also work for any [https://mediawiki.org Mediawiki] instance. It goes through all articles (or a selection if specified) of the project and write HTML/pictures to your local filesystem as plain HTML/JS/CSS/... files or in a ZIM file. | ||
It is distributed via [https://www.npmjs.com/package/mwoffliner npm] and [https://hub.docker.com/r/openzim/mwoffliner Docker]. | |||
If you are a developer, you can download it directly from its [https://github.com/openzim/mwoffliner git repository]. | |||
=== zimwriterfs === | === zimwriterfs === | ||
| Line 49: | Line 49: | ||
=== Zimbalaka === | === Zimbalaka === | ||
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 archive.org https://web.archive.org/web/20150531004251/http://www.arunmozhi.in:80/blog/zimbalaka-an-openzim-creator/#content | ||
Zimbalaka, is designed as a web hosted tool which 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>http://sub.domain.com/</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). | |||
==== 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. The zimming tasks are run by Celery, which has been automated by supervisord. All the co-ordination and message passing happens via Redis. | |||
[https://github.com/tecoholic/Zimbalaka Here is the source code]. | |||
=== zimwriterdb === | === zimwriterdb === | ||
| Line 62: | Line 78: | ||
===zimmer=== | ===zimmer=== | ||
[https://github.com/ | The [https://github.com/vss-devel/zimmer zimmer] package allows creating a ZIM dump from a Mediawiki-based wiki. This package is relatively easy to install and supports both old and new versions of Mediawiki. It is a kind of an alternative to MWoffliner. | ||
The package consists of two Node.js scripts: | |||
* ''wikizimmer.js'' -- creates static HTML files from the wiki's articles. It requires public access both to the normal web interface and to the wiki's API interface. Unlike mwoffliner, this script does not require Redis | |||
* ''zimmer.js'' -- creates a ZIM file from the static HTML files (without requiring the libzim). | |||
== See also == | == See also == | ||
* [[ZIM File Archive]] | * [[ZIM File Archive]] | ||
* [[Bindings]] | * [[Bindings]] | ||
* [[ | * [[Readers]] | ||