Read Offline allows you to download or print posts and pages. You can download the post as PDF, ePub and mobi
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
css
inc
js
languages
lib
templates
vendor
.codeclimate.yml
.eslintignore
.eslintrc
.gitattributes
.gitignore
.travis.yml
CHANGELOG.md
CREDITS.md
Gruntfile.js
README.md
composer.json 0.6.0 Jul 25, 2016
composer.lock
package.json
phpcs.xml
read-offline.php
readme.txt

README.md

Build Status Code Climate

Read Offline

Read Offline allows you to download or print posts and pages. You can download the post as PDF, ePub or mobi

Demo examples | Features | Feedback & Support | Todo | Changelog | Installation | Use | FAQ | Screenshots | Credits

Demo examples

Based on the UTF-8 sampler from the Kermit project:

  • PDF
    • Cover art
    • Table of Contents
    • Header and footer
    • Watermark
    • Protected, only print enabled
  • ePub
    • Cover art
    • Table of Contents
  • mobi
    • Cover Art
    • Table of Contents

For full PDF font support, you must add the 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)
  • 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
    • Cover Page
    • Header and Footer
    • Theme or Custom CSS
    • Watermark
    • Protection
  • ePub (set in Read Offline->ePub)
    • Table of Contents
    • Cover Page (static or per post feature image)
    • 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" 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
  • languages/read-offline.po for easy translation.
  • Support for all mPDF fonts via the Read Offline Fonts add-on plugin

Feedback & Support

If you have any requests, issues, or other feedback to provide on this beta, please use the links below.

Todo

Issues tagged enhancement are planed enhancements.

Changelog

Please see the CHANGELOG.md file.

Installation

  1. Download the plugin and extract the read-offline.zip
  2. Upload the extracted read-offline folder to the /wp-content/plugins/ directory
  3. Activate the plugin through the 'Plugins' menu in WordPress

Use

  1. Add it to the top or bottom of each post and/or page (See Read Offline->General Options).
  2. [pdf], [epub], [mobi] and [print] shortcodes, attributes:
    • text="Download link text", default: text="Download PDF" etc.
    • icon="false", default: icon="true"

FAQ

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).
  2. [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 add-on plugin.

Screenshots

1. Read Offline -> General Options

Read Offline -> General Options

2. Read Offline -> PDF

Read Offline -> PDF

3. Read Offline -> ePub

Read Offline -> Print

4. Read Offline -> mobi

Read Offline -> Print

5. Read Offline -> print

Read Offline -> Print

Developer Notes

Current Version: 0.7.7

Credits

Please see CREDITS.md