Extension:PDFEmbed

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
PDFEmbed
Release status: stable
Implementation Tag, Media
Description Allows to embed PDF files into a page
Author(s) Alexia E. Smithtalk
Latest version 2.0.1 (2017-07-26)
MediaWiki 1.25+
PHP 5.6+
Database changes No
License GNU Lesser General Public License 3.0
Download
Example The Vault
Parameters
$wgPdfEmbed (width, height)
Tags
pdf
Added rights
embed_pdf
Hooks used
ParserFirstCallInit
Translate the PDFEmbed extension if it is available at translatewiki.net
Check usage and version matrix.

The PDFEmbed extension allows PDF files (uploaded to your wiki) to be embedded into a wiki page using <pdf></pdf> tags. The PDF file extension is automatically added and necessarily default permissions are configured. Future functionality will allow this extension to act as a media handler for PDF files.

Installation[edit]

  • Download and place the file(s) in a directory called PDFEmbed in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'PDFEmbed' );
    
  • Configure at your convenience
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration[edit]

If the default configuration needs to be altered add these settings to the "LocalSettings.php" file below the require:

// Default width for the PDF object container.
$wgPdfEmbed['width'] = 800;

// Default height for the PDF object container.
$wgPdfEmbed['height'] = 1090;

Usage Example[edit]

The PDF to be embedded must first be uploaded to the wiki through "Special:Upload". The namespace prefixed file name is then used between the tags to embed it in a page.

<pdf>File:Example.pdf</pdf>

With optional width and height.

<pdf width="500" height="300">File:Example.pdf</pdf>

Scroll to page 10 after document is rendered.

<pdf page="10">File:Example.pdf</pdf>

Change Log[edit]

v2.0.1
  • Switched over to iframes to support newer browsers.
v2.0.0
  • Converted to extension registration.
  • Forcing a max-width: 100%; on the object container.
v1.1.2
  • Added "page" parameter.
v1.1.1
v1.1.0
  • Fix PHP notices being thrown for some parameters.
  • Missing language string.

See also[edit]