Responsive Flipbook Wordpress Plugin Documentation

Greetings! Bellow you will find complete docummentation for Responsive Flipbook Wordpress Plugin.

SupportPurchase

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.

In Flipbook 2.0, we rewrote a lot of code to make sure that our product works fine on all modern browsers and at mobile devices. Please also check this extension if you need to have PDF support.


Folder Structure - top
Responsive Flipbook WordPress Plugin Folder Structure:
FAQ - top
Why cannot I create a book?

Please make sure that your server is ready for the Flipbook plugin. The most important things to verify are:

I do not have a Add Book form after clicking 'Create New Book'?

Please fill a ticket with wp-admin details at our support forum. There is a strange issue at some server where first book cannot be created from the panel and we need to do it manually.

How to set a book to look like in preview?

In FLipbook 2.0, we introduced a Predefined Style option which will adjust the book settings for you. Please notice that you need to save settings after changing the style.

How to force a book to be always opened?

Please just select a 'Always Open?' option from Book Settings -> Main.

How can I disable a single button / buttons from display?

Each of the navigation buttons can be disabled by unchecking the checkbox at Book Settings -> Navigation Settings.

How to display navigation arrows together with other buttons?

Please select 'Group with Navbar' option from Book Settings -> Navigation Settings and make sure that Arrows are enabled.

How to use Page Linking functionality?

If you want to point user to specifed page with a classic anchor link, please add the HTML listed below to your page content and then adjust page number and link title:

<a href="#7" class="rfbwp-page-link">Open 7 page</a>

Change Log - top
Responsive Flip Book WordPress Plugin
-------------------------------------------------

15/06/2016 - Version 2.3.1
- FIXED: Mobile display on small screens
- FIXED: Mobile bottom navigation display
- FIXED: Hard Covers positioning
- FIXED: Slideshow skipping pages
- FIXED: Rare PHP warnings
- FIXED: Batch import without thumbnails
- FIXED: Panel preloader lock
- FIXED: Firefox display quality

-------------------------------------------------

08/03/2016 - Version 2.3
- NEW FEATURE: RTL Support

-------------------------------------------------

12/02/2016 - Version 2.2
- NEW FEATURE: Mobile zoom
- NEW FEATURE: Lazy load for images
- ADDED: System Status pages
- ADDED: Book shelf titles
- IMPROVED: Localization files
- FIXED: Small panel issues
- FIXED: Empty image background display

-------------------------------------------------

28/01/2016 - Version 2.1.4
- IMPROVED: Wordpress 4.4.1 support
- IMPROVED: Visual Composer 4.9.2 support
- IMPROVED: Localization files
- FIXED: Extensions notifications
- FIXED: Download issue at some servers

-------------------------------------------------

08/11/2015 - Version 2.1.3
- ADDED: Fullscreen without browser toolbar
- IMPROVED: Visual Composer 4.8.1 support
- FIXED: Hard Covers position with top navigation
- FIXED: IE9 navigation issue
- FIXED: Some CSS fixes and glitches
- FIXED: Unexpected checkbox in panel
- FIXED: Navigation order of buttons / missing buttons issue
- FIXED: Google Fonts issue at some servers
- FIXED: Extensions information issue

-------------------------------------------------

31/08/2015 - Version 2.1.2
- IMPROVED: Visual Composer 4.7 support

-------------------------------------------------

10/06/2015 - Version 2.1.1
- IMPROVED: Panel Performance
- FIXED: Panel issue at Safari 7
- FIXED: Protocol issue in Extensions panel
- FIXED: Table of Content index
- FIXED: Possible conflict with other plugins related to Menu position
- FIXED: Zoom Icon at low resolutions

-------------------------------------------------

