MediaWiki extensions manual

PDFEmbed Release status: stableCategory:Stable extensions
Implementation	Tag Category:Tag extensions, MediaCategory:Media handling extensions
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.1 (2023-01-24)
MediaWiki	>= 1.40.0
PHP	7.3+
Database changes	No
License	GNU Lesser General Public License 3.0
Download	GitHub: project page git repository URL [help ] commit history Note: No localisation updates are provided by translatewiki.net . Category:Extensions in GitHub version control
Parameters $wgPdfEmbed (width, height)
Tags pdf
Added rights embed_pdf Category:Extensions which add rights
Hooks used ParserFirstCallInit Category:ParserFirstCallInit extensions

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.

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

See also

• Extension:PdfHandler
• Extension:Widgets (PDF-Widget)

This extension is included in the following wiki farms/hosts and/or packages: Fandom Category:Extensions included in Fandom Miraheze Category:Extensions included in Miraheze MyWikisCategory:Extensions included in MyWikis wiki.gg Category:Extensions included in wiki.gg WikiForgeCategory:Extensions included in WikiForge This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm.