Flipbook Professional is a Joomla module for displaying PDF files as a flipping book. Flipping books provide your users with a rich view experience; browse pages, zoom in and out, view in full screen and many more features are available with Flipbook Professional.

Table of Contents

• Installation
• Configuration
  • Show a PDF document as a Flip Book
    • Show PDF Files from Default Folder
    • Show PDF Files from Custom Path
  • Show images from a folder as a Flip Book
  • Show multiple PDF documents as a Flip Book
  • Show both PDF documents and images in a Flip Book
• FAQ (Frequently Asked Questions)
  • Toggling the Font Awesome Library
  • Changing the page mode
  • Right to Left and Left to Right Support
  • How do I enable /disable the Page Turn Sound?
  • Changing page turn sound effects
  • Enabling zoom with scroll wheel
  • Changing the flip book height
  • Changing the colors of a flip book
  • Adjusting page turn speed
  • Toggling button controls
  • How do I hide PDF Source from Page Source?
  • Translations
  • How do I create a direct link to a page?

Installation

Start by downloading the Flipbook Professional Joomla module to your computer.

Once downloaded, use Joomla's extension manager to install the Flipbook Professional module:

• Log in to your Joomla administrator,
• From the top menu, navigate to Extensions -> Manage -> Install,
• Select the tab Upload Package File. Using the installer, browse to the file mod_flippingbook-vX.Y.Z.zip. This will complete the installation proces,
• If installed successfully, you will see an installation success message.

Once installed, you can start configuring Flippingbook Professional.

Configuration

Use Joomla's module manager to configure Flippingbook Professional.

Once logged in your Joomla administrator, select Extensions -> Module from the top menu.

To display a PDF in the Flippingbook Professional module, you will need to configure the following at a minimum:

Set the status to published and specify a position (where you want Flippingbook to be displayed). Also choose whether to show or hide the title.

Assign the module to at least one page.

Specify the PDF to display.

Flipbook Professional includes additional settings for fine-grained configuration:

• Basic Settings - control how Flippingbook is displayed,
• Button Settings - control the layout and display of the navigation buttons,
• PDF Settings- specify the PDF to display,
• Image Settings - specify the location of supporting images,
• Multiple PDFSettings,
• Translation - customize Flppingbook labels.

You can mouse over each setting to learn more.

Configuring and managing modules is explained in more detail in Joomla's documentation. See Extensions Module Manager for more information.

Show a PDF document as a Flip Book

Use the module manager and select the flip book you wish to edit.

Select the Basic Settings tab and change the parameter Select Theme to PDF File.

Next, click on the tab PDF Settings and change Select File Path to either Default Folder or Custom path.

Show PDF Files from Default Folder

If you select Default Folder, uploadthePDFFileto modules/mod_flipbookmaster/assets/pdf_files located under your joomla installation's root folder.

After uploading the PDF File,it should be available in the Select PDF File dropdownlist.

Show PDF Files from Custom Path

If you select CustomPath, you must specify the PDF file path for Custom Path option.

After publishing the module it will show the PDF document as a flipbook.

Show images from a folder as a Flip Book

Upload your images to a folder on your Joomla site. You can use Joomla's media manager to create the folder and upload the images to it. Select Content -> Media from your Joomla administrator's top menu.

Once uploaded:

• Select Extensions -> Modules from the top menu and select your Flipbook module,
• Click on the tab Basic Settings andsetthe parameter Select Theme to Images from Folder,
• Select the tab Image Settings and specify thepath totheImagesFolder you created in the Joomla media manager. The path must be relative to the folder your Joomla web site is intalled to. For example, if your images are in /path/to/joomla/installation/images/myflipbook you will specify images/myflipbook.
• Click Save or Save & Close and the folder's images will be shown as a flip book.

Show multiple PDF documents as a Flip Book

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

• Select the module you want to configure from Extensions -> Modules,
• Select the tab Basic Settings and select Multiple PDF Flipbook from the Select Theme dropdown list,

