Extension: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.5 (2020-11-23) |
| MediaWiki | 1.29.x - 1.35.x (1.30+ only works on some browsers) |
| PHP | 7.0+, 7.3 for 1.35.x |
| MediaWiki 1.36 | Not formally tested |
| MediaWiki 1.34 | Not formally tested |
| MediaWiki 1.32 | Not formally tested |
| Database changes | No |
| License | GNU Lesser General Public License 3.0 |
| Download | GitLab: Note: |
| Example | The Vault |
|
$wgPdfEmbed (width, height) |
|
|
pdf |
|
|
embed_pdf |
|
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
PDFEmbedin yourextensions/folder. - Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'PDFEmbed' );
- Configure at your convenience
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Done – Navigate to
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;
//Allow user the usage of the pdf tag
$wgGroupPermissions['*']['embed_pdf'] = true;
Usage Example[edit]
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[edit]
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 and compatibility wishes for Extension:PDF Include please use https://github.com/WolfgangFahl/PDFEmbed/issues.