Please notice that this plugin will work only with the base plugin: Responsive Flipbook Wordpress plugin which you need to purchase separately from CodeCanyon.
General Informations - top
First of all, we want to say thanks you! We are very grateful that you have chosen our product for your website. We will do everything we can to provide you the best support possible. Feel free asking us if you need more help.
Folder Structure - top
PDF Wizard - Responsive Flip Book WP Extension Folder Structure:
- changelog.txt - this file contains all of the changes from the initial release
- responsive-flipbook-pdf.zip - contains all the files required for the plugin to run & install
- documentation.zip - contains the help files (which you are currently reading)
FAQ - top
Plugin is not working for me.
Please notice that this is only an extension for Responsive Flipbook Wordpress Plugin. You would need to have this plugin installed and activated for PDF Support to work.
Why cannot I create a book from PDF?Please make sure that your server is ready for the Flipbook plugin. The most important things to verify are:
- Memory Limit - please make sure that your server has at least 64M of memory and you have this code in wp-config.php:
define( 'WP_MEMORY_LIMIT', '64M' ); - max_input_vars - this option defines how many vars can be send to server in a single request. By default, it is set to 1000. In some case, you would need this option to be set up to 2000.
- allow_url_fopen - this option allow to import images after convertion at our server. This restriction is deprecated since version 3.0.1.
Please fill a ticket with wp-admin details at our support forum.
How big my PDF file can be?Since version 3.0.1, the whole process is being performed on user browser and server. There is no longer 100MB limit for PDF file size. Please notice that your server might have its own limit: upload_max_filesize & post_max_size.
Conversion takes ages or freezes.Please make sure that you leave browser tab with conversion in progress on top and active. Browser might pause JS processes on inactive tabs to save your device RAM.
Change Log - top
PDF Wizard - Responsive Flip Book WP Extension ------------------------------------------------- 29/08/2018 - Version 3.0.3 IMPROVED: - Security - WordPress 4.9.8 support IMPORTANT: - In year 2019, we are dropping support for "PDF Wizard - Responsive Flip Book WP Extension" versions lower then 3.0. Our conversion server will no longer be operating after 31.12.2018. This means that converting PDF into Flipbook will not be possible while using versions older then 3.0. ------------------------------------------------- 17/08/2018 - Version 3.0.2 FIXED: - Conversion UX adjusted to prevent processing the same file multiple times ------------------------------------------------- 26/06/2018 - Version 3.0.1 IMPROVED: - WordPress 4.9.6 support - Plugin translations REPLACED: - PDF files are no longer send to our server for conversion into images. The whole process is being made on user browser and server - PDF To FlipBook Extension is using now PDF.js library REMOVED: - Quality settings before PDF conversion. PDF pages are converted now with original size and resolution - 100MB PDF file size limit - since conversion is 100% made on user browser and server FIXED: - Incorrect color saturation after conversion for some PDFs - 0KB images size in Media Library on some servers - Script now better recognizes double and single pages - Double / (slash) for plugin files location path ------------------------------------------------- 15/06/2016 - Version 1.3 IMPROVED: Default conversion quality IMPROVED: Conversion performance ------------------------------------------------- 12/02/2016 - Version 1.2.1 IMPROVED: Increased default convert values FIXED: Minor translation issues ------------------------------------------------- 23/06/2015 - Version 1.2 IMPROVED: Increased the maximum PDF size to 100MB FIXED: Minor Fixes and Improvements ------------------------------------------------- 15/05/2015 - Version 1.1 IMPROVED: SSL Support ADDED: Notification about blocked parameter: 'allow_url_fopen' FIXED: Translations problems FIXED: Images Import issue ---------------------------------------------------- 24/04/2015 - Version 1.0 - Release
Sources and Credits - top
We've used the following libraries: Depreacated since version 3.0.1Getting Started - top
In this section we will go over the process of setting up WordPress environment, next we will show you how to install and activate our plugin. Finally you will learn how to set up all of the key features of Flipbook plugin.
Preparing WordPress - top
If you already have WordPress installed on your server just skip to the next section. If you haven't yet installed WordPress on your server here you will find a complete guide on this topic. Just follow the steps and you will be ready in a blink of an eye with your shiny new WordPress website.
Installation and Plugin Activation - top
Each WordPress plugin can be installed in two ways: via ftp client or through the admin panel:
Installing WordPress Plugin via FTP client:- unzip the 'responsive-flipbook-pdf.zip' package (the zip package is inside the folder you have downloaded from CodeCanyon),
- connect to your server,
- navigate to the folder where your WordPress is installed,
- upload the 'responsive-flipbook-pdf' folder into the 'wp-content/plugins' directory (the path will look like this: wp-content/plugins/responsive-flipbook-pdf),
- open the wp-admin panel (navigate through web browser to the folder where you have installed the WordPress e.g www.your_domain.com/wp-admin/),
- login to your wp-admin panel then from the sidebar on the left choose 'Plugins',
- find the 'PDF Wizard - Responsive Flip Book WP Extension' and click the 'Activate' button next to it.
- open the wp-admin panel (navigate through web browser to the folder where you have installed the WordPress e.g www.your_domain.com/wp-admin/),
- login to your wp-admin panel then from the sidebar on the left choose 'Plugins',
- under 'Plugins' choose 'Add New' then 'Upload',
- you will be redirected to upload form, click the 'choose file' button and navigate to the unzipped package that you have download from CodeCanyon site, inside that package is a file called 'responsive-flipbook-pdf.zip' choose it and click 'open',
- once the plugin is done uploading it will automatically install,
- after the installation you will be able to activate the plugin, to do this click the "blue" activation link.
How To Update Flipbook - top
The update should look like this first go to the Envato Toolkit, there you will find two fileds that you must fill out first is the username (this is the username that you used to purchase at CodeCanyon) the second is the API key, to get your API key login to your CodeCanyon account and go to Settings > API Key. Generate your API key and paste it inside the admin panel.
You will see PDF Wizard - Responsive Flip Book WP Extension displayed bellow when you click the save settings. When update is available you will see it bellow those two fields all you need to do is click Install Automatically button. See the image bellow:
Creating Books from PDF - top
Creating Book - top
Once you activated the plugin you will notice new button called 'Convert PDF' at the top and bottom of 'Flip Books' panel. Inside this tab you will find all the necessary tools to convert your PDF into Flipbook.
To begin creating of your first Flip Book from PDF file please click the 'Convert PDF' button. You will be presented with the settings panel for the book.
As you can see, there is only one fields that needs to be filled in:
- Flipbook Name - here you should specify name of the new book.
Quality options listed below are deprecated since version 3.0.1:
- Normal Page - here are the options for normal size pages:
- Max Width / Max Height - determine how big the book can be.
- Quality - determine the quality of the images.
- Zoom Page - here are the options for hi-res size images used in Zoom functionality:
- Max Width / Max Height - determine how big the book can be.
- Quality - determine the quality of the images.
Default settings should be appropriate for most PDF files. If you want to adjust them, please notice that you are not specifying the book size but the maximum book dimensions.
It means that the new book will not be bigger than these values. For example if Max Width is set to 500px and Max Height is set to 500px but your PDF is in 450x600px size, the height of the Flipbook will be set to 500px but the width will be proportional to the ratio of PDF file.
When Flipbook Name is longer than 3 characters, you can select the PDF file from Step 2:
Once all the steps are completed, you can click on 'Convert PDF' button to start the conversion process.
During the process you cannot close the browser window. Please be patient and check the progression bar for each task. Conversion speed is related to server connection.
Add Pages - top
When the PDF conversion is done, you can Add or Edit pages like in the normal Flipbook.
Each of the pages has the same set of settings (it doesn't matter if new page is created or if the page is being edited - the panel is the same):
- Page Type - first drop down in the page panel specifies if the page is single or double. Each book needs a single page at the beginning and the end (like a normal book Flip book also needs a cover).
- Choose Background - you have two types of backgrounds, normal and hi-res. The normal background is a standard background which is used as a background when the page is viewed normally. The hi-res background is used when the book is zoomed (this background is optional). To add a background click the upload image button, use the standard WordPress upload form. To select a page as your background you need to toggle the uploaded image properties and click the 'Use This File' button (Make sure that the 'Full Size' option is checked).
- Page Title - this option specifies the title of page. It is used by Table of Content generator shortcode. You can leave it empty.
- Page Index - this option specifies the index of the page. The best practice is to leave it at it's default, if you want to change the order of your pages you can always do this by simply clicking the arrows next to the page thumbnail (you need to save the page to see the arrows).
- Page URL - specify the page URL. After that the whole page would work as a link to specified URL (leave empty to disable).
- Page Custom Class - specify page custom class (NOTE: Use it in the Page CSS field to target current page).
- Left Page Content - this field has a HTML editor which will help you to format content. Here you can specify the HTML content which will be displayed on the page or left page (double page). To easily place content in two columns (for left and right pages) use the button alongside.
- Page CSS - here you can specify the CSS which will be applied to the page.
Once again, thank you so much for purchasing this plugin. As we wrote at the beginning, we'd be glad to help you if you have any questions relating our product. No guarantees, but we will do our best to assist. If you have any suggestions on how to improve our themes/plugins or documentation please share them!
MPC