Release notes

From EPubExport

Jump to: navigation, search

Contents

Version 0.5.4

Changes from version 0.5.3

  1. Better handling with not empty output buffer.
  2. Solve problem with title object in some wikis.
  3. Portuguese translation - added.

Version 0.5.3

Changes from version 0.5.2

  1. Italian translation - added
  2. better handling with the BOM issue.

Version 0.5.2

Changes from version 0.5.1

  1. Partial Dutch , French, and German are now fully supported.
  2. Change the default CSS a bit.

Version 0.5.1

Changes from version 0.5

  1. Added Dutch , French, Polish, German and Russian translations.
    1. Full Russian translation.
    2. Partial Dutch , French, Polish and German translations.
  2. Change the default CSS a bit.
  3. epub cover page contains the file generation date and time.

Version 0.5

Changes from version 0.04

  1. Add title to the ePubExport special page
  2. Support Hebrew - full support: both UI and the epub file itself.
  3. Embed DejaVuSans fonts for the following languages:
    Afar, Abkhazia, Afrikaans, Akan, Aragonese, Arabic, Asturian/Bable/Leonese/Asturleonese, Avaric, Aymara, Azerbaijani in Azerbaijan, Azerbaijani in Iran, Bashkir, Byelorussian, Berber in Algeria, Berber in Morocco, Bulgarian, Bislama, Edo or Bini, Bambara, Breton, Bosnian, Buriat (Buryat), Catalan, Chechen, Chamorro, Mari (Lower Cheremis / Upper Cheremis), Corsican, Crimean Tatar/Crimean Turkish, Czech, Kashubian, Old Church Slavonic, Chuvash, Welsh, Danish, German, Ewe, Greek, English, Esperanto, Spanish, Estonian, Basque, Persian, Fanti, Fulah (Fula), Finnish, Filipino, Fijian, Faroese, French, Friulian, Frisian, Irish, Scots Gaelic, Galician, Guarani, Manx Gaelic, Hausa, Hawaiian, Hebrew, Hiri Motu, Croatian, Upper Sorbian, Haitian/Haitian Creole, Hungarian, Armenian, Herero, Interlingua, Indonesian, Interlingue, Igbo, Inupiaq (Inupiak, Eskimo), Ido, Icelandic, Italian, Inuktitut, Javanese, Georgian, Kara-Kalpak (Karakalpak), Kabyle, Kikuyu, Kuanyama/Kwanyama, Kazakh, Greenlandic, Kanuri, Kurdish in Armenia, Kurdish in Iraq, Kurdish in Iran, Kurdish in Turkey, Kumyk, Komi (Komi-Permyak/Komi-Siryan), Cornish, Kwambi, Kirgiz, Latin, Luxembourgish (Letzeburgesch), Lezghian (Lezgian), Ganda, Limburgan/Limburger/Limburgish, Lingala, Lao, Lithuanian, Latvian, Malagasy, Marshallese, Maori, Macedonian, Mongolian in Mongolia, Moldavian, Malay, Maltese, Nauru, Norwegian Bokmal, Low Saxon, Ndonga, Dutch, Norwegian Nynorsk, Norwegian (Bokmal), Ndebele, South, Northern Sotho, Navajo/Navaho, Chichewa, Occitan, Oromo or Galla, Ossetic, Papiamento in Netherlands Antilles, Papiamento in Aruba, Polish, Portuguese, Quechua, Rhaeto-Romance (Romansch), Rundi, Romanian, Russian, Kinyarwanda, Yakut, Sardinian, Scots, North Sami, Selkup (Ostyak-Samoyed), Sango, Serbo-Croatian, Secwepemctsin, Slovak, Slovenian, Samoan, South Sami, Lule Sami, Inari Sami, Skolt Sami, Shona, Somali, Albanian, Serbian, Swati, Sotho, Southern, Sundanese, Swedish, Swahili, Tajik, Turkmen, Tagalog, Tswana, Tonga, Turkish, Tsonga, Tatar, Twi, Tahitian, Tuvinian, Uighur, Ukrainian, Uzbek, Venda, Vietnamese, Volapuk, Votic, Walloon, Sorbian languages (lower and upper), Wolof, Xhosa, Yapese, Yiddish, Yoruba, Zhuang/Chuang and Zulu
  4. Support User defined fonts.

New Configuration

  1. Embed / don't embed fonts in the epub file (default - don't embed):
    For non-english wiki sites, as there is no way to know what will be the reading device, and if it has the font for the specific language or not, it is always a good idea to embed the fonts in the epub file. It does increase the size of the file, but it is readable.
    ePubExport came with DejaVuSans fonts that support many languages. In order to embed these fonts in the epub file, the following configuration is required, because the font will not be embedded by default:
    In LocalSettings.php, just below the "require_once("$IP/extensions/ePubExport/ePubExport.php");" line, add
    $wgePubExportProperties['embed_fonts'] = true;
  2. User-defined fonts:
    If the default fonts ars not fit or not support the wiki language, it is possible to embed another fonts. To do so, the $wgePubExportProperties['embed_fonts'] property must be true.
    Then, specify the fonts source as follows:
    $wgePubExportProperties['fonts'][] = _font_1_src_;
    $wgePubExportProperties['fonts'][] = _font_2_src_;
    $wgePubExportProperties['fonts'][] = _font_3_src_;
    Font license is embedded as follows:
    $wgePubExportProperties['font_license'] = _license_src_;

