[MODULE] ePubVersion

Description: Module to create and download .ePub versions of stories.

Current Version: v1.3 Update 1 – (v1.3u1 Fixes installer.php and update.php errors present in version 1.3 and referenced in comments and the eFiction.org/de forums)

Demo: http://www.tgfiction.net (visit any story, and look for the ePub icon under DisplayWord and Printer friendly)

Requirements:

• efiction 3.x
• PHP – 5.3.2 because of functions used in the ePub Class
• I use don’t use any specialized MySQL functions. I use MySQL5 for testing and development, but again, have no specific requirements other than that.
• PHP needs to be compiled with TIDY in order to use the TIDY option.
• Apache Mod_Rewrite is needed for Search/Stanza friendly URL’s
• PHP needs to be compiled with CURL support to enable CURL as an option for image retrieval.
• PHP needs to have URL_FOPEN enabled to enable URL_FOPEN/get_file_contents() as an option for image retrieval.
• I make GREAT use of preg_match/preg_replace so your webhost needs to have perl regular expressions (regexp) enabled in PHP.

.

Mod History:

• v0.7 initial release. Broken Installer, No Image Support, Hardcoded formatting.
• v0.8 Added small configuration section at the top of epubversion.php that can be used to configure $sitename, $siteurl, and $sitetagline which are used for the OPF File’s publisher line, and the “Brought to you by” line on the cover-page.
• v0.8 Added ‘exit();’ right after the epub is sent to the user inorder to stop erroneous/extra data being sent and causing some ebook readers to detect a bad ebpu/zip container.
• v0.9 – copied formatstory() and nblr2() functions from corefunctions.php to epubversion.php to remove errors caused by stories with content warnings.
• v0.9 – Removed includes for TemplatePower, corefunctions.php. pagesetup.php
• v0.9 – more general code cleanup.
• v1.0 – Added Image Support
• v1.0 – Added Admin Configure/Options PaneL
• v1.0 – Added Author Configure/Manage Panel
• v1.0 – Added ePub Browse Panel
• v1.0 – Added Update script
• v1.0 – Added Tidy support
• v1.0 – Added ability to turn off ePub Creations for non logged in users
• v1.0 – Fixed double header error on Cover page (caused crash in Stanza)
• v1.0 – Added Title Sanitation (Caused crash in Stanza)
• v1.0 – Cleaned up code where needed. Compacted some bits
• v1.0u1 – Fixed INSTALL Script
• v1.0u1 – Fixed UPDATE Script
• v1.0u1 – Added MASTER Uninstall script that keeps removing ePub related info from the database even after errors ( modules/epubversion/dropall.php )
• v1.1 – Added choice of URL_FOPEN/get_file_contents() support for those whom don’t have CURL for image retrieval.
• v1.1 – Added choice of NONE which filters all IMG tags from the source material, and creates a image-less ePub eBook.
• v1.2 – Added Dynamic Banner option to banners list.
• v.1.2 – Incorporated changes to browse pages to fix errors as reported by Calash (THX!)
• v1.2 – Added ePub Download Counter
• v1.2 – Added pre-processing preg_replace filter for pre-processing conversion of <b><i><u><em><s><strong> into span tags.
• v1.2 – Added routine for a Combined TIDY+PURE. This option creates the largest resource hit on your server, as it essentially processes each page 4 times. (once for images, once for pre-processing, and then once each to filter through TIDY and HTMLPurifier). Each step improves the output book for better compatibility on more readers).
• v1.2 – Added support for HTMLPurifier (PURE). HTMLPurifier outputs pretty XHTML compliant source pages that make for optimally redered ePub eBooks.
• v1.3 – Added {printepub} {epubcount} {cover} {printthumb} tags to available TPL coding tags.
• v1.3 - Added support for changing the ePub "Language" identifier.
• v1.3 – Added support for site wide "Cover" images for stories.
• v1.3 – Added support for author uploaded/custom "Cover" images for stores.
• v1.3 – Upgraded EPub.php to current released version.
• v1.3 – Upgraded HTML Purifier to current released version.
• v1.3 – Added the ability to use "Cover" images on your eFiction Front page and Stories pages...
• v1.3 – Improved handling of extraneous character sets.
• v1.3 – Fixed several reported errors.
• v1.3 – Fixed Dynamic Banner code.
• v1.3u1 – Fixed installer and update.php errors present in version 1.3 and referenced in comments and the eFiction.org/de forums.

Download: http://storyportal.net/software/epub/

Current Issues:

• All Formatting is currently hardcoded into ePubVersion (I will work on putting the Template.Power template support back in in a later release, but I was having issues mixing the EPub class and the Template.Power class).



Basic Documentation:

To install this module:

1. Upload the entire epubversion folder to the the modules folder within your
eFiction installation.

2. Go to http://yoursite.com/admin.php?action=modules  or
http://www.yoursite.com/modules/epubversion/install.php where
www.yoursite.com is your eFiction site's address.

3. Goto the main default_tpls folder.  Open up viewstory.tpl and
storyindex.tpl and add {printepub} where you want the ePub icon/options
to appear.

4. Do the same for any skins with their own viewstory.tpl and/or storyindex.tpl

You can define $epubicon in your skin's variables.php to override the
default ePub icon if you so desire.

There is one language definition in the en.php file in the languages folder
that provides the alt text for the ePub icon as well as the various text bits
for the rest of the expanded modules..

The configuration variables that used to be set at the top of epubversion.php
are now set via the modules admin options panel. You can access this by
visiting http://yoursite.com/admin.php?action=modules&module=epubversion&admin=true
or by goting to the "Admin" page, clicking on "Modules" and then clicking on the
"Options" link next to ePubVersion.

These variables are used to configure you "Brought to you by" line on the cover
page, and the OPF's publisher information line

This module now has the ability for Authors to turn on/off ePub editions for
each of their stories. This is done via the User/Account menu, by clicking on
"Manage ePub Stories". By default, the ePub bit is set to "0" or "Off" for
all authors. They must "Opt In"

5) We have added several new tags to ePubVersion that can be added to your templates.

{printepub} -- Displays a direct Download link for ePub version of a Story.

{printthumb} -- Displays a thumbnail Image of the epub/Book Cover is one has been
set in "Manage ePub Stories". Cover image is dynamicaly resized so that max width
or height is no larger than 100px. Original Aspect ratios are kept.
Requires PHP Compiled with GD, and GD compiled with PNG/JPG/GIF support.

{cover} -- Displays an Image of the epub/Book Cover is one has been set in "Manage
ePub Stories". Cover image is dynamicaly resized so that max width   
        or height is no larger than 250px. Original Aspect ratios are kept.
        Requires PHP Compiled with GD, and GD compiled with PNG/JPG/GIF support.

{epubcount} -- Returns the number of times a Story has been downloaded as "epub"
in numerical form.

Below you will find sample usage of the new skin tags as found in my index.tpl (recentblock)
and listings.tpl (storyblock). I have made use of CSS to make the various "boxes" size
properly around the images.

<!-- START BLOCK : recentblock -->

<div style="min-height:100px; height:auto!important; height:100px;">
<span style="font-weight: bold; font-size: 1.2em; border-bottom: 1px dashed #999; margin-bottom: 5px;">
{printthumb}{title} by {author} {printepub}</span><br />
<span class="label">Summary: </span>{summary}<br />
<span class="label">Rated:</span> {rating} {score} <span class="label">Categories:</span> {category} {classes}</span>
<br />
</div>
<hr>
<!-- END BLOCK : recentblock -->

<!-- START BLOCK : storyblock -->
<div class="listbox {oddeven}">
<div class="title"><span class="t2">{title}</span> by {author} <span class="label">Rated:</span> {rating} {roundrobin} {score} [{reviews} - {numreviews}] {new} </div>
<div style="min-height:250px; height:auto!important; height:250px;">
{cover}
<div class="content"><span class="label">Summary: </span>{featuredstory}{summary}<br />
<span class="label">Categories:</span> {category} <br />
<span class="label">Characters: </span> {characters}<br />
{classifications}
<span class="label">Series:</span> {serieslinks}<br />
<span class="label">Chapters: </span> {numchapters} {toc}<br />
<span class="label">Completed:</span> {completed}
<span class="label">Word count:</span> {wordcount} <span class="label">Read Count:</span> {count}  <span class="label">ePub Downloads:</span> {epubcount}
{adminlinks}</div></div>
<div class="tail"><span class="label">{printepub} {addtofaves} {reportthis} Published: </span>{published} <span class="label">Updated:</span> {updated}</div>
</div>
{comment}
<!-- END BLOCK : storyblock -->

Please leave my info in any derivative works, as I have left Tammy’s. This module is released under GPL and is free to use. Use it to your hearts content.

You can post comments/complaints here or @ my wordpress site, but the wordpress site (storyportal.net) will probably get replies first.
-HuGgLeS-
-P/KAF/PT