https://wiki.openzim.org/w/api.php?action=feedcontributions&user=Cscott&feedformat=atomopenZIM - User contributions [en]2024-03-28T17:59:37ZUser contributionsMediaWiki 1.36.1https://wiki.openzim.org/w/index.php?title=Build_your_ZIM_file&diff=2837Build your ZIM file2016-07-01T18:21:49Z<p>Cscott: /* Developers */ Update repository links.</p>
<hr />
<div>[[File:Wikipedia-Book-creator.png|right|thumb|The ''[http://en.wikipedia.org/wiki/Special:Book Wikipedia Book Creator]'' is the easiest way to create custom ZIM files from Wikipedia]]<br />
A few ''tools allow people'' to create ZIM files.<br />
<br />
== Users ==<br />
<br />
=== MediaWiki Collection Extension ===<br />
<br />
''Unfortunately this feature was removed. Please subscribe and show your interest on [https://phabricator.wikimedia.org/T73660 this ticket] if you want to see it back].''<br />
<br />
<s><br />
You can create on Wikipedia and all other Wikimedia projects, ZIM files of article selections. [https://en.wikipedia.org/wiki/Special:Book For example on http://en.wikipedia.org]. This is based on the MediaWiki Collection Extension. The Collection extension for MediaWiki provides the ability to select articles and export them in different formats, such as PDF, ODF and ZIM. The main purpose of Collection extension is to create printed books - instead of export you can also choose to have the selected articles printed on demand as a real book.<br />
<br />
The Collection extension can be easily added to any MediaWiki installation:<br />
* [http://www.mediawiki.org/wiki/Extension:Collection Get the extension]<br />
* [http://www.mediawiki.org/wiki/Extension:Collection/openZIM Details on Collection and openZIM]<br />
</s><br />
<br />
=== Ask for a custom ZIM file ===<br />
<br />
If you have a deployment project (so, this file is not only for you own personal purpose), you may ask the Kiwix team to create a ZIM file for you. To do that you need to prepare the following information:<br />
* Text file with the list of article titles (one title per line, with underscores, UTF8)<br />
* The URL of the wiki you want to snapshot<br />
* Prepare a welcome page for the ZIM file (on the wiki, and share with us the title of that page)<br />
* ZIM file metadata:<br />
** Title<br />
** Description (only a few words)<br />
** 48x48 PNG logo<br />
<br />
== Developers ==<br />
[[Image:Schema ZIM File Creation.png|thumb|right|An example approach to create a ZIM file]]<br />
<br />
=== MWoffliner ===<br />
<br />
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 filesystem.<br />
<br />
A virtual machine with MWoffliner is provided [http://download.kiwix.org/dev/ZIMmaker.ova here]. You might have to update the source code to get the last improvements.<br />
<br />
More information are available [https://github.com/kiwix/mwoffliner here].<br />
<br />
=== zimwriterfs ===<br />
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. [https://github.com/wikimedia/openzim/tree/master/zimwriterfs Go to zimwriterfs source code repository].<br />
<br />
A virtual machine with zimwriterfs is provided [http://download.kiwix.org/dev/ZIMmaker.ova here].<br />
<br />
=== Zimbalaka ===<br />
Zimbalaka, a web hosted tool which allows to create #Wikipedia ZIM files based on articles selections.<br />
<br />
You can give it a try at [http://zimbalaka.openzim.org/ http://zimbalaka.openzim.org/].<br />
<br />
More details in this [http://www.arunmozhi.in/blog/zimbalaka-an-openzim-creator/ blog post]. [https://github.com/tecoholic/Zimbalaka Here is the source code].<br />
<br />
=== zimwriterdb ===<br />
[[zimwriterdb]] is part of the openZIM project. This binary uses a pre-filled Postgres Database and create the corresponding ZIM file; the schema for the database is linked on the main zimwriterdb page.<br />
<br />
=== Wiki2html ===<br />
[[Wiki2html]] can be used to prepare static HTML files from a running Mediawiki instance.<br />
<br />
== See also ==<br />
* [[ZIM File Archive]]<br />
* [[Bindings]]<br />
* [[Reader]]</div>Cscotthttps://wiki.openzim.org/w/index.php?title=Releases&diff=2835Releases2016-06-18T08:33:59Z<p>Cscott: typo fix</p>
<hr />
<div>'''openZIM releases''' can be found at the following address:<br />
* http://www.openzim.org/download/<br />
<br />
You can also checkout the code from [[git|our development code repository]].<br />
<br />
If you are looking for binaries, you might rather be interested in [[ZIM Readers|reader applications]] instead. The openZIM libraries and tools are not meant for end-users but for software developers which integrate them into reader applications or export tools.<br />
<br />
== History ==<br />
* 2013/04/19: [http://www.openzim.org/download/zimlib-1.0.tar.gz zimlib 1.0]<br />
* 2013/08/03: [http://www.openzim.org/download/zimlib-1.1.tar.gz zimlib 1.1]<br />
* 2014/05/21: [http://www.openzim.org/download/zimlib-1.2.tar.gz zimlib 1.2]<br />
<br />
== See also ==<br />
* [[Roadmap]]<br />
* [[Git]]<br />
* [https://bugzilla.wikimedia.org/enter_bug.cgi?product=openZIM Report a bug or make a feature request]</div>Cscott