Installation

Flip ​Book​ ​Master​ ​is​ ​a​ ​Joomla​ ​Module.​ ​After​ ​downloading​ ​the​ ​module,​ ​you​ ​can​ ​install​​ it​ ​to​ your ​Joomla​ ​site​ ​by​ ​using​ ​the​ ​Joomla​ ​installer​ ​at​ ​your​ ​Joomla​ ​Site’s​ ​​Administrator ​area.​ URL ​for​ ​the​ ​installer​ ​is:​ ​administrator/index.php?option=com_installer​. After ​the​ ​installation​ ​you​ ​will​​ ​see ​a​ ​success​ ​message.​ Now, ​You​ ​can​ ​visit​ ​the​ ​module​ ​manager​ ​and​ ​start​ ​to​ ​use​ ​the​ ​extension. URL ​for​ ​the​ ​module​ ​manager​ ​is:​ ​administrator/index.php?option=com_modules​
Search ​for​ ​the​ ​module:​ ​Flip​​ ​Book ​Master and click​ ​on​​ the​​ title​ ​to​ ​view​ ​the​ ​module​ ​configuration.​


 

Configuration ​&​ ​Parameters​

 Flip ​Book​ ​Master​ ​has​ ​5​ ​sections​​ at​ ​module​​ parameters:​ 

  1. Basic ​Settings​
  2. PDF ​Settings​
  3. Image ​Settings​
  4. Multiple ​PDF​ ​Settings​
  5. Translation

 Each ​parameter​ ​is​ ​explained​ ​shortly.​​ You​​ must​ ​roll​ ​your​ ​mouse​ ​over​ ​the​ ​parameter​ ​and​ ​​you will ​get​ ​a​ ​short​ ​information​ ​about​ ​the​ ​parameter.​   


 

FAQ (Frequently Asked Questions)

How ​to​ ​show​ ​a​ ​single​ ​PDF​ ​file​ ​as​ ​a​ ​Flip​ ​Book?​

How ​to​ ​show​ ​Images​ ​from​ ​a​ ​Folder​ ​as​ ​a​ ​Flip​ ​Book?​

How ​to​ ​show​ ​Multiple​ ​PDF​ ​Files​​ as​​ a​ ​Flip​ ​Book?​  

How ​to​ ​enable​ ​or​ ​disable​ ​the​ ​Font​ ​Awesome​ ​Library?​

How ​to​ ​change​ ​Page​ ​mode?​

Right ​to​ ​Left​ ​and​ ​Left​ ​to​ ​Right​ ​Support​

How ​to​ ​enable​ ​/​ ​disable​ ​the​ ​Page​ ​Turn​ ​Sound​

How ​to​ ​change​ ​page​ ​turn​ ​sound​ ​effect?​

How ​to​ ​Enable​ ​Zoom​ ​with​ ​Scroll​ ​Wheel?​

How ​to​ ​change​ ​the​ ​Flip​ ​Book​ ​Height?​

How ​to​ ​change​ ​the​ ​​colors​ of​ ​flip​ ​book?​

How ​to​ ​set​ ​page​ ​turn​ ​speed?​

How ​to​ ​hide​ ​PDF​ ​Source​ ​from​ ​Page​ ​Source?​

Translations


 

How to show a​ ​single​ ​PDF​ ​file​ ​​as​ a​ ​Flip​ ​Book?​ 

Go ​to​ ​Basic​ ​Settings​ ​section and ​set​ ​the​ ​​parameter ​​Select ​ ​Theme​ ​to​ ​PDF​ ​ ​File. Then ​go​ ​to​ ​the​ ​PDF​ ​​Settings​ ​section and set the​ "​Select​ ​File​ ​Path"  The value could​ ​be​ ​Default​ ​Folder​ ​or​ ​Custom​ path.

Show PDF Files from Default Folder

If ​you​ ​selected​ ​Default​ ​Folder,​ ​upload​ ​the​ ​PDF​ ​File​ ​​to ​"modules/mod_flipbookmaster/assets/pdf_files". After ​uploading​ ​the​ ​PDF​ ​File,​ ​it​ ​will​ ​be​ ​​show​ at​ ​Select​ ​PDF​ ​File​ ​dropdown​ ​list.​

Show PDF Files from Custom Path

If ​you​ ​selected​ ​Custom​ ​Path,​ ​you​​ must​​ write​ ​​the ​PDF​​ file​ ​​path ​in​ ​to​ ​the​ "Custom​​ ​Path"  textarea.

After ​publishing​ ​the​​ module​​ it​ ​will​ ​show​​ the​ ​​PDF ​file​ ​as​ ​a​ ​flip​book. 


 

Images​ ​from​ ​a​ ​Folder​ ​​as ​​a ​Flip​ ​Book?​

