dayllanmaza / tool

Tools for greater using of Wikisource content

What is Wikisource Export?

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

Requirements

• PHP 7.2
• Composer

Installation

1. Get the source code:

   git clone https://github.com/wsexport/tool.git
   cd tool
   

2. Install dependencies:

   composer install --no-dev
   

   This will create a config.php file that you can edit.

   • In order to export to PDF, plain text, RTF, or Mobi formats you should also install Calibre so that the tool can use the ebook-convert command.
   • To run the integration tests (or just to validate exported ebooks) you should also install epubcheck. If it's not installed at /usr/bin/epubcheck then set the EPUBCHECK_JAR environment variable.

3. Create a mysql database and database user and add these details to config.php.

4. Run ./bin/install.php to initialize the database.

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

Run composer install --dev to install dependencies required for testing. Tests are located in the tests/ directory, to run them:

$ ./vendor/bin/phpunit --exclude-group integration
$ ./vendor/bin/phpunit --group integration # 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/.