• Select the tab Multiple PDF Settings and click on the + button to add PDF documents. For each document you must enter the fields:

  • PDF File Path, E.g. pdfs/myflipbook,
  • Encode the PDF Source. Set yes if you want to hide the PDF File Path from the page source,
  • Link Type. Visitors can navigate from one PDF flipbook to another using either a button, text link or a thumbnail image. If you select Button, enter the Button Text. If you select Text link, specify text for the link. If you select Thumbnail, enter the Thumbnail Image Path, Thumb Over Text and Image Tags.

• Enable Download, you can enable or disable the single Flip Book instance download option,

• Background Color, you can set any background color for the flipbook overlay.

Click on + to add more PDf documents.

Show both PDF documents and images in a Flip Book

You can also show a combination of PDF documents and images within the same Flip Book. Visitors will be able to click on the a button, image or text link and view the Flip Book in an overlay.

• Select the module you want to configure from Extensions -> Modules,
• Select the tab Basic Settings and select Mixed Flipbook from the Select Theme dropdown list,
• Select the tab Multiple PDFs/Images and click on the + button to add PDF documents or images. You will need to specify the Flipbook Type for each entry. This will either be PDF file or Images Folder,
• If PDF file is selected you will need to specify details about the PDF:
  • PDF File, E.g. pdfs/myflipbook,
  • Encode the PDF Source. Set yes if you want to hide the PDF File Path from the page source,
• If Images Folder is selected you will need to specify the location of the images by specifying a path for Images Folder,
• You can also specify the following for both PDF file and Images Folder:
  • Link Type. Visitors can navigate from one flipbook to another using either a button, text link or a thumbnail image. If you select Button, enter the Button Text. If you select Text link, specify text for the link. If you select Thumbnail, enter the Thumbnail Image Path, Thumb Over Text and Image Tags.
  • Enable Download, you can enable or disable the single Flip Book instance download option,
  • Background Color, you can set any background color for the flipbook overlay.

Click on + to add more PDF documents and image folders.

FAQ (Frequently Asked Questions)

Toggling the Font Awesome Library

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

Changing the page mode

You can change the page modes by changing the Page Mode options from the tab 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, located under the tab Basic Settings.

How do I enable /disable the Page Turn Sound?

If you want to turn off the page turn sounds as default, set Enable Sound to No under the Basic Settings tab.

Changing page turn sound effects

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 available in the Select Sound File drop down list. Select the file and enable the Enable Sound option.

Enabling zoom with scroll wheel

You can enable or disable the zoom by mouse scroll wheel feature by setting Enable Scroll Wheel option under Basic Settings.

Changing the flip book height

To change the Flip Book container height, enter a value Container Height option under Basic Settings. You MUST enter a numeric value. For example, if you want to make the container height 600 pixels, specify the value 600.

Changing the colors of a flip book

Under Basic Settings there are options to change the background and the button colors. Use the color picker or enter a color value in hexadecimal format.

Adjusting page turn speed

You can adjust the page turn speed in milliseconds by setting the "Turn Speed" option, which is located under Basic Settings. For example, if you want the page turn speed is 1.25 Seconds, then enter the value : 1250.

Toggling button controls

You can change which button controls are shown or hidden by navigating to Button Settings and hiding unnecessary buttons.

You can also turn off all buttons by setting Hide all controls to ""on**.

How do I hide PDF Source from Page Source?

PLEASE NOTE: This solution is not 100% secure and your PDF can still be accessed but it will at least helps hide the PDF file path from View Page Source.

Set the Encode PDF Source option to NO to hide the PDF File path from view source code.

Translations

Select the tab Translation to change button and text labels.

How do I create a direct link to a page?

To create a direct link to a specific page in the flip book add the #FLIPBOOK-[Hashtag]/{page_id}/ to the end of the page's url, where [Hashtag] is the module option hashtag and {page_id} is the page number to link to.

Example:

http://www.example.com/flipbook-webpage#FLIPBOOK-flipbook/5/

The Hashtag can be changed by selecting the Flipbook module's PDF Settings tab and editing the Hashtag option. For multiple PDFs, select the Multiple PDF Settings tab and edit the Hashtag option for each configured PDF.