=== Read Offline ===
Contributors: PerS
Donate link: http://soderlind.no/donate/
Tags: pdf, epub, mobi, print
Requires at least: 4.0
Tested up to: 4.7
Stable tag: 0.7.7
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Read Offline allows you to download or print posts and pages. You can download the posts as PDF, ePub or mobi
== Description ==
= Demo examples =
Based on the [UTF-8 sampler from the Kermit project](http://www.columbia.edu/kermit/utf8.html):
* [PDF](https://github.com/soderlind/read-offline-fonts/raw/master/examples/internationalizaetion.pdf)
* Cover art
* Header and footer
* Table of Contents
* Watermark
* Protected, only print enabled
* [ePub](https://github.com/soderlind/read-offline-fonts/raw/master/examples/internationalizaetion.epub)
* Cover art
* Table of Contents
* [mobi](https://github.com/soderlind/read-offline-fonts/raw/master/examples/internationa.mobi)
* Cover Art
* Table of Contents
For full PDF font support, you must add the [Read Offline Fonts](https://github.com/soderlind/read-offline-fonts) add-on plugin.
= Features =
* Add download links to the top and bottom of a post or page (configurable in Read Offline->General Options)
* Add download links using `[pdf]`, `[epub]`, `[mobi]` and `[print]` shortcodes.
* You can download a PDF, ePub or mobi file containing the current post or page, or you can print the post / page.
* The download filename is based on the posts slug (`$post->post_name`)
* Adds meta data to the file
* Title, Author, Date, Copyright message etc.
* PDF features (set in Read Offline->PDF)
* Paper formats (A0 - A10, B0 - B10, C0 - C10, 4A0, 2A0, RA0 - RA4, SRA0 - SRA4, Letter, Legal, Executive, Folio, Demy and Royal)
* Table of Contents
* Annotations
* Cover Page
* Header and Footer
* Theme or Custom CSS
* Watermark
* Protection
* ePub (set in Read Offline->ePub)
* Table of Contents
* Cover Page
* Custom CSS
* mobi (set in Read Offline->mobi)
* Table of Contents
* Cover Page
* Print features (set in Read Offline->print)
* Add print header text
* Custom print style
* Permalink support (/read-offline/"postid"/"post-name"."type"). I've written a "[how-to add a permalink to your plugin](http://soderlind.no/archives/2012/11/01/wordpress-plugins-and-permalinks-how-to-use-pretty-links-in-your-plugin/)" guide at soderlind.no
* Google Analytics read-offline event tracking. You can find these under Content » Events in your Google Analytics reports. Assumes you’re using the [Asynchronous version of Google Analytics](http://code.google.com/apis/analytics/docs/tracking/asyncTracking.html)
* languages/read-offline.pot for easy translation.
* Support for all mPDF fonts via the [Read Offline Fonts](https://github.com/soderlind/read-offline-fonts) add-on plugin
* Prevent content from being added by using a wrapper with `class="not-readoffline"`, eg: ` don't include this content in the PDF/ePub/mobi`
== Installation ==
You know the drill:
1. In WordPress Admin, go to `Plugins->Add New`
1. Search for `Read Offline`
1. Install and Activate
1. Go to `Read Offline` in the main admin menu and configure the plugin.
or
1. Download the plugin and extract the read-offline.zip
1. Upload the extracted `read-offline` folder to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
The plugin is also [available at GitHub](https://github.com/soderlind/read-offline)
== Credits ==
Read Offline is using the following libraries:
* [mPDF](https://github.com/mpdf/mpdf) is written by Ian Back and is released under the GNU GPL v2 license.
* [PHPePub](https://github.com/Grandt/PHPePub) is written by Asbjorn Grandt and is released under the GNU Lesser General Public License v2.1
* [phpMobi](https://github.com/raiju/phpMobi) is written by Sander Kromwijk and is released under the Apache license (version 2.0)
* [Admin Page Framework](https://github.com/michaeluno/admin-page-framework) is written by Michael Uno and is released under the following licenses:
* Admin Page Framework (Framework Files) MIT license
* Admin Page Framework - Loader (WordPress Plugin) GPL v2
== Frequently Asked Questions ==
= How do I add download links? =
There are 2 ways you can add the Read Offline links:
1. Add it to the top or bottom of each post and/or page (See Read Offline->General Options).
1. `[pdf]`, `[epub]`, `[mobi]` and `[print]` shortcodes, attributes:
* `text="Download link text"`, default: `text="Download PDF"` etc.
* `icon="false"`, default: `icon="true"`
= Does the plugin support RTL output? =
1. RTL, right-to-left writing direction, is supported in PDF and ePub. For PDF, you'll most likely need the [Read Offline Fonts](https://github.com/soderlind/read-offline-fonts) add-on plugin.
== Screenshots ==
1. Read Offline -> General Options
2. Read Offline -> PDF
3. Read Offline -> ePub
4. Read Offline -> mobi
5. Read Offline -> Print
== Changelog ==
= 0.7.7 =
* [Prevents formats not selected in plugin settings from being saved](https://github.com/soderlind/read-offline/pull/82)
* [Fixes query url of attachment to use site url instead of home](https://github.com/soderlind/read-offline/pull/79) (allows alternate site url to not break the plugin)
= 0.7.6 =
* Tested & found compatible with WP 4.7.
= 0.7.5 =
* Linted CSS files
= 0.7.4 =
* Removed "XX" that was prefixed to the archive title.
= 0.7.3 =
* FIX: Option to save, or not, to media library.
* ADD: Annotations for PDF. Converts foot- / endnotes to annotations. Enable in Read Offline->PDF
* ADD: "Don't include content" using a wrapper with `class="not-readoffline"`, eg: ` don't include this text in the PDF/ePub/mobi`
= 0.7.2 =
* ADD: Support for custom post type
= 0.7.1 =
* FIX: Bug in Table of Contents settings for ePub and mobi.
= 0.7.0 =
* Add `[pdf]`, `[epub]`, `[mobi]` and `[print]` shortcodes.
= 0.6.4 =
* Add, for ePub and mobi table of contents, option to select all headers (h1-h6).
* Use `wp_safe_remote_get()` instead og `wp_remote_get()`
= 0.6.3 =
* Fix load feature image for ePub.
* Tested & found compatible with WP 4.6.
= 0.6.2 =
* Remove notice that you should upgrade to PHP 5.6 (bur really, you should).
= 0.6.1 =
* Add RTL for PDF, ePub and print. PDF needs the [Read Offline Fonts](https://github.com/soderlind/read-offline-fonts) add-on plugin.
= 0.6.0 =
* Add support for all mPDF fonts via the [Read Offline Fonts](https://github.com/soderlind/read-offline-fonts) add-on plugin
* Update mPDF to verion 6.1
= 0.5.0 =
* Add Table of Contents to ePub and mobi, default off. Set it in Read Offline->ePub and Read Offline->mobi
* Readded mobi cover page (kind of catch 22, you must have Table of Contents to get a cover page)
= 0.4.1 =
* Added missing folder
= 0.4.0 =
* Fix ePub and mobi bugs
* Add option in admin to select if you want to cache pdf, epub or mobi files in the Media Libray, default is "No"
* Update PHPePub to version 4.0.7
* Update phpMobi to latest version
* Remove HTMLPurifier
= 0.3.1 =
* Fixed HTML purification (previous version stripped html P-tags, sorry). html-purify is now only used when creating ePub
= 0.3.0 =
* A lot of changes since last commit, please see [CHANGELOG.md](https://github.com/soderlind/read-offline/blob/master/CHANGELOG.md) at GitHub
= 0.2.8 =
* ePub: rewrote routine for embedding images
= 0.2.7 =
* ePub: Added option to add Featured Image as a coverpage
* ePub: Fixed bug with adding images
* Read Offline ePub validates using the [EPUB Validator](http://validator.idpf.org/)
= 0.2.6 =
* Read Offline now works with Pages
= 0.2.5 =
* Solved a bug that prevented a user from adding a custom css to PDF
= 0.2.4 =
* Solved a bug that prevented a user from adding a custom css to ePub
= 0.2.3 =
* Reduced mPDF library size by 90% (!!), incl removing fonts. Only [DejaVu fonts](http://dejavu-fonts.org/) are included. Will add font management (i.e. option to add fonts) in later version. Please [tell me](https://github.com/soderlind/read-offline/issues/new) if this breaks the plugin.
= 0.2.2 =
* Added localization (that is, added missing `load_plugin_textdomain()`)
= 0.2.1 =
* New Feature: Read Offline->Print->Print Style = "The site theme style"
* Biugfixs
* PDF: Page numbering
* ePub: ePub-> Add cover page. Missing cover page gave error.
* Minor fixes.
= 0.2.0 =
* **Complete rewrite**. NOTE, I haven't added support for the `[readoffline]` shortcodes in this version, it will be added in 0.3.0
* Added more PDF features
* Paper formats
* Table of Contents
* Cover Page
* Header and Footer
* Use Theme or Custom CSS
* Add Watermark
* Add Protection
* **Print**: In addition to downloading a PDF, ePub or mobi, you can now print the page
* Add print header text
* Custom print style
* Updated libraries should give better UTF-8 support for PDF, ePub and mobi.
= 0.1.9 =
* Fixed a bug in permalinks that gave 404 for blogs in a subdirectory. Also removed code that gave error when downloading an ePub.
= 0.1.8 =
* Added Google Analytics read-offline event tracking. You can find these under Content » Events in your Google Analytics reports. Assumes you’re using the [Asynchronous version of Google Analytics](http://code.google.com/apis/analytics/docs/tracking/asyncTracking.html)
= 0.1.7 =
* Fixed a small bug
= 0.1.6 =
* Added the option to add custom css to PDF
= 0.1.5 =
* In Settings->Read Offline, added the option to add custom css to ePub
* Added languages/read-offline.po for easy translation.
= 0.1.4 =
* Added permalink support (/read-offline/"postid"/"post-name"."type"). I've written [a how-to add permalink to plugins guide at soderlind.no](http://soderlind.no/archives/2012/11/01/wordpress-plugins-and-permalinks-how-to-use-pretty-links-in-your-plugin/)
* removed the obsolete download.php
= 0.1.3 =
* epub will now validate against http://www.epubconversion.com/ePub-validator-iBook.jsp
* Added language variable to the epub file, ISO 639-1 two letter tag based on the WordPress get_locale()
= 0.1.2 =
* Fix typo in download.php, was including "Epub.inc.php", correct is "EPub.inc.php".
= 0.1.1 =
* bugfix
= 0.1.0 =
* Added the Read Offline shortcode
* Added, in Settings->Read Offline, option to add Read Offline to top and/or bottom of post and page
= 0.0.2 =
* Filename based on the posts slug
* Added meta data
= 0.0.1 =
* Initial release