15/05/2015 - Version 2.1.0
- NEW FEATURE: Page Turn Sounds
- NEW FEATURE: Download Button
- NEW FEATURE: Extensions Panel
- NEW FEATURE: Page Linking functionality
- IMPROVED: Wordpress 4.2.2
- IMPROVED: Performance
- IMPROVED: Compability with Themes & Plugins
- IMPROVED: Code Optimization
- IMPROVED: Mobile Zoom with Touch
- FIXED: Feature Image issue
- FIXED: Mobile Page display
- FIXED: Icons display with some themes
- FIXED: Main Navigation display for Force Open
- FIXED: Aside Navigation centering
- FIXED: 1px Gap between pages
- FIXED: IE9 margin issue

----------------------------------------------------

20/04/2015 - Version 2.0
- NEW FEATURE: 4 New PSD Book Mockups
- NEW FEATURE: 9 Predefined Book / UI Styles
- NEW FEATURE: Bookshelf Shortcode
- NEW FEATURE: Popup Shortcode
- NEW FEATURE: All Shortcodes mapped for Visual Composer
- NEW FEATURE: Hard Covers
- NEW FEATURE: Navigation Style Wizard with predefined styles
- NEW FEATURE: Navigation Settings: border, font, size, color, radius, padding, margins and much more
- NEW FEATURE: Text Navigation
- NEW FEATURE: Four Navigation Positions ( bottom, top, aside left, aside right )
- NEW FEATURE: Navigation Compact Mode
- NEW FEATURE: Left & Right Arrow can be grouped with Navbar
- NEW FEATURE: Icon Select for Navigation Buttons
- NEW FEATURE: 1000+ Icons Integrated
- NEW FEATURE: Automatic Page numeration with display options
- NEW FEATURE: 650+ Google Fonts for Headings / Content / Pagination / Table of Content
- NEW FEATURE: Second Style for Table of Content
- NEW FEATURE: Always Open option, no need to display book cover
- NEW FEATURE: WYSIWYG editor for HTML content
- NEW FEATURE: Two WYSIWYG editors for double pages
- NEW FEATURE: Table of Content generator
- NEW FEATURE: Page Title for Table of Content generator
- NEW FEATURE: Fullscreen background settings: color & opacity
- NEW FEATURE: Page can link to custom hyperlink
- NEW FEATURE: Drag & Drop Sortable for pages
- NEW FEATURE: WPML Support
- NEW FEATURE: Slide Show Speed Setting
- NEW FEATURE: Automatic Book Naming
- IMPROVED: Page Previews
- IMPROVED: Wordpress 4.1 compatibility
- IMPROVED: Multisite Support
- IMPROVED: Front-end Performance
- IMPROVED: Back-end Performance
- IMPROVED: Options Panel Rewrite
- IMPROVED: PO Translations
- IMPROVED: Browsers Support
- IMPROVED: Grid Page View
- IMPROVED: Show All Pages Rewrite
- IMPROVED: Zoom Feature
- IMPROVED: Navigation elements sorting, now with drag & drop
- IMPROVED: Import / Export
- IMPROVED: Batch Images Import
- IMPROVED: New Media Uploader
- IMPROVED: Mobile & Responsive behavior
- IMPROVED: Brand New Documentation
- FIXED: Slide Show Looping
- FIXED: Zoom Scrolling
- FIXED: Zoom Fading Issue
- FIXED: Zoom Scaling
- FIXED: Show All Pages alignment & display
- FIXED: HTML Book Styling
- FIXED: Background Image Alignment
- FIXED: WP Themes Integration
- FIXED: First Book Creation Issue
- FIXED: Page Order Issue
- FIXED: Color Picker
- FIXED: Removing Books Issue
- FIXED: Page Preview Display
- FIXED: Bulk Upload Display Issue
- FIXED: Display issues in Front-end
- FIXED: Other small issues

----------------------------------------------------

24/04/2014 - Version 1.3.3
- Wordpress 3.9 compatibility
- panel improvements

----------------------------------------------------

02/09/2013 - Version 1.3.2
- fixed fatal error on some servers

----------------------------------------------------

30/08/2013 - Version 1.3.1
- import/export fixed

----------------------------------------------------

