mw-ocg-bundler

Generates resource bundles from mediawiki articles

Usage no npm install needed!

<script type="module">
  import mwOcgBundler from 'https://cdn.skypack.dev/mw-ocg-bundler';
</script>

README

mw-ocg-bundler

NPM

Build Status dependency status dev dependency status

A mediawiki article spider tool.

This tool grabs all the dependencies for a given set of articles and creates a directory or zip file. The format is documented at https://www.mediawiki.org/wiki/PDF_rendering/Bundle_format

Installation

Node version 0.8 and 0.10 are tested to work.

Install the node package depdendencies with:

npm install

Install other system dependencies.

apt-get install zip

Running

To generate a bundle for the en.wikipedia.org article United States:

bin/mw-ocg-bundler -v -o bundle.zip -h en.wikipedia.org "United States"

To generate a bundle for a collection of articles about the inner planets:

bin/mw-ocg-bundler -v -o bundle.zip -h en.wikipedia.org --title Planets Mercury Venus Earth Mars

If you have a book specification (in the form of metabook.json and nfo.json files), use:

bin/mw-ocg-bundler -v -o bundle.zip -m metabook.json -n nfo.json

For non-interactive use feel free to remove the -v flag.

For other options, see:

bin/mw-ocg-bundler --help

There are several rendering backends which take bundles in this format as inputs. See mw-ocg-latexer, for instance, which generates PDFs of mediawiki articles via XeLaTeX, and mw-ocg-texter which generates plaintext versions of mediawiki articles.

License

Copyright (c) 2013-2014 C. Scott Ananian

Licensed under GPLv2.