MediaWiki extensions manual
PDFEmbed
Release status: stable
Implementation Tag , Media
Description Allows to embed PDF files into a page
Author(s) Alexia E. Smith, Wolfgang Fahl, Mark A. Hershberger, Chris Koerner and Spas Z.Spasov (Alexia E. Smithtalk)
Latest version 3.0.0 (2022-07-11)
MediaWiki 1.29.x - 1.38.x (1.30+ only works on some browsers)
PHP 7.0+, 7.3 for 1.35.x
Database changes No
License GNU Lesser General Public License 3.0
Download

GitHub:

Note:
No localisation updates are
provided by translatewiki.net .


Legacy version

GitLab:

Note:
No localisation updates are
provided by translatewiki.net .
Parameters
$wgPdfEmbed (width, height)
Tags
pdf
Added rights
embed_pdf
Hooks used
  • ParserFirstCallInit

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

  • 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 file: 
    wfLoadExtension( 'PDFEmbed' );
  • Configure at your convenience
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

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;

//Allow user the usage of the pdf tag
$wgGroupPermissions['*']['embed_pdf'] = true;

Usage Example

The PDF to be embedded must first be uploaded to the wiki through "Special:Upload".

<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>

Filing issues

As of 2020-10 there are two repositories for this extension. The original gitlab one at https://gitlab.com/hydrawiki/extensions/PDFEmbed and a "pseudo fork" at https://github.com/WolfgangFahl/PDFEmbed. For current issues, please use https://github.com/WolfgangFahl/PDFEmbed/issues.

See also

This article is issued from Mediawiki. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.