Using PDF Embedder Premium

Thank you for purchasing PDF Embedder Premium or Premium Secure!

Installation

You should have received an email containing a link to a ZIP file when you purchased the product. Download the ZIP to your computer. In your WordPress site's admin panel, go to Plugins, click 'Add New', and then 'Upload Plugin'. Locate the ZIP file and then click 'Install Now'. Make sure you click to Activate the plugin.

If you already have an existing (free) PDF Embedder plugin installed then you must Deactivate that before attempting to upload the premium version.

Embedding a PDF

Inserting a PDF is as easy as uploading an image into a WordPress page. In your page/post editing screen, click 'Add Media'. Drag and drop your PDF anywhere into the media library and then click 'Insert into post'.

You should see a 'shortcode' like this:

[pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf"]

When you publish the post or page, this should display as an embedded document viewer for your users to step through the PDF!

Customizing the viewer

You can change the shape and toolbar appearance of all embeds on your site (i.e. set site-wide defaults) through the page Settings -> PDF Embedder in your WordPress admin.

Premium Options

All the settings there can also be overridden for individual embeds by adding parameters to the shortcode to configure how the document displays.

Size and Shape

You can optionally override width and height as follows:

[pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" width="500"]

Note the default value for width is 'max'.

Resizing works as follows:

  • If width='max' the width will take as much space as possible within its parent container (e.g. column within your page).
  • If width is a number (e.g. width='500') then it will display at that number of pixels wide.

In all cases, if the parent container is narrower than the width calculated above, then the document width will be reduced to the size of the container.

The height will be calculated so that the document fits naturally, given the width already calculated.

It is possible to specify a fixed height (e.g. height="200"), in which case the document may be cut off vertically.
The height will be reduced to fit if it is larger than needed to display the document correctly.

Customize the Toolbar

Toolbar Location

Add toolbar="[top|bottom|both|none]" to the shortcode to change the location of the Next/Prev toolbar (default is 'bottom').

E.g. [pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" toolbar="top"]

Toolbar Fixed/Hover

Add toolbarfixed="on" (default is 'off') to keep the toolbar open at all times rather than only when the user hovers over the document.
Note this extends the length of your embedded area.

E.g. [pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" toolbarfixed="on"]

Page Turners

Add pageturners="[on|off]" to determine whether the 'page turn arrows' should appear when hovering near the left/right edges of the document.

E.g. [pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" pageturners="on" toolbar="none"]

PDF Title

The PDF embed initially appears in the web page as a link to the PDF file, with the link text provided in the 'title' shortcode parameter (or the base filename if no 'title' is specified). This should be visible to search engine crawlers, and also to viewers in the case of Javascript failure or delay. The link will be replaced by the interactive PDF display as soon as the plugin's Javascript is able to run after the page loads.

E.g. [pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" title="Plan Summary"]

Download PDF

Download Button

Add download="[on|off]" to the shortcode to add a download button to the toolbar (default is 'on' for the regular premium version, 'off' for the secure version).

E.g. [pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" download="on"]

Mobile-friendly

By default, if the embed area is narrower than 500 pixels, the document will appear as a thumbnail with a large 'View in Full Screen' button. This is designed especially for mobile devices where it can be difficult to interact with a small area, but the same 500-pixel logic applies on any web browser.

You can change the cut-off width (or eliminate it entirely) by adding a mobilewidth parameter: e.g. mobilewidth="200", or "0" to always display the interactive document at any screen size. A 'Full Screen' button is always available on the toolbar, regardless.

E.g. [pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" mobilewidth="200"]

Page Number

You can optionally start on any page number in the PDF. For example, to open up on page 5:

[pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" page="5"]

Page Text Box

You can ensure the 'page number' text box is always visible for the user to enter a page number to jump to by using pagetextbox="on". If omitted or "off", the user needs to click on the page number display in order for it to change into a text box.

[pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" pagetextbox="on"]

Zoom starting percentage

Optionally specify the percentage zoom to start off display. For example for 50% zoom:

[pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" zoom="50"]

The full screen display, when first opened, will also use the zoom percentage you specify in the zoom parameter unless you also specify another parameter called fpzoom to override it.

For example, for the normal display to be at 50% zoom, but full screen version to be at 75%:

[pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" zoom="50" fpzoom="75"]

External Links

Links to external websites will open up in a new window if the relevant option is checked in Settings. You can override this behavior for an individual embed by adding the newwindow="on|off" parameter to the shortcode:

[pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" newwindow="off"]

Scroll to top

Scroll to top of page when user clicks next/prev, if this option is checked in Settings. You can override this behavior for an individual embed by adding the scrolltotop="on|off" parameter to the shortcode:

[pdf-embedder url="https://mysite.com/wp-content/uploads/2015/01/Plan-Summary.pdf" scrolltotop="on"]

Secure PDFs

If you are using the PDF Embedder Premium Secure version, you can find out more about the secure functionality here.

Support

We would very much like to hear from you with any questions or feedback at all. Please email contact@wp-pdf.com.

There is also a knowledge base where you can find answers to common questions.