This is a lightweight Android library for working with ZIM files, which are compilations of HTML and media content most often used for bundling Wikipedia articles for offline use. The library provides random access functionality to retrieve articles and their associated media from ZIM compilations, as well as searching of titles in the ZIM file (by prefix), and retrieval of random titles.
Add the following to your build.gradle:
compile 'com.dmitrybrant:zimdroid:0.0.14'
The class ZimReader contains all the functions necessary for parsing and extracting content from
a ZimFile. It can be used like this:
ZimReader reader = new ZimReader(new ZimFile("/path/to/file.zim"));
List<String> results = reader.searchByPrefix("cat", 10);
String randomTitle = reader.getRandomTitle();
String html = reader.getHtmlForTitle(randomTitle);
...and so on.
- Information on the ZIM file format: http://www.openzim.org/wiki/ZIM_file_format
- LZMA decompression library (used as a dependency in this library): https://tukaani.org/xz/java.html
(For my own reference, and sanity)
When ready to publish a new release to Bintray, run the following:
./gradlew build install bintrayUpload
The build step builds the project, the install step invokes Maven to generate the POM file and
install the project to your local repository, and the bintrayUpload step actually uploads it to
Bintray. In order to upload successfully, make sure to add these lines to local.properties in the
root directory of the project:
bintray.user=<your username on bintray>
bintray.apikey=<your API key from bintray>
Copyright 2018-2021 Dmitry Brant
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.