Real3D Flipbook - WordPress Plugin

Email me CodeCanyon portfolio

Thank you for purchasing my item. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form. Thanks so much! Please rate the file on your downloads page if you like it!

This part of the documentation is going to cover, in a step by step instruction the installation of WP Plugins on your WordPress blog in general.

Step 1. Log into your WordPress Admin area.
 
Step 2. Click 'Plugins' button in the admin menu
 
Step 3. Click 'Add new and then 'Upload plugin''
 
Step 4. Select the the plugin zip from your PC, this is the real3dflipbook.zip inside the zip you had previously downloaded from CodeCanyon. Install the zip and click on "Activate Plugin".
 
Should you ever experience slight upload problems then please stay calm, simply use an FTP program to access your blog, then browse to /public_html/wp-content/plugins and upload the unzipped plugin here. Then open the Plugins page and activate the plugin.

Once you have Flipbook plugin activated you can start creating flipbooks.

Step 1. Go to plugin admin page by clicking "Real3D Flipbook" on the left hand side of the admin page. Page 'Flipbooks' will open. Here you can create, duplicate or delete flipbooks. 

Step 2. To create a new flipbook click 'Add New' button. New page 'Edit flipbook' will open where you can create JPG flipbook or PDF flipbook

Flipbook can be created directly from PDF. 

Step 1. Select tab 'Pages' 

Step 2. Click "PDF Flipbook" . Media library will open. 

Step 3. Select or upload pdf file. Pages from pdf will be automatically added to flipbook.

Step 4. Click 'Save'. 

 

PDF from another domain

For using PDF from another domain you need to enable CORS by adding following header to server response 

Access-Control-Allow-Origin: *

Fast PDF loading 

PDF flipbook supports partial PDF download (it can display pages before entire PDF is downloaded). For that feature to work server needs to support range requests.

Flipbook can be created from JPG images. 

Step 1. Select tab 'Pages' 

Step 2. Click button 'JPG flipbook'. Media library will open.

Step 3. Select jpg pages from media library or upload jpg pages to media library. You can select or upload multiple pages at once, no need to upload one by one. 

Step 4. Click 'Save'. 

This option converts PDF to JPG images, saves JPG-s to server to folder wp-content/uploads/{book name} and creates JPG flipbook.

It is optimal way of creating flipbook from PDF if you don't need interactive PDF features like liknks, text search or text select.

Step 1. Select tab 'Pages' 

Step 2. Click "PDF to JPG Flipbook" . Media library will open. 

Step 3. Select or upload PDF file. Pages from PDF will be automatically added to flipbook.

Step 4. Click 'Save'. 

Flipbook created this way will load pages faster then standard PDF flipbook because it does not load PDF.js scripts or process PDF at runtime but only download JPG images.

After pages are added to flipbook you can edit each page by clicking on page thumbnail.

Title - Page title will appear in table of content. It the page title is empty the page will not be llisted in table of content.

HTMLContent - In this section you can add any HTML content to a page, that will be rendered on a separate layer on top of the page image.

For example you can add a link

<a href="http://www.codecanyon.net" traget="_blank">link</a>

you can add any inline css to the element

<a style="position:absolute;left:100px;top:100px;color:#00F" href="http://www.codecanyon.net" traget="_blank">link</a>
you can also add javascript functions to elements, for example 
<div onclick="window.open('http://www.codecanyon.net','_blank')"></div>

or embed iframe 

<iframe width="640" height="390" src="https://www.youtube.com/embed/tS1NCigEB_I" frameborder="0" allowfullscreen></iframe>

After you edited page click 'Save'. Now you can preview flipbook by clicking 'Preview'.

Custom Table of content will override table of content created by page titles or pdf outline embedded in pdf. You can add elements and sub elements. Each element or subelement has properties "title" and "page".

Mode

How the flipbook will be embedded. Available modes are normal - embedded in a container div, lightbox - opens in fullscreen overlay on click, fullscreen - covers entire page

