Tools for greater using of Wikisource content
PHP HTML Other
Latest commit 79489f1 Sep 27, 2016 @Tpt Tpt Fixes tests

README.md

What is Wikisource Export?

Build Status

Wikisource export is a tool for exporting Wikisource page in many formats like epub or xhtml. The documentation can be found here: https://wikisource.org/wiki/Wikisource:WSexport

Installation

You have to download the files and use it with PHP 5.5 or more.

You have to create a temp folder in the root of directories.

This tool depends on Composer to install some dependencies. The easiest way to use it is to run make from the Wsexport Tool main directory:

make install

Or, to install and run composer manually:

curl -sS https://getcomposer.org/installer | php
php composer.phar install

In order to use pdf, txt, rtf and mobi formats you should install Calibre in order to allow the tool to use the ebook-convert command.

Composition

This tool is split into independent parts:

  • utils : api to interact with Wikisource and others things
  • book : export tool in many formats like epub.

The tools can be used in two ways:

  • http in the http folder
  • command line in the cli folder (run ./cli/book.php)

Tests

Tests are located in the tests/ directory, to run them:

$ make test
$ make integration-test # runs integration tests (slow)

Licence

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.