28/08/2013 - Version 1.3
- rewrited parts of Flip Books Panel,
- fixed max_imput_vars issues,
- added page custom CSS,
- added IE8 support,
- added batch image upload,
- added import/export settings,
- added page preview in panel,
- added fullscreen mode,
- added zoom out button,
- minor fixes and improvements.

----------------------------------------------------

22/04/2013 - Version 1.2.8
- fixed adding new pages.

----------------------------------------------------

18/04/2013 - Version 1.2.7
- fixed thumbnails preview,
- fixed links on pages.

----------------------------------------------------

06/03/2013 - Version 1.2.6
- zip currepted fixed,
- path fix.

----------------------------------------------------

05/03/2013 - Version 1.2.5
- thumbs fix.

----------------------------------------------------

04/03/2013 - Version 1.2.4
- IE fix,
- bug fixes.

----------------------------------------------------

10/01/2013 - Version 1.2.3
- last page bug fix,
- shadow behavior fixed,
- arrows behavior fixed,
- mobile appearance improved,
- book position fix.

----------------------------------------------------

18/12/2012 - Version 1.2.2
- html content columns fix,
- html content fix,
- ESC zoom out fix,
- arrows navigation on zoom added.

----------------------------------------------------

12/12/2012 - Version 1.2.1
- wp 3.5 bug fix

----------------------------------------------------

7/12/2012 - Version 1.2
- admin panel fixes,
- zoom bug fix,
- next arrow bug fix,
- many minor bug fixes.

----------------------------------------------------

21/11/2012 - Version 1.1.1
- admin panel bug fix

----------------------------------------------------

09/11/2012 - Version 1.1
- zoom upgrade,
- admin panel bug fix,
- responsive fix,
- auto deleting books fix,
- minor bug fixes,
- admin panel functionality improvements,
- admin panel design improvements.

----------------------------------------------------

18/05/2012 - Version 1.0
- release

Sources and Credits - top
We've used the following libraries:

Getting 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: Installing Plugin via WordPress Admin Panel:
How to set up your book to look like in CodeCanyon preview - top

If you want to set up your book to look like the Flipbook preview from CodeCanyon please follow this guide.

Please notice that you need to save book settings to see changes in Front-end. You can also change each of the settings and adjust them to your needs.


How To Update Flipbook from version < 1.x important! - top

First of all, please understand that we have changed a lot of things in the Options panel. To be sure, that all your settings and books are safe during and after the update, please download the backup file from the notification box at 'Flipbooks'. Additionaly, we will also create a backup in the database.

Backup Popup

After a download of Backup file, please follow the steps from the section below ( How To Update Flipbook from version 2.0+ ) and after it is done please save settings for each of your book separately. In some cases, you will need to adjust the settings to achieve the same UI style like before.

How To Update Flipbook from version 2.0+ - 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.

Envato Toolkit

You will see Responsive Flipbook Wordpress Plugin 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:

Envato Toolkit

Flipbook Options Panel - top

After installation and activation it is time to set up your books. First thing you will notice is the 'Flipbooks' tab added into the WordPress Admin sidebar. This section contains all of the Flipbook options (see image bellow).

We should jump right into the Flipbook Panel because this is the place where all the magic happens (to do this just click the 'Flipbooks' tab).

Flipbooks Panel

Notice: Before leaving the tab make sure to click the 'Save Options' button at the bottom or top of the panel, otherwise your changes will be lost.


Bookshelf - top

In the first tab you will find all of the books. From here you can:

When there is atleast one book added, you can control the options and pages by clicking on the buttons near to the book cover.


Book Settings - top
Main Settings - Main Decorations Settings - Decorations Fonts Settings Settings - Fonts Zoom Settings - Zoom Show All Pages Settings Settings - Show All Pages Navigation Settings

Notice: Please notice that you can change the order of buttons by clicking and dragging the icon near to tooltip.

Settings - Navigation Navigation Style Settings - Navigation Style Pagination Settings Settings - Pagination Hard Covers Settings - Hard Covers

Notice: If you want to use your own custom fonts, not listed in our settings page, you need to add them manually.

