Difference between revisions of "Build your ZIM file"

Jump to navigation Jump to search
137 bytes removed ,  02:00, 12 July 2019
no edit summary
m (→‎zimmer: formatting)
Line 78: Line 78:


===zimmer===
===zimmer===
[https://github.com/vss-devel/zimmer zimmer] package is primarily a tool for creating a ZIM dump from a Mediawiki-based wiki.
The [https://github.com/vss-devel/zimmer zimmer] package allows creating a ZIM dump from any accessible Mediawiki-based wiki. This package is relativly easy to install and supports both old and new versions of Mediawiki.


The package consists of 2 scripts:
The package consists of two Node.js scripts:
* ''wikizimmer.js'' -- dumps the wiki's articles into a collection of static HTML files.
* ''wikizimmer.js'' -- creates static HTML files from the wiki's articles
* ''zimmer.js'' -- builds a ZIM file from a collection of static HTML files. Historically, zimmer.js is mostly a drop-in replacement for zimwriterfs with a notable exception: it doesn't support withFullTextIndex option (index format is not documented).
** Unlike mwoffliner, this script does not require Parsoid or Redis.
 
* ''zimmer.js'' -- creates a ZIM file from the static HTML files
The major point is that wikizimmer.js unlikely to mwoffliner doesn't depend on the Parsoid and Redis and zimmer.js unlikely to zimwriterfs doesn't depend on the zimlib.
** Unlike zimwriterfs, this script does not require zimlib.
 
** This script is used in other projects as a drop-in replacement for zimwriterfs where ''withFullTextIndex'' support is not needed.
The package is relatively easy to install and it can even process some wikis running rather old versions of the Mediawiki engine.


== See also ==
== See also ==
2

edits

Navigation menu