Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cscott/mw-ocg-bundler.old

Mediawiki article spider tool.
https://github.com/cscott/mw-ocg-bundler.old

Last synced: about 2 months ago
JSON representation

Mediawiki article spider tool.

Awesome Lists containing this project

README

        

# mw-ocg-bundler
[![NPM][NPM1]][NPM2]

[![Build Status][1]][2] [![dependency status][3]][4] [![dev dependency status][5]][6]

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 wikipedia article `en:United States`:
```
bin/mw-ocg-bundler -v -o bundle.zip --prefix enwiki "United States"
```

To generate a bundle for a collection of articles about the inner planets:
```
bin/mw-ocg-bundler -v -o bundle.zip --prefix enwiki --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.

[mw-ocg-latexer]: https://github.com/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator-latex_renderer
[mw-ocg-texter]: https://github.com/cscott/mw-ocg-texter
[XeLaTeX]: https://en.wikipedia.org/wiki/XeTeX

[NPM1]: https://nodei.co/npm/mw-ocg-bundler.svg
[NPM2]: https://nodei.co/npm/mw-ocg-bundler/

[1]: https://travis-ci.org/cscott/mw-ocg-bundler.svg
[2]: https://travis-ci.org/cscott/mw-ocg-bundler
[3]: https://david-dm.org/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator-bundler.svg
[4]: https://david-dm.org/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator-bundler
[5]: https://david-dm.org/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator-bundler/dev-status.svg
[6]: https://david-dm.org/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator-bundler#info=devDependencies