Notice: Before leaving the this tab make sure to click the 'Save Options' button at the bottom or top of the panel, otherwise your changes will be lost.

Pages Settings - top
Settings - Pages
Tools and Import & Export - top

As you can see at the image above, you have a few options here:

Pages - Tools

Content - top

Creating First Book - top

Once you activated the plugin you will notice new tab in the left sidebar called 'Flip Books'. Inside this tab you will find all the necessary tools to create and manage books.

To begin creating of your first Flip Book please click the 'Add Your First Book' button. You will be presented with the settings panel for the book.

Each of the books have such panel, in the panel you can setup all of the essential book settings (at this point you do not add pages, this is covered in the next step). First of all you need to decide what dimensions will your book be. Then you have to figure out if you want to use images as the pages of your book (this is the easiest way to create the book) or maybe you would like images pages with HTML content (better for SEO).

Once you figure out this basic stuff it is time to set up your book with pages. Please click 'Save Settings' to save book, after it is done you will see a new tab 'Add Pages'. Now, you should click it and add your first pages.

Content - First Book
Add Pages - top

To add your first page click the 'Add Your First Page' button.

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):

Content - First Book
Bulk upload of pages - top

In Flipbook, you can also upload multiple pages at once. Please notice that this option allows you to only choose a normal and large (hi-res) images and other pages settings like Page Title, Page URL can be set only after the upload is finished.

To perform a bulk upload, please go to 'Add Pages' tab or click 'View Pages' from Bookshelf. You will see a 'Tools' panel at the bottom of the options panel. Please click it to open.

Content - Bulk Upload

As you can see at the image above, you have a few options here:

First, please select images in normal size. Please make sure that the order of images is correct (first page image should be first in the images list). If you wish to upload also a hi-res images, please select them from 'Select large'. Please make sure that the order and amount of Large images is exactly the same as for Normal.

Before you click 'Upload', you can select what type of pages should be created: Double or Single. After that, please click 'Upload' and wait until all pages will be created.

Shortcodes - top

Flipbook comes with awesome Inline Shortcode Wizard where you can select between Flipbook / Popup Flipbook / Bookshelf insert them into post/page.

To enter the Shortcode Wizard click on the book icon in Wordpress editor and a drop down will show up.

There are three shortcodes available:

Flipbook - Select which Flipbook you would like to display.

Content - Shortcodes
[responsive-flipbook id="_ID_"]

Flipbook Popup - Select which Flipbook you would like to display in a popup.

Content - Shortcodes
[flipbook-popup id="_ID_"]Specify content here.[/flipbook-popup]
[flipbook-popup id="_ID_"]<img src="_image_source_">[/flipbook-popup]

Flipbooks BookShelf - Select which Flipbooks you would like to display in a nice looking Bookshelf with Custom background.

Content - Shortcodes

titles param have three options separated with "-". First ( top, middle, bottom ) tells about titles position on books covers. Second ( always, fade, scale ) is for appear effect for titles. The last one ( light, dark ) sets titles background.

[flipbook-shelf ids="_ID_1,_ID_2" style="classic" titles="top-scale-light"]
[flipbook-shelf ids="_ID_1,_ID_2" style="custom-color" color="#e0e0e0" titles="top-always-light"]
[flipbook-shelf ids="_ID_1,_ID_2" style="custom-image" image="IMAGE_ID" titles="top-always-light"]

Table of Content - Create Table of Content for Flipbook.

[rfbwp_toc][{"title":"_page_title_","number":"_page_index_"},{"title":"_page_title_","number":"_page_index_"},...][/rfbwp_toc]
Visual Composer Shortcodes - top

If you are using Visual Composer as a content editor you can also add a Flipbook shortcodes from the Visual Composer dialog.

Content - Visual Composer Shortcodes

Extensions - top

Right now, two extensions are available for Flipbook. We will keep working on this plugin and addons in the future. If you have any idea how we can extend the functionality of our products please share it with us in comments section at CodeCanyon :).


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