First ​of​ ​all​ ​you​ ​must​​ ​prepare ​your​ ​images​ ​in​​ a​​ single​ ​folder​ ​and​ ​upload​ ​to​ ​server.​ In ​that​ ​sample,​ ​i​ ​uploaded​ ​the​ ​images​ ​to​ ​images/myflipbook​ ​folder.​ 

Go ​to​ ​Basic​ ​ ​Settings​ ​section,​ ​set​ ​the​ ​parameter​ ​Select​ ​ ​Theme​ ​to​ ​Images​​ ​from​ ​Folder
Go ​to​ ​Image​ ​ ​Settings​ ​section,​ ​enter​ ​the​ ​images​​ folder​ ​​path ​to​ ​the​ ​Images​ ​Folder parameter ​input​ ​​ ​ ​E.g.​ ​images/myflipbook​
Publish ​the​ ​module​ ​and​ ​images​​ from​​ the​ ​entered​ ​folder​​ will​ ​​be ​shown​ ​as​ ​a​ ​flip​ ​​


 

  

Multiple​ ​PDF​ ​Files​ ​as​ ​a​ ​Flip​ ​Book?​

 You ​can​ ​show​ ​multiple​ ​PDF​ ​Files​ ​​on ​​the ​same​ ​page.​ ​ ​​Visitors ​will​​ be​ ​able​ ​to​ ​​click ​on​​ to​​ a​ button, ​image​ ​or​ ​text​ ​link​ ​and​ ​view​​ ​the ​Flip​ ​Book​ ​in​ ​an​ ​overlay.​ 

  1. Go ​to​ ​Basic​ ​ ​Settings​ ​section,​ ​set​ ​the​ ​​parameter ​​Select ​ ​Theme​ ​to​ ​Multiple​​ ​PDF Flipbook
  2. Go ​to​ ​Multiple​​ ​PDF​ ​Settings​ ​section​ ​and​ ​​start ​​to ​create​ ​Flip​ ​Book​ ​​
  3. Click ​to​ ​+​ ​button​ ​to​ ​create​ ​the​ ​first​ ​instance,​ ​a​ ​new​ ​division​ ​will​ ​​ ​For​ ​each​ instance ​you​ ​must​ ​enter​ ​the​ ​fields.​

 

  • ​PDF​ ​File​ ​Path​ write ​here​ ​where​ ​your​ ​PDF​ ​File​ ​located​ ​on​ ​your​ ​server​ 
  • ​Encode​ ​the​ ​PDF​ ​Source​

Set ​yes​ ​if​ ​you​ ​want​ ​to​ ​hide​ ​the​ ​​PDF​ File​ ​Path​ ​from​ ​the​ ​page​ ​source​

 

  • ​Link​ ​Type​

Visitors ​may​ ​click​ ​to​ ​a​ ​button,​ ​text​ ​link​ ​or​ ​​a​ thumbnail​ ​image​ ​to​ ​open​ ​the​ ​flip​ ​book.​ 

If ​you​ ​select​ ​Button​​, enter ​the​ ​Button​ ​Text​. 

If ​you​ ​select​ ​Text​ ​ ​link​,  enter ​the​ ​a​ ​text​ ​for​ ​the​ ​link​.

If ​you​ ​select​ ​Thumbnail, enter ​the​ ​Thumbnail​ ​Image​ ​Path,​ ​Thumb​ ​Over​ ​Text​ ​and​ ​Image​ ​Tags​. 

  1. Enable ​Download,​ ​you​ ​can​ ​enable​ ​or​ ​disable​ ​the​ ​single​ ​Flip​ ​Book​ ​​instance ​download​ option
  2. Background ​Color,​ ​you​ ​can​ ​set​ ​any​ ​background​​ color​​ for​ ​the​ ​flipbook​ ​overlay​

 After ​entering​ ​all​ ​parameters,​ ​you​ ​may​ ​create​ ​more​ ​instances.​

 You ​can​ ​publish​ ​the​ ​module​ ​and​ ​visitors​ ​will​ ​view,​ ​thumbnail,​ ​button​ ​or​ ​text​ ​​links ​in​ ​​the module ​position.​ ​When​ ​they​ ​click​ ​an​ ​overlay​ ​will​ ​​be ​​opened ​to​ ​show​ ​the​ ​flip​ ​book.​


  

How ​to​ ​enable​ ​or​ ​disable​ ​the​ ​Font​ ​Awesome​ ​Library?​ 

If ​your​ ​site​ ​is​ ​already​ ​loading​ ​Font​ ​Awesome​ ​CSS,​ ​​you ​do​​ not​ ​​need ​to​ ​load​ ​it​ ​​second​ ​time.​ Go ​to​ ​Basic​ ​Settings​ ​and​ ​set​ ​the​ ​Load​ ​Font-Awesome​ ​option​ ​to​ ​NO​.


 

How ​to​ ​change​ ​Page​ ​mode?