View mode

Available are webgl - realistic 3D page flip with lights and shadows, 3d - CSS 3D flip, swipe - horizontal swipe

Texture size

The size of pdf pages in px. For mode webgl this needs to be power of 2, for other modes can be any value. Recommended 1024 - 4096

Zoomed texture size

Override maximum zoom size which is by default equal to texture size. For example "texture size" is 2048, emable zoom beyond texture size with "zoomed texture size" : 3000

Initial zoom

Initial book zoom, recommended between 0.8 and 1

Zoom step

Between 1.1 and 4

Single page

Display one page at a time

Page flip duration  

Duration of flip animation, recommended between 0.5 and 2

Deep linking 

Enables to link to specific page within flipbook, for example if flipbook is at example.com, open page 2 with example.com#2

Deep linking prefix

instead of default deeplinking hash #$page_number it can be defined custom prefix so the hash will be #$prefix$page_number. For example link to flipbook page 2:

myflipboook.com#2

link with custom prefix "book1_page"

 myflipboook.com#book1_page2

Responsive view

Switching from two page layout to one page layout if flipbook width is below certain treshold

Responsive view treshold

Flipbook width treshold for responsive view feature, default 480

Container height

height of the container

Fit to window

if the container will fit the entire screen

Fit to parent div

if the container will fit the parent div

Fit to height

if the container will fit the parent div height

Container responsive height

if the container height will be proportional to width

Container aspect ratio (for responsive height)

the ratio width / height for the responsive container, recommended between 1 and 2

Right to left mode

Flipping from right to left (inverted)

Page width

Override default page width

Page height

Override default page height

Thumbnail size

Thumbnail height for thumbnails view

Logo image

Logo image that will be displayed inside the flipbook container

Logo link

URL that will be opened on logo click

Logo CSS

Custom CSS for logo

Menu CSS selector

Example "#menu" or ".navbar". Used with mode "fullscreen" so the flipbook will be resized correctly below the menu

Container z-index

Set z-index of flipbook container

Preloader text

text that will be displayed below the preloader spinner
 

Lights

Realistic lightning, disable for faster performance

Light pposition x

Light X position, between -500 and 500

Light position y

Light Y position, between -500 and 500

Light position z

Light Z position, between 1000 and 2000

Light intensity

Light intensity, between 0 and 1

Shadows

Realistic page shadows, disable for faster performance

Shadow Map Size

Shadow quality, 1024 or 2048 or 4096

Shadow opacity

Shadow darkness, between 0 and 1

Shadow plane distance

Distance of shadow from the page, between 10 and 20

Page hardness

Between 1 and 5, default 2

Cover hardness

Between 1 and 5, default 2

Page material roughness

Between 0 and 1, default 1

Page material metalness

Between 0 and 1, default 0

Page segments W

Number of page segments horizontally, default 6

Page segments H

Number of page polygons vertically, default 1

Page middle shadow size

Shadow in the middle of the book

Left middle shadow color

CSS color, for example #CCC

Right middle shadow color

CSS color, for example #999

Antialiasing

Disable for faster performance

Camera pan angle

Between -10 and 10

Camera tilt angle

Between -30 and 0

Rotate camera on mouse drag

 

Camera pan max

 
Max pan angle for mouse drag rotate, between 0 and 20

Camera pan min

Min pan angle for mouse drag rotate, between -20 and 0

Camera tilt max

Max tilt angle for mouse drag rotate, between -60 and 0

Camera tilt min

Min tilt angle for mouse drag rotate, between -60 and 0

Rotate camera on mouse move

Camera pan max

Max pan angle for mouse drag rotate, between 0 and 5

Camera pan min

Max pan angle for mouse drag rotate, between -5 and 0

Camera tilt max

Max pan angle for mouse drag rotate, between -10 and 0

Camera tilt min

Max pan angle for mouse drag rotate, between -10 and 0

Override default flipbook settings for mobile devices (hide some buttons on mobile, use different resolution)

 