For example:

   require_once("extensions/ePubExport/ePubExport.php");
   $wgePubExportProperties['embed_fonts'] = true;
   $wgePubExportProperties['css_file'] = "$IP/ebook.css";
   $wgePubExportProperties['fonts'][] = 'extensions/ePubExport/fonts/DejaVuSans.ttf';
   $wgePubExportProperties['fonts'][] = 'extensions/ePubExport/fonts/DejaVuSans-Bold.ttf';
   $wgePubExportProperties['fonts'][] = 'extensions/ePubExport/fonts/DejaVuSans-BoldOblique.ttf';
   $wgePubExportProperties['fonts'][] = 'extensions/ePubExport/fonts/DejaVuSans-Oblique.ttf';
   $wgePubExportProperties['font_license'] = 'extensions/ePubExport/fonts/LICENSE';

NOTE: Using user-defined font require user-defined CSS. ePubExport does not enforce that, but it won't work without CSS that defines and use the user-defined fonts.

Known issues

  1. Some of the links in the pages are corrupted.

New directory tree:


  	extension
	      |
	      +->ePubExport
	                 |
	                 +-->epub
	                 |     |
	                 |     +-> EPub.php
	                 |     +-> EPubChapterSplitter.php
	                 |     +-> Zip.php
	                 |
	                 +-->fonts
	                 |     |
	                 |     +-> LICENSE
	                 |     +-> DejaVuSans.ttf
	                 |     +-> DejaVuSans-Bold.ttf
	                 |     +-> DejaVuSans-BoldOblique.ttf
	                 |     +-> DejaVuSans-Oblique.ttf
	                 |
	                 +-> ePubExport.i18n.alias.php
	                 +-> ePubExport.i18n.php
	                 +-> ePubExport.php
	                 +-> ePubExport_body.php

Version 0.04

New Features

User-defined CSS file

In LocalSettings.php, just bellow the "require_once("$IP/extensions/ePubExport/ePubExport.php");" line, add "$wgePubExportProperties['css_file'] = your_css_file_name".

For example:

require_once("$IP/extensions/ePubExport/ePubExport.php");
$wgePubExportProperties['css_file'] = $IP . "/ebook.css";

Known issues:

Some of the links in the pages are corrupted.

Version 0.03

New Features

  1. Add image support. The file now contains the images themselves , and not only the http link.

Known Issues

  1. Some links does not work.
  2. Version is not updated.

Version 0.02

New Features

  1. New Feature: Print a "last modified" message at the top of each page. Mwdiawiki is a platform for dynamic sites that are changed all the time, e.g. Wikipedia. This message shows what is the version of the content that exported.

Bug Fixes

  1. Bug Fix: As ereg_replace is the ereg_replace function isdeprecated from PHP 5.3.0, using thjis function caused error message instaed of epub file download. Fixed using preg_replace instead.

Version 0.01

1. ePubExport Description
   ePubExport is a wikimedia extension that enables:
   * Export a specific wikimedia page to an electronic book or tablate in epub format.
   * Export a group of wikimedia pages to an electronic book or tablate in epub format. 

2. Extension page in Mediawiki
   http://www.mediawiki.org/wiki/Extension:EPubExport 

3. Minimum requirements
   ePubExport tested with PHP 5.3.0 and 5.2.11.

   Note: Mediawiki does not support on PHP 5.3.1 as it contains a bug.

4. Install
   To install this extension, extract the file in the extensions folder, then add the following to LocalSettings.php:

   require_once("extensions/ePubExport/ePubExport.php");
   
   Directory tree should be as follow:

	extension
	      |
	      +->ePubExport
	                 |
	                 +-->epub
	                 |     |
	                 |     +-> EPub.php
	                 |     +-> EPubChapterSplitter.php
	                 |     +-> Zip.php
	                 |
	                 +-> ePubExport.i18n.alias.php
	                 +-> ePubExport.i18n.php
	                 +-> ePubExport.php
	                 +-> ePubExport_body.php

5. Using ePubExport

5.1. Export Current Page
     In order to export current page, click the "Export as ePub" link at the navigation menu, and save the file.

5.2. Export Group of Pages
     In order to export group of pages in a single epub file, click the "Special pages" link at the navigation menu. then choose the "ePub Export" (found under "Page tools" section).
In the first text area, enter a list of one or more pages to export to ePub, one page name per line.
In the second text area, you may add a description to the epub file.
Choose a name for your file and press "Make ePub" to download the file.

6. External code
   The ePubExport extension uses the epub PHP library. epub library uses the Zip PHP library both libraries are by by Asbjorn Grandt. Both are included in the ePubExport download.
   epub: http://www.phpclasses.org/package/6115-PHP-Create-ebook-in-EPUB-format-for-Apple-iPad-.html
   Zip:  http://www.phpclasses.org/package/6110-PHP-Create-archives-of-compressed-files-in-ZIP-format.html
Personal tools