You ​can​ ​change​ ​the​ ​page​ ​modes​ ​by​ ​changing​ ​the​ ​Page​ ​Mode​ ​options​ ​at​ ​Basic​ ​Settings.​ Single ​page​ ​mode​ ​shows​ ​the​​ active​​ page​ ​at​​ the​ ​​center ​of​ ​the​ ​flip​ ​book.​


  

Right ​to​ ​Left​ ​and​ ​Left​ ​to​ ​Right​ ​Support​?

You ​can​ ​set​ ​the​ ​Flip​ ​Book​ ​Direction​ ​Right​ ​to​ ​Left​​ or​​ Left​ ​to​ ​Right​ ​by​ ​setting​ ​the​ ​Direction​ option ​at​ ​Basic​ ​Settings.​


  

How ​to​ ​enable​ ​/​ ​disable​ ​the​ ​Page​ ​Turn​ ​Sound​?

If ​you​ ​want​ ​to​ ​turn​ ​off​​ ​the ​page​ ​turn​ ​sounds​ ​​as ​​default, ​go​ ​to​ ​Basic​ ​Settings​ ​and​ ​change​ ​the​ parameter ​Enable​ ​Sound​ ​to​ ​No.​


  

How ​to​ ​change​ ​page​ ​turn​ ​sound​ ​effect?​ 

You have to​​ ​upload ​a​ ​sound​ ​file​​ (​.mp3 ​format​)​ ​to​ ​the​ ​folder​ modules/mod_flipbookmaster/assets/sound.​
After ​uploading​ ​the​ ​file,​ ​refresh​ ​or​ ​save​ ​the​ ​module​ ​and​ ​the​ ​file​ ​will​ ​be​ ​visible​ ​​at ​Select​​ Sound​ File ​drop​ ​down​ ​list.​ ​Select​ ​the​ ​file​ ​​and ​​enable ​the​ ​Page​ ​Turn​ ​Sound.​


 

How ​to​ ​Enable​ ​Zoom​ ​with​ ​Scroll​ ​Wheel?​ 

You ​can​ ​enable​ ​or​ ​disable​ ​the​ ​visitors​ ​to​ ​zoom​ ​by​ ​mouse​ ​scroll​ ​wheel.​ ​You​ ​can​ ​​do​ that​ ​​by using ​the​ ​Enable​ ​Scroll​ ​Wheel​ ​​parameter ​​at ​Basic​ ​Settings.​


 

How ​to​ ​change​ ​the​ ​Flip​ ​Book​ ​Height?​ 

If ​you​ ​want​ ​to​ ​change​ ​the​ ​Flip​ ​Book​ ​Container​ ​Height,​ ​enter​ ​a​ ​value​ ​Container​​ Height​ ​input​ area ​at​ ​Basic​ ​Settings.​ ​You​ ​must​​ enter​​ a​ ​numeric​ ​value.​ ​For​ ​example,​ ​if​ ​you​ ​want​ ​to​ ​make​ the ​container​ ​height​ ​600​ ​pixels,​ ​just​ ​enter​ ​600​ ​in​ ​to​ ​the​ ​area.​


 

How ​to​ ​change​ ​the​ ​​colors​ of​ ​flip​ ​book?​

At ​the​ ​basic​ ​settings​ ​section,​​ there​​ are​ ​3​ ​parameters​ ​to​ ​change​ ​the​ ​background​ ​and​ ​the​ button ​colors.​ ​You​ ​can​ ​simply​ ​select​ ​from​ ​color​ ​picker​ ​or​ ​enter​ ​a​ ​​color ​value.​


 

How ​to​ ​set​ ​page​ ​turn​ ​speed?​ 

You ​can​ ​make​ ​page​ ​turn​ ​speed​ ​at​ ​the​ ​Basic​ ​Settings​ ​area.​ ​There​ ​is​ ​a​ ​parameter​ ​called:​ page ​Turn​ ​Speed.​ ​This​ ​is​ ​a​ ​value​ ​in​ ​milliseconds.​ ​For​ ​example,​ ​if​ ​you​ ​want​ ​the​ ​page​ ​​turn speed ​is​ ​1.25​ ​Seconds,​ ​then​ ​enter​ ​the​ ​value​ ​:​ ​1250​.


  

How ​to​ ​hide​ ​PDF​ ​Source​ ​from​ ​Page​ ​Source?​ 

This ​solution​ ​is​ ​not​ ​100​% ​securing​​ your​​ PDF​ ​Files​ ​but​​ at​ ​least​ ​it​ ​helps​ ​you​ ​​to ​hide​ ​the​​ file​ path ​from​ ​page​ ​source​ ​code.​ You ​must​ ​Set​ ​the​ ​Encode​ ​PDF​ ​Source​ ​option​ ​to​ ​NO​ ​to​ ​hide​ ​the​ ​PDF​ ​​File ​path​ ​from​ ​the​ source ​code.​


 

Translations

You ​can​ ​translate​ ​the​ ​module​ ​button​ ​texts​ ​at​ ​the​ ​last​ ​setting​ ​section.​