You can add social share button by clicking button 'Add share button' and then assign icon css class, icon name, link and target. (any font-awesome icon can be used, to see the full list of icons go here)

With UI settings you can change background and menu colors, layout and styles

Layout

Choose between 4 premade UI layouts

Skin

Choose between light, dark or gradient skins

Icons

Choose between Font-awesome or Material icon sets

Advanced settings

Override default UI layout and customize colors, sizes, margins, backgrounds of all UI elements

 

Once you are finnished with adding pages and editing options, you need to

  1. save flipbook
  2. go back to the list of all your flipbook by clicking on 'back to flipbook list' link.
  3. copy the flipbook shortcode you wish to embed. The shortcode is in form [flipbook id="ID"] 
  4. paste the shortcode anywhere in your page / post. 

For quick testing

  1. create a new page
  2. paste the flipbook shortcode
  3. click 'preview page'

Shortcode parameters

id - the id of the flipbook. The default shortcode that looks like this 

[real3dflipbook id="1"]

name - the name of the flipbook. You can embed the flipbook also with name, like this

[real3dflipbook name="flipbook1"]

pdf - you can assign (override) the pdf url that will be displayed with flipbook

if you embed flipbook with shortcode 

[real3dflipbook id="1" pdf="http://www.yourwebsite.com/1.pdf"]

it will show the pdf file that is specified in shortcode. This enables you to create only one "template" flipbook and use it for multiple flipbook on the page. 

You can use that shortcode to show multiple PDF files using the same flipbook like this

[real3dflipbook id="1" pdf="http://www.yourwebsite.com/1.pdf"]

[real3dflipbook id="1" pdf="http://www.yourwebsite.com/2.pdf"]

 

Export to JSON

You can export all your books as JSON. This is useful for making a backup or moving your flipbooks to another server. To export flipbooks to JSON go to plugin anmin page 'Flipbooks' and click 'Export to JSON'. The JSON code will be generated and you can save it to a txt file.

Import from JSON

Import from JSON will remove all your current books and import flipbooks from JSON that you enter (paste) in the input field. Before clicking 'Import from JSON' make sure that you have your current flipbooks saved to JSON.

Moving to another server

You can easily move your flipbooks to another server.. You need to 

1 move all assets (images, pdf-s) to new server

2 Export flipbooks to JSON

3 edit JSON- replace all paths to pages and pdf-s in json with new paths

4 on new server import from the edited JSON

 

Unable to save flipbook settings / unable to add new flipbook

Increase max_input_vars in your php.ini from default 1000 to higher value, for example 3000 and restart server. If you don’t find max_input_vars in your php.ini file then add it like this

max_input_vars=3000

save and restart server. Make sure that max_input_vars in not commented out with semicolon at the beginning of the line like this

;max_input_vars=3000

 

Plugin installation failed

You uploaded the zip that is not valid WordPress plugin (wrong zip file). You need to upload real3dflipbook.zip.

 

PDF Flipbook loads for long time

Make sure your server supports range requests. That is required so PDF pages can be rendered before entire PDF is downloaded. 

 

JPG Flipbook loads for long time

Optimize JPG-s for web use. Images should be 200-300kb in size and maximum 2000 - 3000 px in height.

 

Can I load a PDF/images from another server (cross domain request)?

By default PDF and images needs to be on the same server. To use resources from another domain you need to add Access-Control-Allow-Origin header to server response, for example to allow http://foo.example to load the resources you need to add header
 
Access-Control-Allow-Origin: http://foo.example

 

Flipbook is not working

Please check your browser console for errors. In most cases the problem is that flipbook has no PDF/images specified, or is trying to load PDF/images from another domain. There might also be other javascript errors on the page, coming from another plugin. Try to disable other plugins to see if another plugin is causing the problem.
 

Updating to latest version

Step 1. Re-download the plugin from your Codecanyon downloads page
Step 2. Uninstall the current version
Step 3. Install the new version