Difference between revisions of "Build your ZIM file"

From openZIM
Jump to navigation Jump to search
(→‎zimwriterdb: Got rid of continued mention to a deprecated script which was removed from this page.)
Line 1: Line 1:
[[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]]
[[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]]
A few tools allow people to create ZIM files.
A few ''tools allow people'' to create ZIM files.


== Users ==
== Users ==
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 (see below).


== Developers ==
=== MediaWiki Collection Extension ===
[[Image:Schema ZIM File Creation.png|thumb|right|An example approach to create a ZIM file]]
 
''Unfortunately this feature war removed. Please subscribe and show your interest on [https://phabricator.wikimedia.org/T73660 this ticket] if you want to see it back].''


=== MediaWiki Collection Extension ===
<s>
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.
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.


The Collection extension can be easily added to any MediaWiki installation:
The Collection extension can be easily added to any MediaWiki installation:
* [http://www.mediawiki.org/wiki/Extension:Collection Get the extension]
* [http://www.mediawiki.org/wiki/Extension:Collection Get the extension]
* [http://www.mediawiki.org/wiki/Extension:Collection/openZIM Details on Collection and openZIM]
* [http://www.mediawiki.org/wiki/Extension:Collection/openZIM Details on Collection and openZIM]
</s>
== Ask for a custom ZIM file ==
{{...}}
== Developers ==
[[Image:Schema ZIM File Creation.png|thumb|right|An example approach to create a ZIM file]]


=== zimwriterfs ===
=== zimwriterfs ===

Revision as of 09:50, 15 April 2015

The Wikipedia Book Creator is the easiest way to create custom ZIM files from Wikipedia

A few tools allow people to create ZIM files.

Users

MediaWiki Collection Extension

Unfortunately this feature war removed. Please subscribe and show your interest on this ticket if you want to see it back].

You can create on Wikipedia and all other Wikimedia projects, ZIM files of article selections. 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.

The Collection extension can be easily added to any MediaWiki installation:

Ask for a custom ZIM file

...

Developers

An example approach to create a ZIM file

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. zimwriterfs works, for now only, 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 wile to complete. Go to zimwriterfs source code repository.

zimwriterdb

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.

Wiki2html

Wiki2html can be used to prepare static HTML files from a running Mediawiki instance.

See also